Create Bulk Payment
Creates a bulk payment after obtaining the user’s authorisation.
Feature: CREATE_BULK_PAYMENT
Documentation Index
Fetch the complete documentation index at: https://docs.yapily.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.
Headers
Mandatory. The consent-token containing the user's authorisation to make the request.
Conditional. Represents the user's login ID for the Institution to a personal account.
See PSU identifiers to see if this header is required.
Conditional. Represents the user's login ID for the Institution to a business account.
See PSU identifiers to see if this header is required.
Conditional. The IP address of the PSU.
See PSU identifiers to see if this header is required.
Body
The payment request object defining the details of the bulk payment
Mandatory. The array of PaymentRequest objects to initiate in the bulk payment.
Optional. An alphanumeric string (1-40 chars) used for idempotency. Unique per consent ID for 24 hours. Prevents duplicate bulk file payment submissions.
1 - 40^\S{1,40}$"1cc3e60d-5500-42be-aaeb-3c5e2f5ed048"
Conditional. The identification number of the originator.
- Mandatory for AIB bulk payments
Optional. Used to schedule the bulk payment to be executed at a future date if supported by the Institution. This value must fall on the same calendar day as the executionDateTime provided in the consent/authorisation phase. If the dates do not match, the bulk file payment will fail.