Skip to main content
GET
/
payout
/
rails
/
customers
/
{customer_id}
/
virtual-accounts
Get active virtual accounts
curl --request GET \
  --url http://localhost:4000/v1/payout/rails/customers/{customer_id}/virtual-accounts \
  --header 'Authorization: <api-key>'
[
  {
    "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>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Use this format: ApiKey <your_api_key>

Path Parameters

​
customer_id
string
required

Response

Active virtual accounts retrieved successfully

​
id
string
required
Example:

"e3b0c442-98fc-1c14-b39f-92d1282e8b7a"

​
status
enum<string>
required
Available options:
activated,
deactivated
Example:

"activated"

​
developer_fee_percent
string
required
Example:

"0.1"

​
customer_id
string
required
Example:

"e3b0c442-98fc-1c14-b39f-92d1282e8b7a"

​
created_at
string
required
Example:

"2024-01-01T00:00:00Z"

​
source_deposit_instructions
object
required
​
destination
object
required