Simulate a transfer (sandbox only)
Decides how a transfer ends, so that you can test your webhook handler and fulfilment without moving money. It exists on the sandbox only. On live the call is rejected with HTTP 403, which you should prove during your go-live checks.
Choose a scenario:
scenario | What it simulates |
|---|---|
success | The customer sent the right amount and the transfer landed. |
failed | The transfer failed. |
abandoned | The customer never paid and left the session. |
When the GTBank sandbox is the active transfer processor, success creates a sandbox virtual account if the payment has none, funds it, and returns awaiting_transfer with the account details. The payment then completes through the same webhook path as production, which makes it a faithful test of your handler. In every other case the payment is moved straight to the chosen terminal status and the matching webhook (payment.completed or payment.failed) is emitted.
The payment must still be pending or processing. Simulating a payment that has already finished is rejected with 400.
Authorizations
The accessCode returned by initialise. Scoped to one payment and valid for 60 minutes.
Safe to give to the customer's browser.
Body
How the transfer should end. success simulates a landed transfer, failed a failed transfer, and abandoned a customer who never paid.
success, failed, abandoned