Skip to main content

Create a Tax Payment Batch

POST 
/v2/payment/tax_batches

This endpoint is used to generate a batch of municipal, state, and federal tax payments.

⚠️ New Feature Under Development! This API is in beta version - this means we are constantly improving and adjusting its functionality. Although it is fully functional, some things may change as we receive feedback from developers.

For questions about this feature, please contact us.

Prerequisite​

To issue a payment batch, you must have a Financial Account, specified 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 specified, it must belong to financial_account_uid.

Webhook Events​

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

When registering a Payment Batch, the system creates a command to register it in the financial institution. After the batch registration is confirmed in the institution, the payment.tax_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​

Batch created with format=data (GRU)