Retrieve counterparties
The Business API lets you retrieve the counterparties that you previously added.
The fields returned for a given counterparty will differ depending on whether the counterparty has a Revolut account, as well as on the account currency and the country which the account is based in.
You can:
Retrieve a counterparty
To get information about a single specific counterparty, you must provide this counterparty's ID.
To see example requests and responses:
Filter and retrieve all counterparties
You can retrieve a full list of the counterparties that you previously added to your Revolut Business account.
The results are sorted by the created_at date in the descending order (from newest at the top to oldest at the bottom).
To see example requests and responses:
You can filter this list of counterparties by adding one or more of the query parameters listed below to the URL:
curl -L -X GET 'https://b2b.revolut.com/api/1.0/counterparties?name=John%20Smith&account_no=12345678' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <your access token>'
The following table lists the parameters that you can optionally add as filters:
| Name | Description | Comment |
|---|---|---|
name | The name of the counterparty. | Does not have to be an exact match, partial match is also supported. Note: Special characters must be properly URL-encoded. |
account_no | The exact account number of the counterparty to retrieve. | |
sort_code | The exact sort code of the counterparty to retrieve. | Only allowed in combination with the account number (account_no). |
iban | The exact IBAN of the counterparty to retrieve. | |
bic | The exact BIC of the counterparty to retrieve. | Only allowed in combination with IBAN (iban). |
created_before | Retrieves counterparties with the date created_at < created_before. The default value is the current date and time you are calling the endpoint. | This parameter is also used for pagination. |
Pagination
When retrieving counterparties, the results can be paginated.
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 created_before.
You can modify the size of a single page by specifying the limit parameter. The maximum number of results per page that you can set is 1000.
If you specify the created_before parameter and don't specify the limit parameter, the default limit of 100 is applied.
If you don't specify created_before or limit, no pagination is applied.