Get balance

GET 
/openapi/2026-07/shoplazza-payment/balance

Returns the merchant's current balance summary, including available, pending, rolling reserve, and fixed reserve balances per currency.

Request

Query Parameters

region string

Region of the merchant account (e.g., US, HK). Defaults to the merchant's default region

currency string

Currency of the balance account. Defaults to the merchant's default currency. Must match the specified region

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
list object[]
List of balance items, one entry per currency
Array [
currencystring
Currency code (e.g. USD, EUR)
available_balancestring
Available balance amount
pending_balancestring
Pending (unsettled) balance amount
reserve_balancestring
Rolling reserve balance amount
fixed_reserve_balancestring
Fixed reserve balance amount
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "list": [
      {
        "currency": "string",
        "available_balance": "string",
        "pending_balance": "string",
        "reserve_balance": "string",
        "fixed_reserve_balance": "string"
      }
    ]
  }
}