Skip to navigation

Summary

Payment scheme note in bank transfer instructions: The Get Bank Transfer Instructions response now includes an optional payment_scheme_note field.

Enhancements

Get Bank Transfer Instructions

  • Endpoint: GET /v3/customers/{customer_id}/payments/{payment_id}/bank-transfer-instructions
  • New field: payment_scheme_note (string, optional)
  • Purpose: Guidance on which payment schemes the beneficiary account accepts
  • Behaviour: Varies by the from_country query parameter, and may be absent. When absent, the field is omitted from the response rather than returned as null

This is distinct from payment_reference.disclaimer, which explains why the payment reference must be included for the payment to be processed and reconciled.

All other fields in the response are unchanged. This is a backwards-compatible addition.

Example response:

{
"payment_method": "international_transfer",
"amount": {
"currency": "GBP",
"value": 1000.45
},
"account_details": {
"name": "Currencies Direct Inc",
"address": "4705 South Apopka-Vineland Road, Suite 114, Orlando, Florida, 32819 USA"
},
"bank_details": {
"name": "Barclays",
"address": "1 Churchill Place, Canary Wharf, London, United Kingdom",
"routing_codes": [
{
"type": "IBAN",
"value": "GB06BARC20199075274900",
"label": "IBAN"
},
{
"type": "SWIFTBIC",
"value": "BARCGB22",
"label": "SWIFTBIC"
}
]
},
"payment_reference": {
"value": "ABCD123456",
"label": "Payment reference",
"disclaimer": "Always include this payment reference – it tells us the money has come from you."
},
"payment_scheme_note": "Please note: This account only accepts FPS, BACS and CHAPS payments. FPS payments are available for amounts up to £1 million."
}

Integration Notes

Check for the presence of the key before rendering it. Clients that ignore unknown fields require no change.