v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

CNAB (Retorno)

Listar CNABs

Lista CNABs.

get/v1/discharges

Query parameters

created_fromstring date

A partir da Data de criação do Retorno.

created_tostring date

Até a Data de criação do Retorno.

bank_billet_account_idstring

Filtro por ID da Carteira.

tagsstring

Filtro por tags (separadas por vírgula).

pageinteger

Número da Página

per_pageinteger

Quantidade de registros por página

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Sucesso na listagem de CNABs

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.