Cadastro simplificado de pagador

A API de cadastro simplificado de pagador permite ao parceiro criar um pedido de cadastro entidades pagadoras nos sistemas BTG Pactual.

O seu pedido pode ser reprovado. Para mais informações quanto ao motivo de reprovação, entre em contato com o time de negócios.

Para a utilização da API, caso seja obrigatório o envio de documentos(conforme previamente acordado com o time de business), o cliente precisará fazer uso da API de Arquivos para fazer o upload de documentos referentes ao pagador.

Caso seja necessário, as chaves obtidas pela API de Arquivos devem ser incluídos no corpo da requisição, dentro do objeto documents. Veja Cadastro simplificado de pagadorpara mais infos.

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 cadastro simplificado de pagador deve ser gerado usando o Client Credentials.

É necessário informar o seguinte escopo na realização do fluxo:

EscopoDescrição
empresas.btgpactual.com/payer-onboardingsCadastro de entidade pagadora

Recursos Disponíveis

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

📘

API Reference

Cadastro simplificado de pagador

Eventos

A API de sacado simples dispara os eventos de webhook a seguir:

  • payer-onboarding.updated
{
"onboardingId": "", //Identificador único do pedido de cadastro
"timestamp": "", //Horario da atualização
"status": "PENDENTE_ONBOARDING", //Status do pedido
"reasons" [] //Motivo da alteração do status
}