DepositLinePaymentLineId Property

The PaymentTxnLineId for this deposit line item For the PaymentTxnLineID, use a TxnLineID value exactly as it has been returned by the RECEIVEPAYMENT class after a Get.

Syntax

 deposit.getDepositLinePaymentLineId(index, [callback])
 deposit.setDepositLinePaymentLineId(index,  depositLinePaymentLineId, [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 getDepositLinePaymentLineId([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 setDepositLinePaymentLineId([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

The PaymentTxnLineId for this deposit line item

For the PaymentTxnLineID, use a TxnLineID value exactly as it has been returned by the ReceivePayment class after a Get. If you do not include a DepositLinePaymentLineId but do include a DepositLinePaymentId for a transaction that includes payment lines, only the first payment line from that transaction will be deposited.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String