Skip to main content

​
1.支付通知

当订单支付成功时，支付网关会向商户系统发起回调通知。如果商户系统没有正确返回，支付网关会延迟再次通知。
接口说明
请求URL：该链接是通过统一下单接口提交的参数notifyUrl设置，如果无法访问链接，商户系统将无法接收到支付中心的通知。 请求方式：POST 请求类型：application/x-www-form-urlencoded
通知参数
字段名变量名必填类型示例值描述
通知类型notifyType是int1通知类型:1支付,4结算,5订单交易
支付订单号payOrderId是String(30)P12021022311返回支付系统订单号
商户号mchNo是String(30)M16218734339商户号
应用IDappId是String(24)60cc09bce4b0f1应用ID
商户订单号mchOrderNo是String(30)2016042721060返回商户传入的订单号
支付接口ifCode是String(30)cbcoinpay支付接口编码
支付方式wayCode是String(30)CB_COIN_ADDR支付方式,CB_COIN_ADDR
支付金额amount是int100支付金额,单位分
货币代码currency是String(3)USD三位货币代码,美元:USD
订单状态state是int2支付订单状态 0-订单生成 1-支付中 2-支付成功 3-支付失败 4-已撤销 5-已退款 6-订单关闭
客户端IPclientIp否String(32)210.73.10.148客户端IPV4地址
商品标题subject是String(64)yipay商品标题测试商品标题
商品描述body是String(256)yipay商品描述测试商品描述
渠道订单号channelOrderNo否String2016042721060对应渠道的订单号
渠道错误码errCode否String1002渠道下单返回错误码
渠道错误描述errMsg否String1345869445731渠道下单返回错误描述
扩展参数extParam否String(512)1345869445731商户扩展参数
创建时间createdAt是long1622016572190订单创建时间,13位时间戳
成功时间successTime否long1622016572190订单支付成功时间,13位时间戳
通知请求时间reqTime是String(30)1622016572190通知请求时间，,13位时间戳
签名sign是String(32)C38…签名值，详见签名算法
返回结果
业务系统处理后同步返回给支付中心，返回字符串 success 则表示成功，返回非success则表示处理失败，支付中心会再次通知业务系统。（通知频率为0/30/60/90/120/150,单位：秒） 注意：返回的字符串必须是小写，且前后不能有空格和换行符。 通知示例数据 
{
    "notifyType": 1,
    "amount": 5,
    "body": "商品描述",
    "clientIp": "192.166.1.132",
    "createdAt": "1622016572190",
    "currency": "USD",
    "extParam": "",
    "ifCode": "cbcoinpay",
    "mchNo": "M1621873433953",
    "appId": "60cc09bce4b0f1c0b83761c9",
    "mchOrderNo": "mho1621934803068",
    "payOrderId": "20210525172643357010",
    "state": 3,
    "subject": "商品标题",
    "wayCode": "CB_COIN_ADDR",
    "sign": "C38..."
}
==========================================================

​
2.结算通知

当结算状态发生变化（如结算成功或失败）时，平台会主动通过Webhook方式通知商户。
接口说明
请求URL：该链接是通过结算发起接口提交的参数notifyUrl设置，如果无法访问链接，商户系统将无法接收到支付中心的结算通知。 请求方式：POST 请求类型：application/x-www-form-urlencoded
通知参数
字段名变量名类型示例值描述
通知类型notifyTypeint4通知类型:1支付,4结算,5订单交易
结算请求IDrequestIdStringS202508…商户结算请求ID
状态statusint1结算状态：1-成功, 2-失败
失败原因errorMsgString余额不足结算失败时的原因说明
完成时间completeTimelong1622016572190结算完成时间, 13位时间戳
签名signStringC38…签名值
返回结果
业务系统处理后同步返回给支付中心，返回字符串 success 则表示成功，返回非success则表示处理失败，支付中心会再次通知业务系统。（通知频率为0/30/60/90/120/150,单位：秒） 注意：返回的字符串必须是小写，且前后不能有空格和换行符。 通知示例数据 
{
    "notifyType": 4,
    "requestId": "1234567890",
    "status": 1,
    "errorMsg": "余额不足",
    "completeTime": "1622016572190",
    "sign": "C38..."
}
==========================================================

​
3.订单交易通知

当订单产生交易流水（如客户部分充值、充值合规检测等）时，平台会主动通过Webhook方式通知商户。
接口说明
请求URL：该链接是通过创建支付订单接口提交的参数notifyUrl设置，如果无法访问链接，商户系统将无法接收到支付中心的该订单交易通知。 请求方式：POST 请求类型：application/x-www-form-urlencoded
通知参数
字段名变量名类型示例值描述
通知类型notifyTypeint5通知类型:1支付,4结算,5订单交易
订单交易IDtxIdString1234-5678订单交易ID
支付订单号payOrderIdStringP202508…支付订单号
金额amountdecimal1000.24支付金额,含小数点
币种tokenIdStringETH_USDT币种ID
交易状态statusStringCompleted状态：Confirming-确认中, PendingScreening-合规扫描中,Completed-成功（以该状态为成功入账标准）
签名signStringC38…签名值
返回结果
业务系统处理后同步返回给支付中心，返回字符串 success 则表示成功，返回非success则表示处理失败，支付中心会再次通知业务系统。（通知频率为0/30/60/90/120/150,单位：秒） 注意：返回的字符串必须是小写，且前后不能有空格和换行符。 通知示例数据 
{
    "notifyType": 5,
    "txId": "1234567890",
    "payOrderId": "P1234567890",
    "amount": "1000.85",
    "tokenId": "TRON_USDT",
    "status": "Completed",
    "sign": "C38..."
}