SettlementAmount Property

New settlement amount after the reversal.

Syntax

 fdmsreversal.getSettlementAmount([callback])
 fdmsreversal.setSettlementAmount( settlementAmount, [callback])

Default Value

""

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 the getSettlementAmount([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setSettlementAmount([callback]) 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

To send a full reversal, the new SettlementAmount should be set to "0". The entire transaction will then be reversed, and the original transaction should not be settled with the FDMSSettle class. If you wish to reverse only part of the transaction (known as a "partial reversal"), simply set the SettlementAmount to the new total, minus reversal amount. For instance, if you have a $25 transaction and you wish to reverse $10 because one item was not in stock, set the AuthorizedAmount to "2500" and the SettlementAmount to "1500", and then call Reverse to do a partial reversal.

Note that partial reversals may not be performed on partially authorized transactions. If the ApprovalCode starts with "AL" and the Response.AuthorizedAmount from the original transaction was less than the original TransactionAmount, a full reversal must be performed with the SettlementAmount set to "0".

Data Type

String