创建退款

为 PIX 收款订单创建退款。

接口

POST /cashin/pix/refund-qrcode

认证

Merchant Credential。详见 认证。

请求头

名称	位置	类型	必填	说明	示例
Content-Type	header	string	是		application/json
X-Nonce	header	string	是		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	是		2492265300
X-Timestamp	header	string	是		1638123456
Digest	header	string	是		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	是		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

请求体

字段	类型	必填	说明
amount	number	是	订单金额 — 单位：雷亚尔(BRL), 支持小数点后两位 (min=10; max=50000)
information	string	否	退款说明
platOrderNo	string	是	平台订单号 — 平台订单号 (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32})
refundSn	string	是	退款单号，用户自定义

请求示例

{
  "platOrderNo": "P_2607231123TjyexWSI6kGpJ7W0",
  "refund": "refund_12453",
  "amount": 0.11,
  "information": "User refund"
}

响应

HTTP 200 — 成功

字段	类型	必填	说明
status	integer	是
msg	null	是
data	object	是

data 字段

字段	类型	必填	说明
refundId	string	是
platOrderNo	string	是
information	string	是
amount	number	是
status	string	是	退款状态 (enum=PENDING, SUCCESS, FAILED)
refundSn	string	是

响应示例

{
  "status": 200,
  "msg": null,
  "data": {
    "refundId": "313",
    "platOrderNo": "P_260723s3343yexWSI6kGpJ7W0",
    "information": "User refund",
    "amount": 0.11,
    "status": "PENDING"
  }
}