Retrieve Virtual Account Balance

GET /collection-middleware/virtual-account/{accountNumber}

The Retrieve Virtual Account Balance endpoint retrieves the current balance of a specified virtual account, allowing partners to obtain the available funds in a particular account. This endpoint would be called when a partner needs to verify the balance of a virtual account, typically as part of a payment processing workflow. The response includes details such as the account entity ID, type, currency, and available balance.

Path parameters

Name	Type	Description
accountNumberrequired	string	—

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

Field	Type	Description
entityId	string	—
entityType	string	—
currencyCode	string	—
availableBalance	number	—

Environment

Request

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

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/collection-middleware/virtual-account/{accountNumber}")
        .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/{accountNumber}", {
  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/{accountNumber}",
    headers={
        "Authorization": "Bearer <access-token>"
    },
)

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

Response

200OK

{
  "entityId": "string",
  "entityType": "string",
  "currencyCode": "string",
  "availableBalance": 0
}

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.