v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

CNAB (Remessa)

Criar CNABs em Lote

Criar CNABs em Lote.

Serão feitas solicitações de Remessa de acordo com IDs das ocorrências. Será criada uma solicitação de Remessa para cada carteira associada às ocorrências. Após a criação das Remessas, elas serão processadas e ao término do processamento serão emitidas notificações através dos Webhooks.

post/v1/remittances/bulk

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Request body

bank_billet_remittance_idsinteger[] nullable

IDs de Registros de Remessa.

Response

CNABs criadas

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.