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 Autorização de pix automático deve ser gerado usando o Authorization Code.
É necessário incluir o seguinte escopo:
| Escopo | Descrição |
|---|---|
| brn:btg:empresas:banking:collections | Permite a consulta e gestão de cobrança |
Especificidades
Autorização com valor variável
Para a emissão de autorização de pix automático com valor variável é necessário que o campo amount não seja enviado. Desta maneira, o sistema irá inferir que não um valor fixo.
Eventos de webhook
Os payloads disponíveis abaixo representam o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.
automatic-pix.authorization-created
{
"authorizationId": "1a34ece5-8ae1-4659-977e-b5bac829c4eb",
"createdAt": "2025-06-28T01:41:20.901Z",
"initialDate": "2025-07-30",
"link": {
"contract": "270620251040",
"debtor": {
"taxId": "***153188**",
"name": "Nome do Pagador",
"personType": "F"
}
},
"origin": "DEVELOPERS",
"payee": {
"taxId": "00000000000000",
"name": "Nome da Empresa",
"personType": "J",
"account": {
"number": "000000000",
"branchCode": "50",
"status": "PARTIALLY_BLOCKED"
},
"desk": "PME"
},
"period": "MONTHLY",
"requests": [],
"retryPolicy": "ACCEPT_3R_7D",
"status": "CREATED",
"updatedAt": "2025-06-28T01:41:20.901Z",
"useLineOfCredit": true,
"activation": {
"journeyType": "WAITING_DEFINITION",
"txId": "b49adc6480d84eda87b3653cedc2a6fc"
},
"externalId": "36daac06-eaeb-4fe7-8088-c59f38d585be",
"finalDate": "2026-05-30",
"location": {
"locationId": "31231abb-c822-43a6-8bfd-7c13c4d9b359",
"payeeTaxId": "00000000000000",
"typeCob": "REC",
"createdAt": "2025-06-28T01:41:23.008Z",
"externalId": 9082893086585425000,
"externalUrl": "api.developer.btgpactual.com/pc/p/v2/rec/361be04ccc8a48fe95376bfcfb4bdeec",
"path": "00000000000000/31231abb-c822-43a6-8bfd-7c13c4d9b359.png",
"url": "https://static.empresas.btgpactual.com/pix/dynamic/qrcode/00000000000000/31231abb-c822-43a6-8bfd-7c13c4d9b359.png"
},
"minimumAmountPayee": 0.01,
"qrCodeInfo": {
"emv": "00020101021226910014br.gov.bcb.pix2569api.developer.btgpactual.com/pc/p/v2/3***80950014br.gov.bcb.pix2573api.developer.btgpactual.com/pc/p/v2/rec/361be04ccc8a48fe95376bfcfb4bdeec6304C47B",
"journeyType": "JOURNEY_3"
},
"totalInstallments": 10
}automatic-pix.scheduling-approved
{
"authorizationId": "1a34ece5-8ae1-4659-977e-b5bac829c4eb",
"createdAt": "2025-06-28T01:41:20.901Z",
"initialDate": "2025-07-30",
"link": {
"contract": "270620251040",
"debtor": {
"name": "Nome do Pagador",
"taxId": "***153188**",
"personType": "F"
}
},
"origin": "DEVELOPERS",
"payee": {
"name": "Nome da Empresa",
"taxId": "00000000000000",
"personType": "J",
"account": {
"branchCode": "50",
"number": "000000000"
},
"desk": "PME"
},
"period": "MONTHLY",
"requests": [],
"retryPolicy": "ACCEPT_3R_7D",
"status": "APPROVED",
"updatedAt": "2025-06-28T01:44:29.716Z",
"useLineOfCredit": true,
"activation": {
"journeyType": "JOURNEY_3",
"txId": "b49adc6480d84eda87b3653cedc2a6fc"
},
"approvedAt": "2025-06-28T01:44:29.716Z",
"externalId": "36daac06-eaeb-4fe7-8088-c59f38d585be",
"finalDate": "2026-05-30",
"location": {
"locationId": "31231abb-c822-43a6-8bfd-7c13c4d9b359",
"payeeTaxId": "00000000000000",
"typeCob": "REC",
"createdAt": "2025-06-28T01:41:23.000Z",
"path": "00000000000000/31231abb-c822-43a6-8bfd-7c13c4d9b359.png",
"url": "https://static.empresas.btgpactual.com/pix/dynamic/qrcode/00000000000000/31231abb-c822-43a6-8bfd-7c13c4d9b359.png"
},
"minimumAmountPayee": 0.01,
"payer": {
"taxId": "***153188**",
"personType": "F",
"account": {
"number": "000000000",
"branchCode": "00",
"ispbParticipant": "00000000"
}
},
"qrCodeInfo": {
"journeyType": "JOURNEY_3",
"emv": "00020101021226910014br.gov.bcb.pix2569api.developer.btgpactual.com/pc/p/v2/3***80950014br.gov.bcb.pix2573api.developer.btgpactual.com/pc/p/v2/rec/361be04ccc8a48fe95376bfcfb4bdeec6304C47B"
},
"totalInstallments": 10
}