发起退款
请求方式和路径
POST /payment/payin/v1/createRefund
请求头
字段名 | 类型 | 必传 | 描述 |
---|---|---|---|
content-type | string | 是 | application/json |
x-api-key | string | 是 | Paydify 提供,跟appId 相同 |
x-api-timestamp | string | 是 | 时间戳,单位毫秒 |
x-api-signature | string | 是 | 签名,具体参看签名算法 |
请求体
字段名 | 类型 | 必传 | 描述 |
---|---|---|---|
appId | string(20) | 是 | Paydify 提供 |
mchTxnId | string(60) | 是 | 商户侧订单ID |
paymentTxnId | string(30) | 是 | 支付订单ID |
txnHash | string(120) | 是 | 链上的交易Hash |
mchExtInfo | string(512) | 否 | 商户扩展信息,JSON字符串 |
响应头参数
字段名 | 类型 | 必传 | 描述 |
---|---|---|---|
x-api-key | string | 是 | Paydify 提供,跟appId 相同 |
x-api-timestamp | string | 是 | 时间戳,单位毫秒 |
x-api-signature | string | 是 | 签名,具体参看签名算法 |
返回值
字段名 | 类型 | 描述 |
---|---|---|
status | int | 请求错误码,0 表示成功,非0 表示失败 ,枚举值参看错误码 |
msg | string | 请求错误描述信息 |
data.refundTxnId | string | Paydify 侧的退款订单ID |
data.paymentTxnId | string | 关联的支付订单ID |
data.state | string | 退款状态,枚举值参看退款状态 |
data.errorMsg | string | 退款失败原因说明 |
示例
shell
# 请求
# 成功返回值
{
"status": 0,
"msg": "success",
"data": {
"refundTxnId": "2209141130105863014",
"paymentTxnId": "2209141130105863014",
"state": "pending",
"errorMsg": "xxx"
}
}
# 失败返回值
{
"status": 9999,
"msg": "system error",
"data": null
}
# 请求
# 成功返回值
{
"status": 0,
"msg": "success",
"data": {
"refundTxnId": "2209141130105863014",
"paymentTxnId": "2209141130105863014",
"state": "pending",
"errorMsg": "xxx"
}
}
# 失败返回值
{
"status": 9999,
"msg": "system error",
"data": null
}