Versions Compared

Version Old Version 20 New Version Current
Changes made by

Ivan Saavedra (Unlicensed)

Ivan Saavedra (Unlicensed)

Saved on

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çãogerado previamente), assim como o NSU e o Valor referente a esse débito.

Headers    

Content-Type

application/json

Authorization

Bearer {token}

Request Body    application/json

Schema:

Campo

Tipo

Descrição

Tamanho Máximo

Obrigatório

NSU

nsu

Long

Número sequencial único para identificar o Débito em Questão

-

Sim

TokenAutorizacao

tokenAutorizacao

String

Token cadastrado na Solicitação de Permissão de Débito em Conta. Com tamanho máximo de 30 caracteres.

-

Sim

Valor

valor

Decimal

Valor da Transação para Débito em Conta.

-

Sim

 

JSON:
{
“NSU“: 45654684654321,
”TokenAutorizacao”: “IUDSNM378JDSO38",
"Valor": 7.50,

Code Block
languagejson
{
    "nsu": 45654684654321,
    "tokenAutorizacao": "39e857db-c18b-4b40-8fe1-7b7c9b473aeb",
    "valor": 7.50
}

Response Body    application/json

Schema:

Campo

Tipo

Descrição

Tamanho Máximo

Obrigatório

idDebito

Long

ID

que identifica o

do Débito que foi Cadastrado.

-

Sim

idDebitoAutorizacao

Long

ID

que identifica a

da Autorização

registrada

para

o

Débito

Automático na conta

em

questão

Conta Cadastrado.

-

Sim

idDebitoStatus

Int32

ID

que identifica o status do Débito em Conta.

-

Sim

do 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 Serviço Bancário

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

Número Sequencial Único Disponibilizado pelo Parceiro.

Sim

valor

Decimal

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

-

Sim

dataHoraProcessamento

Date

DateTime

Data

prevista para Processamento deste Débito Automático

-

Não

e Hora que o Débito foi processado.

dataHoraInsercao

DateTime

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

-

Sim

 

JSON:
{

Code Block
languagejson
{
    "idDebito":

...

 2,
    "idDebitoAutorizacao":

...

 7,
    "idDebitoStatus":

...

 2,
    "descricaoStatus": "Aguardando Processamento",

...


    "nsu":

...

 45654684654321,
    "valor": 7.50,

...


    "dataHoraProcessamento": "2020-12-20T20:30:31",

...


    "dataHoraInsercao": "2020-12-20T20:

...

25:

...

24"

...


}