Capture Method

Captures a previously authorized transaction.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int Capture(const char* lpszTransactionId, const char* lpszCaptureAmount);

Unicode (Windows)
INT Capture(LPCWSTR lpszTransactionId, LPCWSTR lpszCaptureAmount);

- (void)capture:(NSString*)transactionId :(NSString*)captureAmount;

#define MID_RETAIL_CAPTURE 5

INPAY_EXTERNAL int INPAY_CALL InPay_Retail_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)