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

File Payment Consents

Get a File Payment Consent

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

get/file-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

File Payment Consents Read

Example response

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

Changes

Changed in 10 of the 50 revisions of this API.3121

Feb 19, 20263bce3f3a48362See the full diff
- ○
  api tag File Payment Consents added
  api-tag-added
- ○
  api tag File Payments removed
  api-tag-removed
Nov 20, 20255dbf59c53db81See the full diff
- ○
  added the new optional header request parameter x-client-id
  new-optional-request-parameter
Nov 18, 20252e4e040f09e033See the full diff
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json; charset=utf-8)
  response-property-type-changed
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json)
  response-property-type-changed
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/jose+jwe)
  response-property-type-changed
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json; charset=utf-8)
  response-property-pattern-added
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json)
  response-property-pattern-added
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (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, 2025e083c4ef6d246See the full diff
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/jose+jwe)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/jose+jwe)
  response-property-min-length-decreased
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 17, 2025e78aaf6dd31c6See the full diff
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/jose+jwe)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/jose+jwe)
  response-property-min-length-decreased
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 17, 202576cda65b3a3e6See the full diff
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/jose+jwe)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/jose+jwe)
  response-property-min-length-decreased
Nov 14, 20259e88fe822ca06See the full diff
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/json)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's maxLength was unset from 2048 for the response status 200 (media type: application/jose+jwe)
  response-property-max-length-unset
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/json)
  response-property-min-length-decreased
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentInformation/items/LineDetails/items/ response property's minLength was decreased from 1 to 0 for the response status 200 (media type: application/jose+jwe)
  response-property-min-length-decreased
Nov 14, 202502a49cac857113See the full diff
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from string/ to integer/int32 for status 200 (media type: application/json)
  response-property-type-changed
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status 200 (media type: application/json; charset=utf-8)
  response-property-pattern-removed
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status 200 (media type: application/json)
  response-property-pattern-removed
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was removed for the status 200 (media type: application/jose+jwe)
  response-property-pattern-removed
Nov 14, 2025334749479aba33See the full diff
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json; charset=utf-8)
  response-property-type-changed
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/json)
  response-property-type-changed
- ▲
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property type/format changed from integer/int32 to string/ for status 200 (media type: application/jose+jwe)
  response-property-type-changed
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json; charset=utf-8)
  response-property-pattern-added
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (media type: application/json)
  response-property-pattern-added
- ○
  the Data/Initiation/RemittanceInformation/Structured/items/ReferredDocumentAmount response's property pattern ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ was added for the status 200 (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 13, 202531bdd8df938d9See the full diff
- ○
  the Data/Debtor/LEI 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 200 (media type: application/json; charset=utf-8)
  response-property-pattern-changed
- ○
  the Data/Debtor/LEI 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 200 (media type: application/json)
  response-property-pattern-changed
- ○
  the Data/Debtor/LEI 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 200 (media type: application/jose+jwe)
  response-property-pattern-changed
- ○
  the Data/Initiation/CreditorAgent/LEI 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 200 (media type: application/json; charset=utf-8)
  response-property-pattern-changed
- ○
  the Data/Initiation/CreditorAgent/LEI 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 200 (media type: application/json)
  response-property-pattern-changed
- ○
  the Data/Initiation/CreditorAgent/LEI 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 200 (media type: application/jose+jwe)
  response-property-pattern-changed
- ○
  the Data/Initiation/UltimateDebtor/LEI 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 200 (media type: application/json; charset=utf-8)
  response-property-pattern-changed
- ○
  the Data/Initiation/UltimateDebtor/LEI 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 200 (media type: application/json)
  response-property-pattern-changed
- ○
  the Data/Initiation/UltimateDebtor/LEI 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 200 (media type: application/jose+jwe)
  response-property-pattern-changed

Full history