Create a Virtual Account

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.11/virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "type": "bankUs",
  "accountHolder": "customer",
  "source": {
    "asset": "usd",
    "network": "ach"
  },
  "destination": {
    "type": "walletOms",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon"
    }
  },
  "sponsorGas": true,
  "label": "Alice USD deposit account"
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.11/virtual-accounts"

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "type": "bankUs",
    "accountHolder": "customer",
    "source": {
        "asset": "usd",
        "network": "ach"
    },
    "destination": {
        "type": "walletOms",
        "details": {
            "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
            "asset": "usdc",
            "network": "polygon"
        }
    },
    "sponsorGas": True,
    "label": "Alice USD deposit account"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    type: 'bankUs',
    accountHolder: 'customer',
    source: {asset: 'usd', network: 'ach'},
    destination: {
      type: 'walletOms',
      details: {id: 'wlt_5h4jzzpr9xre3bamd9ca7qyghn', asset: 'usdc', network: 'polygon'}
    },
    sponsorGas: true,
    label: 'Alice USD deposit account'
  })
};

fetch('https://sandbox-api.polygon.technology/v0.11/virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'type' => 'bankUs',
    'accountHolder' => 'customer',
    'source' => [
        'asset' => 'usd',
        'network' => 'ach'
    ],
    'destination' => [
        'type' => 'walletOms',
        'details' => [
                'id' => 'wlt_5h4jzzpr9xre3bamd9ca7qyghn',
                'asset' => 'usdc',
                'network' => 'polygon'
        ]
    ],
    'sponsorGas' => true,
    'label' => 'Alice USD deposit account'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.11/virtual-accounts"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"type\": \"bankUs\",\n  \"accountHolder\": \"customer\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"network\": \"ach\"\n  },\n  \"destination\": {\n    \"type\": \"walletOms\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice USD deposit account\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.11/virtual-accounts")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"type\": \"bankUs\",\n  \"accountHolder\": \"customer\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"network\": \"ach\"\n  },\n  \"destination\": {\n    \"type\": \"walletOms\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice USD deposit account\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.11/virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"type\": \"bankUs\",\n  \"accountHolder\": \"customer\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"network\": \"ach\"\n  },\n  \"destination\": {\n    \"type\": \"walletOms\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice USD deposit account\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "va_8rzhjp17c4kdp2n3gg79te9zmw",
  "object": "virtualAccount",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "status": "pending",
  "destination": {
    "party": {
      "relationship": "customer",
      "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "entityType": "individual"
    },
    "type": "walletOms",
    "category": "crypto",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1",
      "custodyType": "custodial"
    }
  },
  "label": "Alice USD deposit account",
  "createdAt": "2026-05-14T10:00:00Z",
  "updatedAt": "2026-05-14T10:00:00Z"
}

{
  "error": "<string>",
  "code": "ereborValidationFailed",
  "details": {
    "provider": "<string>",
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ],
    "providerRequestId": "<string>"
  }
}

POST

virtual-accounts

Create a Virtual Account

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.11/virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "type": "bankUs",
  "accountHolder": "customer",
  "source": {
    "asset": "usd",
    "network": "ach"
  },
  "destination": {
    "type": "walletOms",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon"
    }
  },
  "sponsorGas": true,
  "label": "Alice USD deposit account"
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.11/virtual-accounts"

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "type": "bankUs",
    "accountHolder": "customer",
    "source": {
        "asset": "usd",
        "network": "ach"
    },
    "destination": {
        "type": "walletOms",
        "details": {
            "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
            "asset": "usdc",
            "network": "polygon"
        }
    },
    "sponsorGas": True,
    "label": "Alice USD deposit account"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    type: 'bankUs',
    accountHolder: 'customer',
    source: {asset: 'usd', network: 'ach'},
    destination: {
      type: 'walletOms',
      details: {id: 'wlt_5h4jzzpr9xre3bamd9ca7qyghn', asset: 'usdc', network: 'polygon'}
    },
    sponsorGas: true,
    label: 'Alice USD deposit account'
  })
};

fetch('https://sandbox-api.polygon.technology/v0.11/virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'type' => 'bankUs',
    'accountHolder' => 'customer',
    'source' => [
        'asset' => 'usd',
        'network' => 'ach'
    ],
    'destination' => [
        'type' => 'walletOms',
        'details' => [
                'id' => 'wlt_5h4jzzpr9xre3bamd9ca7qyghn',
                'asset' => 'usdc',
                'network' => 'polygon'
        ]
    ],
    'sponsorGas' => true,
    'label' => 'Alice USD deposit account'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.11/virtual-accounts"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"type\": \"bankUs\",\n  \"accountHolder\": \"customer\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"network\": \"ach\"\n  },\n  \"destination\": {\n    \"type\": \"walletOms\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice USD deposit account\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.11/virtual-accounts")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"type\": \"bankUs\",\n  \"accountHolder\": \"customer\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"network\": \"ach\"\n  },\n  \"destination\": {\n    \"type\": \"walletOms\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice USD deposit account\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.11/virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"type\": \"bankUs\",\n  \"accountHolder\": \"customer\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"network\": \"ach\"\n  },\n  \"destination\": {\n    \"type\": \"walletOms\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice USD deposit account\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "va_8rzhjp17c4kdp2n3gg79te9zmw",
  "object": "virtualAccount",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "status": "pending",
  "destination": {
    "party": {
      "relationship": "customer",
      "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "entityType": "individual"
    },
    "type": "walletOms",
    "category": "crypto",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1",
      "custodyType": "custodial"
    }
  },
  "label": "Alice USD deposit account",
  "createdAt": "2026-05-14T10:00:00Z",
  "updatedAt": "2026-05-14T10:00:00Z"
}

{
  "error": "<string>",
  "code": "ereborValidationFailed",
  "details": {
    "provider": "<string>",
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ],
    "providerRequestId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Headers

Idempotency-Key

string

required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Body

application/json

Create a Virtual Account: the inbound bank rail plus the destination that receives the converted funds.

customerId

string

required

Owning customer (cus_… or legacy public id).

source

object

required

Expected inbound bank rail.

Hide child attributes

source.asset

string

required

Fixed for Alpha: "usd".

source.network

string

required

Fixed for Alpha: "usBank".

destination

US bank account · object

required

V0.10 side-shaped destination: walletOms (OMS wallet) or walletExternal (registered ExternalAccount). The server validates asset/network against the resolved EA.

US bank account
IBAN bank account
Canadian bank account
OMS wallet
External wallet (registered)

Hide child attributes

destination.type

enum<string>

required

Type discriminator.

Available options:

bankUs

destination.details

object

required

Hide child attributes

destination.details.id

string

required

US bank ExternalAccount ID (ext_bankUs_ prefix).

destination.details.asset

enum<string>

required

Canonical asset identifier.

Available options:

usd

destination.details.network

enum<string>

required

Network identifier.

Available options:

ach,

achSameDay,

wire

destination.details.accountHolder

enum<string>

required

Who holds the payout bank account (OMS closed enum). customer is the only valid value.

Available options:

customer

destination.amount

string

Wire-safe decimal string for financial float values (USD amounts, percentages).

accountHolder

string

required

Closed for Alpha: must be "customer" (additive later — bankMexico / more accountHolders land within 6-12 months).

type

string

required

Closed for Alpha: must be "bankUs".

returnDestination

US bank account · object

Optional fiat return destination (v0.11-8): where inbound fiat is sent if the outbound leg can't be completed. Bank arms only in v1 — bankUs / bankIban / bankCanada (network swift, USD); walletFiat and bankCanada with network local (CAD) are rejected with 422 railNotSupported.

US bank account
IBAN bank account
Canadian bank account
Fiat wallet

Hide child attributes

returnDestination.type

enum<string>

required

Type discriminator.

Available options:

bankUs

returnDestination.network

enum<string>

required

Rail to return on.

Available options:

ach,

achSameDay,

wire

returnDestination.id

string

required

US bank ExternalAccount id (ext_ prefix).

When true, OMS absorbs the on-chain gas cost for the destination delivery. Only true is currently supported.

bankMemo

string

Optional wire/ACH memo the customer can include.

label

string

Partner display label.

metadata

object

Free-form key-value pairs stored on the resource and echoed back on reads.

Hide child attributes

metadata.{key}

string

Response

The request has succeeded and a new resource has been created as a result.

A dedicated bank account number issued for a customer. Inbound fiat deposits are automatically converted and delivered to the configured destination, creating a transaction per deposit.

string

Virtual Account ID (va_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

object

enum<string>

Resource type discriminator. Always "virtualAccount".

Available options:

virtualAccount

customerId

string

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

status

enum<string>

Current lifecycle status of the virtual account.

Available options:

pending,

active,

frozen,

closed,

deleted,

failed,

inactiveActionRequired

sourceToDestination

enum<string>

Corridor composite derived from the destination type — fiatAccountToCrypto for a crypto-wallet destination (inbound fiat auto-converts), or fiatAccountToFiatAccount for a bank destination (inbound USD forwarded onward).

Available options:

cryptoToCrypto,

cryptoToCash,

cryptoToFiatAccount,

cashToCrypto,

fiatAccountToCrypto,

fiatAccountToFiatAccount

statusReason

string

Human-readable explanation of the current status.

source

object

Expected inbound rail detail.

Hide child attributes

source.asset

string

required

Fixed for Alpha: "usd".

source.network

string

required

Fixed for Alpha: "usBank".

depositInstructions

object

Null until Erebor provisions the DDA (DEPOSIT_ACCOUNT.OPEN).

Hide child attributes

depositInstructions.bankUs

object[]

Hide child attributes

depositInstructions.bankUs.bankName

string

required

depositInstructions.bankUs.bankAddress

string

required

depositInstructions.bankUs.accountNumber

string

required

depositInstructions.bankUs.routingNumber

string | null

required

US domestic only; null for SWIFT.

depositInstructions.bankUs.accountType

string | null

required

US domestic only; null for SWIFT. Always "checking" when present.

depositInstructions.bankUs.BIC

string | null

required

SWIFT only; null for US domestic.

depositInstructions.bankUs.beneficiary

object

required

Beneficiary on a bank routing block - the entity to which the funds are ultimately credited. For SWIFT this is Erebor (the bank); for domestic rails this is the customer. Response-only, system-synthesised (Erebor entity or customer counterparty). The address is a single formatted display line (spec §BankRoutingBlock), e.g. "6 Acme Way, Bentonville, AR 72712 US".

Hide child attributes

depositInstructions.bankUs.beneficiary.name

string

required

depositInstructions.bankUs.beneficiary.address

string

required

depositInstructions.bankUs.memo

string | null

required

SWIFT only; null for US domestic. OMS-generated: "FFC ".

depositInstructions.bankUs.supportedSources

object[]

Asset/network pairs this routing block accepts deposits for.

Hide child attributes

depositInstructions.bankUs.supportedSources.asset

string

required

depositInstructions.bankUs.supportedSources.network

string

required

destination

OMS wallet · object

V0.10: unified side shape.

Hide child attributes

destination.type

enum<string>

required

Type discriminator.

Available options:

walletOms

destination.category

enum<string>

required

High-level grouping: fiatAccount for bank or card accounts, crypto for wallets.

Available options:

crypto

destination.details

object

required

WalletOms instrument details: an OMS-custodied crypto wallet.

Hide child attributes

destination.details.id

string

Internal OMS wallet (wlt_ prefix; legacy acc_ also accepted on input).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.details.asset

string

Canonical asset identifier.

destination.details.network

string

Network identifier.

destination.details.blockchainAddress

string

On-chain address.

destination.details.custodyType

enum<string>

How the wallet is held: custodial or embedded.

Available options:

custodial,

embedded

destination.details.txHash

string

On-chain transaction hash.

destination.details.blockchainAsset

object

BPN extension: resolved on-chain asset identity (protocol/chainId/tokenId).

Hide child attributes

destination.details.blockchainAsset.protocol

enum<string>

required

Available options:

evm,

svm,

sui

destination.details.blockchainAsset.chainId

string

required

destination.details.blockchainAsset.tokenId

string

required

destination.party

Customer · object

Structured identity of who is on this side.

Customer
Another customer
Registered external account
Unregistered external account

Hide child attributes

destination.party.relationship

enum<string>

required

Relationship discriminator.

Available options:

customer

destination.party.customerId

string

required

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.party.entityType

enum<string>

Available options:

individual,

business

returnDestination

US bank account · object

The configured fiat return destination (v0.11-8) for failed outbound legs; absent/null when none is set (the project return policy applies instead, once T13 wires the waterfall).

US bank account
IBAN bank account
Canadian bank account
Fiat wallet

Hide child attributes

returnDestination.type

enum<string>

required

Type discriminator.

Available options:

bankUs

returnDestination.network

enum<string>

required

Rail to return on.

Available options:

ach,

achSameDay,

wire

returnDestination.id

string

required

US bank ExternalAccount id (ext_ prefix).

Whether OMS absorbs the on-chain gas cost for the destination delivery. Persisted from the create/update request (currently only true is accepted).

bankMemo

string

Wire/ACH memo the customer can include with deposits.

label

string

Partner display label.

metadata

object

Free-form key-value pairs supplied at creation or update.

Hide child attributes

metadata.{key}

string

createdAt

string<date-time>

When the virtual account was created.

updatedAt

string<date-time>

When the virtual account was last updated.

failureReason

enum<string>

Set when status = failed; closed enum identifying the failure category.

Available options:

provisioningTimeout,

systemError,

ereborRejected,

deletePendingTimeout

deletionRequestedAt

string<date-time>

Set when DELETE has been requested but the close webhook has not yet finalized.

deletionRequestedBy

string

Identity (JWT subject claim) of the caller who invoked DELETE.

finalBalance

object

DDA balance snapshot at the moment the VA flipped to deleted.

Hide child attributes

finalBalance.value

string

required

Amount in fiat minor units (e.g. cents).

finalBalance.currency

string

required

ISO 4217 currency code.

finalBalance.display

string

required

Human-readable rendering (e.g. "12.34 USD").

Update a Deposit Address

List all Virtual Accounts

⌘I

Overview

Move money

Routes

External Payment Methods

Platform

Create a Virtual Account

Authorizations

Headers

Body

Response