Pagamentos
Permite pagar boletos com código de barras
A API de Pagamentos permite que você pague boletos de cobrança com código de barras registrados na Câmara Interbancária de Pagamentos CIP. Esta API permite realizar, cancelar ou reverter o pagamento e receber confirmações.
Casos de Uso
- Inserir numa plataforma a possibilidade de pagar contas.
- Receber notificações de pagamentos.
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 Pagamentos 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:
| Escopo | Descrição |
|---|---|
empresas.btgpactual.com/payments | Permite criar e consultar pagamentos. |
empresas.btgpactual.com/payments.readonly | Permite consultar pagamentos. |
Recursos Disponíveis
Os recursos da API de Pagamentos estão disponíveis no API Reference.
API Reference
Pagamentos agendados
Um pagamento pode ser agendado até 1 dia antes.
*O formato de data para agendar pagamentos é AAAA-MM-DD.
Caso não haja recursos suficientes para um pagamento, há novas tentativas de hora em hora.
Status de pagamentos
Um pagamento pode ter diversos status antes e depois de ser aprovado.
Antes da aprovação, um pagamento pode exibir os seguintes status:
| Status | Descrição |
|---|---|
| Authorized | Pagamento autorizado. |
| WrongCredentials | Pagamento não autorizado por falta de token ou biometria. |
| CreationError | Erro na criação da pagamento. |
| Canceled | Pagamento cancelado ou expirado. |
| ExecutionError | Erro na execução da pagamento. |
Depois de receber o status Authorized, um pagamento pode exibir os seguintes status:
| Status | Descrição |
|---|---|
| CREATED | Pagamento online em processamento. |
| CONFIRMED | Pagamento confirmado |
| REVERTED | Pagamento estornado |
| FAILED | Falha no pagamento |
| SCHEDULED | Pagamento agendado |
| ADJOURNED | Pagament em retentativa, será reprocessado pelo sistema |
| PROCESSED | Pagamento processado |
| CANCELED | Pagamento cancelado |
Os status CANCELED, FAILED e REVERTED não podem ser revertidos. Ao receber esses status, um pagamento é fechado.
O status CONFIRMED indica que houve débito na conta de origem, mas pode ser estornado.
Eventos de webhook
payments.*
{
"paymentId": "0d0000ac-0c00-0dd0-b00d-00c0e00a00cd",
"category": "BANKSLIP", //Categoria do pagamentos
"type": "BANKSLIP", //Tipo de pagamento
"amount": 1.01,
"scheduledDate": "2024-02-19",
"debitParty": {
"taxId": "00000080000000",
"name": "NOME DA PARTE DEBITADA",
"number": "000000000",
"branchCode": "50",
"bankCode": "208"
},
"detail": {
"digitableLine": "000000000900000000008000000000000000000000000000",
"barcode": "00000000000000000000800000000000000000000000",
"dueDate": "2024-02-21",
"payee": {
"socialName": "NOME SOCIAL DO PAGADOR",
"fantasyName": "NOME DA EMPRESA DO PAGADOR",
"taxId": "00000000000000",
"bankCode": "001"
}
},
"tags": {
"externalId": "TAG PRA IDENTIFICAR"
}
}
Updated 3 months ago