Query Virtual Account

Query a specific virtual account by account number.

Retrieves the details and current status of a virtual account from the payment processor.

Endpoint

POST /v1/virtual-accounts/query

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 to query

Example request

cURL

curl -X POST https://ramp-api.ivorypay.io/api/v1/virtual-accounts/query \
  -H "Authorization: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "accountNumber": "9900123456"
  }'

Node.js

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/virtual-accounts/query", {
  method: "POST",
  headers: {
    "Authorization": "your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    accountNumber: "9900123456",
  }),
});

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

Python

import requests

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

print(response.json())

Go

package main

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

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

	req, _ := http.NewRequest("POST", "https://ramp-api.ivorypay.io/api/v1/virtual-accounts/query", 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 queried",
  "data": {
    "accountNumber": "9900123456",
    "accountName": "IvoryPay - User One",
    "bankName": "Providus Bank",
    "currency": "NGN",
    "status": "ACTIVE"
  }
}

The exact response shape is forwarded from the upstream payment processor and may include additional processor-specific fields.