Refund Method

Refunds a previous transaction.

Syntax

globaldebit.refund(PNRef, [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 issues a refund based on a previously authorized Sale transaction.

Debit card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, there is no ability to capture, void, or reverse debit transactions. You must use the Refund method to return funds to a customer's card. When performing a Refund, the CardMagneticStripe, EncryptedPIN, and KSN are required in addition to the PNRef parameter, which identifies the transaction you're issuing a refund for.

To process a refund, set CardMagneticStripe, EncryptedPIN, and KSN then call Refund with the PNRef parameter set to the PNRef returned in response from the transaction for which you wish to issue a refund. If you leave the TransactionAmount blank, the full amount of the original transaction will be refunded. However, you may issue a partial refund for any value up to the original sale amount. For example:

Full Refund:

class.CardMagneticStripe = "9999999800002773=05121015432112345678" 
class.CardEntryDataSource = edsMagneticStripe
class.EncryptedPIN = "623F36B53CC18393"
class.KSN = "000000008F000021"
  
class.Refund("123456"); // "123456" is the PNRef from the original transaction

class.CardMagneticStripe = "9999999800002773=05121015432112345678" 
class.CardEntryDataSource = edsMagneticStripe
class.EncryptedPIN = "623F36B53CC18393"
class.KSN = "000000008F000021"
   
class.TransactionAmount = "15.00"; // Original transaction was for $25.00, so this is a partial refund
class.Refund("123456"); // "123456" is the PNRef from the original transaction

Note: Partial refunds are supported regardless of the time and date or batch status (open or closed). To perform a partial refund, pass any TransactionAmount that is less than the original transaction amount to the Refund transaction as per the example above.