Domestic Payment Consents3

Domestic Payments3

Domestic Scheduled Payment Consents2

Domestic Scheduled Payments3

Domestic Standing Order Consents2

Domestic Standing Orders3

File Payment Consents4

File Payments4

International Payment Consents3

International Payments3

International Scheduled Payments3

International Scheduled Payments Consents3

International Standing Orders3

International Standing Orders Consents2

International Scheduled Payments

Changes to Get an International Scheduled Payment

get/international-scheduled-payments/{InternationalScheduledPaymentId}

Nov 20, 20255dbf59c53db8 Revision changes
- info
  added the new optional header request parameter x-client-id
Nov 18, 20252e4e040f09e0 Revision changes
- breaking
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json; charset=utf-8)
- breaking
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json)
- breaking
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/jose+jwe)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json; charset=utf-8)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/jose+jwe)
Nov 18, 20254ac465cd8df5 Revision changes
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/jose+jwe)
Nov 18, 2025e083c4ef6d24 Revision changes
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/jose+jwe)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/jose+jwe)
- info
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/jose+jwe)
- info
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/jose+jwe)
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json)
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/jose+jwe)
Nov 18, 20257200524aada4 Revision changes
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/jose+jwe)
Nov 18, 2025432908f7ba34 Revision changes
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json)
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/jose+jwe)
Nov 18, 2025a5f21d69fbc0 Revision changes
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/jose+jwe)
Nov 17, 20257491ba5b5906 Revision changes
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
Nov 17, 2025e78aaf6dd31c Revision changes
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/jose+jwe)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/jose+jwe)
- info
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/jose+jwe)
- info
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/jose+jwe)
Nov 17, 202576cda65b3a3e Revision changes
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/jose+jwe)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/jose+jwe)
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
Nov 17, 20255bd66a1398ff Revision changes
- info
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/jose+jwe)
- info
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/jose+jwe)
Nov 14, 20259e88fe822ca0 Revision changes
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json)
- breaking
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/jose+jwe)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json; charset=utf-8)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)
- breaking
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/jose+jwe)
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
- warning
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
- warning
  removed the optional property // from the response with the status (media type: application/json)
- warning
  removed the optional property // from the response with the status (media type: application/jose+jwe)
Nov 14, 202502a49cac8571 Revision changes
- breaking
  the ///// response's property type changed from string to integer, and format from no format to int32 for status (media type: application/json)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status (media type: application/json; charset=utf-8)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status (media type: application/json)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status (media type: application/jose+jwe)
Nov 14, 2025334749479aba Revision changes
- breaking
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json; charset=utf-8)
- breaking
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json)
- breaking
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/jose+jwe)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json; charset=utf-8)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json)
- info
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/jose+jwe)
Nov 13, 20256311e4226757 Revision changes
- warning
  added the new CANC enum value to the / response property for the response status (media type: application/json; charset=utf-8)
- warning
  added the new CANC enum value to the / response property for the response status (media type: application/json)
- warning
  added the new CANC enum value to the / response property for the response status (media type: application/jose+jwe)
- warning
  added the new RCVD enum value to the / response property for the response status (media type: application/json; charset=utf-8)
- warning
  added the new RCVD enum value to the / response property for the response status (media type: application/json)
- warning
  added the new RCVD enum value to the / response property for the response status (media type: application/jose+jwe)
- info
  the // response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json)
- info
  the // response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/jose+jwe)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/jose+jwe)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/jose+jwe)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/jose+jwe)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/jose+jwe)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/json)
- info
  the /// response's property pattern was changed from ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2} to ^[A-Z0-9]{18,18}[0-9]{2,2}$ for the status (media type: application/jose+jwe)
Nov 12, 20250b2fc7ad58f3 Revision changes
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json)
- info
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/jose+jwe)
Nov 12, 2025fe2d7792c95d Revision changes
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json; charset=utf-8)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)
- info
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/jose+jwe)