Skip to content

Read the order stream

GET
/v1/admin/stream/orders/

Returns the orders that changed after pointer, in the order they changed. Each order is in the stream once, with its latest state: a change moves it to the end with a higher sequence. Admins only.

Authorization

apiKey
headerAuthorizationBasic <token>

HTTP Basic authentication with your admin API key as the username and an empty password.

Query Parameters

pointer?integer

The highest sequence you've processed. Start at 0.

Range0 <= value
Default0
limit?integer

The maximum number of orders to return.

Range1 <= value <= 250
Default100

Response Body

The orders after the pointer. An empty list means you're up to date.

application/json
  1. response
results?array<>
curl -X GET 'https://api.example.com/v1/admin/stream/orders/' \  --user "$API_KEY:"
{  "results": [    {      "sequence": 1,      "data": {        "id": "738709ef-d555-4720-9e49-05b1c7f14657",        "merchant_id": "b8a1c2d4-1234-4c5d-9e8f-0123456789ab",        "project_id": "c5078bef-f741-4f26-a13f-26e7916bb00c",        "created": "2026-10-12T06:47:00.619883+00:00",        "occurred": "2026-10-12T06:48:00.619883+00:00",        "status": "completed",        "amount": 2995,        "currency": "EUR",        "description": "Acme Coffee order 1042",        "merchant_order_id": "1042",        "flags": [          "is-test"        ],        "transactions": [          {            "id": "979becbd-e91d-4656-802e-ce0bd290f56a",            "amount": 2995,            "status": "completed",            "channel": "ecom",            "credit_debit": "credit",            "payment_method": "credit-card",            "payment_method_brand": "visa",            "payment_method_details": {              "truncated_pan": "411111******1111",              "vault_token": "1386995d-15f3-45e0-a9d3-2f769f672f2c"            },            "settlement_amount": 2995,            "settlement_currency": "EUR",            "occurred": "2026-10-12T06:48:00.619883+00:00",            "events": []          }        ]      }    }  ]}