DOCUMENTAÇÃO CORPORATIVA

Listar Débitos em Conta

GET /api/debito

Endpoint responsável listar todos os Débitos realizados pelo parceiro solicitante de acordo com as datas informadas (período máximo de 60 dias).

Headers    

Content-Type

application/json

Authorization

Bearer {token}

Request Body    application/json

Schema:

Campo

Tipo

Descrição

Tamanho Máximo

Obrigatório

dataInicial

DateTime

Data Inicial da Busca referente a Data de Inserção de Solicitações Cadastradas pelo Parceiro.

-

Sim

dataFinal

DateTime

Data Final da Busca referente a Data de Inserção de Solicitações Cadastradas pelo Parceiro.

-

Sim

 

JSON:

{ "dataInicial": "2020-12-01T00:00:00", "dataFinal": "2020-12-22T00:00:00" }

 

 

Response Body    application/json

Schema:

Campo

Tipo

Descrição

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:

[     {         "idDebito": 12312,         "idDebitoAutorizacao": 13131,         "idDebitoStatus": 5,         "descricaoStatus": "Cancelado",         "nsu": 45654684654323,         "valor": 10.50,         "dataHoraProcessamento": null,         "dataHoraInsercao": "2020-12-15T10:23:36.604718"     },     {         "idDebito": 135416,         "idDebitoAutorizacao": 12341,         "idDebitoStatus": 2,         "descricaoStatus": "Processado",         "nsu": 45654684654325,         "valor": 10.50,         "dataHoraProcessamento": "2020-12-15T10:33:41.94",         "dataHoraInsercao": "2020-12-15T10:27:07.3333333"     } ]