Get order by ID

GET

/orders/:orderId

GET

/orders/:orderId

$ curl https://public-api.alphax.com/orders/orderId \
>      -H "X-API-Key: <apiKey>"

1 {
2   "order": {
3     "id": "01jc0tpy0zjb0pvfh2jcej8yd6",
4     "reference": "ORDER-12345",
5     "description": "Payment for Order #12345",
6     "currency": "USD",
7     "paidNotificationUrl": "https://your-backend-app.com/payment-notification/ORDER-12345",
8     "dueNotificationUrl": "string",
9     "paymentLink": "https://pay.demo.alphax.asia/01k5dcgey2my8jptnmfpdft0xx",
10     "dueAt": "2026-05-05T22:00:00.00Z",
11     "paidAt": "2026-05-05T22:00:00.00Z",
12     "createdAt": "2026-05-05T22:00:00.00Z",
13     "updatedAt": "2026-05-05T22:00:00.00Z",
14     "lineItems": [
15       {
16         "id": "01k5dcgey2my8jptnmfpdft023",
17         "name": "T-Shirt",
18         "quantity": 2,
19         "unitPrice": 10.99
20       }
21     ]
22   }
23 }

Get order by its ID

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

orderIdstringRequired

Response

Details of the requested order

orderobject

Errors

404

Not Found Error