Qodex.ai

Open Banking API

Number of APIs: 55

Introduction

The Revolut Open Banking API is the gateway for third-party providers to interact with Revolut customers and products.

You can take advantage of the Open Banking API to build your banking applications whether you are a regulated third party provider that wants to get account and transaction information of Revolut customers and initiate different types of payments.

To get started using the Open Banking API, check the user guides.

Environments

To make use of this Qodex Collection, you will need to use Environment variables. Inside Revolut Developers Qodex workspace you will see an Environment created called Open Banking - Sandbox. You can use that Environment for testing all the Revolut APIs in a sandbox environment.

You will need to change the values of each variable with your own values.

We do not recommend to use this Qodex collection in Production in order to maintain the privacy of your credentials.

See the information regarding the environment variables below:

Production URL: https://oba.revolut.com

Sandbox URL: https://sandbox-oba.revolut.com

url: The base url of Revolut Open Banking APIs.

auth_url: The authentication base url for obtaining the access token. Production: https://oba-auth.revolut.com Sandbox: https://sandbox-oba-auth.revolut.com

jwk_domain: The domain where your JWK url is hosted.

kid: The kid which you set up in your JWK.

private_key: The full contents of the private.key file.

client_id: The client_id obtained when a Application is created via the Developer Portal or by Dynamic Client Registration.

redirect_uri: The redirect_url provided in the Developer Portal or by Dynamic Client Registration

Some of these variables do not appear in the requests or params, but they are used as Pre-request Script and Tests, in order to automate some processes in the Open Banking flow.

Automatic variables

This Qodex Collection contains a set of scripts that helps automate the whole Open Banking flow and saves some responses as variables. Here are the variables that are displayed automatically:

access_token: Whenever the Get Access Token endpoint is invoked, the response is saved in the access_token variable, so that it can be used to create consents afterwards.

accounts_access_token: Whenever the Get Authorization Access Token endpoint is invoked, the response is saved in the accounts_access_token variable, so that it can be used to invoke Accounts endpoints.

payments_access_token: Whenever the Get Payment Access Token endpoint is invoked, the response is saved in the payments_access_token variable, so that it can be used to execute Payments.

consentId: Whenever a new consent it created, the consentId variable is saved as a new variable and used afterwards to create a payment or to retrieve account information.

Adding Certificates

For the /token endpoint in this Qodex Collection, it will be required to be signed by a key and a certificate in order to work. To do so, certificates need to be added into Qodex. Complete the following steps in order to set up certificates to work with the Open Banking APIs:

  1. Open up settings on Qodex (top right gear icon and click settings)

  2. In the General tab, turn SSL certificate verification off

  3. In the Certificates tab, make sure that the CA certificates option is turned off

  4. On the Client Certificates section click on Add Certificate

  5. Fill out the Host field with the host of where you will be sending requests to. (For Open Banking - Sandbox it would be sandbox-oba-auth.revolut.com)

  6. For the CRT File section, add your transport.pem certificate

  7. For the KEY File section, add your private.key

  8. Click Add

The final setup in the Client Certificates should look like this:

Host: sandbox-oba-auth.revolut.com

CRT File: /your_path/transport.pem

KEY File: /yourpath/privatekey.keey

And that will do it. You now should be able to interact with endpoints on sandbox-oba-auth that require requests to be signed with a key and certificate!

More Information

You can find more information of Revolut Open Banking APIs in our documentation. You can also visit our community page and help center.

  1. Payments-Domestic Standing Orders - Retrieve Domestic Standing Orders Consent GET {{url}}/domestic-standing-order-consents/{{consentId}}

  2. Accounts - Retrieve all account's transactions GET {{url}}/accounts/:id/transactions

  3. Payments-Domestic Payments - Retrieve domestic payment consent GET {{url}}/domestic-payment-consents/{{consentId}}

  4. Accounts - Create account access consent POST {{url}}/account-access-consents

  5. Accounts - Retrieve account access consent GET {{url}}/account-access-consents/{{consentId}}

  6. Accounts - Delete account access consent DELETE {{url}}/account-access-consents/{{consentId}}

  7. Accounts - Retrieve all accounts GET {{url}}/accounts

  8. Accounts - Retrieve an account GET {{url}}/accounts/:id

  9. Accounts - Retrieve an account balance GET {{url}}/accounts/:id/balances

  10. Accounts - Retrieve all account's beneficiaries GET {{url}}/accounts/:id/beneficiaries