Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

AdjustTip Method

Sends a tip adjustment request.

Syntax

tsyshcretail.adjustTip(retrievalNumber, originalAmount, tipAmount, [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

Sends a tip adjustment request, which allows you to add a tip amount to the transaction specified by RetrievalNumber. Response will contain additional details about the tip adjustment request.

Method parameters are:

RetrievalNumberThe ResponseRetrievalNumber from the previously authorized transaction.
OriginalAmountThe original authorized amount.
TipAmountThe tip amount that you want to add to the transaction.

Minimum required properties:

Note: To use the TransactionNumber instead of the returned ResponseRetrievalNumber to void the transaction, you can set RetrievalNumber to "" (empty string) and the value contained within TransactionNumber will be used instead.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0