Cregis Developer Docs
POST/api/v2/payout

发起钱包提币(v2)

V2 版本在 V1 基础上新增 wallet_idfrom_address 两个可选参数,支持指定出款钱包或发起地址,适用于多钱包管理场景。

如项目开启提币外部验证,Cregis 会先向项目中配置的外部验证 URL 发起 提币外部验证通知,并根据返回的 okdeny 决定是否继续处理。

频率限制: 1000 次/分钟

请求

请求体

required

application/json
  • noncestringrequired

    6位随机字符串

  • timestampinteger<int64>required

    时间戳

  • signstringrequired

    签名

  • pidinteger<int64>required

    创建的WaaS项目ID

  • currencystringrequired

    币种标识

  • to_addressstringrequired

    接收方地址,在进行提币前建议先对接收方地址进行校验

  • amountstringrequired

    提币金额

  • third_party_idstringrequired

    调用方业务编号,由您自己的业务系统生成

  • wallet_idinteger<int64>

    指定出款钱包ID,不传则默认使用该项目设置的默认出款钱包的默认付款地址进行出款,请参考 创建项目

  • from_addressstring

    发送方地址,不传则默认使用该项目设置的默认出款钱包的默认付款地址进行出款,请参考 创建项目

  • callback_urlstring

    回调地址,该提币信息被处理时会向对应的callback_url发起回调通知,回调详情参考 提币通知

  • remarkstring

    转账的描述。不超过256位字符

  • memostring

    memo、tag等上链信息,仅Ton、Xrp支持

响应

200成功,返回 Cregis 系统流水号
application/json
  • codestring

    返回状态码,成功码只有一个”code”: “00000”,其他所有返回码都是表示执行出现异常,请参考 返回码

  • msgstring

    返回信息

  • dataobject

    返回数据

    • cidinteger<int64>

      系统流水号