Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

POST /api/debito

Endpoint responsável por Efetuar um Débito em Conta, retornando os dados do mesmo em caso de sucesso. Para efetuar esse Débito o Parceiro precisa enviar o Token da Autorização (Gerado no enpoint Solicitar Autorização de Débito em Conta, também presente nesta Documentação), assim como o NSU e o Valor referente a esse débito.

...

Schema:

Campo

Tipo

DescriçãoTamanho Máximo

Obrigatório

idDebito

Long

ID que identifica o Débito que foi Cadastrado.

-

Sim

idDebitoAutorizacaoidDebitoStatus

LongInt32

ID que identifica a Autorização registrada para o status do Débito Automático na conta em questãoConta.

-

Sim

idDebitoStatusdescricaoStatus

Int32

ID que identifica o status String

Descrição do Status do Débito em Conta.

1 - Aguardando Processamento

Débito foi cadastrado e está aguardando processamento.

2 - Processado

Débito foi processado com sucesso e a movimentação financeira foi realizada.

3 - Não Autorizado

Débito não foi Autorizado.

4 - Falha no Serviço Bancário

Ocorreu um erro não esperado ao processar a movimentação financeira através do serviço bancário.

5 - Cancelado

Débito foi cancelado e não será processado novamente.

Sim

mensagem

String

Mensagem de apoio para o processo.

nsu

Long

Número Sequencial Único Disponibilizado pelo Parceiro.

Sim

valor

Decimal

Valor da Transação para Débito Automático.-

Sim

dataHoraProcessamento

Date

Data prevista para Processamento deste Débito Automático

-

Não

dataHoraInsercao

DateTime

Data e Hora que o Débito em Conta foi Registrado

-

Sim

 

JSON:
{
"idDebito": 2
"idDebitoAutorizacao":3,
"idDebitoStatus": 1,
"descricaoStatus": "Aguardando Processamento",
"mensagem": "Ok",
"nsu": 21546141321,
"valor": 7.50,
"dataProcessamento": "2020-12-20T20:30:31",
"dataHoraInsercao": "2020-12-20T20:30:31"
}

...