Create Refund

Create a refund for a PIX Cash In payment.

Endpoint

POST /cashin/pix/refund-qrcode

Authentication

Merchant Credential. See Authentication.

Request headers

Name	In	Type	Required	Description	Example
Content-Type	header	string	Yes		application/json
X-Nonce	header	string	Yes		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	Yes		2492265300
X-Timestamp	header	string	Yes		1638123456
Digest	header	string	Yes		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	Yes		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Request body

Field	Type	Required	Description
amount	number	Yes	Order amount — Unit: Brazilian Real (BRL), up to 2 decimal places (min=10; max=50000)
information	string	No	Refund description
platOrderNo	string	Yes	Platform order number — Platform order number (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32})
refundSn	string	Yes	Refund SN, merchant-defined

Request example

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

Response

HTTP 200 — Success

Field	Type	Required	Description
status	integer	Yes
msg	null	Yes
data	object	Yes

data fields

Field	Type	Required	Description
refundId	string	Yes
platOrderNo	string	Yes
information	string	Yes
amount	number	Yes
status	string	Yes	Refund status (enum=PENDING, SUCCESS, FAILED)
refundSn	string	Yes

Response example

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