Versions Compared

Key

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

DELETE   /api/debito/{nsu}

Endpoint responsável por Cancelar um Débito em Conta. Caso este Débito esteja Processado, será realizado o Estorno do mesmo, caso contrário, será somente Cancelado, ficando assim indisponível para Processamento.

...

Campo

Tipo

Descrição

Tamanho Máximo

Obrigatório

NSUnsu

Int32Long

Número Sequencial Único que identifica a Débito em Conta a ser buscado

-

Sim

 

Response Body    application/json

  Schema:

Campo

Tipo

Descrição

Obrigatório

Localizador

String

Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista.

Sim

Mensagem

String

Mensagem indicando resultado da operação.

Sim

JSON:

...

idDebito

Long

ID que identifica o Débito.

idDebitoAutorizacao

Long

ID que identifica a Autorização registrada para o Débito na conta em questão.

idDebitoStatus

Int32

ID que identifica o status do Débito em Conta;

descricaoStatus

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 Processamento

Ocorreu uma falha não esperada no Processamento.

5 - Cancelado

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

6 - Estornado

Mesmo que Cancelado, porém acontece quando o Débito já foi realizado. Neste caso, os valores serão estornados para a Conta em questão.

nsu

Long

NSU que identifica o Débito.

valor

Decimal

Valor da Transação para Débito.

dataHoraProcessamento

DateTime

Data e Hora prevista para Processamento deste Débito

dataHoraInsercao

DateTime

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

 

 

JSON:

Code Block
languagejson
{
    "idDebito": 15,
    "idDebitoAutorizacao": 10,
    "idDebitoStatus": 2,
    "descricaoStatus": "Processado",
    "nsu": 45654684654322,
    "valor": 7.50,
    "dataHoraProcessamento": "2020-10-26T21:58:52.65",
    "dataHoraInsercao": "2020-10-26T20:58:42.2566667"
}