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_countryquery parameter, and may be absent. When absent, the field is omitted from the response rather than returned asnull
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:
Integration Notes
Check for the presence of the key before rendering it. Clients that ignore unknown fields require no change.