⚙️
API Explorer
  • Overview
  • API Reference
    • 交易
      • Sessiontoken
      • customer
      • Payment methods
      • Confirm charge
      • Checkout payment
      • Local payment
    • 授权交易完成/撤销
      • Authorization
    • 拒付
    • 退款
    • 物流
    • 交易查询
    • 网关绑定支付通道查询
    • 结算明细查询
    • 风控-来源网址查询
  • Webhook
    • 概述
    • 交易事件
    • 预授权事件
    • 退款事件
    • 拒付事件
    • 支付结果跳转
  • 附录
    • 数据签名过程
    • 测试账号信息
    • 常见错误码
    • 常见问题
    • 旧版API文档
Powered by GitBook
On this page
  1. API Reference

退款

退款申请与查询

Previous拒付Next物流

Last updated 2 years ago

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

applyRefund.sh
curl --request POST \
  --url https://{openApiUrl}/openApi/V2022-03/refund \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \
  --data '{
    "merTrackNo": "7313961647432084782",
    "refundAmount": "0.01",
    "refundReason": "0.01",
    "refundType": "2",
    "remark": "remark",
    "tradeNo": "2022051812003332818907"
}'

退款查询请求报文示例

refund.sh
curl --request GET\
  --url https://{openApiUrl}/openApi/V2022-03/refund/442011 \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

结果对象属性描述

property name
type
description

code

String

响应码

message

String

响应信息

data

Object

数据对象

batchNo

String

退款编号,唯一

refundDescription

String

退款描述

refundReason

String

退款原因

refundStatus

String

退款状态

pending:待处理

success:成功

fail:失败

tradeNo

String

交易流水号

退款查询

get

退款查询

Path parameters
batchNostring(10)Required

退款编号;最小长度为1,最大长度为9

Header parameters
gateway-nostring(16)Required

网关号

request-idstring(64)Required

请求id,30分钟之内唯一

request-timestring(16)Required

时间戳,以毫秒(ms)为单位,请求误差不能超过10分钟

sign-infostring(255)Required

验签字段,具体加签方式请参阅数据签名过程章节

Responses
200
OK
*/*
get
GET /openApi/V2022-03/refund/{batchNo} HTTP/1.1
Host: {openapiurl}
gateway-no: null
request-id: null
request-time: null
sign-info: null
Accept: */*
200

OK

{
  "code": "00000",
  "data": {
    "batchNo": 30002,
    "refundDescription": "退款描述",
    "refundReason": "尺寸不对",
    "refundStatus": "refund",
    "tradeNo": "2021092810011380477264"
  },
  "message": "message info"
}
  • POST退款申请
  • 退款申请接口请求报文示例
  • GET退款查询
  • 退款查询请求报文示例

退款申请

post

退款申请

Header parameters
gateway-nostring(16)Required

网关号

request-idstring(64)Required

请求id,30分钟之内唯一

request-timestring(16)Required

时间戳,以毫秒(ms)为单位,请求误差不能超过10分钟

sign-infostring(255)Required

验签字段,具体加签方式请参阅数据签名过程章节

Body

退款申请对象

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,如:2021092810011380477264

Example: 2021092810011380477264
Responses
200
OK
*/*
post
POST /openApi/V2022-03/refund HTTP/1.1
Host: {openapiurl}
gateway-no: null
request-id: null
request-time: null
sign-info: null
Content-Type: application/json
Accept: */*
Content-Length: 137

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

OK

{
  "code": "00000",
  "data": {
    "batchNo": 30002,
    "refundDescription": "退款描述",
    "refundReason": "尺寸不对",
    "refundStatus": "refund",
    "tradeNo": "2021092810011380477264"
  },
  "message": "message info"
}