Open Banking API
Retrieve all payments of a file payment
api
get
/file-payments/{FilePaymentId}/report-file

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.

Authorization​

Each Open Banking API must contain an authorization header in the following format to make a call: Bearer <yourAccessToken>.

Before you start, ensure that you've got an access token with the correct scope using the /token endpoint. You need to get the authorization code first and exchange it for an access token.

danger

Never share your access_token with anyone, as it can be used to access the banking data that you have access to and initiate transactions.

For more information, see Tutorial: Get account and transaction information and Tutorial: Initiate your first payment as examples.

x-jws-signature​

Open Banking API Payment requests additionally require a JSON Web Signature (JWS) which needs to be added to the header of the request. The JWS signature must be obtained using the full content of the payload.

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.

Possible values: 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.

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

The amount of money.

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

ISO 4217 currency code in upper case.

Possible values: non-empty and <= 100 characters

The unique reference assigned to the payment.

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

The status of the payment.

Was this page helpful?
Loading...