v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

Lotes

Exportar Lote no Formato .zip

Exportar lote no formato .zip.

Após a requisição a exportação entra numa fila para gerar o arquivo do lote. A URL do arquivo do lote será retornada pelo endpoint de Exportação do Lote.

post/v1/bank_billet_batches/{id}/zip

Path parameters

idstring required

ID do Lote

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Response

Solicitação de exportação do lote criada com sucesso

idinteger

ID arquivo de exportação do lote

account_idinteger

ID da conta

bank_billet_batch_idinteger

ID do lote

status'pending' | 'enqueued' | 'processed' | 'failed'

Situação da exportação do lote:

pending Pendente
enqueued Na Fila
processed Processado
failed Falhou

file_format'zip' | 'pdf'

Formato do Arquivo:

zip Pendente
pdf Na Fila

output_urlstring nullable

Url do arquivo.

processed_atstring date-time nullable

Data e hora do processamento.

created_atstring date-time nullable

Data e hora de criação.

updated_atstring date-time nullable

Data e hora da última atualização.