v1

latestOpenAPI 3.1.02026-07-26500375.1 KB

Fetch Subaccount Balance API

The following endpoint retrieves balance of a single subaccount

get/merchants/subaccount/balance/{id}

Path parameters

idstring required

Unique identifier of the subaccount, which can be taken from the response of Register subaccount API or Fetch Subaccount API

Query parameters

as_ofstring

The specific date for which you wish to retrieve the closing balance. Defaults to current time if not specified.

Please ensure that the value is in RFC3339 format. Example: "2022-03-29T10:00:00.000+07:00"

Response

200

Example response

{
  "data": {
    "subaccounts": [
      {
        "id": "mer_6VFgScbAcL7612",
        "name": "Demo Sub Mercahnt",
        "is_enabled": true,
        "subaccount_ref_id": "reference_demo_001"
      }
    ],
    "total_count": 2
  }
}