API ReferenceGet wallet balance

Get wallet balance

GET/api/v1/wallet/balance

Read the authenticated account's prepaid wallet balance. Poll to monitor funds proactively: because shipment creation is gated on available, POST /api/v1/shipments can start rejecting on insufficient funds the instant available dips below the next quote. held = open holds against in-flight shipments; available = balance - held. Read-only; no Idempotency-Key.

Parameters

No parameters.

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "available": 0,
    "balance": 0,
    "currency": "HKD",
    "held": 0
  }
}

Returned object

Field	Type	Sample
status	number	200
message	string	OK
data	object	{4 keys}