CSL Pay Developers
Home / Reference / Virtual Account

Create a Virtual Account

POST /collection-middleware/create/virtual-account

A partner would call this endpoint when they need to create a new virtual account for a specific, providing the external reference, account name, and currency. The endpoint returns the created virtual account details, including the account number, status, and any errors encountered during the process.

Request body

  • externalReferencerequired string
    A unique reference provided by the merchant for the virtual account.
  • accountNamerequired string
    The name of the account holder associated with the virtual account.
  • currencyrequired string
    The three-letter ISO 4217 code representing the currency of the virtual account.

Response 200

  • success boolean
    Indicates whether the request was successful
  • externalReference string
    A unique reference provided by the client for the virtual account
  • 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
    • accountCurrency string
      The currency 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
    • accountStatus string
      The status of the virtual account
  • error object2 fields
    Contains error details if the request was unsuccessful
    • code string
      The error code if the request was unsuccessful
    • message string
      A description of the error if the request was unsuccessful