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

Initiate an International Scheduled Payment

Enables a PISP to initiate an already PSU-approved International Scheduled Payment.

post/international-scheduled-payments

Headers

x-fapi-auth-datestring

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressstring

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstring required

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-keystring required

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signaturestring required

A detached JWS signature of the body of the payload.

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

x-client-idstring

Only used if an ASPSP requires the client ID in order to return rate limit headers.

TPPs must refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.

This header must not be used for client authentication

Request body

Example request

{
  "Data": {
    "Initiation": {
      "Creditor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "CreditorAgent": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "UltimateCreditor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "UltimateDebtor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562"
          }
        ]
      }
    }
  }
}

Response

International Scheduled Payments Created

Example response

{
  "Data": {
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN"
      }
    ],
    "Initiation": {
      "Creditor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "CreditorAgent": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "UltimateCreditor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "UltimateDebtor": {
        "LEI": "IZ9Q00LZEVUKWCQY6X15"
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562"
          }
        ]
      }
    },
    "Debtor": {
      "LEI": "IZ9Q00LZEVUKWCQY6X15"
    }
  }
}

Changes

Changed in 24 of the 50 revisions of this API.12078171

Feb 3, 202659fa1131ff963See the full diff
- ○
  added the new Other enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new Other enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new Other enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
Nov 20, 20258aca7b397e143See the full diff
- ○
  added the new CRYP enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new CRYP enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new CRYP enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
Nov 20, 20255dbf59c53db831See the full diff
- ▲
  removed the enum value CRYP of the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-removed
- ▲
  removed the enum value CRYP of the request property / (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value CRYP of the request property / (media type: application/jose+jwe)
  request-property-enum-value-removed
- ○
  added the new optional header request parameter x-client-id
  new-optional-request-parameter
Nov 20, 20254a10fcc8639c3See the full diff
- ○
  added the new CRYP enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new CRYP enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new CRYP enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
Nov 18, 20251c8f74b55cd41See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Nov 18, 20252e4e040f09e075See the full diff
- ▲
  added the pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ to the request property ///// (media type: application/json; charset=utf-8)
  request-property-pattern-added
- ▲
  added the pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ to the request property ///// (media type: application/json)
  request-property-pattern-added
- ▲
  added the pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ to the request property ///// (media type: application/jose+jwe)
  request-property-pattern-added
- ▲
  the ///// request property type changed from integer to string, and format from int32 to no format (media type: application/json)
  request-property-type-changed
- ▲
  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)
  response-property-type-changed
- ▲
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/json)
  response-property-type-changed
- ▲
  the ///// response's property type changed from integer to string, and format from int32 to no format for status (media type: application/jose+jwe)
  response-property-type-changed
- ○
  the ///// request property type was generalized from integer to string, and format from int32 to no format (media type: application/json; charset=utf-8)
  request-property-type-generalized
- ○
  the ///// request property type was generalized from integer to string, and format from int32 to no format (media type: application/jose+jwe)
  request-property-type-generalized
- ○
  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)
  response-property-pattern-added
- ○
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/json)
  response-property-pattern-added
- ○
  the ///// response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status (media type: application/jose+jwe)
  response-property-pattern-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 18, 20254ac465cd8df531218See the full diff
- ▲
  the //////// request property's minLength was increased from 0 to 1 (media type: application/json; charset=utf-8)
  request-property-min-length-increased
- ▲
  the //////// request property's minLength was increased from 0 to 1 (media type: application/json)
  request-property-min-length-increased
- ▲
  the //////// request property's minLength was increased from 0 to 1 (media type: application/jose+jwe)
  request-property-min-length-increased
- ●
  the //////// request property's maxLength was set to 2048 (media type: application/json; charset=utf-8)
  request-property-max-length-set
- ●
  the //////// request property's maxLength was set to 2048 (media type: application/json)
  request-property-max-length-set
- ●
  the //////// request property's maxLength was set to 2048 (media type: application/jose+jwe)
  request-property-max-length-set
- ●
  changed the pattern of the request property // from [A-Z]{2,2} to ^[A-Z]{2,2}$ (media type: application/json; charset=utf-8)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from [A-Z]{2,2} to ^[A-Z]{2,2}$ (media type: application/json)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from [A-Z]{2,2} to ^[A-Z]{2,2}$ (media type: application/jose+jwe)
  request-property-pattern-changed
- ●
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status (media type: application/jose+jwe)
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status (media type: application/json; charset=utf-8)
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status (media type: application/jose+jwe)
  response-optional-property-removed
- ○
  added the new BillPayment enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new BillPayment enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new BillPayment enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
- ○
  added the new EcommerceGoods enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new EcommerceGoods enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new EcommerceGoods enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
- ○
  added the new EcommerceServices enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new EcommerceServices enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new EcommerceServices enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
- ○
  added the new PartyToParty enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new PartyToParty enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new PartyToParty enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
- ○
  added the new PispPayee enum value to the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-added
- ○
  added the new PispPayee enum value to the request property / (media type: application/json)
  request-property-enum-value-added
- ○
  added the new PispPayee enum value to the request property / (media type: application/jose+jwe)
  request-property-enum-value-added
- ○
  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)
  response-property-pattern-changed
- ○
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)
  response-property-pattern-changed
- ○
  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)
  response-property-pattern-changed
Nov 18, 2025e083c4ef6d2421312See the full diff
- ▲
  removed the enum value BillPayment of the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-removed
- ▲
  removed the enum value BillPayment of the request property / (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value BillPayment of the request property / (media type: application/jose+jwe)
  request-property-enum-value-removed
- ▲
  removed the enum value EcommerceGoods of the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-removed
- ▲
  removed the enum value EcommerceGoods of the request property / (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value EcommerceGoods of the request property / (media type: application/jose+jwe)
  request-property-enum-value-removed
- ▲
  removed the enum value EcommerceServices of the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-removed
- ▲
  removed the enum value EcommerceServices of the request property / (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value EcommerceServices of the request property / (media type: application/jose+jwe)
  request-property-enum-value-removed
- ▲
  removed the enum value PartyToParty of the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-removed
- ▲
  removed the enum value PartyToParty of the request property / (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value PartyToParty of the request property / (media type: application/jose+jwe)
  request-property-enum-value-removed
- ▲
  removed the enum value PispPayee of the request property / (media type: application/json; charset=utf-8)
  request-property-enum-value-removed
- ▲
  removed the enum value PispPayee of the request property / (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value PispPayee of the request property / (media type: application/jose+jwe)
  request-property-enum-value-removed
- ▲
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json; charset=utf-8)
  response-property-max-length-unset
- ▲
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/json)
  response-property-max-length-unset
- ▲
  the //////// response property's maxLength was unset from 2048 for the response status (media type: application/jose+jwe)
  response-property-max-length-unset
- ▲
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json; charset=utf-8)
  response-property-min-length-decreased
- ▲
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)
  response-property-min-length-decreased
- ▲
  the //////// response property's minLength was decreased from 1 to 0 for the response status (media type: application/jose+jwe)
  response-property-min-length-decreased
- ●
  changed the pattern of the request property // from ^[A-Z]{2,2}$ to [A-Z]{2,2} (media type: application/json; charset=utf-8)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from ^[A-Z]{2,2}$ to [A-Z]{2,2} (media type: application/json)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from ^[A-Z]{2,2}$ to [A-Z]{2,2} (media type: application/jose+jwe)
  request-property-pattern-changed
- ○
  the //////// request property's minLength was decreased from 1 to 0 (media type: application/json; charset=utf-8)
  request-property-min-length-decreased
- ○
  the //////// request property's minLength was decreased from 1 to 0 (media type: application/json)
  request-property-min-length-decreased
- ○
  the //////// request property's minLength was decreased from 1 to 0 (media type: application/jose+jwe)
  request-property-min-length-decreased
- ○
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
  response-optional-property-added
- ○
  added the optional property // to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property // to the response with the status (media type: application/jose+jwe)
  response-optional-property-added
- ○
  added the optional property // to the response with the status (media type: application/json; charset=utf-8)
  response-optional-property-added
- ○
  added the optional property // to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property // to the response with the status (media type: application/jose+jwe)
  response-optional-property-added
- ○
  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)
  response-property-pattern-changed
- ○
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json)
  response-property-pattern-changed
- ○
  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)
  response-property-pattern-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 18, 20257200524aada433See the full diff
- ●
  changed the pattern of the request property // from [A-Z]{2,2} to ^[A-Z]{2,2}$ (media type: application/json; charset=utf-8)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from [A-Z]{2,2} to ^[A-Z]{2,2}$ (media type: application/json)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from [A-Z]{2,2} to ^[A-Z]{2,2}$ (media type: application/jose+jwe)
  request-property-pattern-changed
- ○
  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)
  response-property-pattern-changed
- ○
  the // response's property pattern was changed from [A-Z]{2,2} to ^[A-Z]{2,2}$ for the status (media type: application/json)
  response-property-pattern-changed
- ○
  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)
  response-property-pattern-changed
Nov 18, 2025432908f7ba3433See the full diff
- ●
  changed the pattern of the request property // from ^[A-Z]{2,2}$ to [A-Z]{2,2} (media type: application/json; charset=utf-8)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from ^[A-Z]{2,2}$ to [A-Z]{2,2} (media type: application/json)
  request-property-pattern-changed
- ●
  changed the pattern of the request property // from ^[A-Z]{2,2}$ to [A-Z]{2,2} (media type: application/jose+jwe)
  request-property-pattern-changed
- ○
  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)
  response-property-pattern-changed
- ○
  the // response's property pattern was changed from ^[A-Z]{2,2}$ to [A-Z]{2,2} for the status (media type: application/json)
  response-property-pattern-changed
- ○
  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)
  response-property-pattern-changed

Full history (24 revisions)