TrackingId Property

User-generated unique tracking number.

Syntax

 adaptivepay.getTrackingId([callback])
 adaptivepay.setTrackingId( trackingId, [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 getTrackingId([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 setTrackingId([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

You can use this property to specify your own unique tracking ID, and later use this value to obtain information about a payment or to request a refund. The TrackingId is provided as a convenience in cases when you already maintain an ID that you want to associate with a payment. You can also track and make changes to payments using the PaymentKey.

Note: You are responsible for ensuring that the TrackingId is unique

Data Type

String