Recebíveis Cartão Crédito

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 Recebíveis de cartão de crédito 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 informar um dos seguintes escopos na realização do fluxo:

Máquina de estados do Recebível

Códigos de Erro

A tabela abaixo contém os códigos de erros que a API devolve, quando falha em operar, e suas respectivas descrições indicando o causador da falha.

Eventos de webhook

Os payloads disponíveis abaixo representam o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.

receivables-credit-card.update

{  
  "receivable": {  
    "receivableId": 20,  
    "payerId": "01027058000191",  
    "payeeId": "37297902000141",  
    "maturityDate": "2024-02-15",  
    "brand": "Visa",  
    "maturityAmount": 50000.55,  
    "maximumDisbursementAmount": 40000.44,  
    "status": "InDisbursement"  
  },  
  "registeredAmount": 30500.35,  
  "disbursementAmount": 30000.33  
}

receivables-credit-card.balance-summary

Enviado todos os dias às 11h.

{  
  “companyId”: “37297902000141”,  
  "overdueReceivablesUnpaidAmount": 200.12,  
  "dueTodayReceivablesUnpaidAmount": 2000.12  
}