---
title: "Simulate a transfer into a sandbox virtual account"
method: POST
path: "/api/v1/payment-method/virtual-account/simulate-transfer"
tags: ["Sandbox helpers"]
---

# Simulate a transfer into a sandbox virtual account

`POST /api/v1/payment-method/virtual-account/simulate-transfer`

## Request

- Base URL: `https://sandbox.api.afriex.com`
- URL: `https://sandbox.api.afriex.com/api/v1/payment-method/virtual-account/simulate-transfer`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/payment-method/virtual-account/simulate-transfer/post.ts> (a function with typed inputs; its response is checked against the schema)

Sandbox only; returns 403 in production. Credits a bank transfer into one of your sandbox virtual accounts, the way the account provider's deposit notification would, so balances and your transaction webhook behave as in production. Pass the account number; for an account created with an `amount` (a one-time account), also pass the `reference` it was issued with. The deposit is reported by the transaction webhook.

## Request body

- object
  - `accountNumber` string, required: The virtual account number to pay into.
  - `amount` number, required: The amount transferred.
  - `currency` string, required: The account's currency.
  - `reference` string: The reference a one-time (amount-bound) account was issued with. Not needed for a reusable account.
  - `outcome` 'success' | 'failed': Defaults to `success`.

## Response `202`

Accepted. The reference of the new deposit.

- object
  - `data` object
    - `reference` string

## Other responses

- `400`: Invalid request.
- `403`: Not available in production.
- `404`: No sandbox virtual account with that number for your business.
- `500`: Server error.
- `503`: Temporarily unavailable: an upstream service failed or timed out, or the API is momentarily offline. Retry with backoff and honour the Retry-After header when present.

---

[API](https://skmtc.dev/afriex/apis/afriex-business-api.md) - [All operations](https://skmtc.dev/afriex/apis/afriex-business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/afriex/apis/afriex-business-api/revisions/d94198b6c256?raw)