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:

Escopo	Descrição
`brn:btg:empresas:receivables:credit-card`	Permite a consulta dos dados e criação de uma antecipação de recebível
`brn:btg:empresas:receivables:credit-card.readonly`	Permite consulta do dados de uma antecipação de recebível

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.

Código	Descrição
OPRCC000	Erro inesperado
OPRCC001	Empresa não cadastrada
OPRCC002	Conta de Desembolso não cadastrada
OPRCC003	Nenhum recebível solicitado foi encontrado
OPRCC004	Recebíveis solicitados não pertencem a empresa
OPRCC005	Recebíveis solicitados não estão disponíveis para antecipar
OPRCC006	Valor solicitado maior que o valor disponível para antecipar
OPRCC007	Valor solicitado menor que o valor mínimo possível
OPRCC008	Limite não cadastrado para a empresa
OPRCC009	Operação fora da grade horária
OPRCC010	Empresa não pode operar por não pagar o Saldo Devedor
OPRCC011	Paginador com valores inconsistentes

Eventos de webhook

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

Evento	Descrição
`receivables-credit-card.update`	Atualização do recebível
`receivables-credit-card.balance-summary`	Informe do saldo devedor
`receivables-credit-card.batch-receivable-update`	Atualização dos recebíveis em lote
`receivables-credit-card.batch-operation-update`	Atualização das operações em lote

receivables-credit-card.update

{
    "receivable": {
        "receivableId": 107629006,
        "payerId": "01027058000191",
        "payeeId": "37297902000141",
        "maturityDate": "2025-07-17",
        "scheme": "Elo",
        "maturityAmount": "4913.42",
        "status": "WaitingSignatures"
    },
    "registeredAmount": "0.00",
    "disbursementAmount": "4900.15"
}

receivables-credit-card.balance-summary

Enviado todos os dias às 10h.

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

receivables-credit-card.batch-receivable-update

[
    {
        "receivable": {
            "receivableId": 107629006,
            "payerId": "01027058000191",
            "payeeId": "37297902000141",
            "maturityDate": "2025-07-17",
            "scheme": "Elo",
            "maturityAmount": "4913.42",
            "status": "WaitingSignatures"
        },
        "registeredAmount": "0.00",
        "disbursementAmount": "4900.15"
    },
    {
        "receivable": {
            "receivableId": 107629612,
            "payerId": "01027058000191",
            "payeeId": "37297902000141",
            "maturityDate": "2025-07-18",
            "scheme": "AmericanExpress",
            "maturityAmount": "1065.60",
            "status": "WaitingSignatures"
        },
        "registeredAmount": "0.00",
        "disbursementAmount": "1061.76"
    }
]

receivables-credit-card.batch-operation-update

[
    {
        "operation": {
            "operationId": 59428,
            "status": "Cancelled",
            "payerId": "01027058000191",
            "payeeId": "37297902000141"
        }
    }
]