Update Virtual Account Status
Enable or disable a virtual account.
Enables or disables a virtual account. Disabled accounts cannot receive deposits.
Endpoint
POST /v1/virtual-accounts/statusAuthentication
API key only (JWT not accepted). This route uses the API-key guard exclusively.
Header
Value
Authorization
<api_key>
Request body
Field
Type
Required
Description
accountNumber
string
Yes
Virtual account number
status
string
Yes
New status. Expected values: Enabled or Disabled (these are the literal strings the service compares against: Enabled maps to ACTIVE, anything else to INACTIVE). Note: the DTO does not apply @IsIn validation, so any string is accepted at the validation layer.
Example request
curl -X POST https://ramp-api.ivorypay.io/api/v1/virtual-accounts/status \
-H "Authorization: your_api_key" \
-H "Content-Type: application/json" \
-d '{
"accountNumber": "9900123456",
"status": "Disabled"
}'const response = await fetch("https://ramp-api.ivorypay.io/api/v1/virtual-accounts/status", {
method: "POST",
headers: {
"Authorization": "your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify({
accountNumber: "9900123456",
status: "Disabled",
}),
});
const data = await response.json();
console.log(data);Example response
The data payload echoes the updated VirtualAccount row (same field set as the Create Virtual Account response).
Last updated