TransactionDisplayAmount Property

Purchase amount to be authorized.

Syntax

 mpi.getTransactionDisplayAmount([callback])
 mpi.setTransactionDisplayAmount( transactionDisplayAmount, [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 getTransactionDisplayAmount([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 setTransactionDisplayAmount([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

This field contains the transaction amount to be authorized. The transaction amount is to be presented with all currency-specific punctuation, as this will be the number displayed to the customer. This number must be equivalent to the TransactionAmount property. This field may not contain a negative number.

Data Type

String