PaymentBillRef Property

Biller-supplied reference information when paying a bill, if available.

Syntax

 billpayment.getPaymentBillRef([callback])
 billpayment.setPaymentBillRef( paymentBillRef, [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 getPaymentBillRef([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 setPaymentBillRef([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

Biller-supplied reference information when paying a bill, if available.

This is optional when submitting a payment request.

This property is not available at design time.

Data Type

String