Fully or partially refunds a payment paid by credit card or Pix.
Credit card payments can be refunded when they are confirmed or received. The cancellation may take up to 10 business days to appear on the payer's statement.
Payments received via Pix allow a full refund or multiple partial refunds, as long as the sum of the refunded amounts does not exceed the total payment amount.
The refund amount depends on the combination of value and splitRefunds:
- If only
splitRefundsis provided, the total amount will be the sum of the amounts defined in the Splits. - If
valueandsplitRefundsare provided,valuedefines the total. The amounts defined insplitRefundsare debited from the respective participants and the remainder is debited from the main payment. - If neither field is provided, the refund will be full.
Balance for refundPayment fees, such as settlement and notification fees, are not returned in the refund.
Therefore, when fully refunding a Pix payment right after receiving it, the available balance may be insufficient to return the total amount. In this case, the operation returns a
400error and you need to make sufficient balance available in the account.
When there is subsequent processing, track the outcome through the Events for payments.
Related content
Guides
Not found