🇬🇧
Yativo Documentation
Spanish
English
English
  • Yativo
  • Introduction to Yativo
    • Financial Infrastructure
    • About Us
  • Dashboard
  • Business Plans
  • Getting Started with Yativo API
  • Yativo API Glossary
  • API reference
    • Misc.
      • Countries
      • States
      • City
  • Security and Authentication
    • Security
    • Authentication
    • Idempotency in API Requests
  • Environment
    • Environments
  • Notifications
    • Webhook
  • Compliance
    • Verification
      • KYC
      • KYB
      • KYC/KYB Update
      • KYC Status
      • Global Business Search
    • Supported Jurisdiction
    • Supported Countries, Currencies and Payment Method
  • User Management
    • Customer
      • Get Customers
      • Retrieve customer
      • Add Customer
  • Payments
    • Currencies
    • Crypto Wallets
      • Generate Wallet Address
      • Fetch Wallet Address
      • Crypto Deposit History
      • Single crypto deposit history
    • Payout
      • Payout
      • Get Payouts
      • Get Payout
      • Beneficiaries
        • Get Beneficiaries
        • Add Beneficiary Payment Details
        • Update Beneficiary
        • Archive Beneficiary
        • Add Beneficiary
    • Payin
    • Virtual Cards
      • Supported Currency, Country
      • Create card
      • Fetch card
      • Top up card
      • Get Transactions
      • Freeze and Unfreeze Card
    • Virtual Accounts
      • Create VIrtual Accounts
        • USD Virtual Account
        • Mexico Virtual Account
        • Brazil PIX QR
      • Virtual Account Management
      • Transaction History
  • Foreign Exchange
    • Exchange Rate
      • Request Quote
  • Transactions
    • Transaction Summary
    • Get Single Transaction
  • Crypto System
    • Yativo Crypto Platform API
Powered by GitBook
On this page
  1. Crypto System

Accounts

Overview

Accounts are central to how Yativo operates. An account represents a primary crypto wallet for a user or business. Sub-accounts allow for finer-grained wallet management and delegation.

Use Case

  • For Businesses: Use accounts to manage company wallets and allocate sub-accounts to individual customers.

  • For End Users: Provide wallet functionality for storing, sending, and receiving crypto.

Endpoints

Get All Accounts

  • URL: GET /api/v1/accounts

  • Description: Fetches all accounts associated with the authenticated user.

  • Implementation Context:

    • Use to display an account dashboard with wallet balances for an admin or a customer.

  • Response Example:

  • [
        {
            "account_id": "acc123",
            "name": "Business Wallet",
            "balance": "5000.00",
            "currency": "USDT"
        }
    ]

Create Sub-Account

  • URL: POST /api/v1/accounts/sub-accounts

  • Description: Creates a sub-account under a parent account.

  • Implementation Context:

    • Ideal for creating wallets for individual customers under a business umbrella.

    • Sub-accounts can be used to segregate funds for specific users or purposes.

  • Request Example:

  • {
        "name": "Customer Wallet",
        "account_id": "acc123",
        "customer_id": "cus456"
    }
  • Response Example:

{
    "status": "success",
    "sub_account_id": "sub123",
    "message": "Sub-account created successfully."
}

Last updated 5 months ago