E-Payment Integrator 2020 Node.js Edition

Questions / Feedback?

VoidTransaction Method

Voids a previously authorized transaction.

Syntax

icharge.voidTransaction(transactionId, [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 voids a transaction that has been previously authorized, but which has not yet gone to settlement, or been "captured". The TransactionId parameter indicates to the Gateway which transaction is to be voided, and should contain the ResponseTransactionId from the original transaction.

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

To cancel a transaction which has already been captured, use the Credit method.

The LinkPoint gateway requires you send the ResponseInvoiceNumber rather than the ResponseTransactionId.

For the PSIGateXML gateway, send the ResponseTransactionId as normal.

For the Heartland gateway, a reversal transaction will be sent when a TransactionAmount is specified. Otherwise a void transaction will be sent.

Copyright (c) 2021 /n software inc. - All rights reserved.
E-Payment Integrator 2020 Node.js Edition - Version 20.0 [Build 7941]