WEBHOOK

订单支付通知（Webhook）

由服务端主动推送的回调通知，需在你的服务实现接收端点。

根据创建订单填写的callback_url,当订单状态变化时会通过该回调地址通知调用方，具体了解创建订单接口中的callback_url参数该接口为Cregis向业务方发起回调通知请求，只会产生一次回调：

回调事件

回调事件名称(event_name)	回调事件类型(event_type)	描述
order	expired	订单超时通知
order	paid	订单支付完成通知
order	paid_partial	订单部分支付通知
order	paid_over	订单超额支付通知
order	refunded	订单退款通知
order	paid_remain	订单补款通知

请求方式

HTTP POST application/json发起回调请求后当接收到返回内容为success字符串时为回调成功，否则为回调失败。

如回调失败，可在 Cregis 客户端异常回调页面内进行手动重推，以确保业务逻辑完整性。

请求

回调载荷

application/json

noncestring
6位随机字符串
pidinteger<int64>
项目编号
signstring
签名
timestampinteger<int64>
时间戳
event_namestring
enum: "order"
事件名称
event_typestring
enum: "expired", "paid", "paid_partial", "paid_over", "refunded", "paid_remain"
事件类型
data支付结果回调字段 | 超时回调字段 | 退款回调字段 | 后续补款回调字段
订单信息
按事件类型匹配其一
选项 1 · 支付结果回调字段
order_amountstring
订单金额
order_currencystring
订单货币代码，即ISO 4217货币代码,例如 CNY、HKD，请参考订单货币列表
cregis_idstring
Cregis 订单编号
order_idstring
商家订单编号
statusstring
enum: "new", "paid", "expired", "paid_over", "paid_partial", "canceled"
订单状态

new待支付

paid已支付

expired订单超出有效时间

paid_over付款超出订单金额

paid_partial付款小于订单金额

canceled订单已取消，如已完成退款

valid_timeinteger<int32>
订单超时时间【单位/分钟】
remarkstring
订单备注信息
payer_idstring
付款人id标识
payer_namestring
付款人姓名
payer_emailstring
付款人邮箱
created_timeinteger<int64>
订单创建时间【13位时间戳】
cancel_timeinteger<int64>
订单取消时间【13位时间戳】
payment_addressstring
充值地址
receive_amountstring
汇率转换后的订单金额
receive_currencystring
汇率转换后的订单货币单位
pay_amountstring
实际到账金额
pay_currencystring
到账货币单位
exchange_ratestring
货币汇率
tx_idstring
交易hash
transact_timeinteger<int64>
订单支付完成时间【13位时间戳】
选项 2 · 超时回调字段
order_amountstring
订单金额
order_currencystring
订单货币代码，即ISO 4217货币代码,例如 CNY、HKD，参考法币信息列表接口
cregis_idstring
Cregis 订单编号
order_idstring
商家订单编号
statusstring
enum: "new", "paid", "expired", "paid_over", "paid_partial", "canceled"
订单状态

new待支付

paid已支付

expired订单超出有效时间

paid_over付款超出订单金额

paid_partial付款小于订单金额

canceled订单已取消，如已完成退款

valid_timeinteger<int32>
订单超时时间【单位/分钟】
remarkstring
订单备注信息
payer_idstring
付款人id标识
payer_namestring
付款人姓名
payer_emailstring
付款人邮箱
created_timeinteger<int64>
订单创建时间【13位时间戳】
cancel_timeinteger<int64>
订单取消时间【13位时间戳】
选项 3 · 退款回调字段
order_amountstring
订单金额
order_currencystring
订单货币代码，即ISO 4217货币代码,例如 CNY、HKD，参考法币信息列表接口
cregis_idstring
Cregis 订单编号
order_idstring
商家订单编号
statusstring
enum: "new", "paid", "expired", "paid_over", "paid_partial", "canceled"
订单状态

new待支付

paid已支付

expired订单超出有效时间

paid_over付款超出订单金额

paid_partial付款小于订单金额

canceled订单已取消，如已完成退款

valid_timeinteger<int32>
订单超时时间【单位/分钟】
remarkstring
订单备注信息
payer_idstring
付款人id标识
payer_namestring
付款人姓名
payer_emailstring
付款人邮箱
created_timeinteger<int64>
订单创建时间【13位时间戳】
cancel_timeinteger<int64>
订单取消时间【13位时间戳】
payment_addressstring
充值地址
receive_amountstring
汇率转换后的订单金额
receive_currencystring
汇率转换后的订单货币单位
pay_amountstring
实际到账金额
pay_currencystring
到账货币单位
exchange_ratestring
货币汇率
tx_idstring
交易哈希
transact_timeinteger<int64>
订单支付完成时间【13位时间戳】
refund_requestedstring
enum: "yes", "no"
订单是否发生退款

no无退款记录

yes有退款记录

typeinteger
enum: 0, 1
退款类型

0部分退款

1全额退款

refund_idstring
Cregis退款订单编号
refund_addressstring
退款收款人的链上地址
refund_currencystring
退款订单的币种填入加密货币token_name，格式：USDT-BEP20，USDT-TRC20
refund_amountstring
退款金额
refund_feestring
退款所需gas fee
actual_refund_amountstring
扣减矿工费后的实际退款金额 = 退款订单金额amount-gas_fee_amount
refund_statusinteger
enum: 0, 1, 2
退款状态

0退款处理中

1退款成功

2退款失败

refund_tx_idstring
退款交易哈希
refund_created_timeinteger<int64>
退款订单创建时间【13位时间戳】

e.g. 1720508269092 即 2024-07-09 14:57:49 092
refund_transact_timeinteger<int64>
退款订单最后更新时间【13位时间戳】

e.g. 1720508269092 即 2024-07-09 14:57:49 092
选项 4 · 后续补款回调字段
order_amountstring
订单金额
order_currencystring
订单货币代码，即ISO 4217货币代码,例如 CNY、HKD，参考法币信息列表接口
cregis_idstring
Cregis 订单编号
order_idstring
商家订单编号
statusstring
enum: "new", "paid", "expired", "paid_over", "paid_partial", "canceled"
订单状态

new待支付

paid已支付

expired订单超出有效时间

paid_over付款超出订单金额

paid_partial付款小于订单金额

canceled订单已取消，如已完成退款

valid_timeinteger<int32>
订单超时时间【单位/分钟】
remarkstring
订单备注信息
payer_idstring
付款人id标识
payer_namestring
付款人姓名
payer_emailstring
付款人邮箱
created_timeinteger<int64>
订单创建时间【13位时间戳】
cancel_timeinteger<int64>
订单取消时间【13位时间戳】
payment_addressstring
充值地址
receive_amountstring
汇率转换后的订单金额
receive_currencystring
汇率转换后的订单货币单位
pay_amountstring
实际到账金额
pay_currencystring
到账货币单位
exchange_ratestring
货币汇率
tx_idstring
交易哈希
transact_timeinteger<int64>
订单支付完成时间【13位时间戳】
additional_pay_currencystring
补款货币单位
additional_pay_amountstring
补款金额
additional_payment_addressstring
补款地址
additional_payment_tx_idstring
补款交易hash
additional_payment_transact_timeinteger<int64>
补款订单支付完成时间【13位时间戳】

响应

200您的服务端需返回 HTTP 200 且响应体严格等于纯文本 `success`（text/plain）

text/plain

string

请求示例

application/json

{
  "nonce": "m8jisx",
  "pid": 1382528827416576,
  "sign": "cebd2bfd56766f1143dc40d078b64dac",
  "timestamp": 1687848653294,
  "event_name": "order",
  "event_type": "paid",
  "data": {
    "order_amount": "100",
    "order_currency": "HKD",
    "cregis_id": "po1420761885130752",
    "order_id": "merchant_order_id_123",
    "status": "paid",
    "valid_time": 30,
    "remark": "购买商品",
    "payer_id": "p_001",
    "payer_name": "张三",
    "payer_email": "[email protected]",
    "created_time": 1719993183015,
    "cancel_time": 1719994983015,
    "payment_address": "TMainWalletAddressXXXXXXXXXXXXXXXXXX",
    "receive_amount": "12.86",
    "receive_currency": "USDT",
    "pay_amount": "100",
    "pay_currency": "USDT",
    "exchange_rate": "0.1286",
    "tx_id": "0x0502f2bfd96cd0f55edea3343513940f3af7fe594eae77f08d2f46ea24829b11",
    "transact_time": 1719993183325
  }
}

响应示例

200 · text/plain

success