Skip to main content

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.

Bulk Payments are currently available as a BETA version.
Use Get Bulk Payment Status Details to retrieve the status of each individual payment within a bulk payment request.

​
Supported institutions

This endpoint is currently supported by the following instituions:
  • HSBC
  • Lloyds
  • Revolut
  • Virgin Money
To check whether an institution supports this feature, look for EXISTING_BULK_PAYMENT_DETAILS in the institution’s feature list via Get Institutions.
When supported by the institution, EXISTING_BULK_PAYMENT_DETAILS is automatically included in the consent scope during authorisation (Create Bulk Payment Authorisation).

​
Request

Execute get payment details (GET /bulk-payments/{bulkPaymentId}/details), specifying the bulk payment file Id in the path. 
curl -L -X GET 'https://api.yapily.com/bulk-payments/{bulkPaymentId}/details' \
  -H 'Consent: {consentToken}' \
  -u 'APPLICATION_KEY:APPLICATION_SECRET'
When an individual payment has not completed successfully, the response includes a statusDetails object with a code and reason.
Some institutions do not return a recognisable status code. In that case statusDetails will not be present in the payment entry.

​
Payment status detail codes

CodeDescription
B000Unrecognised status reason code from the institution
B001Payment rejected, no specific reason given
B002Insufficient funds in debtor account
B003Incorrect or invalid account number
B004Payment flagged as fraudulent origin
B005Duplicate payment detected
B006Rejected for regulatory or compliance reason
B007Rejected at customer’s own request
B008Amount is zero, not allowed, or too low
B009Missed bank cut-off time
B010Invalid payment format or structure
B011Technical problem at institution
B012Payment accepted, pending processing
B013Payment held by institution for further review
B014Payment held due to fraud screening