SyncPaymentId Property

Transaction Id assigned by the server to the payment.

Syntax

 billpayment.getSyncPaymentId(index, [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 getSyncPaymentId([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 setSyncPaymentId([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

Transaction Id assigned by the server to the payment.

The SyncPaymentId is returned after a bill payment request (when calling the PayBill method, which can be either a single payment or a recurring payment model).

This identifier value can be used as reference to this payment or model in any modification or cancellation request (as parameter when the ModifyPayment or CancelPayment methods are called).

The size of the array is controlled by the SyncPaymentCount property.

This property is read-only and not available at design time.

Data Type

String