Versions Compared

Version Old Version 17 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. 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çã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

IdDebitoAutorizacao

Int32

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

-

Sim

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

DataProcessamento

 

...

Date

...

Data prevista para Processamento deste Débito em Conta

...

-

...

Sim

 

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

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

Response Body    application/json

Schema:

IdDebito

Campo

Tipo

Descrição

Tamanho Máximo

Obrigatório

idDebito

Long

ID

que identifica o

do Débito que foi Cadastrado.

-

idDebitoAutorizacao

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

IdDebitoStatus

Int32

ID

que identifica o

do status do Débito em Conta

;

.

-

descricaoStatus

Sim

Valor

Decimal

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

-

Sim

DataProcessamento

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

DataHoraInsercao

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.

valor

Decimal

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

dataHoraProcessamento

DateTime

Data e Hora que o Débito foi processado.

dataHoraInsercao

DateTime

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

-

Sim

 

JSON:
{
"IdDebito": 2
"IdDebitoAutorizacao":3,
“IdDebitoStatus“: 1,
"Valor": 7.50,
"DataProcessamento": "2020-12-20",
"Liquidado": false,
"DataHoraInsercao": "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

<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://localhost:44380/api/debito", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{\"IdDebitoAutorizacao\":3,\"Valor\":7.50,\"DataProcessamento\":“2020-12-20“}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImNhaW8uZm9udGVzIiwianRpIjoiZDVkMmQ4ZmVlMDgwNDk2MWE3ZjQ3NWY2MjRiMTkxYmQiLCJOZXRDb3JlVXNlcklkIjoiNjdjNjVhMDQtOTM0NC00MzE0LTYwYzgtMDhkN2RjMGNkMmI2IiwiUm9sZUxldmVsIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvT3BlcmFkb3IiOiIwIiwiSWRDbGllbnRlQnJva2VyIjpbIjAiLCIwIl0sInJvbGUiOiJFc3RhYmVsZWNpbWVudG8iLCJuYmYiOjE1OTIyNTk1ODcsImV4cCI6MTU5MjI2MzE4NywiaWF0IjoxNTkyMjU5NTkyLCJpc3MiOiJTc29BdWRpZW5jZSIsImF1ZCI6IlNzb0F1ZGllbmNlIn0.ktfw3Hooj022BX0A_Vhyv7qq0led91t71oSrTBkA3OU" ), )); $response = curl_exec($curl); curl_close($curl); echo $response;
Code Block
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"
}