Retrieve Virtual Account Information

GET /collection-middleware/virtual-account/reference

The Get Virtual Account endpoint is used to retrieve a virtual account reference, which is required for subsequent transactions. A partner would call this endpoint when they need to obtain a virtual account reference for a new transaction. This endpoint returns the virtual account details, including the account number, name, currency, and status.

Query parameters

Name	Type	Description
externalReference	string	Partner reference supplied at creation

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

Field	Type	Description
success	boolean	—
externalReference	string	—
data	object	—
accountNumber	string	—
accountName	string	—
accountCurrency	string	—
accountStatus	string	—
error	object	—
code	string	—
message	string	—

Environment

Request

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

OkHttpClient client = new OkHttpClient();

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

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

Response

200OK

{
  "success": true,
  "externalReference": "string",
  "data": {
    "accountNumber": "string",
    "accountName": "string",
    "accountCurrency": "string",
    "accountStatus": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting started.