v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
CNAB (Retorno)

Enviar CNAB

Envia um arquivo CNAB de retorno bancário para processamento de pagamentos e baixas de boletos.

post/v1/discharges

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Response

CNAB enviado com custom_data e tags

idinteger

ID do CNAB

filenamestring nullable

Nome do arquivo

status'unprocessed' | 'processed'

Situação do arquivo:

  • unprocessed Pendente
  • processed Processado
processed_atstring date-time nullable

Data de Processamento.

created_via_apiboolean nullable

Enviado pela API

bank_billet_account_idinteger nullable

ID da Carteira de Cobrança.

created_via_integrationstring date-time nullable

Data de recebimento automático do banco.

created_atstring date-time nullable

Data e hora de criação do registro

updated_atstring date-time nullable

Data e hora da última atualização do registro

external_idstring nullable

ID externo.

custom_dataobject nullable

Dados customizados.

tagsstring[] nullable

Etiquetas.

tag_liststring nullable

Lista de etiquetas separadas por vírgula.