Criar um Lote de Pagamento de Boletos

Esse endpoint é utilizado para a geração de um lote de pagamento.

Pré-requisito

Para emitir um lote de pagamento é necessário ter uma Conta Financeira, informada em financial_account_uid. A conta de pagamento aplicada ao lote é definida em payment_account_uid; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à financial_account_uid.

Eventos de Webhook

O evento payment.batch.db.created é disparado nesta operação.

Ao cadastrar um Lote de Pagamento, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento payment.bank_billet_batch.confirmed é disparado.

O evento payment.db.created também é disparado nesta operação caso o lote contenha um novo pagamento.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Parametros para criação de um Lote de Pagamento

uuid
required

UID da Conta Financeira de Origem

uuid | null

Conta de pagamento aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.

payments
array
required

Lista de Pagamentos de Boletos novos ou existentes.

payments*
Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json