Pix Cobrança

Crie e gerencie QR codes dinâmicos para pagamentos via Pix

Suggest Edits

A API de Pix Cobrança permite que você crie e gerencie QR codes dinâmicos para pagamentos via Pix Contas corrente e de pagamento podem receber Pix.

Casos de Uso

*Pagamentos via Pix podem ser feitos usando apenas dados bancários.

  • Usar Pix Cobrança do BTG Empresas como meio de pagamento.
  • Criar Pix Cobrança a partir de um sistema de gestão empresarial.
  • Integrar um sistema de contas a receber.
  • Aplicativos móveis com emissão e gerenciamento de QR codes dinâmicos de cobrança.

Segurança

📘

BTG Id

O Authorization Server do BTG Empresas se chama BTG Id. Usando o BTG Id, um aplicativo parceiro consegue consentimento e autorização para executar operações nas APIs do BTG em nome do cliente. Para saber mais, acesse a documentação do BTG Id

Escopos necessários

O token para consumir a API de Pix Cobrança deve ser gerado usando o Authorization Code.

O escopo openidé obrigatório. Ele permite consultar o perfil do usuário BTG com acesso à conta.

É necessário escolher um dos seguintes escopos:

EscopoDescrição
empresas.btgpactual.com/pix-cash-inPermite criação e consulta de Pix Cobrança e recebimento de webhooks.
empresas.btgpactual.com/pix-cash-in.readonlyPermite consulta de Pix Cobrança e recebimento de webhooks.

Recursos Disponíveis

Os recursos da API de Pix Cobrança estão disponíveis no API Reference.

📘

API Reference

Pix Cobrança

Eventos

A API de Pix Cobrança disponibiliza os seguintes eventos de webhook:

instant-collection.paid

Indica Pix Cobrança pago.

{
  "id": "488f99ff-15d5-4694-ba6a-bcea811935b5",
  "txId": "f35eb3fa37904cff8cdbb5cca30f7bad",
  "status": "PAID",
  "pixKey": "b1e00008-0005-4a9c-ab05-70003ed62452",
  "displayText": "Fatura 000000008",
  "amount": {
    "value": 720,
    "allowCustomerChangeValue": false
  },
  "location": {
    "id": "9c14c560-7a8b-47ec-a77f-00e94b5cc0ec",
    "integrationId": "3047031029004432472",
    "type": "cob",
    "path": "00000000000001/9c14c560-7a8b-47ec-a77f-00e94b5cc0ec.png",
    "description": "Fatura 000000008",
    "url": "https://static.empresas.btgpactual.com/pix/dynamic/qrcode/00000000000000/9c14c560-7a8b-47ec-a77f-00e94b5cc0ec.png",
    "integrationUrl": "api.developer.btgpactual.com/v1/p/v2/b1f11f2b088e497995e7c4090185814a"
  },
  "paidAt": "2023-05-04T14:41:06.0530057Z",
  "paidAmount": 720,
  "payee": {
    "taxId": "00000000000001",
    "currency": "BRL",
    "branchCode": "00",
    "number": "000000006"
  },
  "paidBy": {
    "taxId": "000000000000002",
    "name": "JUBIABA LTDA",
    "currency": "BRL",
    "branchCode": "50000",
    "number": "10000"
  }
}

instant-collection.unlinked

Indica que um QR code foi desvinculado da cobrança.

{
  "id": "343e5732-5c76-490e-9b66-9869c0669813",
  "txId": "8f452f7ad1ad4d51ba391db932fadb8b",
  "taxId": "0000000000001",
  "status": "UNLINKED",
  "pixKey": "[email protected]",
  "displayText": "",
  "amount": {
    "value": 1,
    "allowCustomerChangeValue": false
  },
  "location": {
    "id": "b649febc-9711-4c83-bfc5-b16a335370f2",
    "type": "cob",
    "description": ""
  },
  "tags": {
    "order": "dev1",
    "venda": "281862"
  }
}

Updated 3 months ago