API Client
Orders

Documentation OpenAPI

Orders / GET /v1/orders/{orderId}

Retrieve an order

Retrieve one owned order for status checks and reconciliation.

Last updated on

GET
/v1/orders/{orderId}

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

Path Parameters

orderId*string

Identifier returned by a successful order creation request.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orders/string"
{  "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"}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    },    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    },    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    },    "requestId": "string"  }}

List orders

List orders owned by the authenticated user or organization.

Errors

Stable customer API error envelope.

On this page

EndpointAuthenticationRequestResponsesTry It