E-Payment Integrator V6 - Online Help
E-Payment Integrator V6
Questions / Feedback?

CheckFrontImageData Property

This property contains the scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .

Syntax

 check21.getCheckFrontImageData(index, [callback])
 check21.setCheckFrontImageData(index,  checkFrontImageData_Buffer, [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 getCheckFrontImageData([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setCheckFrontImageData([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

This property contains the scanned image of the front of the physical check, in the format specified by CheckImageFormat and compressed using the designated CheckImageCompression. You may either specify the raw binary image data in this property, or specify the path and filename of an image on disk in the CheckFrontImageFilename property. If both are specified CheckFrontImageData will be used. If both properties are left empty, no records referencing the front image of the check will be added to the file.

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

This property is not available at design time.

Data Type

Buffer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0