Refund status list

The transaction query can return the Payment.Refunds node, which records the refund requests made for the transaction. The query only displays these records and does not request or change a refund. Each item shows the requested amount, the status of the request, and the date it was received.

"Refunds": [
  {
    "Amount": 10000,
    "Status": 4,
    "ReceivedDate": "2025-01-31T16:26:26.743"
  }
]

PROPERTY	DESCRIPTION	TYPE
`Payment.Refunds.Amount`	Amount requested in the refund request, in cents. The amount does not indicate that the refund was completed. To find out the result of the request, check `Payment.Refunds.Status`.	Number
`Payment.Refunds.Status`	Status of the refund request. See the following table.	Number
`Payment.Refunds.ReceivedDate`	Date and time the refund request was received, in the format `YYYY-MM-DDThh:mm:ss.fff`.	Text

Status list

CODE	STATUS	DESCRIPTION
0	Communication failure	The refund request could not be completed due to a communication failure with the acquirer.
1	Refund scheduled (Pix)	The refund request was registered and scheduled for processing.
2	Refund scheduled (Card)	The refund request was registered and scheduled for processing.
3	Success	The refund was processed and completed.
4	Denied	The acquirer rejected the refund request.

ℹ️
The Payment.Refunds.Status list is different from the Payment.Status list. The codes in one do not have the same meaning in the other. To check the payment status, see Transaction Status List.

How to interpret the response

The Refunds node can appear in the transaction query, but it is not returned in the response to the void request.
When a request is denied (status 4), the ProviderReturnCode and ProviderReturnMessage fields give the reason for the denial. To check the meaning of the code, see Void return codes.
To check the current status of the transaction, see Payment.Status, Payment.VoidedDate, and Payment.VoidedAmount. The Refunds node shows the result of refund requests and does not replace this information.