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/status

Authentication

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

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"
  }'

Node.js

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);

Python

import requests

response = requests.post(
    "https://ramp-api.ivorypay.io/api/v1/virtual-accounts/status",
    headers={
        "Authorization": "your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "accountNumber": "9900123456",
        "status": "Disabled",
    },
)

print(response.json())

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {
	body, _ := json.Marshal(map[string]string{
		"accountNumber": "9900123456",
		"status":        "Disabled",
	})

	req, _ := http.NewRequest("POST", "https://ramp-api.ivorypay.io/api/v1/virtual-accounts/status", bytes.NewBuffer(body))
	req.Header.Set("Authorization", "your_api_key")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	respBody, _ := io.ReadAll(resp.Body)
	fmt.Println(string(respBody))
}

Example response

{
  "success": true,
  "message": "Virtual account status updated",
  "data": {
    "id": "9b1a3e6f-7c2d-4e5a-8f12-1234567890ab",
    "accountNumber": "9900123456",
    "status": "INACTIVE"
  }
}

The data payload echoes the updated VirtualAccount row (same field set as the Create Virtual Account response).