跳转至

通过 API 进行充值与提币管理

本指南将分步骤说明如何通过 Cactus API 实现充值与提币。

本指南涵盖内容

  • 创建钱包
  • 申请钱包地址
  • 向钱包充值代币并跟踪交易状态
  • 从钱包中提现代币
  • 查询钱包余额

前置条件

  1. 在调用我们的 API 之前,请确保已完成所有必要的 API 准备工作。
  2. 在调用我们的 API 时,请确保严格遵循所有 API 签名认证要求。
  3. 管理员需为 API 用户分配相应的角色与权限。有关可用角色及权限的更多信息,请参阅《用户手册》 > 快速开始 > 业务员权限。
  4. 此外,管理员需将业务员的 IP 地址添加至 API IP 白名单。该 IP 地址为发起 API 请求的来源地址,可在用户管理中进行配置。
  5. 管理员应根据业务需求,查看并配置各业务线下的各项风控措施,包括 提现审核、提现限额 以及 提现白名单。

创建钱包

要使用Cactus创建钱包,管理员必须在所选业务线下创建该钱包。

请注意,隔离账户下的钱包仅能通过网页界面创建,API 不支持创建。

申请钱包地址

在完成钱包设置后,您需要在钱包中生成充值地址以接收代币。\ 要在刚创建的业务线下的钱包中生成充值地址,请调用申请地址接口。

请求成功完成后,响应将返回新生成的地址。这些地址也可在Cactus 页面中查看。随后,您即可将代币充值到这些地址。

发起充值

将代币充值到上述地址后,用户可以通过两种方式监控交易:使用回调(Callback)接收充值通知,或通过 API 获取交易状态。

选项 1:使用回调接收充值通知

我们建议实现回调,以接收 充值状态 和 提现状态 的实时通知。

要为您的业务线设置回调,管理员需登录 Cactus 页面,并为对应的业务线配置回调 URL。

有关 Cactus 回调结构 及 数据传输机制 的详细信息,请参见此处。如需了解充值状态在不同场景下的更新流程,请参阅订单与充值状态页面。

选项 2:通过 API 获取交易状态

要通过 API 查询充值交易状态,用户可调用获取交易详情API,并将 tx_types 查询参数设置为 DEPOSIT。

提币

创建提币订单

要通过 API 发起提现请求,用户可调用 创建提币订单 API。我们建议用户在提现前,先调用查询钱包信息 API 接口,检查钱包或地址中的可用余额。

确认提币订单

根据管理员设置的内部风控规则,所有提现订单均需经过白名单保护、提现金额阈值检查,以及必要的提现审批流程。

要跟踪提现订单的状态,可参考 回调通知 或调用 获取订单详情 API(通过 status 字段查看)。

如果您拥有 订单审核人员角色,且提现订单处于待审批状态,也可以通过 审核订单 API 对订单进行审核和批准。

监控提币状态

各提币状态的流转流程可参考此处。请注意,Cactus 回调 与 获取订单详情 API 遵循相同的提现订单状态流程。

查询钱包余额

提现订单状态为 finished 后,您可以通过 查询单个钱包详情 API 查询更新后的钱包余额。\ 此外,您还可以通过 获取交易详情 API 查看已完成的交易记录。