Credit Card Receivables

Resumo do saldo devedor

Obtém um resumo dos valores não quitados ou ainda não recebidos pelas credenciadoras dos recebíveis antecipados

get/credit-card-receivables/balance-summary

Request

  • Base URL
    https://api.sandbox.empresas.btgpactual.com
  • Auth
    OAuth 2
    Authorization codehttps://id.btgpactual.com/oauth2/authorize
    Token URLhttps://id.btgpactual.com/oauth2/token
    Scopesbrn:btg:empresas:credit:receivables-credit-card.readonly, brn:btg:empresas:credit:receivables-credit-card

Response

Success

companyIdstring

CNPJ da empresa

overdueReceivablesUnpaidAmountstring double

Soma dos valores não quitados de recebíveis vencidos

dueTodayReceivablesUnpaidAmountstring double

Soma dos valores não quitados de recebíveis vencendo hoje

Example response

{
  "companyId": "37297902000141",
  "overdueReceivablesUnpaidAmount": "200.12",
  "dueTodayReceivablesUnpaidAmount": "2000.12",
  "receivablesOverdue": [
    {
      "status": "InDisbursement",
      "balance": "2000.12",
      "interestArrears": "0",
      "latePaymentFee": "0",
      "penaltyFee": "0",
      "maturityDate": "2025-01-29"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.