PaymentOptionsHeaderImageURL Property

The URL where the image is stored that appears in the header of customer emails.

Syntax

 adaptivepay.getPaymentOptionsHeaderImageURL([callback])
 adaptivepay.setPaymentOptionsHeaderImageURL( paymentOptionsHeaderImageURL, [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 getPaymentOptionsHeaderImageURL([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 setPaymentOptionsHeaderImageURL([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 URL where the image is stored that appears in the header of customer emails.

The image dimensions are 43 pixels high x 240 pixels wide. This property is optional.

Data Type

String