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 Payments

Get payment details for a File Payment

Enables a PISP to retrieve detailed information on the status of payments within a File.

get/file-payments/{FilePaymentId}/payment-details

Path parameters

FilePaymentIdstring required

FilePaymentId

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

Payment Details Read

Changes

Changed in 6 of the 50 revisions of this API.124524

Feb 19, 20263bce3f3a48362See the full diff
- ○
  api tag File Payments added
  api-tag-added
- ○
  api tag Payment Details 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 19, 2025896620f429f9621See the full diff
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status response property's maxLength was unset from 4 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-max-length-unset
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status response property's maxLength was unset from 4 for the response status 200 (media type: application/json)
  response-property-max-length-unset
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status response property's maxLength was unset from 4 for the response status 200 (media type: application/jose+jwe)
  response-property-max-length-unset
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status 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/PaymentStatus/items/StatusDetail/Status 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/PaymentStatus/items/StatusDetail/Status 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
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
Nov 18, 2025aaaa675dbfd821See the full diff
- ○
  removed the CANC enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the CANC enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the CANC enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the CANC enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the CANC enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the CANC enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the INCO enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the INCO enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the INCO enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the INCO enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the INCO enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the INCO enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the INFA enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the INFA enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the INFA enum value from the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the INFA enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the INFA enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the INFA enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-removed
- ○
  removed the RCVD enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-removed
- ○
  removed the RCVD enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-removed
- ○
  removed the RCVD enum value from the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 17, 2025e78aaf6dd31c621See the full diff
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status response property's maxLength was unset from 4 for the response status 200 (media type: application/json; charset=utf-8)
  response-property-max-length-unset
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status response property's maxLength was unset from 4 for the response status 200 (media type: application/json)
  response-property-max-length-unset
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status response property's maxLength was unset from 4 for the response status 200 (media type: application/jose+jwe)
  response-property-max-length-unset
- ▲
  the Data/PaymentStatus/items/StatusDetail/Status 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/PaymentStatus/items/StatusDetail/Status 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/PaymentStatus/items/StatusDetail/Status 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
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new CANC enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INCO enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new INFA enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/StatusDetail/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 13, 202531bdd8df938d3See the full diff
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json; charset=utf-8)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new RCVD enum value to the Data/PaymentStatus/items/Status response property for the response status 200 (media type: application/jose+jwe)
  response-property-enum-value-added

Full history