Sign in

v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
CNAB (Remessa)

Listar CNABs

Lista CNABs.

get/v1/remittances

Query parameters

pageinteger

Número da Página

per_pageinteger

Quantidade de registros por página

expire_fromstring date

A partir da Data de vencimento do boleto.

expire_tostring date

Até a Data de vencimento do boleto.

created_fromstring date

A partir da Data de criação da Remessa.

created_tostring date

Até a Data de criação da Remessa.

bank_billet_account_idstring

Filtro por ID da Carteira.

our_codestring

Filtro por Nosso número.

tagsstring

Filtro por tags (separadas por vírgula).

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Sucesso na listagem de CNABs

idinteger

ID do CNAB

contentstring nullable

Conteúdo da remessa

filenamestring nullable

Nome do arquivo

status'unprocessed' | 'processed' | 'send'

Situação do arquivo:

  • unprocessed Pendente
  • processed Processado
  • send Enviada para o banco (Somente quando contratado envio automático)
processed_atstring date-time nullable

Data de Processamento.

created_atstring date-time nullable

Data e hora de criação.

updated_atstring date-time nullable

Data e hora da última atualização.

urlstring nullable

URL do arquivo de remessa.

created_via_apiboolean nullable

Enviado pela API

bank_billet_account_idinteger nullable

ID da Carteira de Cobrança.

remittance_numberinteger nullable

Número da remessa

sent_via_integrationstring date-time nullable

Data e hora de envio automático para o banco.

bank_billet_idsinteger[] nullable

IDs de boletos.

external_idstring nullable

ID externo.

custom_dataobject nullable

Dados customizados.

tagsstring[] nullable

Etiquetas.

tag_liststring nullable

Lista de etiquetas separadas por vírgula.