Simulate a transfer to a virtual account

The virtual accounts you generate using your test API keys can not be funded in real life. In other for you to understand the shape of the data we send to your webhook URL for every payment received, we have provided an endpoint to simulate a transfer to a test virtual account.

POST https://api.ivorypay.io/v1/virtual-accounts/transfer-simulation

Request Body

NameTypeDescription

amount*

Number

Amount to be transferred to the account

accountNumber*

String

A valid virtual account number

{
    "status": "success",
    "message": "Transfer simulation was successfully",
    "data": {
        "accountNumber": "6353226122",
        "amount": 1500
    }
}

Below is a sample of the request body we send to your webhook URL.

{
  "event": "virtualAccountTransfer.success",
  "data": {
    "accountNumber": "6353226122",
    "principalAmount": 1500,
    "settledAmount": 1499.7,
    "fee": 0.3,
    "remarks": "Payment from Stephen Nwakasi / 2023-09-13T10:53:24.049Z",
    "currency": "NGN",
    "senderName": "Stephen Nwakasi",
    "customerReference": "77iugugiuf87t98ytg0gh809",
    "environment": "TEST",
    "paymentReference": "D4unr9HgoAsObLC8xNva4hBPFyuHKTP0"
  }
}

Last updated