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

FilteringPagination
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
Query Parameters
Header Parameters
Header Parameters

Response​

OK

Response body
Body array of objects
Was this page helpful?
GET
/api . /1.0 . /orders . 
Parameters
curl -L -X GET 'https://merchant.revolut.com/api/1.0/orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <yourSecretApiKey>'
Response body samples
[
  {
    "id": "f0d685f4-07ab-4eff-ba80-5811303c607d",
    "type": "PAYMENT",
    "state": "PENDING",
    "created_at": "2021-02-10T18:17:37.959383Z",
    "updated_at": "2021-02-10T18:17:37.959383Z",
    "order_amount": {
      "value": 35000,
      "currency": "GBP"
    },
    "order_outstanding_amount": {
      "value": 35000,
      "currency": "GBP"
    }
  },
  {
    "id": "feca684a-b9ea-4033-9bc4-b9e6ac12ada6",
    "type": "PAYMENT",
    "state": "COMPLETED",
    "created_at": "2021-02-10T16:59:23.642673Z",
    "updated_at": "2021-02-10T16:59:50.886826Z",
    "completed_at": "2021-02-10T16:59:50.886826Z",
    "settlement_currency": "USD",
    "email": "sally.gibson@lloydsbank.co.uk",
    "order_amount": {
      "value": 1000,
      "currency": "GBP"
    },
    "order_outstanding_amount": {
      "value": 0,
      "currency": "GBP"
    }
  },
  {
    "id": "f3c5e3f1-f73a-4853-a9e3-b0261301c66a",
    "type": "PAYMENT",
    "state": "COMPLETED",
    "created_at": "2021-02-10T16:58:47.507560Z",
    "updated_at": "2021-02-10T16:59:52.847017Z",
    "completed_at": "2021-02-10T16:59:52.847017Z",
    "description": "URBAN 'Panther' Watch by José Almeida",
    "capture_mode": "AUTOMATIC",
    "merchant_order_ext_ref": "testorder123",
    "customer_id": "31345442-3d03-4c4b-8354-3bdaf0ca9600",
    "email": "someothermail@gmail.com",
    "order_amount": {
      "value": 777,
      "currency": "GBP"
    },
    "order_outstanding_amount": {
      "value": 0,
      "currency": "GBP"
    }
  }
]