Void

ℹ️

Please refer to the API Reference for the complete request example:

Void a credit card payment.

Void is a feature that allows the merchant to refund a purchase order. It may occur due to insufficient stock, shopper withdrawal, or other operational reasons.

In the Payment Gateway, it is possible to request a void for debit and credit cards.

⚠️

Warning

The operational rules for void, such as deadlines, when the refund appears for the cardholder, and how the reversal is processed, may vary depending on the acquirer handling the transaction.

If the merchant needs to check specific requirements, they must verify directly with the responsible acquirer.

For specific details about the Cielo acquirer, consult the documentation at Cancellation,

Partial and Full Void

The Payment Gateway allows you to void either the entire authorized and captured amount or only part of it, according to the merchant's needs.

To send a void request, the merchant must fill in the Amount field with the amount to be refunded.

Partial void is only available when the transaction is created with Payment.Capture = "true".

• For credit cards, partial void can be requested more than once, until the total sale amount is refunded.
• For debit cards, the availability of partial void may vary depending on the acquirer. If the value informed in Amount is "0" (zero) or if this parameter is not sent, the Gateway considers the void as a full refund of the captured amount.

For full void, send the Amount field with the total amount.

Full void must be requested by informing the Amount field with the total authorized or captured amount. After the full void, it is not possible to make new requests for this same transaction.

For more details about void and refund by acquirer in the Gateway, see: Cancelamento e estorno de transações. in Portuguese.

Batch Void

In addition to individual void via API, the Gateway allows the merchant to perform batch voids through the E-commerce Portal, respecting the acquirer's deadlines.

Learn more at:

• Cancelamento em lote: until 11:59 PM on the day the transaction is created;
• Estorno em lote: from the day after the transaction is created.