A Batch Upload request is used to upload to the system a flat file of transaction that you wish to have processed. The file can contain a mixture of authorizations, returns, postauths, etc. Files uploaded in this manner or through the Transaction Administration Area are processed offline and an email is sent upon completion with a URL pointing to a results file.

Transaction Administration - Batch Upload

Overview

The Batch Upload operation allows a transaction batch file to be submitted for offline processing. The uploaded file is validated and queued for batch execution according to gateway processing rules.

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	`batchfile`	Specifies batch file upload operation.	Must be set to `batchfile`.
`batchid`	Mandatory	string	N/A	`1234567890`	Numeric identifier assigned to the batch file.	Used for tracking and reconciliation.
`num-txns`	Mandatory	integer	N/A	`5000`	Number of transactions contained in the batch file.	Maximum allowed is `5000`.
`emailresults`	Mandatory	string	39	`user@example.com`	Email address used to send batch completion notification.
`sndemail`	Mandatory	string	N/A	`yes`, `no`	Controls whether customer receipts are emailed.	If set to `yes`, receipt emails are sent to customers.
`data`	Mandatory	file/string	N/A	Batch file content	Contains the full transaction batch file payload.	Format must follow the Batch Upload Specification.
`notify-email`	Optional	string	39	`user@example.com`	Email address for system alerts and processing issues.

Reference: Credit Card Storage Validation Policy

Response Parameters

Variable	Value	Description	Notes
`FinalStatus`	`success`, `problem`	Indicates whether the batch file was successfully processed for upload.	`success` = uploaded successfully; `problem` = upload failure.
`MErrMsg`	string	Error message returned when upload fails.	Only present on failure.