BatchInquiry Method

Retrieves the current state of the open batch.

Syntax

ptechhostsettle.batchInquiry([callback])

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 this 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

A batch inquiry will provide the host batch totals to the Point Of Sale (POS). If the POS and the Host are out of balance, discrepancies can be corrected prior to the batch being released. A batch inquiry will not release the batch for settlement. Use the BatchRelease method or Paymentech's online merchant interface to settle the batch.

Batch Inquiry and Release response data will be returned in the ResponseBatchNumber, ResponseBatchNetAmount, ResponseBatchTransCount, ResponseBatchOpen, and ResponseBatchClose properties. Additional information concerning the type of transactions in the settlement will be broken down into the PaymentTypeName, PaymentTypeNetAmount and PaymentTypeTransCount properties.

class.BatchInquiry()
class.BatchRelease(class.ResponseBatchNetAmount)