Skip to main content
POST
/
payout
/
rails
/
virtual-accounts
Create virtual account
curl --request POST \
  --url http://localhost:4000/v1/payout/rails/virtual-accounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_currency": "mxn",
  "liquidation_address_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "developer_fee_percent": "0.5"
}
'
{
  "success": true,
  "message": "<string>",
  "statusCode": 123,
  "timestamp": "<string>",
  "data": {
    "id": "e3b0c442-98fc-1c14-b39f-92d1282e8b7a",
    "status": "activated",
    "developer_fee_percent": "0.1",
    "customer_id": "e3b0c442-98fc-1c14-b39f-92d1282e8b7a",
    "created_at": "2024-01-01T00:00:00Z",
    "source_deposit_instructions": {
      "clabe": "012345678901234567",
      "bank_account_number": "1234567890",
      "bank_routing_number": "123456789",
      "bank_beneficiary_name": "John Doe",
      "bank_beneficiary_address": "123 Main St",
      "iban": "GB82WEST12345698765432",
      "bic": "ABCDGB2L",
      "account_number": "12345678",
      "sort_code": "12-34-56",
      "br_code": "12345678",
      "account_holder_name": "John Doe",
      "bank_name": "Bank of Example",
      "bank_address": "123 Bank St",
      "payment_rails": [
        "spei",
        "wire"
      ]
    },
    "destination": {
      "currency": "usdc",
      "payment_rail": "avalanche_c_chain",
      "address": "0xE84B9045c4735241A71e5c6976695e59A5A7758c",
      "blockchain_memo": "<string>",
      "bridge_wallet_id": "<string>",
      "prefunded_account_id": "<string>"
    }
  },
  "path": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use this format: ApiKey <your_api_key>

Body

application/json
​
source_currency
enum<string>
required

Fiat currency for deposits into this virtual account

Available options:
usd,
eur,
mxn,
brl,
gbp
Example:

"mxn"

​
liquidation_address_id
string

UUID of a liquidation address to use as the destination. If omitted, auto-resolves from the integrator's most recent liquidation address.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
developer_fee_percent
string

Developer fee percentage as a decimal string (e.g. "0.5" for 0.5%)

Example:

"0.5"

Response

​
success
boolean
required
​
message
string
required
​
statusCode
number
required
​
timestamp
string
required
​
data
object
​
path
string