Business API
Retrieve a list of counterparties
api
get
/counterparties

Retrieve a list of counterparties

Get all the counterparties that you have created, or use the query parameters to filter the results.

The counterparties are sorted by the created_at date in reverse chronological order.

The returned counterparties are paginated. The maximum number of counterparties returned per page is specified by the limit parameter. To get to the next page, make a new request and use the created_at date of the last counterparty returned in the previous response.

For more information, see the guides: Retrieve counterparties.

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​

Query Parameters
Query Parameters

The name of the counterparty to retrieve. It does not need to be an exact match, partial match is also supported.

note

Special characters must be properly URL-encoded.

The exact account number of the counterparty to retrieve.

The exact sort code of the counterparty to retrieve. Only allowed in combination with the account_no parameter.

The exact IBAN of the counterparty to retrieve.

The exact BIC of the counterparty to retrieve. Only allowed in combination with the iban parameter.

Default value: the date-time at which the request is made

Retrieves counterparties with created_at < created_before. The default value is the current date and time at which you are calling the endpoint.

Provide it in ISO 8601 format.

Possible values: >= 1 and <= 1000

Default value: 100

The maximum number of counterparties returned per page.

To get to the next page, make a new request and use the created_at date of the last counterparty returned in the previous response as the value for created_before.

Response​

List of your counterparties

Response body
Body array

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