Débito

🚧

Funcionalidade

O endpoint de Débito está disponível apenas para parceiros cadastrados na funcionalidade.

Consulte nosso time de atendimento para saber mais!

💸 Realizando Débito em Conta Corrente

O endpoint de Débito em Conta Corrente

permite ao parceiro lançar um débito na conta corrente Nikos do cliente. O lançamento terá efeito imediato se as informações forem enviadas corretamente.

Para realizar a requisição, é necessário fornecer os dados da conta de destino do débito. Para obter as contas bancárias cadastradas para o cliente, consulte a seção Contas Bancárias.

Caso necessário, a lista de bancos está disponível na seção Bancos.

📘

Conta Bancária

Diferentemente do Crédito, a conta bancária fornecida na requisição DEVE ser uma das contas cadastradas para o cliente. Consulte a seção Contas Bancárias para obter as contas disponíveis.

Para o uso correto do Débito em Conta Corrente, as seguintes informações devem ser fornecidas na requisição:

🆔 user_virtual_account: Campo indicando a subconta do cliente.

🔢 destiny_account_number: Número da conta bancária de destino. Consultar as contas bancárias do cliente em Contas Bancárias.

🔢 destiny_account_digit: Número do dígito verificador da conta bancária de destino. Consulte as contas bancárias do cliente na seção Contas Bancárias.

💰 amount: Valor a ser debitado.

🔤 external_id: ID de identificação externo fornecido pelo parceiro, podendo ser constituído por qualquer caractere. Campo opcional.

O endpoint fará as seguintes verificações para concluir do débito corretamente:

  • Se o parceiro está cadastrado na funcionalidade.
  • Se a conta é de um cliente presente na base do parceiro.
  • Se a conta bancária de destino é uma das contas bancárias cadastradas para o cliente.
  • Se a conta bancária de destino é de um dos bancos exclusivos para retirada. Consulte a seção Bancos Exclusivos para Retiradas para verificar os bancos exclusivos para seu parceiro.
  • Se o cliente possui saldo.

📃 Extrato

Com o débito realizado corretamente, é possível consultar o extrato do cliente na seção Extrato Financeiro.

O saldo do cliente após o débito pode ser consultado na seção Saldo.

Além disso, é possível buscar os débitos realizados pelo parceiro. Basta realizar uma consulta na seção Lista de Débitos. Os filtros disponíveis estão descritos na página do endpoint.