Retrieve an order list

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

Filtering	Pagination
Filter the orders that you want to retrieve, for example, only retrieve the orders that have a specific email. Parameters used for filtering: `from_created_date` `to_created_date` `customer_id` `email` `merchant_order_ext_ref` `state`	View the orders without loading all of them at once, for example, return a specified number of orders per page. Parameters used for pagination: `limit` `created_before`

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

Request

Query Parameters

Possible values: >= 1 and <= 1000

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

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

The parameter is case sensitive.

Header Parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

Response

Response body

Body array of objects

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

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 authorisation.
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 and currency outstanding to be paid for this order.

Address

Retrieve an order list

Request​

Response​

Request

Response