Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Revolut Counterparties API

Manage counterparties that you intend to transact with.Request and response examples can vary based on the account provider's location and type of the counterparty. For more information, see the guides: [Create a counterparty](https://developer.revolut.com/docs/guides/manage-accounts/counterparties/create-a-counterparty), [Retrieve counterparties](https://developer.revolut.com/docs/guides/manage-accounts/counterparties/retrieve-counterparties), and [Update a counterparty's payment method](https://developer.revolut.com/docs/guides/manage-accounts/counterparties/update-counterparty-payment-method).:::noteIn the Sandbox environment, you cannot add real people and businesses as Revolut counterparties. Therefore, to help you simulate [Create a counterparty](https://developer.revolut.com/docs/api/business#add-counterparty) requests, we have created some test accounts for counterparties of profile type `personal`.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`:::

Revolut Counterparties API is one of 46 APIs that Revolut publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Counterparties. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 7 paths, and defines 28 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://b2b.revolut.com/api/1.0, https://sandbox-b2b.revolut.com/api/1.0.

8 operations 7 paths 28 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://b2b.revolut.com/api/1.0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Revolut Counterparties API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (AccessToken).

  • AccessToken — Each Business API request must contain an authorization header in the following format to make a call: Bearer . The access token will be obtained the first tim…

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Counterparties 8

Manage counterparties that you intend to transact with. Request and response examples can vary based on the account provider's location and type of the counterparty. For more info…

POST
/account-name-validation
Validate an account name (CoP/VoP)
validateAccountName body → 200400401404default
GET
/counterparties
Retrieve a list of counterparties
getCounterparties 7 params → 200400401default
POST
/counterparty
Create a counterparty
addCounterparty body → 200400404422default
GET
/counterparties/countries
Check supported countries and currencies
getCounterpartyCountries → 200default
GET
/counterparties/fields
Check counterparty field requirements
getCounterpartyRequirements 4 params → 200400404422default
GET
/counterparty/{counterparty_id}
Retrieve a counterparty
getCounterparty 1 param → 200default
DELETE
/counterparty/{counterparty_id}
Delete a counterparty
deleteCounterparty 1 param → 204default
PATCH
/counterparties/{counterparty_id}/payment-methods/{payment_method_id}
Update a counterparty's payment method
updateCounterpartyPaymentMethod 2 params body → 204default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are CreateCounterpartyRequest (24 properties), CounterpartyAccount (23 properties), Counterparty (10 properties), UpdateCounterpartyPaymentMethodAddress (6 properties). Each schema is shown below with its type and property counts.

ErrorWithId
object
3 properties 3 required
IndividualName
object
The name of the counterparty, provided when the counterparty is an individual (personal account type) and is not being added via Revtag. If specified, companyn…
2 properties
Currency
string
[ISO 4217](https://en.wikipedia.org/wiki/ISO4217) currency code in upper case.
CountryCodeCard
string
The country of the card issuer, provided as a 2-letter [ISO 3166](https://en.wikipedia.org/wiki/ListofISO3166countrycodes) code.
Error
object
2 properties 2 required
UpdateCounterpartyPaymentMethodAddress
object
The updated address for the counterparty's payment method. All required fields must be provided.
6 properties 4 required
AccountCurrency
string
[ISO 4217](https://en.wikipedia.org/wiki/ISO4217) currency code in upper case.
CounterpartyRequirementsField
object
Represents a contextual field and its rules.
4 properties 2 required
CounterpartyRequirementsFieldOption
object
An allowed value option for the field.
2 properties 1 required
CounterpartyCountriesResponse
object
The response containing supported bank countries and their available currencies.
1 property 1 required
CreateCounterpartyRequest
object
24 properties
CounterpartyAddress
object
The address of the counterparty's account.
6 properties 1 required
CounterpartyRequirementsResponse
object
The response containing applicable counterparty fields and their validation rules.
1 property 1 required
ValidateAccountNameRequest
UpdateCounterpartyPaymentMethodRequest
object
The request body for updating a counterparty's payment method address.
1 property 1 required
Counterparties
array
Counterparty
object
10 properties 5 required
CounterpartyRequirementsFieldRegex
object
Regular expression validation rules.
2 properties 2 required
ValidateAccountNameResponse
CountryCode
string
The counterparty's bank country, provided as a 2-letter [ISO 3166](https://en.wikipedia.org/wiki/ListofISO3166countrycodes) code.
ProfileType
string
The type of the counterparty. Indicates whether the recipient is an individual or a company.
CounterpartyErrorParams
object
Additional parameters related to the error.
1 property
CounterpartyCard
object
6 properties 6 required
BeneficiaryAddress
object
The address of the counterparty.
6 properties 2 required
CounterpartyCountry
object
A supported bank country with its available currencies.
2 properties 2 required
CounterpartyAccount
object
23 properties 3 required
BankCountryCode
string
The country of the bank, provided as a 2-letter [ISO 3166](https://en.wikipedia.org/wiki/ListofISO3166countrycodes) code.
CounterpartyError
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revolut-counterparties-api-openapi.yml Raw ↑

Other APIs Revolut publishes across the network.

Revolut Accounting API
Revolut Accounting categories API
Revolut Accounts API
Revolut Apple Pay merchant registration API
Revolut Applications API
Revolut Balance API
Revolut Card invitations API
Revolut Cards API
Revolut Configuration API
Revolut Customers API
Revolut Disputes API
Revolut Domestic payment API