File payment

Upload a payment file

Use this endpoint to upload a file for the given file payment consent.

For the format of the CSV file, check the request body details.

:::note Download an example CSV file. :::

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

post/file-payment-consents/{ConsentId}/file

Request

Base URL
https://oba-auth.revolut.com
Auth
API key in header Authorization and API key in header x-jws-signature

Path parameters

ConsentIdstring required

The ID of the account access consent.

Headers

x-fapi-financial-idstring required

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

x-fapi-customer-last-logged-timestring

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: <nobr>Sun, 10 Sep 2017 19:43:31 UTC</nobr>.

x-fapi-customer-ip-addressstring

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

x-fapi-interaction-idstring

An RFC4122 UUID used as a correlation ID.

Authorizationstring required

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

x-idempotency-keystring required

Each request is processed only once per x-idempotency-key. The idempotency key is valid for 24 hours.

x-jws-signaturestring required

A detached JWS signature of the body of the payload.

x-customer-user-agentstring

The user agent that the PSU is using.

Request body text/csv

string required

The CSV payments file. Provided as CSV-formatted text representing file payments, or as the path to the CSV payments file preceded by @. For the format of the CSV file, check the details below.

<details><summary>The format of the payment file:</summary>

FIELD	REQUIRED	DESCRIPTION
Name	Yes	Can contain up to 80 characters. If recipient type is INDIVIDUAL, this field must contain a first and a last name, separated by a space.
Recipient type	Yes	Can be either INDIVIDUAL or COMPANY.
Account number	For UK transfers	Must contain valid account number if provided.
Sort code	For UK transfers	Must contain valid sort code if provided.
Routing number	For US transfers	Must contain valid routing number if provided.
IBAN	For SEPA transfers	Must contain valid IBAN if provided.
BIC	For SEPA transfers	Must contain valid BIC if provided.
Recipient bank country	Yes	Must contain valid ISO 3166-1 country code.
Currency	Yes	Must contain valid ISO 4217 currency code.
Amount	Yes	Must match the following pattern [0-9](\.[0-9])?.
Payment reference	Yes	Can contain up to 100 characters.
Recipient country	No	Must contain valid ISO 3166-1 country code if provided.
State or province	No	Can contain up to 50 characters.
Address line 1	No	Can contain up to 50 characters.
Address line 2	No	Can contain up to 50 characters.
City	No	Can contain up to 50 characters.
Postal code	No	Can contain up to 50 characters.

</details> <br/>

Response

File Payment CSV Uploaded

EmptyBody nullable required

An empty JSON object ({}).

Changes

No recorded changes to this operation across all 2 revisions of this API.