---
title: "Simulate a deposit to a virtual account"
method: POST
path: "/v2/users/{userId}/virtual-accounts/{accountId}/simulate-deposit"
tags: ["Virtual Account"]
---

# Simulate a deposit to a virtual account

`POST /v2/users/{userId}/virtual-accounts/{accountId}/simulate-deposit`

Simulate a deposit to a virtual account in sandbox environment. This endpoint is only available in sandbox and allows testing deposit flows.

**Note:** This endpoint is only available in sandbox environment.

## Path parameters

- `userId` string, required
- `accountId` string, required

## Request body

- SimulateVirtualAccountDeposit
  - `amount` string, required — Amount to simulate deposit
  - `paymentRail` 'WIRE' | 'ACH', required — Payment rail for the simulated deposit , recommended to use WIRE for faster settlement
  - `requestId` string, required — Unique identifier for the request (recommend using uuid v4)
  - `source` object, required
    - `routingNumber` string, required — Routing number of the source bank account
    - `accountNumber` string, required — Account number of the source bank account
    - `name` string, required — Name on the source bank account
    - `bankName` string, required — Name of the source bank
  - `userId` string — Optional user ID to associate with this deposit
  - `reference` string — Optional reference for this deposit
  - `description` string — Optional description for this deposit

## Response `200`

Successfully triggered sandbox deposit

- SimulateVirtualAccountDeposit
  - `amount` string, required — Amount to simulate deposit
  - `paymentRail` 'WIRE' | 'ACH', required — Payment rail for the simulated deposit , recommended to use WIRE for faster settlement
  - `requestId` string, required — Unique identifier for the request (recommend using uuid v4)
  - `source` object, required
    - `routingNumber` string, required — Routing number of the source bank account
    - `accountNumber` string, required — Account number of the source bank account
    - `name` string, required — Name on the source bank account
    - `bankName` string, required — Name of the source bank
  - `userId` string — Optional user ID to associate with this deposit
  - `reference` string — Optional reference for this deposit
  - `description` string — Optional description for this deposit

## Other responses

- `401` — Unauthorized
- `404` — Resource not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/hifi/apis/hifi-api.md) · [All operations](https://skmtc.net/hifi/apis/hifi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hifi/hifi-api/versions/15a39c342fd1/schema)