Pix Cobrança

A API de Pix Cobrança possibilita a criação, consulta e gerenciamento de QR code dinâmico para pagamentos. O cliente recebedor poderá liquidar os pagamentos atraves da API ou da assinatura dos eventos de webhooks.

Casos de Uso

  • Utilizar a Pix Cobrança do BTG Empresas como meio de pagamento em um e-commerce.
  • Criar Pix Cobrança a partir de um ERP.
  • Integração com sistemas de contas a receber.
  • Aplicativos móveis com funcionalidade de emissão e gerenciamento de QR Code Dinâmico de Cobrança.

Segurança

📘

BTG Id

O BTG Id é o authorization server do BTG Pactual, responsável pelos fluxos de autenticação, autorização e emissão de access tokens com escopos necessários para consumir a API.

O token para consumo da API de Pix Cobrança deve ser gerado utilizando o fluxo Authorization Code. Abaixo os escopos necessários:

EscopoDescrição
openidEscopo que dá permissão a consulta do perfil do usuário BTG com acesso a conta.
empresas.btgpactual.com/pix-cash-inEscopo que dá permissão para criação, consulta de Pix Cobrança e recebimento de webhooks.
empresas.btgpactual.com/pix-cash-in.readonlyEscopo que dá permissão para consulta de Pix Cobrança e recebimento de webhooks.

Recursos Disponíveis

Os recursos da API de Pix Cobrança estão documentados no API Reference, que pode ser acessado através do link abaixo.

📘

API Reference

Pix Cobrança API

Eventos

A API de Pix Cobrança disponibiliza uma série de eventos de webhook, que podem ser utilizados para receber atualizações das transições de status:

Identificação do EventoEventoDescrição
instant-collection.unlinkedQR code desvinculado da cobrançaOcorre quando um QR code de pix cobrança é desvinculado.
instant-collection.paidPix cobrança pagoOcorre quando um pix cobrança é pago.