Lista de Actions

Ações no Hub são requisições HTTP na API Pagar.me. Cada ação representa um recurso da API, ou seja, um verbo (GET, POST, etc) sobre um endpoint (/core/v5/orders, /core/v5/charges/{chargeId}, etc).

🚧
URL das Actions
Na interação como aplicativo, as requisições devem ser enviadas para https://hubapi.pagar.me, a tecnologia do Hub irá funcionar como uma camada acima da tecnologia da V5, sendo assim você irá realizar a chamada para a URL descrita acima e com uma autenticação (basic Auth) utilizando o Accesstoken (chave enviada na integração do Lojista com o APP) em Base 64.
Exemplo de listagem de pedidos:
Authorization :
Basic ODc5ZDAyMzU4OGJhYmE3YTgyZGE1ODkwOWExYjY2MmU0ZTU1YWE2MzQ1YzY4ZjA5MDZhYmU1ZjYwMGI2ODBhYg==
POSThttps://hubapi.pagar.me/core/v1/orders

Você pode ver a listagem de Actions e suas respectivas descrições nesta API ou na tabela abaixo com as respectivas documentações.

Permissão no HUB	Referência da API
Criar Cobrança	https://docs.pagar.me/reference/incluir-cobran%C3%A7a-no-pedido
Obter Cobrança	https://docs.pagar.me/reference/obter-cobran%C3%A7a
Listar Cobranças	https://docs.pagar.me/reference/listar-cobran%C3%A7as
Capturar Cobrança	https://docs.pagar.me/reference/capturar-cobran%C3%A7a
Cancelar Cobrança	https://docs.pagar.me/reference/cancelar-cobran%C3%A7a-1 https://docs.pagar.me/reference/cancelar-cobran%C3%A7a-com-split-1
Atualizar Cartão de Cobrança	https://docs.pagar.me/reference/editar-cart%C3%A3o-de-cobran%C3%A7a
Atualizar Vencimento de Cobrança	https://docs.pagar.me/reference/editar-data-de-vencimento-da-cobran%C3%A7a
Atualizar Pagamento de Cobrança	https://docs.pagar.me/reference/editar-m%C3%A9todo-de-pagamento
Retentar Cobrança	https://docs.pagar.me/reference/retentar-uma-cobran%C3%A7a-manualmente
Criar Pedido	https://docs.pagar.me/reference/criar-pedido-2 https://docs.pagar.me/reference/criar-pedido-multimeios https://docs.pagar.me/reference/criar-pedido-multicompradores https://docs.pagar.me/reference/criar-pedido-com-meio-de-pagamento-checkout https://docs.pagar.me/reference/criar-pedido-com-meio-de-pagamento-checkout-multimeios https://docs.pagar.me/reference/criar-pedido-com-split-1
Obter Pedido	https://docs.pagar.me/reference/obter-pedido
Listar Pedidos	https://docs.pagar.me/reference/listar-pedidos
Fechar Pedido	https://docs.pagar.me/reference/fechar-um-pedido
Criar Item de Pedido	https://docs.pagar.me/reference/incluir-item
Atualizar Item de Pedido	https://docs.pagar.me/reference/editar-item-do-pedido
Deletar Item de Pedido	https://docs.pagar.me/reference/deletar-item
Deletar Todos Itens do Pedido	https://docs.pagar.me/reference/remover-todos-os-itens
Criar Cliente	https://docs.pagar.me/reference/criar-cliente-1
Obter Cliente	https://docs.pagar.me/reference/obter-cliente-1
Listar Clientes	https://docs.pagar.me/reference/listar-clientes-1
Atualizar Cliente	https://docs.pagar.me/reference/editar-cliente-1
Criar Cartão	https://docs.pagar.me/reference/criar-cart%C3%A3o
Obter Cartão	https://docs.pagar.me/reference/obter-cart%C3%A3o
Listar Cartões	https://docs.pagar.me/reference/listar-cart%C3%A3o
Atualizar Cartão	https://docs.pagar.me/reference/editar-cart%C3%A3o
Deletar Cartão	https://docs.pagar.me/reference/excluir-cart%C3%A3o
Criar Endereço	https://docs.pagar.me/reference/criar-endere%C3%A7o-1
Obter Endereço	https://docs.pagar.me/reference/obter-endere%C3%A7o-1
Listar Endereços	https://docs.pagar.me/reference/listar-endere%C3%A7os-1
Deletar Endereço	https://docs.pagar.me/reference/excluir-endere%C3%A7o-1
Atualizar Endereço	https://docs.pagar.me/reference/editar-endere%C3%A7o-1
Criar Plano	https://docs.pagar.me/reference/criar-plano-1
Obter Plano	https://docs.pagar.me/reference/obter-plano-1
Listar Planos	https://docs.pagar.me/reference/listar-planos-1
Atualizar Plano	https://docs.pagar.me/reference/editar-plano-1
Deletar Plano	https://docs.pagar.me/reference/excluir-plano-1
Atualizar Metadata de Plano	https://docs.pagar.me/reference/editar-metadados-do-plano-1
Criar Item do Plano	https://docs.pagar.me/reference/incluir-item-2
Atualizar Item do Plano	https://docs.pagar.me/reference/editar-item-1
Deletar Item do Plano	https://docs.pagar.me/reference/remover-item-1
Criar Assinatura	https://docs.pagar.me/reference/criar-assinatura-avulsa https://docs.pagar.me/reference/criar-assinatura-de-plano-1
Obter Assinatura	https://docs.pagar.me/reference/obter-assinatura-1
Cancelar Assinatura	https://docs.pagar.me/reference/cancelar-assinatura-1
Listar Assinaturas	https://docs.pagar.me/reference/listar-assinaturas-1
Atualizar Cartão de uma Assinatura	https://docs.pagar.me/reference/editar-cart%C3%A3o-da-assinatura-1
Atualizar Método de Pagamento de uma Assinatura	https://docs.pagar.me/reference/editar-meio-de-pagamento-da-assinatura
Atualizar Metadata de uma Assinatura	https://docs.pagar.me/reference/editar-metadados-da-assinatura-1
Atualizar Afiliação de Gateway de uma Assinatur	https://docs.pagar.me/reference/editar-afilia%C3%A7%C3%A3o-da-assinatura-no-gateway
Criar Item na Assinatura	https://docs.pagar.me/reference/incluir-item-1
Atualizar Item na Assinatura	https://docs.pagar.me/reference/editar-item
Deletar Item na Assinatura	https://docs.pagar.me/reference/remover-item
Incluir Uso de Item na Assinatura	https://docs.pagar.me/reference/incluir-uso
Deletar Uso de Item na Assinatura	https://docs.pagar.me/reference/remover-uso
Listar Usos de Item na Assinatura	https://docs.pagar.me/reference/listar-uso
Criar Desconto na Assinatura	https://docs.pagar.me/reference/incluir-desconto-1
Deletar Desconto na Assinatura	https://docs.pagar.me/reference/remover-desconto-1
Criar Fatura	https://docs.pagar.me/reference/criar-fatura-1
Obter Fatura	https://docs.pagar.me/reference/obter-fatura-1
Listar Fatura	https://docs.pagar.me/reference/listar-faturas-1
Cancelar Fatura	https://docs.pagar.me/reference/cancelar-fatura-1
Criar Recebedor	https://docs.pagar.me/reference/criar-recebedor-1
Obter Recebedor	https://docs.pagar.me/reference/obter-recebedor-1
Atualizar Recebedor	https://docs.pagar.me/reference/editar-recebedor-1
Listar Recebedores	https://docs.pagar.me/reference/listar-recebedores-1
Incluir incremento	https://docs.pagar.me/reference/incluir-incremento-1
Obter incremento	https://docs.pagar.me/reference/obter-incremento-1
Listar incrementos	https://docs.pagar.me/reference/listar-incrementos
Remover incremento	https://docs.pagar.me/reference/remover-incremento-1
Renovar ciclo	https://docs.pagar.me/reference/renovar-ciclo-1
Obter ciclo	https://docs.pagar.me/reference/obter-ciclo-1
Listar ciclos	https://docs.pagar.me/reference/listar-ciclos-1
Editar data de início da assinatura	https://docs.pagar.me/reference/editar-data-de-in%C3%ADcio-da-assinatura-1
Editar preço mínimo da assinatura	https://docs.pagar.me/reference/editar-minimum-price-da-assinatura
Ativar faturamento manual	https://docs.pagar.me/reference/ativar-faturamento-manual-1
Desativar faturamento manual	https://docs.pagar.me/reference/desativar-faturamento-manual-1
Editar regras do Split	https://docs.pagar.me/reference/editar-ativa%C3%A7%C3%A3o-ou-regras-do-split
Obter saldo	https://docs.pagar.me/reference/obter-saldo
Criar saque	https://docs.pagar.me/reference/cria-saque-1
Obter saque	https://docs.pagar.me/reference/obter-saque-1
Listar saques	https://docs.pagar.me/reference/listar-saques-1
Atualizar configurações de antecipação automática	https://docs.pagar.me/reference/atualizar-informa%C3%A7%C3%B5es-de-antecipa%C3%A7%C3%A3o-autom%C3%A1tica-1
Listar descontos	https://docs.pagar.me/reference/listar-descontos-2
Obter desconto	https://docs.pagar.me/reference/obter-desconto-1
Listar itens de uma assinatura	https://docs.pagar.me/reference/listar-%C3%ADtens-de-uma-assinatura
Remover desconto	https://docs.pagar.me/reference/remover-desconto-1
Obter item do pedido	https://docs.pagar.me/reference/obter-item-do-pedido
Renovar cartão	https://docs.pagar.me/reference/renovar-cart%C3%A3o-1
Excluir cartão	https://docs.pagar.me/reference/excluir-cart%C3%A3o
Editar cartão de cobrança	https://docs.pagar.me/reference/editar-cart%C3%A3o-de-cobran%C3%A7a
Editar método de pagamento	https://docs.pagar.me/reference/editar-m%C3%A9todo-de-pagamento
Confirmar cobrança (cash)	https://docs.pagar.me/reference/confirmar-cobran%C3%A7a-cash
Deletar item	https://docs.pagar.me/reference/deletar-item
Obter recebíveis	https://docs.pagar.me/reference/retornando-receb%C3%ADveis
Obter um recebível	https://docs.pagar.me/reference/obter-receb%C3%ADveis-copy
Obter histórico das operações	https://docs.pagar.me/reference/obter-hist%C3%B3rico-das-opera%C3%A7%C3%B5es
Obter histórico específico de uma operação	https://docs.pagar.me/reference/obter-hist%C3%B3rico-espec%C3%ADfico-de-uma-opera%C3%A7%C3%A3o

📘
Tokenização de Cartão
A Tokenização de Cartão, por ser um recurso público que é autenticado apenas com a public key do lojista deve ser feita diretamente pelo API Pagar.me. O seu app receberá a public key do lojista na instalação, porém para utilizar o token do cartão será necessário permissão em algum recurso que utilize essa funcionalidade como OrderCreate ou SubscriptionCreate.
https://docs.pagar.me/reference/criar-token-cart%C3%A3o-1

📘
API de Bins
É uma API pública que também devem ser utilizadas diretamente na API Pagar.me e não necessita autenticação.
https://docs.pagar.me/reference/obter-informa%C3%A7%C3%B5es-do-bin

PermissãoObter Conta:

Esta permissão é um pouco diferente, ao adicioná-la ao seu Aplicativo você poderá obter dados configurados na conta pagar.me, da loja que instalou o seu aplicativo.

Essas informações podem ser usadas para modelar o seu negócio e facilitar ainda mais a utilização da loja em sua aplicação.

Request

Path

GET https://hubapi.pagar.me/core/v1/accounts/{accountId}

Query Params:

accountId → É o ID da “loja” do Estabelecimento dentro da Merchant

Autenticação

Autenticação em Base64 com o accesstoken

Response

  
  {  
    "id": "acc_0000000000000000",  
    "secret_key": "****************", 
    "public_key": "pk_test_0000000000000000",  
    "name": "test0",  
    "time_zone": "E. South America Standard Time",  
    "default_currency": "BRL",  
    "status": "active",  
    "antifraud_settings": {  
        "auto_cancel": true,  
        "auto_capture": true  
    },  
    "mundipagg_settings": {  
        "merchant_key": "****************",  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "pagarme_settings": {  
        "api_key": "****************",
        "crypto_key": "****************",
        "updated_at": "2021-08-25T22:42:45Z",  
        "version": 4  
    },  
    "credit_card_settings": {  
        "enabled": true,  
        "gateway": "simulator",  
        "updated_at": "2022-05-18T02:53:17Z"  
    },  
    "debit_card_settings": {  
        "enabled": true,  
        "gateway": "simulator",  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "voucher_settings": {  
        "enabled": true,  
        "gateway": "simulator"  
    },  
    "boleto_settings": {  
        "enabled": true,  
        "bank": "001",  
        "instructions": "Pay until payday.",  
        "gateway": "pagarme",  
        "updated_at": "2021-08-25T22:44:09Z",  
        "due_days": 3  
    },  
    "bank_transfer_settings": {  
        "enabled": true,  
        "bank": "001",  
        "gateway": "mundipagg",  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "wallet_settings": {  
        "max_cards": 10,  
        "enabled": true,  
        "updated_at": "2021-04-12T23:46:47Z",  
        "shared": false,  
        "customer_default": {}  
    },  
    "safetypay_settings": {  
        "enabled": true,  
        "gateway": "mundipagg",  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "facebook_settings": {  
        "app_id": null,  
        "app_secret": "****************",  
        "permissions": null,  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "general_settings": {  
        "display_name": "Ka testes - test",  
        "logo": null,  
        "email": null,  
        "website": null,  
        "theme": null,  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "split_settings": {  
        "enabled": true,  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "subscription_settings": {  
        "enabled": true,  
        "boleto_due_days": null,  
        "usage_report_enabled": false  
    },  
    "order_settings": {  
        "multi_payments_enabled": true,  
        "multi_buyers_enabled": true,  
        "open_orders_enabled": true,  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "notification_settings": {  
        "enabled": true,  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "guaranteed_cancellation_settings": {  
        "enabled": true,  
        "updated_At": "2021-04-12T23:46:47Z"  
    },  
    "renew_card_settings": {  
        "renew_on_payment_enabled": true,  
        "manual_renew_enabled": true,  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "cash_Settings": {  
        "enabled": true,  
        "updated_At": "2021-04-12T23:46:47Z"  
    },  
    "checkout_settings": {  
        "address_type": "brazilian",  
        "enabled": true,  
        "updated_at": "2021-04-12T23:46:47Z"  
    },  
    "pix_settings": {  
        "enabled": false,  
        "updated_at": "2023-06-12T20:36:54Z"  
    }  
}