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.

Test accounts for Sandbox

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

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.

Counterparty typeName field to use when added with:
RevtagOther details
Individualname (string)individual_name (object with string subfields for first and last name)
Companyname (string)company_name (string)

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

Request

Counterparty to add

Request body
Body object

Possible values: [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.

The Revtag of the counterparty to add.

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.

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.

Caution

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.

The name of the counterparty, provided when the counterparty is an individual (personal account type) and is not being added via Revtag.

If specified, company_name and name must be empty.

The first name of the individual counterparty.

The last name of the individual counterparty.

Pattern: Value must match regular expression ^[A-Z]{2}$
Example: "GB"

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

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

ISO 4217 currency code in upper case.

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.

Example: "Revolut LTD"

Street line 1 information.

Example: "1 Canada Square"

Street line 2 information.

Example: "Ontario"

The name of the region (state or province), for example, Ontario for Canada.

Example: "London"

The name of the city.

Pattern: Value must match regular expression ^[A-Z]{2}$
Example: "GB"

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

Example: "E14 5AB"

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 counterparty. Indicates whether the recipient is an individual or a company.

Pattern: Value must match regular expression ^[A-Z]{2}$

The counterparty's bank country, provided as a 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.

Pattern: Value must match regular expression ^[A-Z]{2}$
Example: "GB"

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

Pattern: 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.

Pattern: Value must match regular expression ^[A-Z]{2}$

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

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

ISO 4217 currency code in upper case.

Was this page helpful?