Simulate a customer bank transfer (test mode only)
simulate_transferSimulate a customer bank transfer into a test virtual account to verify payment success, webhook events, and rejection rules in sandbox without moving live funds.
Instructions
Simulate a customer bank transfer (test mode only).
Test mode only (403 test_mode_only with a live key). Simulate a transfer into one of your test virtual accounts, as a customer would make it.
The transfer then flows through the same pipeline as live money: the payment moves to succeeded and webhooks are sent. A wrong amount into an exact-amount account is refused (400 simulation_rejected), as a real transfer would be. An account that is not active (for example a one-time account that already received its payment) is refused before anything is sent (409 virtual_account_not_active). A 202 only means the simulation was accepted; watch the payment or its events for the outcome.
Test mode only: needs an sk_test_ key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Amount in kobo | |
| sender_name | No | Name of the simulated sender | |
| account_number | Yes | Your virtual account number that should receive the transfer | |
| sender_account_number | No | Account number of the simulated sender. Refunds go back to the sender, so a test value here (see the sandbox test values) lets you test refund outcomes. |