Esta seção exemplifica todos os métodos relacionados a Débitos em Conta.
POST /api/debito
Endpoint responsável por cadastrar Para efetuar um Débito em Conta, retornando os dados do mesmo em caso de sucesso.
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
Request Body application/json
Schema:
...
IdDebitoContaAutorizacao
...
Int32
...
ID que identifica a Autorização registrada para o Débito Automático na conta em questão.
...
Obrigatório
...
Valor
...
Int32
...
Valor da Transação para Débito Automático.
...
Obrigatório
...
DataProcessamento
...
Int32
...
Data prevista para Processamento deste Débito Automático
...
Obrigatório
JSON:
{
"IdDebitocontaAutorizacao":3,
"Valor": 7.50,
"DataProcessamento": “2020-12-20“
}
Response Body application/json
Schema:
...
IdDebitoconta
...
Long
...
IdDebitoContaAutorizacao
...
Long
...
ID que identifica a Autorização registrada para o Débito Automático na conta em questão.
...
Obrigatório
...
IdDebitoContaStatus
...
Int32
...
ID que identifica o status do Débito em Conta;
...
Valor
...
Decimal
...
Valor da Transação para Débito Automático.
...
Obrigatório
...
DataProcessamento
...
Date
...
Data prevista para Processamento deste Débito Automático
...
Obrigatório
...
Liquidado
...
Boolean
...
Boolean que identifica se o Débito em Conta foi Liquidado ou não.
...
DataHoraInsercao
...
DateTime
JSON:
{
"IdDebitoContaAutorizacao":3,
"Valor": 7.50,
"DataProcessamento": “2020-12-20“
}
Exemplos de Implementação:
C#
| Code Block | ||
|---|---|---|
| ||
var client = new RestClient("https://localhost:44380/api/debitoconta");
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", "{\"IdDebitocontaAutorizacao\":3,\"Valor\":7.50,\"DataProcessamento\":“2020-12-20“}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content); |
PHP
| Code Block | ||
|---|---|---|
| ||
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://localhost:44380/api/debitoconta",
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 =>"{\"IdDebitocontaAutorizacao\":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;
|
GET /api/debito
Endpoint responsável listar todos os Débitos em Conta cadastrados pelo parceiro solicitante.
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
Exemplos de Implementação:
C#
| Code Block | ||
|---|---|---|
| ||
var client = new RestClient("https://localhost:44380/api/debitoconta");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImNhaW8uZm9udGVzIiwianRpIjoiZDVkMmQ4ZmVlMDgwNDk2MWE3ZjQ3NWY2MjRiMTkxYmQiLCJOZXRDb3JlVXNlcklkIjoiNjdjNjVhMDQtOTM0NC00MzE0LTYwYzgtMDhkN2RjMGNkMmI2IiwiUm9sZUxldmVsIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvIjoiMCIsIklkRXN0YWJlbGVjaW1lbnRvT3BlcmFkb3IiOiIwIiwiSWRDbGllbnRlQnJva2VyIjpbIjAiLCIwIl0sInJvbGUiOiJFc3RhYmVsZWNpbWVudG8iLCJuYmYiOjE1OTIyNTk1ODcsImV4cCI6MTU5MjI2MzE4NywiaWF0IjoxNTkyMjU5NTkyLCJpc3MiOiJTc29BdWRpZW5jZSIsImF1ZCI6IlNzb0F1ZGllbmNlIn0.ktfw3Hooj022BX0A_Vhyv7qq0led91t71oSrTBkA3OU");
request.AddParameter("application/json,text/plain", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content); |
PHP
...
| language | php |
|---|
...
o Parceiro precisa seguir o seguinte fluxo:
Solicitar uma autorização de Débito em uma Conta específica. Esta solicitação ficará disponível para aprovação pelo Titular da Conta, que poderá aprovar ou não. Quando uma Solicitação for aprovada o Parceiro será Autorizado a efetuar Débitos nessa Conta em questão, respeitando as regras de valores máximos definidas na Solicitação. Esta Solicitação ocorre através do endpoint Solicitar Autorização para Débito em Conta.
Após solicitar a autorização, o Parceiro pode acompanhar o status desta solicitação através do endpoint Listar Solicitações de Autorização para Débito em Conta.
Uma vez aprovado, o Parceiro poderá efetuar Débitos na Conta especificada e Autorizada respeitando os valores máximos definidos na Autorização. Débitos em uma Conta Autorizada são realizados no endpoint Efetuar Débito em Conta. Os Débitos cadastrados possuem um prazo máximo de processamento de 4 horas a partir do momento do cadastro.
Havendo alguma inconsistência o Débito poderá ser cancelado pelo endpoint Cancelar Débito em Conta. Caso o débito não esteja Processado, seu status será alterado para Cancelado e o débito não será realizado. Por outro lado, se o débito estiver Processado, seu status será alterado para Estornado e o valor do débito será estornado.
Para Controle dos Débitos cadastrados, o Parceiro terá acesso a endpoints preparados para listar os Débitos por Período (Listar Débitos em Conta), ou Obter um Débito específico tanto através do NSU quanto através do ID (Obter Débito em Conta por NSU e Obter Débito em Conta por ID).