Get Virtual Account Balances By Merchant ID

GET /collection-middleware/virtual-account/merchant/{merchantId}

The Get Virtual Account Balances By Merchant ID endpoint retrieves a list of virtual account balances associated with a specified merchant ID. A partner would call this endpoint to obtain the current balances for a merchant's virtual accounts. This endpoint returns a list of virtual account balances in the merchant's currency.

Path parameters

merchantIdrequired string

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

An array of objects. Each item has these fields:

accountNumber string

The unique identifier for the merchant's virtual account.
accountName string

The name of the virtual account holder.
currencyCode string

The ISO 4217 currency code for the virtual account.
availableBalance number

The current available balance of the virtual account.
bankCode string

The bank code associated with the virtual account.
bankname string

The name of the bank associated with the virtual account.

Environment

Request

curl -X GET "https://api.dev.cslpay.io/collection-middleware/virtual-account/merchant/{merchantId}" \
  -H "Authorization: Bearer <access-token>"

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/collection-middleware/virtual-account/merchant/{merchantId}")
        .get()
        .addHeader("Authorization", "Bearer <access-token>")
        .build();

try (Response response = client.newCall(request).execute()) {
    if (!response.isSuccessful()) {
        throw new IOException("Unexpected status " + response.code());
    }
    System.out.println(response.body().string());
}

const response = await fetch("https://api.dev.cslpay.io/collection-middleware/virtual-account/merchant/{merchantId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>"
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api.dev.cslpay.io/collection-middleware/virtual-account/merchant/{merchantId}",
    headers={
        "Authorization": "Bearer <access-token>"
    },
)

response.raise_for_status()
print(response.json())

Response

200OK

[
  {
    "accountNumber": "string",
    "accountName": "string",
    "currencyCode": "string",
    "availableBalance": 0,
    "bankCode": "string",
    "bankName": "string"
  }
]

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.

Try it

GET /collection-middleware/virtual-account/merchant/{merchantId}

Requests go to your test environment only. Nothing here reaches production, and your token is forwarded once and never stored.

Environment Request URL

GET

Authorization

Sent with this request only and never stored. Use a test credential — if a proxy in front of this site blocks POST, the request is retried as an encoded URL, which edge logs can capture. Get one from Getting Started.

Path Parameters

merchantId required

Response

Response headers