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 3 Current »

POST /api/debito/sincrono

Endpoint responsável por Efetuar um Débito em Conta, de maneira Síncrona, 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:

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

autoConfirmado

Booleana

Indica de o Débito será Auto Confirmado, ou seja, se este já será considerado como Sucesso pela Câmara de Débito no momento em que é realizado. Necessitando de uma comunicação de Cancelamento pelo Parceiro caso ocorra algum problema.

-

Não

 

JSON:

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

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.

idDebitoStatus

Int32

ID do status do Débito em Conta. Para um Débito Síncrono o Status será sempre 2 que indica que o Débito foi Processado.

descricaoStatus

String

Descrição do Status do Débito em Conta. Para um Débito Síncrono, o Status retornará sempre Processado, em caso de sucesso.

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:

{
    "idDebito": 2,
    "idDebitoAutorizacao": 7,
    "idDebitoStatus": 2,
    "descricaoStatus": "Processado",
    "nsu": 45654684654321,
    "valor": 7.50,
    "dataHoraProcessamento": "2020-12-20T20:30:31",
    "dataHoraInsercao": "2020-12-20T20:25:24"
}

  • No labels