Bulk payments

Further information on how to create bulk payments with Yapily.

Bulk payment request

To create a bulk payment with the Yapily API, you specify an array of Single Payments and provide them to the payments object in the the BulkPaymentRequest when executing any of the bulk payment endpoints.

Depending on the restrictions of each Institution, you may have to make specific adjustments to the payments array. More information on these types of restrictions are listed below.

Account beneficiaries

For each Institution in the UK that has the limitation where each Payee must be a trusted beneficiary for the execution of the bulk payment to occur successfully, Yapily has introduced the ACCOUNT_BENEFICIARIES feature to allow TPPs to get all the beneficiaries for the Payer account to cross check that each Payee is a trusted beneficiary.

To access the beneficiaries of an account, you must obtain a valid AIS consent using [Create Account Authorisation] (/api/#create-account-authorisation) and then use the resultant consentToken to execute [Get Account Beneficiaries] (/api/#get-account-beneficiaries).

Unfortunately, it is not in scope for Open Banking to allow the dynamic adding of beneficiaries through Open Banking APIs so the payments service user must do this manually through their bank.

Execution

Once the bank is instructed to execute the payment, the bank will decide whether or not they execute the bulk as a whole, meaning that if one payment fails, the entire bulk may fail.

Known restrictions

Barclays

• Only immediate domestic payments are supported
• Maximum 50 payments per request
• Minimum 5 payments per request
• Minimum total payments amount is £0.01
• Maximum total payments amount is £50000
• The ‘reference’ field is mandatory for every payment in the bulk transaction
• The character field length for Debtor Account Name and Creditor Account Name is <140 characters
• Please avoid using special characters (such as '.', '#', or ' [ ] ') in contact names and references, as this can prevent you from completing bulk payment

HSBC

• Only immediate domestic and scheduled domestic payments are supported
• Maximum 25 payments per request
• For HSBC Business customers cannot exceed a single payment limit, which is setup by the client
• For HSBC Corporate bank limit for faster payments is £25K
• As a result, all payments must have a payment execution date that is 2-45 days in the future
• Only one Payer object should be specified in the bulk payment

Lloyds

• Only immediate domestic and scheduled domestic payments are supported
• Maximum 25 payments per request
• Minimum total payments amount is £0.01 (1p)
• Maximum total payments amount would be determined by the account limits on the specific accounts being used.
• The property requestedExecutionDateTime is not supported for this bank
• A reference for every payment is required
• Only one Payer object should be specified in the bulk payment
• Maximum 18 characters for payee.name
• Maximum 18 characters for paymentIdempotencyId

Natwest

• Only immediate domestic and scheduled domestic payments are supported
• Maximum 50 payments per request
• Bankline customers have a maximum limit of:
  • 3000 payments to multiple payees at once from a single debit account
  • 4000 payments to multiple payees at once from multiple debit accounts
• Each payment in the bulk must have the same payment type
• Bulk payments are only accepted where all the creditors are trusted beneficiaries
• Each payment in the bulk must have maximum of 16 characters for reference
• Customers daily payment limits are shared across bulk payments and individual payments. For example, if a customer has a daily limit of £1000, the value of bulk and individual payments they make collectively on one day can't exceed £1000
• A bulk payment can consist uniquely of either Single immediate Payments or Future Dated Payments
• Maximum 18 characters for payee.name
• 'payer' object should be specified in the bulk payment
• Two-factor authentication is always required for bulk payments. Customers will be asked to authenticate themselves using MFA in their mobile app or via card and reader

RBS

• Only immediate domestic and scheduled domestic payments are supported
• Maximum 25 payments per request
• Each payment in the bulk must have the same payment type
• Bulk payments are only accepted where all the creditors are trusted beneficiaries
• Each payment in the bulk must have maximum of 16 characters for reference

Santander

• Only immediate domestic and scheduled domestic payments are supported
• Maximum 1750 payments per request
• For every payment in the bulk payment the same Payer object must be specified
• Bulk payments are only accepted where all the creditors are trusted beneficiaries

Revolut

• Payees must be set up as trusted beneficiaries on the payer account before a bulk payment is attempted
• For bulk payments, payee.address.country , payee.address.postCode and payee.address.townName are mandatory for each payment in the bulk payment request
• Revolut Business users can only authorise bulk payments via the web application and not the mobile app
• There is a limit of 1000 payees per bulk payment
• If the payee for a payment in a bulk payment file is a business, paymentRequest.payee.merchantCategoryCode should be provided

Virgin Money

• The bank can accept:
  • 750 payments in a single file if they are all from the same debtor account and are all being remitted on the same day (e.g. payroll)
  • 150 payments in a single file if they are coming from different debtor accounts and/or are being remitted on different days
• Supports both instant and scheduled bulk payments
• The payments with no date would be immediate payments.
• Aggregated value of batch payments must be within the company/user's approval limit
• Payment limits for business accounts vary per account and can be set by the customers
• The bank limit for faster payments is £250K
• Support only JSON format for file upload
• All the payments in the file should be of one payment type i.e. FPS, CHAPS or BACS
• Virgin Money will usually schedule the payment request immediately, but delays may occur during busy periods or if additional approvals are required
• The initiation section of the payment must match the corresponding sections of the payment consent resource; discrepancies will generate an error response and the request will not be processed
• Bulk payment request response times can be slower than those for other integrations due to a deficiency in the bank's system

Solaris

• The requested execution date should not be passed in the requests as it will be skipped in the request to institution
• PSU-IP-ADDRESS is required for bulk payments