Delete Virtual Account

Close and delete a virtual account.

Closes a virtual account so it can no longer receive deposits.

This is a soft delete. The local VirtualAccount row is not removed — its status is flipped to INACTIVE. The upstream payment processor is also instructed to delete the account, so once disabled the same virtual account number should not be reused.

Endpoint

DELETE /v1/virtual-accounts/:accountNumber

Authentication

API key only (JWT not accepted). This route uses the API-key guard exclusively.

Header	Value
Authorization	<api_key>

Path parameters

Parameter	Type	Description
accountNumber	string	Virtual account number

Example request

cURL

curl -X DELETE https://ramp-api.ivorypay.io/api/v1/virtual-accounts/9900123456 \
  -H "Authorization: your_api_key"

Node.js

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/virtual-accounts/9900123456", {
  method: "DELETE",
  headers: {
    "Authorization": "your_api_key",
  },
});

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

Python

import requests

response = requests.delete(
    "https://ramp-api.ivorypay.io/api/v1/virtual-accounts/9900123456",
    headers={
        "Authorization": "your_api_key",
    },
)

print(response.json())

Go

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://ramp-api.ivorypay.io/api/v1/virtual-accounts/9900123456", nil)
	req.Header.Set("Authorization", "your_api_key")

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

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

Example response

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

The data payload echoes the (now INACTIVE) VirtualAccount row.