Skip to main content
POST
/
api
/
v1
/
merchant
/
payment
/
{mchOriginalTransactionId}
/
refund
支付退款
curl --request POST \
  --url https://stageapi.paymatrixpay.com/api/v1/merchant/payment/{mchOriginalTransactionId}/refund \
  --header 'Content-Type: application/json' \
  --header 'X-Merchant-Id: <x-merchant-id>' \
  --header 'X-Nonce: <x-nonce>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>' \
  --data '
{
  "merchant_transaction_id": "<string>",
  "merchant_refund_time": "<string>",
  "refund_currency_code": "USD",
  "refund_amount": 123,
  "reason": "商品质量问题",
  "remark": "客户退货退款"
}
'
{
  "code": "<string>",
  "msg": "<string>",
  "trace_id": "<string>",
  "data": {
    "platform_transaction_id": "<string>",
    "merchant_transaction_id": "<string>",
    "original_transaction_id": "<string>",
    "refund_data": {
      "refund_currency_code": "<string>",
      "refund_amount": 123,
      "actual_refund_currency_code": "<string>",
      "actual_refund_amount": 123,
      "refund_status": "<string>",
      "refund_time": "2023-11-07T05:31:56Z"
    }
  }
}

Headers

X-Merchant-Id
integer<int64>
required

商户 Id

X-Signature
string
required

签名字符串

Maximum string length: 5000
X-Timestamp
integer<int64>
required

时间戳毫秒值

X-Nonce
string
required

随机字符串

Maximum string length: 10

Path Parameters

mchOriginalTransactionId
string
required

Body

application/json
merchant_transaction_id
string
required

商户退款交易 id

Required string length: 1 - 19
merchant_refund_time
string<yyyyMMddHHmmss>
required

商户退款时间

refund_currency_code
string
required

退款币种,通常与支付币种相同

Example:

"USD"

refund_amount
number
required

退款金额,支持多次退款,累计退款金额不能大于原交易总金额

reason
string

退款原因描述,提供退款的原因

Maximum string length: 512
Example:

"商品质量问题"

remark
string

备注,商户对退款的补充说明

Maximum string length: 256
Example:

"客户退货退款"

Response

200 - */*

OK

code
string

状态码

msg
string

消息

trace_id
string

调用链ID, 用于定位问题

data
object