Retrieve all payments of a file payment

Get the state of all individual payments for the given file payment.

note

Currently only the JSON format is supported.

For more information, see Tutorials: Create a file payment.

Request​

Path Parameters

Path Parameters

The ID of the file payment.

Header Parameters

Header Parameters

The unique ID of the ASPSP that the request is issued to. The ID of Revolut is 001580000103UAvAAM.

Pattern: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

The date and time when the PSU last logged in with the TPP.

All dates in the HTTP headers are represented as RFC 7231 Full Dates. For example: Sun, 10 Sep 2017 19:43:31 UTC.

The IP address of the PSU if the PSU is logged in with the TPP.

An RFC4122 UUID used as a correlation ID.

The access token that you've generated. For more information, see Generate an access token.

The user agent that the PSU is using.

Response​

File Payments Read

HTTP Headers

HTTP Headers

Header containing a detached JWS signature of the body of the payload.

An RFC4122 UUID used as a correlation ID.

Response body

Body object

The list of payments included in the file payment. Each element in the list corresponds to a single payment and contains the amount, reference, and status of that individual payment.

The amount of money paid. Specifies the amount and the currency.

Pattern: Value must match regular expression ^\d{1,13}\.\d{1,5}$

The amount of money.

Pattern: Value must match regular expression ^[A-Z]{3}$

ISO 4217 currency code in upper case.

Possible length: non-empty and <= 100 characters

The unique reference assigned to the payment.

Possible values: [Created, Pending, Completed, Failed, Deleted]

The status of the payment.