OnLink
API reference

Read one of your orders

Scoped to your own orders: another partner’s order id returns 404, not 403. The shape follows the order’s side. A BUY order carries the payment instructions, our paymentReference, and — once your payment has been matched — the provider’s own references for it: the M-PESA/PesaLink code your customer recognises, plus the bank’s transaction id. A SELL order carries the deposit address and the transaction hash you attached.

GET
/v1/orders/{id}

Authorization

partner-key
X-OnLink-Key<token>

In: header

Path Parameters

id*string

Your order id

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/orders/string"
{  "orderId": "3a7c1f90-8b2d-4e56-9a01-cd23ef456789",  "status": "awaiting_usdt",  "kesAmount": "1281000.00",  "usdtAmount": "10000.000000",  "rate": "128.1000",  "expiresAt": "2026-09-01T09:30:00.000Z",  "depositAddress": "TQiBwkXtUUNygiLdSwdeaZCKagwPsD1a7C",  "chain": "tron",  "sendBefore": "2026-09-01T09:30:00.000Z",  "txHash": "5d6a3c7b1e4f2a908c6d5b4a3928170f6e5d4c3b2a1908f7e6d5c4b3a2918070"}