API de Débito Direto da Belvo (1.0.0)

Copiar

• Copiar para LLM

  Copiar página como Markdown para LLMs
• Ver como Markdown

  Abrir esta página como Markdown
• Abrir no ChatGPT

  Obter insights do ChatGPT
• Abrir no Claude

  Obter insights do Claude
• Conectar ao Cursor

  Instalar servidor MCP no Cursor
• Conectar ao VS Code

  Instalar servidor MCP no VS Code

Use o recurso Institutions para: listar todas as instituições para as quais você pode fazer pagamentos e de onde pode recebê-los.

Um Cliente é o usuário final, seja um indivíduo ou uma empresa, que possui a conta bancária envolvida em uma operação de débito ou pagamento. O Belvo Direct Debit armazena as informações essenciais deste Cliente para simplificar e reutilizá-las em vários métodos de pagamento e destinos de pagamento.

Um Método de Pagamento contém os detalhes da conta bancária de origem da qual você debitará os fundos.

Uma Solicitação de Pagamento é a transação real que você deseja executar para debitar fundos de uma conta. Cada Solicitação de Pagamento deve estar associada a um Método de Pagamento previamente criado. Para cada nova transação que você deseja realizar, é necessário criar uma nova Solicitação de Pagamento.

Use o recurso Movements para listar todos os Movements da conta (transações que ocorrem dentro da sua conta bancária).

Um Consentimento em Débito Direto é a prova de que seu cliente confirmou que terá fundos debitados de sua conta (Método de Pagamento). Essa prova é composta por fotos do documento de identidade, uma selfie e um contrato assinado.

Use o recurso Loans para registrar e rastrear instantâneos do portfólio de empréstimos para clientes de débito direto. Cada instantâneo captura o estado atual da dívida de um cliente.

Cada instantâneo é identificado de forma única por merchantCustomerId + targetCollectionDate, onde targetCollectionDate é a data em que a Belvo tentará coletar o pagamento — definida automaticamente para o dia em que a solicitação foi feita ou para o próximo dia útil no México. Você só pode fazer um POST de um instantâneo por cliente por dia; uma solicitação duplicada no mesmo dia do calendário retorna um 409 Conflict.