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. Este débito será realizado na Data de Processamento solicitada, com prazo máximo de quatro horas a partir do momento do cadastro. Para efetuar esse Débito o Parceiro precisa enviar o ID e 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 referente a esse débito.

...

Campo

Tipo

Descrição

Tamanho Máximo

ObrigatórioIdDebitoAutorizacao

Int32

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

-

Sim

NSU

Long

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

-

Sim

TokenAutorizacao

String

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

-

Sim

Valor

Decimal

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

-

Sim

DataProcessamento

Date

Data prevista para Processamento deste Débito em Conta

-

Sim

 

JSON:
{
"IdDebitoAutorizacao":3,
“NSU“: 45654684654321,
”TokenAutorizacao”: “NDJU298VNEUH139HKBASVE“IUDSNM378JDSO38",
"Valor": 7.50,
"DataProcessamento": “2020-12-20“
}

Response Body    application/json

...

Campo

Tipo

Descrição

Tamanho Máximo

Obrigatório

idDebito

Long

ID que identifica o Débito que foi Cadastrado.

-

Sim

idDebitoAutorizacao

Long

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

-

Sim

idDebitoStatus

Int32

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

-

Sim

nsu

Long

Número Sequencial Único Disponibilizado pelo Parceiro.

Sim

valor

Decimal

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

-

Sim

dataProcessamentodataHoraProcessamento

Date

Data prevista para Processamento deste Débito Automático

-

Sim

liquidado

Boolean

Boolean que identifica se o Débito em Conta foi Liquidado ou não.

-

Sim

Não

dataHoraInsercao

DateTime

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

-

Sim

...

JSON:
{
"idDebito": 2
"idDebitoAutorizacao":3,
“idDebitoStatus“"idDebitoStatus": 1,
"valordescricaoStatus": 7.50"Aguardando Processamento",
"dataProcessamentonsu": "2020-12-20"21546141321,
"liquidadovalor": false7.50,
"dataHoraInsercaodataProcessamento": "2020-12-20T20:30:31"
}

Exemplos de Implementação:

C#

Code Block
var client = new RestClient("https://localhost:44380/api/debito");

var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImNhaW8uZm9udGVzIiwianRpIjoiZDVkMmQ4ZmVlMDgwNDk2MWE3ZjQ3NWY2MjRiMTkxYmQiLCJOZXRDb3JlVXNlcklkIjoiNjdjNjVhMDQtOTM0NC00MzE0LTYwYzgtMDhkN2RjMGNkMmI2IiwiUm9sZUxldmVsIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvT3BlcmFkb3IiOiIwIiwiSWRDbGllbnRlQnJva2VyIjpbIjAiLCIwIl0sInJvbGUiOiJFc3RhYmVsZWNpbWVudG8iLCJuYmYiOjE1OTIyNTk1ODcsImV4cCI6MTU5MjI2MzE4NywiaWF0IjoxNTkyMjU5NTkyLCJpc3MiOiJTc29BdWRpZW5jZSIsImF1ZCI6IlNzb0F1ZGllbmNlIn0.ktfw3Hooj022BX0A_Vhyv7qq0led91t71oSrTBkA3OU");

request.AddParameter("application/json,text/plain", "{\"IdDebitoAutorizacao\":3,\"Valor\":7.50,\"DataProcessamento\":“2020-12-20“}",  ParameterType.RequestBody);

IRestResponse response = client.Execute(request);

Console.WriteLine(response.Content);

PHP

...

,
"dataHoraInsercao": "2020-12-20T20:30:31"
}