Merchant API
Retrieve an order list
api
get
/api/1.0/orders

Retrieve an order list

Retrieve all the orders that you've created. You can also use the query parameters to:

  • Filter the orders that you want to retrieve, for example, only retrieve the orders that have a specific email. (Filtering)
  • View the orders without loading all of them at once, for example, return a specified number of orders per page. (Pagination)

The response contains an array of simplified Order objects. To get the full details of an Order object, use the Retrieve an order endpoint.

Authorization​

Each Merchant API request must contain an authorization header in the following format to make a call: 

'Authorization: Bearer <yourSecretApiKey>'

Before you start, ensure that you've successfully applied for a Merchant Account in your Revolut Business Account.

The Public key is on the same path in your Revolut Business account as the Secret key. There are two different functions for each:

  • Public key should be provided with payment methods at checkout
  • Secret key is used as a part of the authorization header for all server calls, e.g., creating order

Complete the following steps to generate the Production API keys (Secret, Public):

  1. Log in to your Revolut Business portal.
  2. On the top left corner, click your account name, click APIs then select Merchant API.
  3. Under the Production API Secret key and Production API Public key sections you will find the API keys needed. If it's your first time on this page, you will need to click the Generate button to create your unique API keys.

You can also use this link to directly open the Merchant API page.

Merchant API - Settings

note

Use these keys only for the production environment. For the Revolut Business Sandbox environment, use the sandbox API keys.

SSL​

note

This authentication protocol is used exclusively when using Fast checkout.

Connection over HTTPS is using SSL authentication. For successful authentication, your system's certificate should be issued by a Public Certificate Authority (PCA) and your system should trust Revolut's public certificate.

Revolut-Pay-Payload-Signature​

note

This authentication protocol is used exclusively when using Fast checkout.

Data integrity and authorship will be verified using a payload-based signature. The response of a successful URL registration for address validation (see: Register address validation for Fast checkout) will contain a secret signing key.

The signing key will be used by Revolut to compute a Hash-based Message Authentication Code (HMAC) payload signature whenever the registered URL is called, which should be verified by your backend.

Request​

Query Parameters
Query Parameters

Default value: 100

The maximum number of orders returned per page. Used for pagination.

Retrieve orders with a created_date < created_before. Used for pagination. Use the created_date of the last order returned in the previous response to get to the next page.

The default value is the current date and time you are calling the endpoint.

Retrieve all orders with a created_date ≥ from_created_date. Used for filtering.

Use the ISO date format : yyyy-MM-ddTHH:mm:ss[.SSSSSS]Z. For example, 2021-02-10T16:59:50.886826Z.

Retrieve all orders with a created_date ≤ to_created_date. Used for filtering.

Use the ISO date format : yyyy-MM-ddTHH:mm:ss[.SSSSSS]Z. For example, 2021-02-10T16:59:50.886826Z.

Retrieve all orders that have this customer_id associated to them. Used for filtering.

Retrieve all orders that have this email associated to them. Used for filtering.

This parameter is case sensitive.

Merchant order ID for external reference. Use this field to filter and retrieve all the orders that have this ID. Used for filtering.

This parameter is case sensitive.

Possible values: [PENDING, PROCESSING, AUTHORISED, COMPLETED, CANCELLED, FAILED]

Retrieve all orders with specific states. You can pass several states. Used for filtering.

If multiple states are selected, for example AUTHORISED and COMPLETED, orders with either of the selected values are returned. See this example of such a request:

https://merchant.revolut.com/api/1.0/orders?state=AUTHORISED&state=COMPLETED

The parameter is case sensitive.

Response​

OK

Response body
Body array

Permanent order ID used to retrieve, capture, cancel, or refund an order after authorization.

Possible values: [PAYMENT, REFUND, CHARGEBACK]

The type of the order.

Possible values: [PENDING, PROCESSING, AUTHORISED, COMPLETED, CANCELLED, FAILED]

The state of the order.

The date and time the order was created.

The date and time the order was last updated.

The date and time the order was completed.

The description of the order.

The capture mode of the order. AUTOMATIC is used by default.

  • AUTOMATIC: The order is captured automatically after payment authorization.
  • MANUAL: The order is not captured automatically. You must manually capture the order later.

For more information, see Capture an order.

ISO 4217 currency code in upper case. All payments made towards this order are settled in this currency.

Merchant order ID for external reference.

Use this field to set the ID that your own system can use to easily track orders.

The ID of the customer associated with this order.

The email of the customer.

The phone number of the customer.

The amount and currency of the order.

The amount of the order (minor currency unit). For example, enter 7034 for €70.34 in the field.

The currency of the order. ISO 4217 currency code in upper case.

The amount and currency outstanding to be paid for this order.

The amount of the order (minor currency unit) that is outstanding. For example, enter 7034 for €70.34 in the field.

The currency of the amount that is outstanding. ISO 4217 currency code in upper case.

Street line 1 information.

Street line 2 information.

The region associated with the address.

The city associated with the address.

The country associated with the address.

The postcode associated with the address.

Was this page helpful?
Loading...