API Client
Orders

Documentation OpenAPI

Orders / GET /v1/orders

List orders

List orders owned by the authenticated user or organization.

Last updated on

GET
/v1/orders

Authorization

AuthorizationBearer <token>

Preferred customer API authentication. Create a personal or organization key from /my-account?tab=settings, then send Authorization: Bearer <api_key>. Query-string API keys are not supported.

In: header

Query Parameters

limit?integer

Maximum number of items to return. Defaults to 50 when omitted.

Range1 <= value <= 100
offset?integer

Zero-based offset for paginated list requests.

Range0 <= value
sourceSystem?string

Optional client-defined source system used to filter orders created by a specific integration.

Length1 <= length <= 64

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orders"
{  "object": "list",  "data": [    {      "id": "ord_123",      "object": "order",      "status": "queued",      "paymentStatus": "paid",      "serviceId": "prod_123",      "productId": "prod_123",      "target": "@customer_handle",      "quantity": 100,      "amount": 250000,      "currency": "NGN",      "sourceSystem": "customer_api",      "externalOrderId": "client-order-1001",      "createdAt": "2026-05-25T10:00:00.000Z",      "updatedAt": "2026-05-25T10:00:01.000Z"    }  ],  "limit": 50,  "offset": 0}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    },    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    },    "requestId": "string"  }}

Create an order

Create one wallet-funded order with idempotent retry protection.

Retrieve an order

Retrieve one owned order for status checks and reconciliation.

On this page

EndpointAuthenticationRequestResponsesTry It