DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

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.

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

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",
"Valor": 7.50,
"DataProcessamento": “2020-12-20“
}

Response Body    application/json

Schema:

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

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

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#

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;

  • No labels