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:

EscopoDescrição
empresas.btgpactual.com/paymentsPermite criar e consultar pagamentos.
empresas.btgpactual.com/payments.readonlyPermite consultar pagamentos.

Recursos Disponíveis

Os recursos da API de Pagamentos estão disponíveis no API Reference.

📘

API Reference

Pagamentos

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:

StatusDescrição
AuthorizedPagamento autorizado.
WrongCredentialsPagamento não autorizado por falta de token ou biometria.
CancelledPagamento cancelado ou expirado.
CreationErrorErro na criação da pagamento.
ExecutionErrorErro na execução da pagamento.

Depois de receber o status Authorized, um pagamento pode exibir os seguintes status:

StatusDescrição
CREATEDPagamento online em processamento.
CONFIRMEDPagamento confirmado
REVERTEDPagamento estornado.
FAILEDFalha no pagamento.
SCHEDULEDPagamento agendado
ADJOURNEDPagament em retentativa, será reprocessado pelo sistema
PROCESSEDPagamento processado
CANCELEDPagamento 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.