crate::connectivity::fiat::controller::openapi::virtual_accounts

Create a USD virtual account. Repeat the body external_id with the same account and asset, and the account's current nickname, to retrieve the same account. Unconfirmed requests may be retried within the bank's 72-hour retry window. A PENDING response has no receiving instructions; retrieve the account to check progress.

Changed on
post/v1/accounts/{account_id}/virtual-accounts

Request

Path parameters

account_idstring required

Account ID (BZ-/IN-) or legacy customer UUID

Request body

external_idstring required

Partner-supplied external_id request value (UUID) used to make a create request idempotent. Validated at the API boundary and stored on the resource as an external identifier.

asset'USD' required
nicknamestring required

Customer nickname, unique within the customer. Must not be blank.

Example request

{
  "external_id": "550e8400-e29b-41d4-a716-446655440000",
  "nickname": "Payroll"
}

Response

Virtual account creation result or an existing account

virtual_account_idstring required

Stable virtual account identifier.

asset'USD' | 'EUR' | 'CNY' | 'HKD' | 'MXN' | 'BRL' | 'GBP' | 'AED' | 'INR' | 'PHP' | 'SGD' | 'JPY' required
nicknamestring required

Customer-provided nickname; empty when unset.

external_idstring nullable

Customer-provided UUID used when creating an additional virtual account.

is_defaultboolean required

True for default accounts provided by 1Money; false for additional accounts.

status'PENDING' | 'ACTIVE' | 'DEACTIVE' | 'FAILED' required
created_atstring required
last_modified_atstring required

Example response

{
  "virtual_account_id": "VA-7K3M-9X2R",
  "fee": {
    "value": "1.00",
    "asset": "USD"
  },
  "created_at": "2025-08-21T07:56:57.981Z",
  "last_modified_at": "2025-08-21T07:56:57.981Z",
  "networks": [
    {
      "network": "US_FEDWIRE",
      "account_holder": {
        "address": {
          "full_address": "490 2nd St Suite 300, San Francisco, CA 94107",
          "country_code": "USA",
          "address_line1": "490 2nd St",
          "address_line2": "Suite 300",
          "city": "San Francisco",
          "region": "CA",
          "postal_code": "94107"
        }
      }
    }
  ]
}

Changes