Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Virtual Accounts

Create a Virtual Account

Create a Virtual Account or Virtual IBAN for the specified customer

post/customers/{customerID}/virtual_accounts

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

Headers

Idempotency-Keystring required

Request body

developer_fee_percentstring number

The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.

Example request

{
  "developer_fee_percent": "0.1",
  "fee_config": {
    "source": {
      "fee_percent": "1.5",
      "fee_amount": "10.00",
      "minimum_fee": "1.00",
      "maximum_fee": "1000.00"
    }
  },
  "source": {
    "currency": "usd"
  },
  "destination": {
    "currency": "usdc",
    "payment_rail": "polygon",
    "address": "0xdeadbeef"
  },
  "travel_rule_data": {
    "originator": {
      "name": "Jane Smith",
      "address": {
        "street_line_1": "123 Market St",
        "street_line_2": null,
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "USA"
      },
      "identifying_information": {
        "type": "national_id",
        "number": "1234567890",
        "issuing_country": "USA"
      },
      "birth_date": "2000-01-31",
      "place_of_birth": {
        "city": "San Francisco",
        "country": "USA"
      },
      "wallet_type": "self_custodied",
      "wallet_attested_ownership_at": "2026-04-01T12:00:00Z"
    },
    "beneficiary": {
      "is_self": true,
      "wallet_type": "external"
    }
  }
}

Response

Virtual Account object created

idstring

A UUID that uniquely identifies a resource

status'activated' | 'deactivated'

The activation status of the Virtual Account

developer_fee_percentstring number

The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.

customer_idstring

A UUID that uniquely identifies a resource

created_atstring date-time

Time of creation of the virtual account

Example response

{
  "developer_fee_percent": "0.1",
  "fee_config": {
    "source": {
      "default": {
        "fee_percent": "0.5",
        "minimum_fee": "1.00"
      },
      "wire": {
        "fee_amount": "10.00",
        "fee_percent": "1.0"
      }
    }
  },
  "source_deposit_instructions": {
    "currency": "usd",
    "payment_rails": [
      "ach_push",
      "fednow",
      "wire"
    ],
    "bank_name": "Lead Bank",
    "bank_address": "1801 Main St., Kansas City, MO 64108",
    "bank_beneficiary_name": "Customer Name",
    "bank_beneficiary_address": "1234 Main St., Kansas City, MO 64108",
    "bank_account_number": "123456789",
    "bank_routing_number": "87654321"
  },
  "destination": {
    "currency": "usdc",
    "payment_rail": "polygon",
    "address": "0xdeadbeef"
  }
}