Ceffu OpenAPI Documentation Platform
  1. Archive
Ceffu OpenAPI Documentation Platform
  • Changes
    • Upcoming Changes
    • Change log
  • Development Tools and Resource
    • Overview
      • Welcome to Ceffu OpenAPI
    • Quickstart
      • Initial Setup
      • Using the Ceffu SDK
    • Authentication
    • Rate limit
    • Error Codes
    • Webhook Introduction
  • Concepts
    • Ceffu Custody
  • System Endpoints
    • Get System status
  • Wallet Management
    • Ceffu Supported Asset Endpoint
      • Get Prime Wallet supported coins list
      • Get Qualified Wallet supported coins list
      • Get Cosign Wallet supported coins list
    • Qualified Wallets and Prime Wallets Endpoint
      • Create Wallet
      • Update Wallet Details
      • Get Wallet List
      • Get Asset Details
      • Get Wallet Asset Summary
    • Deposits
      • Get Deposit Address
      • Get Deposit History
      • Get Deposit Details
    • Withdrawals
      • Withdrawal
      • Get Withdrawal Fee (estimated)
      • Get Withdrawal History
      • Get Withdrawal Details
    • Whitelisted Addresses
      • Get Whitelisted Address List
      • Get Correspondent’s Options
      • Add/Edit Whitelisted Address
    • Transactions
      • Transaction History List
  • PW Sub Wallets
    • Sub-Wallet Management
      • Create Sub-Wallet
      • Update Sub-Wallet Details
      • Get Sub-Wallet List
      • Get Sub-Wallet Asset Details
      • Get Sub-Wallet Asset Summary
    • Sub-Wallet Deposits
      • Get Sub-Wallet Deposit Address
      • Get Deposit Address List under Prime Wallet
      • Get Deposit History under Sub-Wallet
      • Get Sub-Wallet Deposit History By Prime Wallet
    • Internal Transfers
      • Transfer between Sub Wallet and Prime Wallet
      • Get Transfer History between Sub-Wallet and Prime Wallet
    • Transactions
      • Get Transaction Details of Prime Wallet Internal Transfer
  • MirrorX
    • Link & Account
      • Get MirrorX LinkId List
    • Balances & Positions
      • Check MirrorX Available amount
      • Get MirrorX Asset Positions
    • Orders
      • Get MirrorX Orders
      • Place MirrorX Orders
  • Webhooks & Notifications
    • Resend webhook notifications
  • Archive
    • API Use Case
    • Mirror Endpoints
      • Get Mirror Linked Binance UID List
      • MIrror Assets Application
      • MIrror Assets Settlement
      • Get Mirror Operation Records
      • Get Mirrored Asset Positions
      • Get Mirrored Asset Summary
    • Wallet Endpoints
      • Get Transfer Detail with Exchange
      • Get Transfer History with Exchange
      • Transfer with Exchange
      • Get Withdrawal History
      • Get Withdrawal Details
      • Withdrawal
      • Get Sub-Wallet List (V1)
  1. Archive

API Use Case

Major API Use Case:#

Use Case 1 —Wallet Creation:#

Goal:
Create Qualified and Prime Wallets for a new client to enable asset custody and transactions.
Actor:
Product or Integration Engineer
Preconditions:
Client authentication is set up.
API key and secret are available.
Flowchart
flow-1.png
API Flow:
1.
Create Wallet – Create Qualified Wallet or Prime Wallet.
2.
Get Wallet List – Verify creation and retrieve wallet IDs.
3.
Get Asset Details / Get Wallet Asset Summary – Confirm initial asset status.
4.
Update Wallet Details - Update the wallet information. (Optional)
Expected Outcome:
Wallets are successfully created and appear in the wallet list.

Use Case 2 — Deposit Flow#

Goal:
Enable user to deposit assets into Qualified Wallet or Prime Wallet.
Actor:
User or Operations
Preconditions:
Destination wallet exists.
Asset is supported in corresponding wallet type. (Check from website or apis: Get Prime Wallet Supported Coins List api, Get Qualified Wallet supported coins list api)
Flowchart:
flow-2.png
API Flow:
1.
Get Deposit Address – Get user deposit address.
2.
User sends funds on-chain.
3.
Deposit Tracking
Get Deposit History – Track deposit. (Optional)
Get Deposit Details – Retrieve full transaction details. (Optional)
Set up webhook - Receive real-time notifications for critical events such as deposits, withdrawals, transaction updates, and wallet status change. (Optional)
5.
Get Wallet Asset Summary – Verify updated balance.
Expected Outcome:
Deposit appears in history and reflects in wallet balance.

Use Case 3 — Whitelisted Address Management#

Goal:
Allow users or operations to manage withdrawal addresses and ensure compliance with correspondent rules.
Actor:
Compliance Officer, Operations, or Backend Service
Preconditions:
Destination address exists.
Flowchart:
flow-3.png
API Flow:
1.
Get Whitelisted Address List – Retrieve the current list of whitelisted addresses.
2.
Get Correspondent's Options – Check allowed correspondent networks or partners for the asset.
3.
Add/Edit Whitelisted Address – Add a new address or update an existing one.
4.
Get Whitelisted Address List – Confirm the changes were applied successfully.
Expected Outcome:
Whitelist addressed and correspondent options are updated successfully.

Use Case 4 — Withdrawal Flow#

Goal:
Allow users to withdraw assets from their wallet securely and track the process.
Actor:
User or Backend Service
Preconditions:
Wallet has sufficient balance.
Destination address is whitelisted.
Flowchart:
flow-4.png
API Flow:
1.
Get Prime Wallet supported coins list, Get Qualified Wallet supported coins list, Get Cosign Wallet supported coins list - Check the supported assets to get the accurate coin/network symbol (Optional)
2.
Get Withdrawal Fee (Estimated) – Check estimated fees. (Optional)
3.
Get Whitelisted Address List – Check destination address is in whitelisted address list. (Optional)
4.
Get Asset Details - Check the balance before withdrawal. (Optional)
5.
Withdrawal – Initiate withdrawal.
6.
Withdrawal Tracking
Get Withdrawal Details – Retrieve final status. (Optional)
Get Withdrawal History – Monitor transaction. (Optional)
Set up webhook - Receive real-time notifications for critical events such as deposits, withdrawals, transaction updates, and wallet status change. (Optional)
Expected Outcome:
Withdrawal successfully executed and is visible in transaction history.

Use Case 5 — Create,Manage and Monitor Sub-Wallet#

Goal:
Create, manage, and monitor Sub-Wallets for specific operations of clients. You can create as many as sub-wallets under a prime wallet
Actor:
Product or Operations
Preconditions:
Parent Prime Wallet exists.
FlowChart
flow-5.png
API Flow:
1.
Create Sub-Wallet – Create new operational wallet.
2.
Update Sub-Wallet Details – Modify wallet settings or metadata. (Optional)
3.
Monitor
Get Sub-Wallet List – Retrieve Sub-Wallets under Prime Wallet. (Optional)
Get Sub-Wallet Asset Details / Get Sub-Wallet Asset Summary – Monitor balances. (Optional)
Get Transaction Details of Prime Wallet in Sub-Wallet Context – Reconcile transactions. (Optional)
Expected Outcome:
Sub-Wallets are created and are visible in list, with accurate asset details.

Use Case 6 — Sub Deposit Flow#

Goal:
Enable users to manage deposits for Sub-Wallets under a Prime Wallet, including retrieving deposit addresses and tracking deposit history.
Actor:
User or Operations
Preconditions:
Prime Wallet exists.
Sub-Wallet(s) exist under the Prime Wallet.
FlowChart:
flow-6.png
API Flow:
1.
Get Sub-Wallet Deposit Address – Retrieve the deposit address for a specific Sub-Wallet.
2.
Get Deposit Address List under Prime Wallet – List all deposit addresses associated with Sub-Wallets under a Prime Wallet.
3.
Get Sub-Wallet Deposit History By Prime Wallet
 – Retrieve deposit transaction history for a specific Sub-Wallet.
Expected Outcome:
Sub-Wallet deposit addresses are accessible, deposit lists are complete, and historical deposit transactions can be monitored for reconciliation or reporting.

Use Case 7 — Internal Transfers (Prime ↔ Sub-Wallet)#

Goal:
Move assets internally between Prime and Sub-Wallets for liquidity management.
Actor:
Operations or Treasury
Preconditions:
Both wallets exist and have sufficient balances.
Sub-wallets can only transfer assets to their parent prime wallet.
Flowchart
flow-7.png
API Flow:
1.
Transfer between Sub-Wallet & Prime Wallet – Execute transfer.
2.
Get Transfer History between Sub-Wallet & Prime Wallet – Verify transaction records.
3.
Get Sub-Wallet Asset Summary – Confirm updated balances.
Expected Outcome:
Funds successfully transferred internally without on-chain fees.

Use Case 8 — MirrorX Trading Integration#

Goal:
Allow users to trade directly via MirrorX using linked custody accounts.
Actor:
Trader or Trading Bot
Preconditions:
MirrorX link established.
Wallet has sufficient balance.
Flowchart
flow-8.png
API Flow:
1.
Get MirrorX LinkID List – Retrieve available link IDs.
2.
Check MirrorX Available Amount – Verify available balance.
3.
Place MirrorX Orders – Submit order.
4.
Get MirrorX Orders – Track order status.
5.
Get MirrorX Asset Positions – View open positions.
Expected Outcome:
Orders successfully placed and positions updated in MirrorX.

Use Case 9 — Transaction History & Operational Monitoring#

Goal:
Enable operations to monitor transactions.
Actor:
Operations or Support
Preconditions:
API dashboard and webhook monitoring enabled.
API Flow:
1.
Transaction History List – Retrieve all transaction records.
2.
Get Deposit Details / Get Withdrawal Details – Investigate specific transactions.
3.
Get Deposit History / Get Withdrawal History – Review inflow/outflow activity.
4.
Resend Webhook Notifications – Ensure delivery of missing events.
Expected Outcome:
Ops team gains full visibility over transactions.

Use Case 10 — Supported Assets Discovery#

Goal:
Enable users to retrieve a list of supported assets per wallet type.
Actor:
Developer or Integration Engineer
Preconditions:
API key authorized for wallet queries.
API Flow:
1.
Get Prime Wallet Supported Coins List
2.
Get Qualified Wallet Supported Coins List
3.
Get Cosign Wallet Supported Coins List
Expected Outcome:
System returns supported coins per wallet type.
Previous
Resend webhook notifications
Next
Get Mirror Linked Binance UID List