Core Features & API Overview
- Query Available Products
- Endpoint: GET /api/v1/earn/offers
- Function: Retrieves a list of all available wealth management products for subscription, including key information such as product ID, name, description, estimated APY, currency, subscription limits, and status.
- Use Case: Helps users dynamically discover investable options.
- Product Subscription & Management
- Subscribe: POST /api/v1/earn/purchase
- Used to subscribe to a specified wealth management product. Required parameters include productId, currency, amount, and a client-defined clOrderId for idempotency.
- Cancel Subscription: DELETE /api/v1/earn/purchase
- Cancels a subscription order before it is filled. Requires either the system orderId or the client-defined clOrderId.
- Product Redemption & Management
- Redeem: POST /api/v1/earn/redeem
- Used to redeem held units of an earn channel product. Supports redemption by specifying either the unit or the percent of the holding. Also requires a clOrderId for idempotency.
- Cancel Redemption: DELETE /api/v1/earn/redeem
- Cancels a redemption order before it is filled.
- Order & Position Query
- Query Order History: GET /api/v1/earn/orders
- Queries historical order records and their detailed status, filterable by product, order type (purchase, redeem, etc.), time range, and more.
- Query Position Overview: GET /api/v1/earn/balance
- Fetches the user's current holdings in wealth management products, including comprehensive information such as held units, latest net asset value, and unrealized earnings.
Key Operational Workflow A typical automated wealth management workflow is as follows:
- Call GET /earn/offers to check available products.
- Call POST /earn/purchase to execute a subscription.
- (Optional) If needed, call DELETE /earn/purchase to cancel the subscription.
- Call GET /earn/balance to monitor holding values.
- Call POST /earn/redeem to execute a full or partial redemption.
- Call GET /earn/orders at any time to verify all operation records.