Skip to main content
POST
Create Refund

Some important rules

  • Only charges credited to the wallet can be refunded.
  • The customer must have at least the refund amount available in the wallet.
  • Pix: can only be returned with 90 days or less.
  • Credit card: 180 days or less.

Sandbox Testing

To test refund scenarios in the sandbox environment, the field amount must be one of the following values: 100, 1000, or 10000.Additionally, you must include the field reason with the value “APRO”.

Path Parameters

integer
required
The cash-in ID (payin ID) for which the refund will be created.Example: 63730

Request Body

integer
required
The refund amount.Example: 10
string
required
Reason for the refund.Example: "Teste"
string
URL to receive webhook notifications about refund status changes.

Response

integer
Refund ID.
integer
The ID of the payin (cash-in) being refunded.
integer
Current status ID of the refund.Status codes:
  • 2: Requested
  • 4: Paid (refund completed)
  • 5: Error
object
User who created the refund.
integer
Client ID.
integer
Refund amount.
array
History of status changes.
string
End-to-end ID (for Pix transactions). Can be null.
string
Reason for the refund.
string
Error code from wallet (if any). Can be null.
string
URL for webhook notifications. Can be null.
string
Refund created date.
string
Refund update date.

Important Information About the Webhook metadata

Refund Status

If an error occurs during the refund process (status 5), the field total_refund_amount will be decremented by the requested amount. When the refund is successfully paid, the amount will be incremented again.

Webhook Payload Examples:

Requested:
Error:
Paid:

Refund Status Flow

Success scenario:
Error scenario: