Skip to main content
Version: 2.0.x

Balance

Request

API URL: /merchant/v2/{GUID}/balance

Note

{GUID} Obtained from the merchant backend (API Docking -> GUID)

✅ Required ⭕ Optional ❌ Not used

HeaderContentDescription
Content-Typetext/plain
X-Transaction-Signature{transaction_signature}Please refer to Transaction Signature
ParamTypeRequiredSignDescription
user_idStringMerchant identification
balance_modeInteger0 = Return total balance(Default)
1 = Return available balance
2 = Return total balance and available balance
timestampIntegerRequest timestamp (10 digits), If the time difference is allowed to be 5 seconds, it will fail.
signStringSignature string. Please refer to Data Signature and Verification

Response

ParamTypeRequiredSignDescription
user_idStringMerchant identification
PHPArrayDisplay channels and balances on them (Please refer to Response Example)
signStringSignature string. Please refer to Data Signature and Verification

Response Example