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

get/counterparties

Request

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

Query parameters

namestring

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

account_nostring

The exact account number of the counterparty to retrieve.

sort_codestring

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

ibanstring

The exact IBAN of the counterparty to retrieve.

bicstring

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

created_beforestring date-time

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.

limitinteger

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

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.