Counterparties

Create a counterparty

Create a new counterparty to transact with.

Revtags in Sandbox

In the Sandbox environment, you cannot add real people and businesses as Revolut counterparties. To help you simulate adding counterparties using Revtag, we created some test accounts of profile type personal that you can use.

<details id='test-accounts-for-sandbox'> <summary> <b>Test accounts for Sandbox</b> </summary>

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

</details>

Address field recommendations

Some payment rails may have stricter requirements regarding the address field – for example, by also requiring the region field.
This is why we recommend that you use all available address fields (including street_line1, region and city) when creating a counterparty.

This significantly reduces the risk of any disruption to payments made via the API.

Multiple counterparties with the same details

You cannot create multiple counterparties with the same Revtag. This restriction does not apply to other details. For example:

Revtag: If you've already added johnsmith as a Revolut counterparty, you can't add another counterparty with the johnsmith Revtag. If you try to do so, you'll get an error.
Other details: If you've added John Smith as an individual UK counterparty using GBP with sort_code=54-01-05 and account_no=12345678, you can still use the same details to create another counterparty.

Counterparty name

When creating a counterparty, ensure that you use the correct field to define the counterparty's name.

<table> <thead> <tr> <th rowSpan="2"> Counterparty type</th> <th colSpan="2">Name field to use when added with:</th> </tr> <tr> <th>Revtag</th> <th>Other details</th> </tr> </thead> <tbody> <tr> <th>Individual</th> <td><code>name</code> (string)</td> <td><code>individual_name</code> (<b>object</b> with string subfields for first and last name)</td> </tr> <tr> <th>Company</th> <td><code>name</code> (string)</td> <td><code>company_name</code> (string)</td> </tr> </tbody> </table>

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

post/counterparty

Request

Base URL
https://b2b.revolut.com/api/1.0
Auth
HTTP bearer

Request body

profile_type'personal' | 'business'

The type of the Revolut profile. Indicates whether the counterparty is a personal or business account. Provide it when adding a Revolut counterparty via Revtag.

revtagstring

The Revtag of the counterparty to add.

namestring

The name of the counterparty, provided when the counterparty is being added via Revtag.

If specified, individual_name and company_name must be empty.

:::note The name that you provide must match or closely match the actual name associated with the account that you're trying to add. Otherwise, the creation fails and a 404 error is returned. :::

company_namestring

The name of the counterparty, provided when the counterparty is a company (business account type) and is not being added via Revtag.

If specified, individual_name and name must be empty.

:::warning The company_name must contain at least 2 letters (not just characters). For example, names like 12 will fail validation because they are two characters but not two letters. :::

bank_countrystring

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

currencystring

ISO 4217 currency code in upper case.

account_nostring

The bank account number of the counterparty.

ibanstring

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

sort_codestring

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

routing_numberstring

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

bicstring

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

clabestring

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

ifscstring

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

bsb_codestring

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

route'ach' | 'fedwire' | 'swift'

Routing method for US USD transfers. When omitted, defaults to ach for US-registered businesses and fedwire for non-US businesses.

Required when bank_country is US and the desired routing method differs from the default.

bank_numberstring

Brazilian bank identification code (COMPE). Required for BR counterparties.

branch_codestring

Brazilian branch (agência) code. Required for BR counterparties.

account_type'checking' | 'savings'

Bank account type. Defaults to checking for US ACH transfers when omitted.

Required for BR, CO, and CL counterparties.

tax_idstring

Tax identification number.

Required and routed based on bank_country and recipient type:

Country	Recipient type	Tax ID type	Format	Example
BR	Individual	CPF (Cadastro de Pessoas Físicas)	^\d{11}$ or ^\d{3}\.\d{3}\.\d{3}-\d{2}$	52998224725 or 529.982.247-25
BR	Company	CNPJ (Cadastro Nacional da Pessoa Jurídica)	^\d{14}$ or ^\d{2}\.\d{3}\.\d{3}/\d{4}-\d{2}$	12345678000195 or 12.345.678/0001-95
CO	Company	NIT (Número de Identificación Tributaria)	^\d{10}$	9012345678
CL	Individual, Company	RUT (Rol Único Tributario)	^\d{7,8}[0-9Kk]$	12345678K

national_idstring

National identification number. Required when bank_country is CO and profile_type is personal, must specify Colombian Cédula de Ciudadanía.

phonestring

The phone number of the counterparty in E.164 format.

For internal (Revolut) counterparties: the recipient's Revolut phone number used to look them up.
For external counterparties in CO, KR, and LK: the bank account phone number. Required when bank_country is CO, KR, or LK.

Country-specific formats:

Country	Format description	Format	Example
CO	+57 followed by 10 digits	^\+?57\d{10}$	+573001234567
KR	+82 followed by 10 digits	^\+?82\d{10}$	+821012345678
LK	+94 followed by 10 digits	^\+?94\d{10}$	+941234567890

business_registration_idstring

Company registration number. Required for business LK counterparties (profile_type: business).

Example request

{
  "bank_country": "GB",
  "address": {
    "street_line1": "Revolut LTD",
    "street_line2": "1 Canada Square",
    "region": "Ontario",
    "city": "London",
    "country": "GB",
    "postcode": "E14 5AB"
  },
  "route": "ach",
  "bank_number": "033",
  "branch_code": "0001",
  "account_type": "checking",
  "phone": "+573001234567",
  "business_registration_id": "PV12345"
}

Response

Added counterparty

idstring uuid required

The ID of the counterparty.

namestring required

The name of the counterparty.

revtagstring

The Revtag of the counterparty.

profile_type'personal' | 'business'

The type of the counterparty. Indicates whether the recipient is an individual or a company.

countrystring

The counterparty's bank country, provided as a 2-letter ISO 3166 code.

state'created' | 'draft' | 'deleted' required

Indicates the state of the counterparty.

created_atstring date-time required

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

updated_atstring date-time required

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

Example response

{
  "accounts": [
    {
      "bank_country": "GB",
      "route": "ach",
      "bank_number": "033",
      "branch_code": "0001",
      "account_type": "checking",
      "phone": "+573001234567",
      "business_registration_id": "PV12345"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.