Business API
Create a counterparty
api
post
/counterparty

Create a counterparty

Create a new counterparty to transact with.

Test accounts for Sandbox

In the Sandbox environment, you cannot add real people and businesses as Revolut counterparties. To help you simulate Create a counterparty requests for counterparties of profile type personal, we created some test accounts. Look inside for test Revtags.

To add a counterparty via Revtag, use one of these pairs for the name and revtag fields respectively:

  • Test User 1 & john1pvki
  • Test User 2 & john2pvki
  • ...
  • Test User 9 & john9pvki

For more information, see the guides: Create a counterparty.

Access Token​

Each Business API request must contain an authorization header in the following format to make a call: Bearer <your_access_token>.

The access token will be obtained the first time you set up your application and has an expiration of 40 minutes. During setup, a refresh_token will also be obtained which allows to obtain a new access_token.

danger

Never share your client-assertion JWT (JSON web token), access_token and refresh_token with anyone, as these can be used to access your banking data and initiate transactions.

Access tokens can be issued with four security scopes and require a JWT (JSON Web Token) signature to be obtained:

  • READ: Permissions for GET operations.

  • WRITE: Permissions to update counterparties, webhooks, and issue payment drafts.

  • PAY: Permissions to initiate or cancel transactions and currency exchanges.

  • READ_SENSITIVE_CARD_DATA: Permissions to retrieve sensitive card details.

    caution

    If you enable the READ_SENSITIVE_CARD_DATA scope for your access token, you must set up IP whitelisting. Failing to do so will prevent you from accessing any Business API endpoint.

    IP whitelisting means that you must specify an IP or a set of IPs which will be the only IPs from which requests to the API will be accepted. To do so:

    1. Go to the Revolut Business web app settings -> APIs -> Business API.
    2. Select the corresponding API certificate.
    3. In Production IP whitelist, provide the IP(s) which should be whitelisted, and save.

To configure your JWT and obtain the refresh and first access tokens, complete the following steps:

  1. Sign up for a Revolut Business account
  2. Prepare your Sandbox environment
  3. Make your first API request

Request​

Counterparty to add

Request body
Body object

The name of the company counterparty. Use when individual_name or name isn't specified and profile_type is business.

Possible values: [personal, business]

The type of the Revolut profile. Used when adding an existing Revolut user via Revtag.

The name of the counterparty that you create for an existing Revolut user via Revtag. Provide the value only when you specify personal for profile_type.

The name of the individual counterparty. Use when company_name isn't specified.

The first name of the individual counterparty.

The last name of the individual counterparty.

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

The country of the bank as the 2-letter ISO 3166 code.

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

ISO 4217 currency code in upper case.

The Revtag of the counterparty to add.

The bank account number of the counterparty.

The IBAN number of the counterparty's account. This field is displayed for IBAN countries.

The sort code of the counterparty's account. This field is required for GBP accounts.

The routing number of the counterparty's account. This field is required for USD accounts.

The BIC number of the counterparty's account. This field is required for non-SEPA IBAN/SWIFT.

The CLABE number of the counterparty's account. This field is required for SWIFT MX.

The IFSC number of the counterparty's account. This field is required for INR accounts.

The BSB number of the counterparty's account. This field is required for AUD accounts.

The address of the counterparty.

Street line 1 information.

Street line 2 information.

The name of the region.

The name of the city.

The country of the counterparty as the 2-letter ISO 3166 code.

The postcode of the counterparty address.

Response​

Added counterparty

Response body
Body object

The ID of the counterparty.

The name of the counterparty.

The Revtag of the counterparty.

Possible values: [personal, business]

The type of the Revolut profile. Used when adding an existing Revolut user via Revtag.

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

The bank country of the counterparty as the 2-letter ISO 3166 code.

Possible values: [created, draft, deleted]

Indicates the state of the counterparty.

The date and time the counterparty was created in ISO 8601 format.

The date and time the counterparty was last updated in ISO 8601 format.

The list of public accounts associated with this counterparty.

The ID of the counterparty's account.

The name of the counterparty.

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

The country of the bank as the 2-letter ISO 3166 code.

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

ISO 4217 currency code in upper case.

Possible values: [revolut, external]

Indicates the type of account.

The bank account number of the counterparty.

The IBAN number of the counterparty's account if applicable.

The sort code of the counterparty's account if applicable.

The routing number of the counterparty's account if applicable.

The BIC number of the counterparty's account if applicable.

The CLABE number of the counterparty's account if applicable.

The IFSC number of the counterparty's account if applicable.

The BSB number of the counterparty's account if applicable.

Possible values: [no, expected]

Indicates the possibility of the recipient charges.

caution

This field is deprecated and should be disregarded. It is returned for legacy purposes only.

The list of cards associated with this counterparty.

The ID of the counterparty's card.

The name of the counterparty.

The last four digits of the card number.

Possible values: [visa, mastercard]

The card brand.

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

The country of the card issuer as the 2-letter ISO 3166 code.

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

ISO 4217 currency code in upper case.

Was this page helpful?
Loading...