CSL Pay Developers
Home / Reference / Virtual Account

Get Virtual Account Details

GET /collection-middleware/virtual-account/reference

The Get Virtual Account Details endpoint is used to retrieve the details of a virtual account, such as its account number, name, currency, and status. A partner would call this endpoint to retrieve the current state of a virtual account, typically after creating or updating the account. This endpoint returns the virtual account details in a JSON response.

Query parameters

  • externalReference string
    Partner reference supplied at creation

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

  • success boolean
    Indicates whether the request was successful
  • externalReference string
    A unique reference provided by the external system
  • data object6 fields
    Contains the virtual account details
    • accountNumber string
      The account number associated with the virtual account
    • accountName string
      The name associated with the virtual account
    • bankCode string
      The unique code assigned to a bank
    • bankName string
      The name of the bank associated with the virtual account reference.
    • accountCurrency string
      The currency associated with the virtual account
    • accountStatus string
      The current status of the virtual account
  • error object2 fields
    Contains error details if the request failed
    • code string
      A unique code identifying the error
    • message string
      A description of the error that occurred