Skip to main content

Create a Batch of Utility Bill Payments

POST 
/v2/payment/utility_batches

This endpoint is used for the generation of a payment batch.

Prerequisite​

To issue a payment batch, you must have a Financial Account, informed in financial_account_uid. The payment account applied to the batch is defined in payment_account_uid; if omitted, the oldest linked to the financial account is used; if informed, it must belong to financial_account_uid.

Webhook Events​

The payment.batch.db.created event is triggered in this operation.

When creating a Payment Batch, the system creates a command to register it with the financial institution. After the batch registration is confirmed at the institution, the payment.utility_batch.confirmed event is triggered.

The payment.db.created event is also triggered in this operation if the batch contains a new payment.

Request​

Responses​

Payment Batch Created