Ceffu OpenAPI Documentation Platform
  1. Changes
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 Detail
    • 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
    • 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. Changes

Change log

2025-10-30#

Added new params jurisdictionVaspCode and selfHostedWalletProvider to API
/open-api/v1/wallet/addWhitelist
Add/Edit Whitelisted Address – Ceffu OpenAPI Documentation Platform
jurisdictionVaspCode is conditionally required when toFromType = 0 (see param description).
selfHostedWalletProvider is required when toFromType = 1.
Added new params jurisdictionRequired and jurisdictionVaspItem to API
/open-api/v1/wallet/whitelist/options
Get Correspondent’s Options – Ceffu OpenAPI Documentation Platform
When jurisdictionRequired = true, jurisdictionVaspItem must be input during address add/edit operations.

2025-07-10#

Add new parameter confirmation on api endpoint for adding/updating whitelisted addresses
Add available values for parameter confirmation of correspondent's options

2025-05-12#

Add new api endpoints for whitelisted addresses
Get list of whitelisted addresses
Add/Update whitelisted addresses
Get configuration options of the whitelisted address
Support new webhook event: Deposit Pending (Non-whitelisted From Address)

2025-03-03#

Add field "currentBlock" on GET Deposit History and GET Deposit Detail API to indicate current confirmed block number for on-chain deposits.
A Node.js SDK is available on github.

2024-10-21#

Deposit Functionality Update: The Deposit Detail V1 API has been discontinued. Please use the upgraded Deposit Detail V2 API for new features and improvements.
A Postman collection of apis is available on github.

2024-10-01#

Sub-wallets with auto-collection enabled do not support transfers. If you wish to perform transfers, please disable the auto-collection feature first. Endpoint: /open-api/v1/subwallet/transfer

2024-07-24#

Remove field "encoded" from webhook response data
Update error codes
Support querying deposit detail by orderViewId

2024-06-19#

Update to Workspace API:
Generated API Keys will only be able to perform get/post requests for the specific Workspace.

2024-05-08#

Update webhook response data format

2024-04-25#

New Endpoint: Transaction History List
Added a new endpoint to get transaction History
Endpoint: /open-api/v1/wallet/transaction/history
https://apidoc.ceffu.io/apidoc/shared-c9ece2c6-3ab4-4667-bb7d-c527fb3dbf78/api-3471859

2024-01-26#

Co-sign Wallet Withdrawal Support
OpenAPI now supports withdrawals using Co-sign Wallets.
Endpoint: /open-api/v2/wallet/withdrawal
https://apidoc.ceffu.io/apidoc/shared-c9ece2c6-3ab4-4667-bb7d-c527fb3dbf78/api-3471332
New Endpoint: Co-sign Wallet Supported Coins List
Added a new endpoint to get a list of coins supported by Co-sign Wallets.
Endpoint: /open-api/v1/wallet/cosign/coin
https://apidoc.ceffu.io/apidoc/shared-c9ece2c6-3ab4-4667-bb7d-c527fb3dbf78/api-3471824
Expanded Support for Co-sign Wallet in OpenAPI
All OpenAPI functionalities supported by Qualified Wallets are now available for Co-sign Wallets, except for wallet creation.
OpenAPI Deposit Blocks Information Update
Updated deposit blocks information in OpenAPI.
Endpoints:
/open-api/v1/wallet/deposit/history
/open-api/v2/wallet/deposit/detail
Updated Fields: confirmedBlockCount, unlockConfirm, maxConfirmBlock
https://apidoc.ceffu.io/apidoc/shared-c9ece2c6-3ab4-4667-bb7d-c527fb3dbf78/api-3471811
https://apidoc.ceffu.io/apidoc/shared-c9ece2c6-3ab4-4667-bb7d-c527fb3dbf78/api-3471336

2023-12-27#

Ceffu OpenAPI Upgrade Notice: For detailed information on the latest upgrades, please refer to the Ceffu OpenAPI upgrade documentation.
Deposit Functionality Update: The Deposit feature has been upgraded to version 2. Check out the new capabilities and enhancements here: Upgrade Deposit (V2).
Archiving Older Versions: We've moved Deposit (V1), Withdraw (V1), and Get Sub-Wallet List (V1) functionalities to our archive section for reference. We strongly encourage our clients to expedite their migration to the newer versions, as we may retire these V1 versions in the future.
Discontinuing Previous Services: Please note that Mirror1.0 and the Binance Transfer services have been sunsetted and are no longer available.

2023-12-01#

Added Webhook Endpoints, which enables you to set up endpoint URLs to monitor notifications related to events that occur on the platform.
We will sunset the previous domain; please use and update to this one: https://apidoc.ceffu.io/
For Prime Wallet withdrawal and deposit, we only credit 8 digits; any less than that will be lost.
Please note the request times limitation: every ID can’t request more than 30 times every second and no more than 7000 times per 5 minut

2023-09-29#

Added Wallet and Suballet asset Summary endpoints to enable users to query aggregated Asset Summary in BTC and USD equivalent value.
Added Wallet Asset Summary
Added Subwallet Asset Summary

2023-09-14#

Added Check MirrorX Available amount endpoints before placing MirrorX Orders
Added Check MirrorX Available amount

2023-08-17#

Introduced MirrorX services via OpenAPI, allowing clients to seamlessly integrate MirrorX features into their systems.
Added Get MirrorX LinkId List
Added Get MirrorX Delegation Orders
Added MirrorX Asset Positions
Added Place MirrorX Orders

2023-07-10#

Added Mirror endpoints to enable users to initiate Mirror Operations via OpenAPI.
Added Get Mirror Linked Binance UID List
Added Mirrored Assets Application
Added Mirrored Assets Settlement
Fixed Mirror status mapping issues

2023-06-19#

Added support for 'toWalletId' as an alternative to 'withdrawalAddress' in input parameters for withdrawal v2 endpoints.
Introduced sub-wallets Transfer Detail endpoints for querying specific transfer orders.
Updated Get Qualified Wallet and Get Prime Wallet Coin List endpoints to return real number format.
Update Create Wallet Endpoints to return WalletIdStr in Response
Enhanced Get Deposit History Endpoints' status to cover both Processing and Failed transactions.

2023-05-08#

Added new Query Sub Wallet Deposit History by Prime Wallets endpoint under Sub-Wallet endpoints

2023-04-05#

Added createTime output param on Get Transfer History between Sub Wallet and Prime Wallet endpoint.
Added createTime output param on Get Transfer Detail with Exchange endpoint.
Added createTime output param on Get Transfer History with Exchange endpoint.
NOTES: New createTime will be available on 6Apr

2023-03-01#

Added Mirror endpoints to allow user query mirror asset positions.
Added Get Mirrored Asset Positions
Added Get Mirrored Asset Summary
Updated below endpoints's response to include requestId
Modified Get Withdrawal History (version 2) endpoint
Modified Get Transfer History with Exchange endpoint
Modified Get Transfer History between Sub Wallet and Prime Wallet endpoint
Updated below endpoints to allow requestId as input parameter
Modified Get Withdrawal Detail (version 2) endpoint
Modified Get Transfer Detail with Exchange endpoint

2023-02-08#

Updated transaction status of transfer with exchange API endpoint to align with other transaction type.
Status: 10: Pending; 20: Processing; 30: Send success; 40: Confirmed; 99: Failed

2023-01-16#

Added a group of withdrawal endpoints to standardise the network fee deduction mechanism for both Qualified wallet and Prime wallet.
Added Withdrawal (v2) Endpoint
Added Get Withdrawal History (v2) Endpoint
Added Get Withdrawal Detail (v2) Endpoint
IMPORTANT NOTES: The amount field in Withdrawal (v2) endpoint means withdrawal amount excluded network fee in v2, that is exact amount receiver will receive. Please use Get Withdrawal History v2 and Get Withdrawal Detail (v2) together with Withdrawal (v2).
Added Mirror Operation Records Endpoints

2022-12-26#

Added Get Withdrawal Fee Endpoint
allows to get estimated withdrawal fee by providing walletId, coinSymbol, network and withdrawal amount
GET /open-api/v1/wallet/withdrawal/fee
Added Update Wallet Details Endpoint
allows to update wallet attributes
POST /open-api/v1/wallet/updateWallet
Added Update Sub wallet Details Endpoint
allows to update sub wallet attributes
POST /open-api/v1/subwallet/updateSubWallet
Added Get Sub Wallet List (v2) Endpoint
allows to get sub wallet details list of the requested prime wallet
GET /open-api/v2/subwallet/list

2022-11-30#

Modified Transaction Objects,
New field maxConfirmedBlock added;
New field unlockConfirm added;
Affected endpoints:
GET /open-api/v1/wallet/deposit/detail
GET /open-api/v1/wallet/deposit/history
GET /open-api/v1/wallet/withdrawal/detail
GET /open-api/v1/wallet/withdrawal/history
GET /open-api/v1/subwallet/deposit/history
Added New field addressRegex
addressRegex for validating Wallet Address (For reference only)
Affected endpoints:
GET /open-api/v1/wallet/shared/coin
GET /open-api/v1/wallet/qualified/coin

2022-11-03#

Added Get Wallet List Endpoint
allows to get all parent wallet ID of the institution including both Qualified Wallets and Prime Wallets. [Not include the underlying sub wallet]
GET /open-api/v1/wallet/list
Previous
Upcoming Changes
Next
Welcome to Ceffu OpenAPI