跳转到主要内容
POST
/
v1
/
pay
/
address
/
refundconvert
闪兑订单退款
curl --request POST \
  --url https://api.example.com/v1/pay/address/refundconvert \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "refundRequestId": "483902480932841787",
  "prepayId": "1665553233227833",
  "refundOrderCurrency": "BTC",
  "refundOrderAmount": "1.1",
  "refundPayCurrency": "USDT",
  "refundPayAmount": "1000.1",
  "refundReason": "refund test",
  "receiverId": 123456
}
'
{
  "status": "SUCCESS",
  "code": "00000",
  "errorMessage": "",
  "data": {
    "refundRequestId": "483902480932841787",
    "prepayId": "1665553233227833",
    "orderCurrency": "BTC",
    "orderAmount": "2.2",
    "refundOrderAmount": "1.1",
    "payCurrency": "USDT",
    "payAmount": "44000",
    "refundPayAmount": "1000.1"
  }
}
API描述:对闪兑地址支付单发起退款,只支持闪兑地址支付单,若提供的参数对应到直付支付单,会返回错误

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID

示例:

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

X-GatePay-Signature
string
必填

签名

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8"

X-GatePay-Timestamp
string
必填

时间戳(毫秒)

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数

示例:

"9578"

请求体

application/json
refundRequestId
string

退款请求号

prepayId
string

订单ID

refundOrderCurrency
string

退款订单币种

refundOrderAmount
string

退款订单币种对应退款金额

refundPayCurrency
string

退款订单支付币种

refundPayAmount
string

退款订单支付币种对应退款金额

refundReason
string

退款原因

receiverId
string

地址支付退款接收人在gate系统的user_id

响应

200 - application/json

成功响应

闪兑地址支付单退款响应

refundRequestId
string
必填

商户退款请求ID

prepayId
string
必填

拟退款的订单id

orderCurrency
string
必填

订单币种

orderAmount
string
必填

订单金额

refundOrderAmount
string
必填

订单币种对应的退款金额

payCurrency
string
必填

用户支付币种

payAmount
string
必填

订单中用户应该支付的金额

refundPayAmount
string
必填

对应订单用户支付币种的退款金额