TransactionId Property

The PayPal transaction ID associated with the payment.

Syntax

 adaptiverefund.getTransactionId([callback])
 adaptiverefund.setTransactionId( transactionId, [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 getTransactionId([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 setTransactionId([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

A chained or parallel payment can be viewed as a set of individual payments. PaymentKey and TrackingId refer to the entire set, but TransactionId refers to one specific payment inside of the larger set. For a simple payment, the TransactionId refers to the same thing as the PaymentKey and TrackingId.

Specify the payment you're interested in using either the PaymentKey, TransactionId, or TrackingId. It is not recommended to specify more than one of these properties, unless they identify the same payment. If the properties do not belong to the same payment, the TransactionId is used; next, PayPal uses the PaymentKey. If more than one of these is specified, the TrackingId is never used.

Note that the Instant Payment Notification message associated with the payment will contain this transaction id. See the IPN class for more info about these notifications.

Data Type

String