Partner API

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 tells you where your KES debit stands. A SELL order carries the deposit address and the transaction hash you attached.

get/v1/orders/{id}

Request

  • Base URL
    https://sandbox.onlink.africa
  • Auth
    API key in header X-OnLink-Key

Path parameters

idstring required

Your order id

Response

Your order. The shape follows its side — a sell order matches OrderDetailResponseDto, a buy order BuyOrderResponseDto. Branch on the presence of depositAddress versus kesDebit, or keep the side you created it with.

OR

Example response

{
  "orderId": "3a7c1f90-8b2d-4e56-9a01-cd23ef456789",
  "status": "awaiting_usdt",
  "kesAmount": "1281000.00",
  "usdtAmount": "10000.000000",
  "rate": "128.1000",
  "kesTotalAmount": "1268180.00",
  "fee": {
    "kesAmount": "12820.00",
    "currency": "KES",
    "percentBps": 100,
    "flatKesAmount": "10.00"
  },
  "expiresAt": "2026-09-01T09:30:00.000Z",
  "depositAddress": "T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb",
  "chain": "tron",
  "sendBefore": "2026-09-01T09:30:00.000Z",
  "txHash": "5d6a3c7b1e4f2a908c6d5b4a3928170f6e5d4c3b2a1908f7e6d5c4b3a2918070"
}

Changes

No recorded changes to this operation across all 1 revision of this API.