CSL Pay Developers
Home / Reference / Virtual Account

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

  • accountNumberrequired string

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

  • accountNumber string
    The unique identifier for the virtual account.
  • accountName string
    The name associated with the virtual account.
  • currencyCode string
    The ISO 4217 code for the currency associated with the virtual account.
  • availableBalance number
    The current balance available for transactions on the virtual account.
  • bankName string
    The name of the bank associated with the virtual account.
  • bankCode string
    The unique identifier for the bank associated with the virtual account.