Skip to content

发起退款

请求方式和路径

POST /payin/v1/createRefund

请求头

字段名类型必传描述
content-typestringapplication/json
x-api-keystringPaydify提供,跟appId相同
x-api-timestampstring时间戳,单位毫秒
x-api-signaturestring签名,具体参看签名算法

请求体

字段名类型必传描述
mchTxnIdstring(60)商户侧订单ID
paymentTxnIdstring(30)支付订单ID
txnHashstring(120)链上的交易Hash
mchExtInfostring(512)商户扩展信息,JSON字符串

响应头参数

字段名类型必传描述
x-api-keystringPaydify提供,跟appId相同
x-api-timestampstring时间戳,单位毫秒
x-api-signaturestring签名,具体参看签名算法

返回值

字段名类型描述
codestring响应码,SYS_SUCCESS表示成功
messagestring响应消息
messageDetailstring响应消息详情
successboolean是否成功
data.refundTxnIdstringPaydify侧的退款订单ID
data.paymentTxnIdstring关联的支付订单ID
data.statestring退款状态,枚举值参看退款状态
data.errorMsgstring退款失败原因说明

示例

shell
# 请求

# 成功返回值
{
  "code": "SYS_SUCCESS",
  "message": null,
  "messageDetail": null,
  "data": {
    "refundTxnId": "2209141130105863014",
    "paymentTxnId": "2209141130105863014",
    "state": "pending",
    "errorMsg": "xxx"
  },
  "success": true
}

# 失败返回值
{
  "code": "SYS_ERROR",
  "message": "System error",
  "messageDetail": "Error details",
  "data": null,
  "success": false
}
# 请求

# 成功返回值
{
  "code": "SYS_SUCCESS",
  "message": null,
  "messageDetail": null,
  "data": {
    "refundTxnId": "2209141130105863014",
    "paymentTxnId": "2209141130105863014",
    "state": "pending",
    "errorMsg": "xxx"
  },
  "success": true
}

# 失败返回值
{
  "code": "SYS_ERROR",
  "message": "System error",
  "messageDetail": "Error details",
  "data": null,
  "success": false
}