Ceffu OpenAPI Documentation Platform
  • ChangeLog
  • Getting Started
    • Welcome to Ceffu OpenAPI
    • Introduction
    • General Info
    • Data Objects
    • Webhook Introduction
    • Use Case
    • Frequently Asked Questions
    • Error Codes
  • System Endpoints
  • Wallet Endpoints
  • Sub-Wallet Endpoints
  • MirrorX Endpoints
  • Webhook
  • Archive
logoPowered by Apifox
  1. Getting Started

Use Case

An use case on B2B2C scenario

User Activity Flow


Major API functions in Ceffu OpenAPI

  • Wallet Creation
    Ceffu institutional client (“Client”) can create Qualified Wallet or Prime Wallet through OpenAPIs
    API for creating a wallet

  • User Account Opening
    Client can utilize Ceffu sub wallet feature to serve their own users. First create a Prime Wallet and after that create sub wallets under the corresponding wallet. Each sub wallet has its own dedicated deposit address.
    Note that sub wallet assets will be transfered to parent Prime Wallet if auto-collection is enabled.
    API for creating a sub wallet

  • Deposit Flow
    Client can get the addresses of wallets and sub wallets, and start fund deposit into wallets.
    API for getting address of a wallet
    API for getting address of a sub wallet

    Client can query the deposit history of a wallet or the detail of a given deposit transaction.
    API for getting deposit history of a wallet
    API for getting deposit history of a sub wallet
    API for getting deposit detail

  • Withdrawal Flow
    Withdrawal is supported only on parent wallets. To withdraw assets from a sub wallet, Client shall transfer the asset to a Prime Wallet first before calling api for withdrawal.
    API for transfering assets between sub wallet and prime wallet
    API for requesting withdrawal

  • Check Wallet Balance
    Client can get a full list of assets of a given wallet.
    API for getting asset list of a wallet
    API for getting asset list of a sub wallet

  • MirrorX Flow
    MirrorX allows Clients to delegate their assets balance available in Prime Wallet to Binance sub-account while keeping their assets under Ceffu's custody at the same time. To start, first link a Prime Wallet with a Binance sub-account on Ceffu Web Portal or Ceffu iOS app.
    API for getting list of linked wallets

    After linkage is established, Client can check the available amount for delegation/undelegation, and get current MirrorX position.
    API for getting MirrorX available amount
    API for getting MirrorX asset positions

    Client can then delegate assets from Ceffu to Binance or undelegate from Binance to Ceffu.
    API for placing MirrorX order
    API for getting MirrorX order history

  • Transaction History
    Client can retrieve a concise record of their transactions.
    API for getting transaction history

Last modified: 9 months ago