A Batch Review request is used to retrieve the delimited results of the Batch Upload you have previously submitted. You would use this feature, only after you have received notification that your uploaded file has been processed.

Transaction Administration - Batch Upload Results

Overview

The Batch Upload Results operation retrieves processing results for a previously submitted batch file. It provides status information and, when available, detailed transaction-level output.

Request Parameters

Variable	Requirement	Type	Max Size	Possible Values / Example	Description	Notes
`publisher-name`	Mandatory	string	N/A	Example: `gatewayuser`	Gateway account username issued to you.
`publisher-password`	Mandatory	string	N/A	Example: `securepassword`	Remote Client Password used for API authentication.	This differs from the administrative login password.
`mode`	Mandatory	string	N/A	`batchresults`	Specifies the batch results retrieval operation.	Must be set to `batchresults`.
`batchid`	Mandatory	string	N/A	`1234567890`	Numeric identifier representing the batch file.	Used to locate previously submitted batch uploads.

Response Parameters

Variable	Value	Description	Notes
`FinalStatus`	`success`, `problem`	Indicates whether the request for results retrieval succeeded.	Does not represent batch completion status.
`MErrMsg`	string	Error message returned when request fails.	Example: invalid batch ID or missing batch record.
`results`	string	Delimited dataset containing batch transaction results.	Format depends on batch processing configuration.
`batchstatus`	`pending`, `complete`	Current processing state of the batch.	`pending` = still processing; `complete` = fully processed.
`trans_pending`	integer	Number of transactions still awaiting processing.	Only returned when `batchstatus` is `pending`.
`trans_success`	integer	Number of successfully processed transactions.	Only returned when `batchstatus` is `pending`.