capture Method

Captures a previously authorized transaction.

Syntax

def capture(transaction_id: str, capture_amount: str) -> None: ...

Remarks

This method captures a transaction that has been previously authorized with the auth_only method. The TransactionId parameter indicates to the gateway which transaction is to be captured, and should contain the response_transaction_id from the original transaction. The CaptureAmount parameter is the value to be captured from the customer's credit card, and can be different from the authorized amount.

Please see the gateway information in the table of contents to determine if your gateway supports Capture transactions.

The LinkPoint and PSIGateXML gateways require you send the response_invoice_number rather than the response_transaction_id.

The SecurePay gateway does not require the TransactionId for captures. Instead, you must send the response_approval_code returned from the original response in the auth_code property.

The MyVirtualMerchant and Converge gateways do not require the TransactionId for captures. Instead, you must send the response_approval_code returned from the original response in the auth_code property. Note that there is a new capture transaction type available for these gateways. To use the new transaction type, set the MyVirtualMerchantTransactionType to "CCCOMPLETE" and call on_capture like normal. When using this transaction type, TransactionId is required and response_approval_code is not applicable.