退款

退款申请

post

退款申请

Required scopes

This endpoint requires the following scopes:

Authorizations

Authorization

AuthorizationstringRequired

Header parameters

authorizationanyRequired

ACCESS_TOKEN，格式：Bearer ACCESS_TOKEN

request-idstring(20)Required

请求id，最小长度为1，最大长度为20，30分钟之内唯一

request-timestring(19)Required

请求时间，时间格式为 yyyy-MM-dd'T'HH:mm:ss ，请求误差不能超过30分钟

Body

application/json

退款申请对象

merTrackNostring(50)Optional

商户跟踪号，用户商户唯一标识一笔退款记录；最小长度为1，最大长度为50，如：454515154

Example: 454515154

refundAmountstring(11)Optional

退款金额，最多两位小数；最小长度为1，最大长度为11，如：10.22

Example: 10.22

refundReasonstring(100)Required

退款原因，字段过长会被截取；最小长度为1，最大长度为100，如：退款

Example: 退款

refundTypeinteger(1) · int32Optional

退款类型 1全额退款; 2部分退款；固定长度为1，如：1

Example: 1

remarkstring(100)Optional

退款备注，传输什么就返回什么，字段过长会被截取；最小长度为1，最大长度为100，如：备注

Example: 备注

tradeNostring(64)Required

流水订单号；最小长度为1，最大长度为64，如：202101010000

Example: 202101010000

Responses

200

OK

*/*

post

/openApi/refund

HTTPcURLJavaScriptPython

POST /openApi/refund HTTP/1.1
Host: {openApiUrl}
Authorization: YOUR_API_KEY
authorization: null
request-id: null
request-time: null
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "merTrackNo": 454515154,
  "refundAmount": 10.22,
  "refundReason": "退款",
  "refundType": 1,
  "remark": "备注",
  "tradeNo": 202101010000
}

200

OK

{
  "data": {
    "batchNo": 30002,
    "gatewayNo": 10001001,
    "merNo": 10001,
    "refundDescription": "退款描述",
    "refundReason": "尺寸不对",
    "refundStatus": "refund",
    "tradeNo": 202101010000
  },
  "result": {
    "code": "text",
    "message": "text"
  }
}

退款申请接口请求报文示例

applyRefund.sh

curl --request POST \
  --url https://{openApiUrl}/openApi/refund \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 2022-05-21T23:59:59' \
  --header 'authorization:Bearer 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822' \
  --data '{
    "merTrackNo": "7313961647432084782",
    "refundAmount": "0.01",
    "refundReason": "0.01",
    "refundType": "2",
    "remark": "remark",
    "tradeNo": "2022051812003332818907"
}'

退款查询

get

退款查询

Required scopes

This endpoint requires the following scopes:

Authorizations

Authorization

AuthorizationstringRequired

Path parameters

batchNointeger(10)Required

退款编号；最小长度为1，最大长度为10，如：736743

Header parameters

authorizationanyRequired

ACCESS_TOKEN，格式：Bearer ACCESS_TOKEN

request-idstring(20)Required

请求id，最小长度为1，最大长度为20，30分钟之内唯一

request-timestring(19)Required

请求时间，时间格式为 yyyy-MM-dd'T'HH:mm:ss ，请求误差不能超过30分钟

Responses

200

OK

*/*

get

/openApi/refund/{batchNo}

HTTPcURLJavaScriptPython

GET /openApi/refund/{batchNo} HTTP/1.1
Host: {openApiUrl}
Authorization: YOUR_API_KEY
authorization: null
request-id: null
request-time: null
Accept: */*

200

OK

{
  "data": {
    "batchNo": 30002,
    "gatewayNo": 10001001,
    "merNo": 10001,
    "refundDescription": "退款描述",
    "refundReason": "尺寸不对",
    "refundStatus": "refund",
    "tradeNo": 202101010000
  },
  "result": {
    "code": "text",
    "message": "text"
  }
}

退款查询请求报文示例

refund.sh

curl --request GET\
  --url https://{openApiUrl}/openApi/refund/442011 \
  --header 'request-id: 58675' \
  --header 'request-time: 2022-05-21T23:59:59' \
  --header 'authorization:Bearer 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822' \

结果对象属性描述

property name	type	description
result	Object	请求响应对象
code	String	响应码
message	String	响应信息
data	Object	数据对象
merNo	Integer	商户号
gatewayNo	Integer	网关号
batchNo	String	退款编号，唯一
refundDescription	String	退款描述
refundReason	String	退款原因
refundStatus	String	退款状态 -1：失败 0：待审核 1：审核成功未处理 2：审核成功已处理
tradeNo	String	交易流水号