Mark Paid

Allows authorized physical agent operators to finalize in-person cash transactions. The agent verifies the physical currency directly at the counter and marks the order as paid using their agent credentials.

POST/v1/agent/orders/mark-paidLive & Sandbox

Request Headers

HeaderTypeStatusDescription
AuthorizationstringRequiredBearer vxz_tok_* (OAuth 2.0 Scoped Bearer Token)
Content-TypestringRequiredapplication/json
Idempotency-KeystringRecommendedUnique key for this operation, 8–80 characters. Send it to make retries safe: repeating the same key returns the original result instead of performing the operation twice. Without it the API derives a key from the request body and replays the original result for a few minutes, so an accidental double submit is still ignored.

Body Parameters (JSON)

ParameterTypeStatusDescription
agentCodestringRequiredYour registered physical agent terminal code (e.g. AGT_NBO_9482).
orderIdstringRequiredAgent order identifier (e.g. AGT_ORD_55819).
collectedCashAmountnumberRequiredPhysical cash amount verified by the agent operator at counter.
collectedCashCurrencystringRequired3-letter ISO currency code (e.g. KES).
notestringOptionalAudit observation recorded by the agent operator.

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

Request Example
curl -X POST https://developer.vixzz.com/v1/agent/orders/mark-paid \
  -H "Authorization: Bearer vxz_tok_c2b_8f9k3m9s2a1l" \
  -H "Content-Type: application/json" \
  -d '{
    "agentCode": "AGT_NBO_9482",
    "orderId": "AGT_ORD_55819",
    "collectedCashAmount": 15000,
    "collectedCashCurrency": "KES",
    "note": "Physical cash verified and received at counter"
  }'

JSON Return Response Body (200 OK)

Response
{
  "success": true,
  "orderId": "AGT_ORD_55819",
  "status": "COMPLETED",
  "orderType": "CASH_IN",
  "customerAccount": "3810482910482",
  "cashReceived": 15000,
  "commissionEarned": 120,
  "agentWalletBalanceAfter": 850000,
  "completedAt": "2026-09-07T02:30:00.135Z",
}