Virtual Account

Simulate a deposit to a virtual account

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.

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

Request

Base URL
https://production.hifibridge.com
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.

userIdstring required

ID of the user

accountIdstring required

ID of the virtual account

amountstring required

Amount to simulate deposit

paymentRail'WIRE' | 'ACH' required

Payment rail for the simulated deposit , recommended to use WIRE for faster settlement

requestIdstring required

Unique identifier for the request (recommend using uuid v4)

userIdstring

Optional user ID to associate with this deposit

referencestring

Optional reference for this deposit

descriptionstring

Optional description for this deposit

Successfully triggered sandbox deposit