PaymentTransactionId Property

Contains the Transaction ID of a PayPal payment.

Syntax

 invoice.getPaymentTransactionId([callback])
 invoice.setPaymentTransactionId( paymentTransactionId, [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 getPaymentTransactionId([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 setPaymentTransactionId([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

Contains the Transaction ID of a PayPal payment.

Note: This property is only used after a call to GetDetails is made, provided that the invoice was paid by PayPal.

Data Type

String