Changelog

Oct 14, 2026

  • Added a new endpoint to retrieve bank account types. Endpoint: GET /v2/resources/bankAccountTypes
  • Added a new endpoint to retrieve a paginated, filterable statement feed for a currency account. Endpoint: POST /v2/currencyAccounts/{currencyCode}/statement-feed
  • Added a new endpoint to retrieve the recipient fields for a given country and currency. Endpoint: GET /v2/recipients/fields/country/{countryCode}/currency/{ccyCode}

Sep 21, 2026

  • Removed the idCountry field from recipient and payment requests and responses. Recipient ID type is validated against the bank country. Endpoints:
    • POST /v2/recipients
    • GET /v2/recipients
    • PUT /v2/recipients/{recipientId}
    • GET /v2/recipients/{recipientId}
    • POST /v2/recipients/validate
    • POST /v2/recipients/validate-batch
    • POST /v2/payments
    • GET /v2/contracts/{contractNumber}/payments/{clientReference}/recipient
    • PUT /v2/contracts/{contractNumber}/payments/{clientReference}/recipient
  • Added support for validating recipients against a specific sub-account number, enabling enterprise account groupings to use batch recipient validation. Endpoint: POST /v2/recipients/validate-batch
  • Added a branchNumber field to the bank account object, for payments that require a bank branch number. Endpoints:
    • POST /v2/recipients
    • GET /v2/recipients
    • PUT /v2/recipients/{recipientId}
    • GET /v2/recipients/{recipientId}
    • POST /v2/recipients/validate
    • POST /v2/recipients/validate-batch
    • POST /v2/payments
    • GET /v2/contracts/{contractNumber}/payments/{clientReference}/recipient
    • PUT /v2/contracts/{contractNumber}/payments/{clientReference}/recipient
  • Enhanced recipient validation to enforce the same mandatory address fields (line1, locality, postcode) as recipient creation, ensuring consistent results between the two endpoints. Endpoint: POST /v2/recipients/validate
  • Improved authentication support for recipient creation when using a sub-account number under Enterprise Account Grouping. Endpoint: POST /v2/recipients

Aug 18, 2026

  • Added a new endpoint to retrieve the full list of recipient ID types across all countries in a single call, removing the need to query ID types by country individually. Endpoint: GET /v2/resources/recipientIdTypes

Jul 20, 2026

  • Added a new endpoint to retrieve supported ID types by country, simplifying country-specific recipient validation. Endpoint: GET /v2/resources/recipientidtypes/{countryCode}
  • Added a new recipient batch validation endpoint to help identify issues before processing bulk recipient uploads. Endpoint: POST /v2/recipients/validate-batch

Apr 20, 2026

  • Enhanced the Pay API quoting flow to support specifying Payments and Recipients, updating existing quotes for spot and forward payments, Direct Debit settlement, creating quotes without a destination country, and adding the same recipient to a contract multiple times.

Feb 17, 2026

  • Introduced a dedicated Swagger changelog section for Pay API.
  • Updated and clarified Swagger documentation (including Quotes and Direct Debit details).
  • Improved validation and error handling for Get FX Contract bad requests.

Jan 21, 2026

  • Improved validation error messages for invalid date range filters. Endpoint: GET /v2/contracts

Jan 6, 2026

  • Addressed an issue where contract invoices did not always display all associated payments when multiple payments were added to a contract in quick succession. Endpoint: GET /v2/contracts/{contractNumber}/invoice
  • Enhanced the Payment Recipient retrieval to support FX contracts and provide more complete recipient details. Endpoint: GET /v2/contracts/{contractNumber}/payments/{clientReference}/recipient

On this page

Get help