RErevolut
File payment

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.

post/file-payment-consents

Request

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

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

Example request

{
  "Data": {
    "Initiation": {
      "FileType": "text/csv",
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.IBAN"
      }
    }
  }
}

Response

File Payment Consents Created

Example response

{
  "Data": {
    "Initiation": {
      "FileType": "text/csv",
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.IBAN"
      }
    }
  }
}

Changes

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