Capture Method

Captures a previously authorized transaction.

Syntax

retail.capture(transactionId, captureAmount, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method captures a transaction that has been previously authorized with the AuthOnly method. The TransactionId parameter indicates to the Gateway which transaction is to be captured, and should contain the ResponseTransactionId 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 ResponseInvoiceNumber rather than the ResponseTransactionId.

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

The MyVirtualMerchant and Converge gateways do not require the TransactionId for captures. Instead, you must send the ResponseApprovalCode returned from the original response in the AuthCode 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 Capture like normal. When using this transaction type, TransactionId is required and ResponseApprovalCode is not applicable.