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

Field	Type	Description
externalReference required	string	—
accountName required	string	—
currency required	string	—

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 POST "https://api.dev.cslpay.io/collection-middleware/create/virtual-account" \
  -H "Authorization: Bearer <access-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "externalReference": "string",
  "accountName": "string",
  "currency": "<^[A-Za-z]{3}$>"
}'

OkHttpClient client = new OkHttpClient();

String payload = """
    {
      "externalReference": "string",
      "accountName": "string",
      "currency": "<^[A-Za-z]{3}$>"
    }
""";

RequestBody body = RequestBody.create(
        payload, MediaType.get("application/json"));

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/collection-middleware/create/virtual-account")
        .post(body)
        .addHeader("Authorization", "Bearer <access-token>")
        .addHeader("Content-Type", "application/json")
        .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/create/virtual-account", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <access-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "externalReference": "string",
    "accountName": "string",
    "currency": "<^[A-Za-z]{3}$>"
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    "https://api.dev.cslpay.io/collection-middleware/create/virtual-account",
    headers={
        "Authorization": "Bearer <access-token>",
        "Content-Type": "application/json"
    },
    json={
      "externalReference": "string",
      "accountName": "string",
      "currency": "<^[A-Za-z]{3}$>"
    },
)

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.