Initiates a batch payment with multiple creditors. Each payment in the batch shares the same debtor account.
This endpoint supports both domestic and scheduled domestic payments:
- For domestic payments: omit the requestedExecutionDate field in creditor entries
- For scheduled domestic payments: include the requestedExecutionDate field in creditor entries
The debtorAccount can be either 'iban', 'bban', or 'sortCodeAccountNumber'.
The creditorAccount in each creditor entry can be either 'iban', 'bban', 'sortCodeAccountNumber' (UK), 'BGNR', or 'PGNR'.
Each creditor can optionally include a referenceId - a user-generated reference ID to keep track of payments
for pairing payment IDs with reference IDs once they receive the response from this API.
To enable a custom redirect, include the x-redirect-url parameter in the request header. The callback will then include a resource_id (the batch-id) and a result
(the request's status, either 'OK' or 'FAILED'). This API will return a 1426 error if consent is required and a 1428 'payment authorization required' if the payment requires SCA.
If you get error code '1428' then you have to call API '/ics/v3/payments/batch-transfer/{batchId}/authorize' to get authorization URL. Once you receive the URL, you can use it to get
authorized with the respective bank. This single authorization will cover all payments in the batch.
NOTE: The max limit for creditors in a batch payment is 20.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||