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

GetSummary Method

Sends a batch summary inquiry request.

Syntax

tsyshcbatchmgr.getSummary([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

This method allows you to retrieve summary details about each type in the current batch. The summary details can be retrieved via SummaryResults and Response will contain details about the inquiry request.

Minimum required properties:

BatchNumber can optionally be set to specify the batch you want to retrieve details for. If BatchNumber is not set, the current open batch will be used.

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