fiatAccountToCrypto) and delivers crypto to the customer’s configured wallet. No developer action is required after the account is provisioned.
Virtual accounts are persistent. OMS keeps them active until they are frozen, closed, or deleted.
Virtual accounts must be enabled for your project: OMS provisions the underlying deposit accounts with a virtual account provider configured during onboarding. To get set up, share your use case below.
Contact us
Tell us about your on-ramp flow and we’ll enable virtual accounts for your project.
How it works
Once a virtual account is provisioned, you display its bank deposit instructions to the customer. When fiat arrives at that account, OMS:- Detects the inbound deposit on the bank rail.
- Creates a transaction with a typed
precursorofvirtualAccount, carrying thevirtualAccountIdand its bank routing block. - Moves the transaction directly to
processing(there is no quote step, because pricing cannot be locked before the funds arrive). - Converts the deposited fiat to crypto and delivers it to the configured wallet.
sourceToDestination: "fiatAccountToCrypto" and follows the standard transaction lifecycle, including webhook events.
Creating a virtual account
Create a virtual account withPOST /virtual-accounts:
The
201 response returns the virtual account with bankDetails: null. OMS provisions the underlying deposit account asynchronously, and the account moves from pending to active once the bank details are ready.
Deposit instructions
ThebankDetails field carries dual-rail bank deposit instructions to display in your UI. It is null until the underlying deposit account is provisioned. Both a domestic block and a SWIFT block are populated so a customer can fund the account from a US bank or from an international bank:
memo references the customer’s provisioned account so the receiving bank credits the correct account.
Third-party deposits
A virtual account is a named account: it carries the onboarded customer’s own legal name, so inbound transfers are addressed to your customer, not to Polygon or your platform. Senders do not need to be registered or identity-matched to the account holder. Any third party can push funds to the account over the supported rails, and each inbound deposit auto-creates its own transaction and fires its own events, so two deposits from two different senders arrive as two records. Every inbound payment is screened (AML and sanctions) before it converts. Each deposit carries the originator details from the payment message: name, account and routing as sent, rail, amount, and reference. Wire and SWIFT payments carry the originator’s name consistently; many ACH payments do not include it, so build reconciliation on your own reference and amount rather than on sender name alone.Listing and retrieving
GET /virtual-accounts lists virtual accounts across every customer in your organization. Both filters are optional: customerId scopes the list to one customer, and status to one lifecycle state. Paginate with limit, startingAfter, and endingBefore; each page returns nextCursor, previousCursor, and hasMore.
GET /virtual-accounts/{virtualAccountId} fetches a single virtual account by ID.
Updating
PATCH /virtual-accounts/{virtualAccountId} accepts destination (re-point to a different walletExternal target), sponsorGas, label, and metadata; any other key in the body is rejected with 400. A PATCH that re-points to walletOms is rejected with 422 destinationWalletOmsNotSupported.
Re-pointing destination to a healthy external account recovers a virtual account from inactiveActionRequired back to active. A re-point on an already active account updates the target without a status transition.
Deleting
DELETE /virtual-accounts/{virtualAccountId} returns 202 and starts an asynchronous close of the underlying deposit account. The response echoes the virtual account with deletionRequestedAt set (deletionRequestedBy identifies the caller); the status stays as-is during the delete-pending window and finalizes to deleted once the underlying account closes. finalBalance snapshots the deposit account balance at the moment the account flips to deleted.
Statuses
Simulating inbound deposits
In sandbox, you can simulate an inbound bank deposit to test your webhook and reconciliation flows without moving real funds. This endpoint is available in non-production environments only.POST /virtual-accounts/{virtualAccountId}/simulate/inbound-transfer with a type-discriminated body. Set type to bankUs (with network set to ach or wire) for US domestic rails, or bankIban (with network set to swift) for international rails. Amounts are decimal strings in whole units:
ach, wire) settle synchronously and return submitted. SWIFT transfers settle asynchronously with the upstream provider and return pending plus a referenceId:
Deposit address vs. virtual account
Both are persistent auto-route configurations. The difference is which side is fiat:Related
- Virtual accounts guide: walkthrough of the inbound flow and webhook handling
- Deposit addresses: the crypto equivalent for on-chain deposits
- External accounts: registering an external wallet as a virtual account destination
- Transaction lifecycle: statuses, sub-statuses, and webhook events for the auto-created transaction