Capture

ℹ️

Valid only for credit card transactions. See the request example at: Capture a credit card payment

The capture confirms the authorization of the transaction so that the amount can be settled. When a transaction is captured, the amount is charged to the card and included in the buyer's invoice. Only captured transactions are settled for the merchant.

The Gateway allows full or partial capture. There are three types of capture:

• Automatic capture: requested in the same credit transaction authorization request by sending the Payment.Capture parameter as "true";
• Subsequent capture: requested after authorization when the Payment.Capture parameter is sent as "false";
• Batch capture: performed via the e-commerce portal for multiple transactions

If the payment is created with Payment.Capture = "false", it must be captured later.

⚠️

Warning

The operational rules for capture, such as deadlines, minimum amounts, and specific conditions, may vary depending on the acquirer processing the transaction. If the merchant needs to check this information, they must verify it directly with the responsible acquirer.

To check the rules for the Cielo acquirer, access the documentation at: Capture.

In this section, we present the guidelines for performing subsequent capture.

General capture rules

• Only transactions with status 1 (Authorized) can be captured. A transaction with status 1 (Authorized) has been approved by the issuer, but the amount has not yet been charged to the shopper's card. Capture is the next step to transfer the amount to the merchant's account;
• After capture, the transaction changes to status 2 (PaymentConfirmed). Capture indicates that the purchase amount has been effectively charged to the shopper's card and transferred to the merchant's account.

After capture, it is not possible to perform additional captures on the same transaction.

Partial and Full Capture

The payment gateway allows you to capture either the entire authorized amount or only part of it, according to the merchant's needs. The capture can be:

• For partial capture, send the Amount field in the capture request with the desired amount to be captured;
• For full capture, do not send the Amount field. The total authorized amount will be considered.

After the capture is sent, it is not possible to send new captures for the same transaction.

⚠️

Warning

ServiceTaxAmount is exclusive to airlines.