---
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`

## Request

- Base URL: `https://production.hifibridge.com`
- URL: `https://production.hifibridge.com/v2/users/{userId}/virtual-accounts/{accountId}/simulate-deposit`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hifibridge/apis/hifi-api/docs/v2/users/:userId/virtual-accounts/:accountId/simulate-deposit/post.ts> (a function with typed inputs; its response is checked against the schema)

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.dev/hifibridge/apis/hifi-api.md) - [All operations](https://skmtc.dev/hifibridge/apis/hifi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hifibridge/apis/hifi-api/revisions/74d9e530fbea?raw)