跳转到主要内容
POST
/
payment
/
open
/
institution
/
v2
/
standard
/
order
/
refund
创建退款
curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/v2/standard/order/refund \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "prepayId": "1991810932510167040",
  "refundRequestId": "lux202511x093726",
  "refundAmount": "0.018",
  "refundReason": "test"
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "refundRequestId": "lux202511x093725",
    "refundGateId": "35803047115358215",
    "prepayId": "1991810932510167040",
    "orderAmount": "1.1",
    "refundAmount": "0.018",
    "errMsg": "",
    "orderCurrency": "USDT",
    "payCurrency": "USDT",
    "payAmount": "0.018"
  }
}

请求头

X-GatePay-Certificate-ClientId
string
必填

商户在Gate商户后台注册应用时分配的clientId

示例:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
必填

请求签名。GatePay通过此签名来确定此请求是否合法

X-GatePay-Timestamp
string
必填

请求生成时的UTC时间戳,milliseconds。请注意,GatePay不处理收到请求时间与这个时间戳差距大于10秒钟的请求

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机字符串,字符符合HTTP Header头部的规范,建议长度在32个字符以内,字符串组成为数字和字母

示例:

"9578"

X-GatePay-On-Behalf-Of
string
必填

被代理的机构账户id

示例:

"2124538349"

请求体

application/json
refundRequestId
string
必填

商户退款 ID,由商户生成唯一并保证小于 32 字节

Maximum string length: 32
prepayId
string
必填

订单 ID,订单须为完成支付状态才能发起退款

refundAmount
string
必填

退款金额

refundReason
string
必填

退款原因

refundStyle
integer<int64>

退款方式:1 原路退 2 指定退

refundPayChannel
integer<int64>

退款支付方式:1 Gate 2 Web3

refundToGateUid
string

退款至用户 id,Gate 方式时必填

refundChain
string

退款网络,Web3 时必填

refundBearType
string

退款承担类型:1 商家承担 2 用户承担

memo
string

退款备注

refundAmountTypeFull
string

退款金额类型:1 全部退 2 部分退

needNotify
boolean

是否需要通知

refundLimit
boolean

退款是否限制次数

refundCurrency
string

退款币种

refundFundStatementId
integer<int64>

发起退款的流水 id

refundSource
integer<int64>

退款发起的源头:0 订单 1 流水

响应

200 - application/json

成功

status
string
code
string
errorMessage
string
data
object