Query Orders

Enables retail agent POS terminals to list pending cash-in and cash-out requests initiated by customers.

Request Headers

HeaderTypeStatusDescription
AuthorizationstringRequiredBearer vxz_tok_* (OAuth 2.0 Scoped Bearer Token)
GET/v1/agent/ordersLive & Sandbox

Body Parameters (JSON)

ParameterTypeStatusDescription
agentCodestringRequiredAgent shortcode (e.g. 640192)
statusstringConditionalFilter by PENDING, PAID, COMPLETED
limitnumberConditionalMax results per page (default 20)

Request Code Snippets (cURL, Node, Python, PHP, Go)

Request Example
curl -X GET "https://developer.vixzz.com/v1/agent/orders?agentCode=AGT_NBO_9482&status=PENDING" \
  -H "Authorization: Bearer vxz_tok_c2b_8f9k3m9s2a1l"

JSON Return Response Body (200 OK)

Response
{
  "agentCode": "AGT_NBO_9482",
  "pendingOrders": [
    {
      "orderId": "AGT_ORD_55819",
      "orderType": "CASH_IN",
      "customerAccount": "3810482910482",
      "amount": 15000,
      "currency": "KES",
      "commissionEarned": 120,
      "createdAt": "2026-09-07T02:30:00Z"
    }
  ]
}