Skip to main content
interface Account {
  id: string;
  name: string;
  currency: string;
  status: "active" | "suspended";
  created_at: string;
}

interface AccountBalance {
  currency: string;
  available: string;
  on_hold: string;
  total: string;
}

interface SubAccount {
  id: string;
  parent_account_id: string;
  name: string;
  currency: string;
  status: "active" | "suspended";
  created_at: string;
}

interface SubAccountAddress {
  id: string;
  sub_account_id: string;
  address: string;
  network: string;
  created_at: string;
}

interface CreateSubAccountRequest {
  name: string;
  currency: string;
}

interface CreateSubAccountAddressRequest {
  sub_account_id: string;
  network: string;
}

List accounts

GET /accounts
curl -X GET 'https://api.yativo.com/api/accounts' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
{
  "status": "success",
  "data": [
    {
      "id": "acc_01HX9KZMB3F7VNQP8R2WDGT4E5",
      "name": "Main USD Account",
      "currency": "USD",
      "status": "active",
      "created_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "acc_02HX9KZMB3F7VNQP8R2WDGT4E6",
      "name": "EUR Account",
      "currency": "EUR",
      "status": "active",
      "created_at": "2026-02-01T10:00:00Z"
    }
  ]
}

Get account

GET /accounts/{account_id}
account_id
string
required
The account ID.
curl -X GET 'https://api.yativo.com/api/accounts/acc_01HX9KZMB3F7VNQP8R2WDGT4E5' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Get account balance

GET /accounts/{account_id}/balance
curl -X GET 'https://api.yativo.com/api/accounts/acc_01HX9KZMB3F7VNQP8R2WDGT4E5/balance' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
{
  "status": "success",
  "data": {
    "currency": "USD",
    "available": "12450.00",
    "on_hold": "200.00",
    "total": "12650.00"
  }
}

Get account assets

GET /accounts/{account_id}/assets
curl -X GET 'https://api.yativo.com/api/accounts/acc_01HX9KZMB3F7VNQP8R2WDGT4E5/assets' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
{
  "status": "success",
  "data": [
    { "symbol": "USD", "name": "US Dollar", "balance": "12450.00" },
    { "symbol": "EUR", "name": "Euro", "balance": "3200.00" }
  ]
}

Get account transactions

GET /accounts/{account_id}/transactions
curl -X GET 'https://api.yativo.com/api/accounts/acc_01HX9KZMB3F7VNQP8R2WDGT4E5/transactions' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Sub-accounts

Sub-accounts allow you to segment funds within a parent account — useful for isolating balances per product, customer segment, or region.

Create sub-account

POST /accounts/sub-accounts
name
string
required
A descriptive label for the sub-account.
currency
string
required
The currency code (ISO 4217), e.g. "USD", "EUR".
curl -X POST 'https://api.yativo.com/api/accounts/sub-accounts' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Customer Escrow USD",
    "currency": "USD"
  }'
{
  "status": "success",
  "data": {
    "id": "sub_01HX9KZMB3F7VNQP8R2WDGT4E5",
    "parent_account_id": "acc_01HX9KZMB3F7VNQP8R2WDGT4E5",
    "name": "Customer Escrow USD",
    "currency": "USD",
    "status": "active",
    "created_at": "2026-03-26T10:00:00Z"
  }
}

Get sub-account

GET /accounts/{account_id}/sub-accounts/{sub_account_id}
curl -X GET 'https://api.yativo.com/api/accounts/acc_01HX/sub-accounts/sub_01HX' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Get sub-account addresses

GET /accounts/sub-accounts/addresses/{sub_account_id}
curl -X GET 'https://api.yativo.com/api/accounts/sub-accounts/addresses/sub_01HX' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Create sub-account address

POST /accounts/sub-accounts/addresses
sub_account_id
string
required
The sub-account to create an address for.
network
string
required
The network to generate an address on (e.g. "polygon", "ethereum", "solana").
curl -X POST 'https://api.yativo.com/api/accounts/sub-accounts/addresses' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "sub_account_id": "sub_01HX9KZMB3F7VNQP8R2WDGT4E5",
    "network": "polygon"
  }'
{
  "status": "success",
  "data": {
    "id": "addr_01HX9KZMB3F7VNQP8R2WDGT4E5",
    "sub_account_id": "sub_01HX9KZMB3F7VNQP8R2WDGT4E5",
    "address": "0xAbCdEf1234567890AbCdEf1234567890AbCdEf12",
    "network": "polygon",
    "created_at": "2026-03-26T10:05:00Z"
  }
}