🇬🇧
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
  • Base URL
  • Key Features
  • Getting Started
  • Example Request
  • Documentation
  • Support
  1. Crypto System

Yativo Crypto Platform API

Welcome to the Yativo Crypto Platform API!

This APIs help Yativo businesses for crypto use cases.

Base URL

The API's base URL for all requests is:

https://crypto-api.yativo.com

Ensure that all endpoints are appended to this base URL. For example, to retrieve all accounts, use:

GET https://crypto-api.yativo.com/api/v1/accounts

Key Features

  • Account Management: Create and manage primary accounts and sub-accounts for users.

  • Wallet Integration: Link wallets to accounts for secure storage and operations.

  • Gas Station: Enable businesses to cover gas fees for blockchain transactions on networks like BEP20, independently of Yativo fees.

  • Customer Management: Add, update, and retrieve customer profiles for seamless integration with your platform.

  • Real-Time Market Prices: Fetch the latest market prices for supported crypto assets.

  • Transaction Handling: Monitor and retrieve transaction histories with detailed statuses.

  • Webhooks: Automate notifications for key events like completed transactions or account changes.


Getting Started

To get started, follow these steps:

1. Authentication

All requests must include a bearer token for authentication. Obtain this token by logging in with your credentials.

  • Endpoint: POST /api/authentication/login

Include the token in the Authorization header for subsequent API requests:

Authorization: Bearer <your-token>

2. KYC Requirements

  • For Business Users: Complete Yativo’s KYC verification to activate your account.

  • For End Users: Ensure all customer accounts undergo KYC compliance before activating wallets or performing transactions.

3. Set Up Your Gas Station

The Gas Station wallet allows you to cover gas fees for blockchain transactions on behalf of your users.

  • Create your Gas Station: POST /api/v1/accounts/gas-station/create

  • Deposit assets like BNB for BEP20 transactions.

4. Start Building

  • Create customer accounts: POST /api/v1/customers

  • Create primary and sub-accounts for users: POST /api/v1/accounts/sub-accounts

  • Fetch live crypto asset prices: GET /api/v1/assets/prices


Example Request

Get Account Balance

Fetch the balance of a specific account.

Request:

GET https://crypto-api.yativo.com/api/v1/accounts/{account_id}/balance  
Authorization: Bearer <your-token>

Response:

{
    "account_id": "acc123",
    "balance": "1500.00",
    "currency": "BNB"
}

Documentation


Support

For questions or assistance, contact us at support@yativo.com.

Yativo — Empowering your fintech journey with scalable, secure, and efficient solutions.

PreviousGet Single Transaction

Last updated 6 months ago

For a detailed explanation of all endpoints, refer to the complete .

Yativo Crypto Platform API Documentation