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 Payment Consents

Get an International Payment Consent

Enables a PISP to retrieve the status of an intent to initiate an International Payment.

get/international-payment-consents/{ConsentId}

Path parameters

ConsentIdstring required

ConsentId

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-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

Response

International Payment Consents Read

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.3184111

Feb 19, 20263bce3f3a48362See the full diff
- ○
  api tag International Payment Consents added
  api-tag-added
- ○
  api tag International Payments removed
  api-tag-removed
Feb 3, 202659fa1131ff963See the full diff
- ●
  added the new Other enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new Other enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new Other enum value to the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-added
Nov 20, 20258aca7b397e143See the full diff
- ●
  added the new CRYP enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new CRYP enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new CRYP enum value to the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-added
Nov 20, 20255dbf59c53db84See the full diff
- ○
  added the new optional header request parameter x-client-id
  new-optional-request-parameter
- ○
  removed the CRYP enum value from the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the CRYP enum value from the / response property for the response status (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the CRYP enum value from the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-removed
Nov 20, 20254a10fcc8639c3See the full diff
- ●
  added the new CRYP enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new CRYP enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new CRYP enum value to the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-added
Nov 18, 20252e4e040f09e033See the full diff
- ▲
  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 ///// 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, 20254ac465cd8df5153See the full diff
- ●
  added the new BillPayment enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new BillPayment enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new BillPayment enum value to the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new EcommerceGoods enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new EcommerceGoods enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new EcommerceGoods enum value to the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new EcommerceServices enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new EcommerceServices enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new EcommerceServices enum value to the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new PartyToParty enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new PartyToParty enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new PartyToParty enum value to the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new PispPayee enum value to the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new PispPayee enum value to the / response property for the response status (media type: application/json)
  response-property-enum-value-added
- ●
  added the new PispPayee enum value to the / response property for the response status (media type: application/jose+jwe)
  response-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, 2025e083c4ef6d24618See the full diff
- ▲
  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
- ○
  removed the BillPayment enum value from the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the BillPayment enum value from the / response property for the response status (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the BillPayment enum value from the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the EcommerceGoods enum value from the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the EcommerceGoods enum value from the / response property for the response status (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the EcommerceGoods enum value from the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the EcommerceServices enum value from the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the EcommerceServices enum value from the / response property for the response status (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the EcommerceServices enum value from the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the PartyToParty enum value from the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the PartyToParty enum value from the / response property for the response status (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the PartyToParty enum value from the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the PispPayee enum value from the / response property for the response status (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the PispPayee enum value from the / response property for the response status (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the PispPayee enum value from the / response property for the response status (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  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, 20257200524aada43See the full diff
- ○
  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, 2025432908f7ba343See the full diff
- ○
  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)