OpenPoly logo
Wallet Adapter

Balance

Balance lookup contract for the operator wallet adapter.

Balance

Return current operator-owned wallet balance for one user.

Path

GET /balance

Query params

ParameterTypeRequirementNotes
external_user_idstringRequiredStable operator-side user ID.
currency_codestringRequiredExpected wallet currency. Current REST v1 value: IDR.

Example

GET /balance?external_user_id=operator-user-123&currency_code=IDR

Response

{
  "external_user_id": "operator-user-123",
  "currency_code": "IDR",
  "balance_minor": 150000,
  "remote_reference": "wallet-lookup-123"
}
FieldTypeRequirementOpenPoly behavior
balance_minorintegerRequiredMust be numeric and finite. Missing, non-numeric, or non-finite values produce REST_V1_INVALID_BALANCE_RESPONSE. This is the only response field required by the parser.
external_user_idstringOptionalFalls back to the requested ID when omitted. Connection tests reject a mismatched non-empty value.
currency_codestringOptional echoThe current parser uses the requested operator currency.
remote_referencestringOptionalPreserved for observability when non-empty.

Rules

  • return integer balance_minor; do not send major-unit decimals
  • currency must match operator integration currency
  • no floating values
  • signing header is not sent for this GET request
Copyright © 2026