Open Banking API
Create a file payment consent
api
post
/file-payment-consents

Create a file payment consent

Create a file payment consent described in the Open Banking API documentation: Account and Transaction API Specification.

note

File Payments are available only for Revolut Business users. Currently only the text/csv file type is supported for File Payments.

When you make the API call, ensure that you pass the corresponding JSON Web Signature (JWS) in the x-jws-signature request header. Note:

  • The JWS is generated from the request body with the TPP signing key that is specified in the JWS header.
  • The JWS consists of a header and a signature in the <jws_header>..<jws_signature> format.

To see how to create a JWS, see the guide: Work with JSON Web Signatures.

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​

Default

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.

Possible length: <= 40 characters
Pattern: Value must match regular expression ^(?!\s)(.*)(\S)$

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

A detached JWS signature of the body of the payload.

The user agent that the PSU is using.

Request body
Body object 

OBWriteDataFileConsent2

The initiation payload that the initiating party sends to the ASPSP, which is used to request movement of funds using a payment file.

Example: "text/csv"

The payment file type.

Possible length: non-empty and <= 44 characters

A base64 encoding of a SHA256 hash of the file to be uploaded.

Possible length: non-empty and <= 40 characters

Reference for the file.

The date and time when the initiating party requests the clearing agent to process the payment. This is the date the debtor's account is to be debited.

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.

For example: 2017-04-05T10:43:07+00:00.

Possible length: non-empty and <= 50 characters

User community specific instrument.

Use this element to specify a local instrument, local clearing option and/or further qualify the service or service level.

The details to identify the account.

Possible values: [UK.OBIE.IBAN, UK.OBIE.SortCodeAccountNumber, US.RoutingNumberAccountNumber, US.BranchCodeAccountNumber]
Example: ["UK.OBIE.IBAN","UK.OBIE.SortCodeAccountNumber"]

The name of the identification scheme.

Possible length: non-empty and <= 256 characters

The account ID that an institution assigns to identify the account, which is known by the account owner.

Possible length: non-empty and <= 70 characters

The account name that the account servicing institution assigns.

The account name is the name or names of the account owner(s) represented at an account level.

The account name is not the product name or the nickname of the account.

Possible length: non-empty and <= 34 characters

The secondary account ID that the account servicing institution assigns.

Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination.

The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Possible length: non-empty and <= 140 characters

The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Possible length: non-empty and <= 35 characters

The unique reference that the creditor assigns to unambiguously identify the payment transaction.

If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money.

If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

note

Faster Payments Scheme can accept only 18 characters for the Reference field.

caution

Only one reference should be provided, if both Reference and Unstructured parameters are provided, then the Unstructured parameter will be ignored.

Response​

File Payment Consents Created

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 

OBWriteDataFileConsentResponse2

Possible length: non-empty and <= 128 characters

The unique ID that the ASPSP assigns to identify the consent resource.

The date and time when the resource was created.

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.

For example: 2017-04-05T10:43:07+00:00.

Possible values: [Authorised, AwaitingAuthorisation, AwaitingUpload, Consumed, Rejected]

The status of the consent.

The date and time when the consent resource status was updated.

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.

For example: 2017-04-05T10:43:07+00:00.

The initiation payload that the initiating party sends to the ASPSP, which is used to request movement of funds using a payment file.

Example: "text/csv"

The payment file type.

Possible length: non-empty and <= 44 characters

A base64 encoding of a SHA256 hash of the file to be uploaded.

Possible length: non-empty and <= 40 characters

Reference for the file.

The date and time when the initiating party requests the clearing agent to process the payment. This is the date the debtor's account is to be debited.

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.

For example: 2017-04-05T10:43:07+00:00.

Possible length: non-empty and <= 50 characters

User community specific instrument.

Use this element to specify a local instrument, local clearing option and/or further qualify the service or service level.

The details to identify the account.

Possible values: [UK.OBIE.IBAN, UK.OBIE.SortCodeAccountNumber, US.RoutingNumberAccountNumber, US.BranchCodeAccountNumber]
Example: ["UK.OBIE.IBAN","UK.OBIE.SortCodeAccountNumber"]

The name of the identification scheme.

Possible length: non-empty and <= 256 characters

The account ID that an institution assigns to identify the account, which is known by the account owner.

Possible length: non-empty and <= 70 characters

The account name that the account servicing institution assigns.

The account name is the name or names of the account owner(s) represented at an account level.

The account name is not the product name or the nickname of the account.

Possible length: non-empty and <= 34 characters

The secondary account ID that the account servicing institution assigns.

Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination.

The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Possible length: non-empty and <= 140 characters

The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Possible length: non-empty and <= 35 characters

The unique reference that the creditor assigns to unambiguously identify the payment transaction.

If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money.

If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

note

Faster Payments Scheme can accept only 18 characters for the Reference field.

caution

Only one reference should be provided, if both Reference and Unstructured parameters are provided, then the Unstructured parameter will be ignored.

Links relevant to the payload.

The absolute URI to the resource.

The absolute URI to the next pagination resource.

The absolute URI to the previous pagination resource.

Meta data relevant to the payload.

Used for pagination. Indicates how many pages of results are available.

Was this page helpful?
Loading...