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 | A unique reference provided by the client to identify the virtual account. |
| accountName required | string | The name of the account holder associated with the virtual account. |
| currency required | string | The three-letter ISO code representing the currency of the virtual account. |
Response 200
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the virtual account creation was successful |
| externalReference | string | A unique reference provided by the client for the virtual account |
| data | object | Contains the details of the virtual account |
| accountNumber | string | The account number of the virtual account |
| accountName | string | The name associated with the virtual account |
| accountCurrency | string | The currency associated with the virtual account |
| accountStatus | string | The current status of the virtual account |
| error | object | Contains error details if the virtual account creation failed |
| code | string | The error code if the virtual account creation failed |
| message | string | The error message if the virtual account creation failed |