...
...
POST
...
/api/debito
Endpoint responsável por cadastrar 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 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:
IdDebitoContaAutorizacao
Int32
ID que identifica a Autorização registrada para o Débito Automático na conta em questão.
Obrigatório
Valor
Campo | Tipo | Descrição | Tamanho Máximo | Obrigatório |
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 |
Int32
Data prevista para Processamento deste Débito Automático
Obrigatório
JSON:
{
"IdDebitocontaAutorizacao":3,
"Valor": 7.50,
"DataProcessamento": “2020-12-20“
}
JSON:
| Code Block | ||
|---|---|---|
| ||
{
"nsu": 45654684654321,
"tokenAutorizacao": "39e857db-c18b-4b40-8fe1-7b7c9b473aeb",
"valor": 7.50
} |
Response Body application/json
Schema:
Campo | Tipo | Descrição |
idDebito | Long |
ID do Débito que foi Cadastrado. | ||
idDebitoAutorizacao | Long | ID |
da Autorização |
para |
Débito |
em |
Conta Cadastrado. |
Obrigatório
idDebitoStatus | Int32 | ID |
do 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
...
. | ||
descricaoStatus | String | Descrição do Status do Débito em Conta.
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 |
JSON:
| Code Block | ||
|---|---|---|
| ||
{
"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"
} |