Orders
Get Order Status
Return the compact payment and fulfillment status projection for an order.
Endpoint
GET /api/v1/orders/{orderId}/status
Response
Returns a compact projection of order payment and fulfillment status:
{
"success": true,
"data": {
"orderId": "kr7exampleorder",
"_creationTime": 1234567890123,
"state": "Completed",
"shortReference": "128304",
"paymentGateway": "MomoPay",
"paymentGatewayStatus": "Paid",
"paymentReference": "MP20240331001",
"amount": 12.50,
"currency": "GHS",
"errorMessage": null,
"createdAt": 1234567890123,
"submittedAt": 1234567900000,
"completedAt": 1234567950000
}
}Response fields
| Field | Type | Notes |
|---|---|---|
orderId | orders id | Order identifier |
_creationTime | number | Creation timestamp (unix ms) |
state | string | Pending, Processing, Completed, or Failed |
shortReference | string | User-friendly reference code |
paymentGateway | string | Payment method used |
paymentGatewayStatus | string | Unpaid, Paid, or Refunded |
paymentReference | string | External payment reference |
amount | number | GHS amount |
currency | string | GHS |
errorMessage | string | null | Error reason if failed |
createdAt | number | Creation timestamp |
submittedAt | number | null | Submission timestamp |
completedAt | number | null | Completion timestamp |
Route Variants
These paths are equivalent:
GET /api/v1/orders/{orderId}GET /api/v1/orders/{orderId}/status
Other nested paths return 404
Errors
404- Order not found or belongs to different user403- Insufficient permissions
Sample request
curl -X GET "https://api.netconnectgh.online/api/v1/orders/kr7exampleorder/status" \
-H "X-API-KEY: netconnect_live_your_secret_here" \
-H "Content-Type: application/json"