Segurança
BTG IdO 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 Onboarding consignado deve ser gerado usando o Client Credentials.
| Escopo | Descrição |
|---|---|
empresas.btgpactual.com/payer-register | Permite realizar o onboarding de consignado |
Eventos de webhook
O payload disponível abaixo representa o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.
| Eventos | Descrições |
|---|---|
| payroll-loan-payer.authorized | Notificação de mudanças de status para autorizado. |
| payroll-loan-payer.disapproved | Notificação de mudanças de status para reprovado. |
| payroll-loan-payer.error | Notificação de mudanças de status para error. |
| payroll-loan-payer.pending | Notificação de mudanças de status para pendente de ajuste. |
| payroll-loan-payer.pending_analysis | Notificação de mudanças de status para pendente de análise. |
payroll-loan-payer.*
{
"taxId": "111444445000333",
"onboardingId": "444e9444-6d27-4281-b01b-c8d14446d184",
"timestamp": "2025-07-23T13:18:30.1553811+00:00",
"status": "REPROVADO",
"reasons": [
"Entidade não encontrada na Receita Federal"
]
}