Skip to main content
POST
Simulate an Inbound Transfer
This endpoint is a crucial tool for testing your integration in our sandbox environment 🧪. It allows you to simulate an incoming bank transfer to a specific virtual account, triggering any associated webhooks and updating the account’s balance.
This endpoint is available only in the sandbox environment and will not work in production. It is designed exclusively for testing purposes.

Endpoint

Use this endpoint to simulate a credit transaction to one of your virtual accounts. POST /v1/virtual-account/simulate/transfer

Request Body

The request body must include the amount and the unique reference of the virtual account you wish to fund.

Request Example

Here is an example of how to call the endpoint using cURL.
copy

Authorizations

x-api-key
string
header
required

Body

application/json

Details of the simulated transfer.

amount
integer
required

The amount to transfer in the lowest currency unit (e.g., cents for USD).

Example:

10000

reference
string
required

Reference number used in the virtual account creation.

Example:

"TXN1234567"

Response

Transfer simulation successful.

status
string
Example:

"success"

message
string
Example:

"Virtual account funded successfully."