A Batch Auth request is a way to perform multiple auth’s with one request to the server.

Transaction Administration - Batch Auth

Overview

The Batch Auth operation enables multiple authorization requests to be submitted and processed within a single API call. Each transaction is individually numbered and evaluated, allowing bulk processing while maintaining per-transaction response tracking.

Request Format

Each entry in the batch uses the same fields as a normal authorization (mode=auth), as documented in Section 1. Remote Authorization. Append a numeric suffix to each per-transaction field name, starting at 1 and incrementing sequentially (for example, -1, -2, -3).

Batch-level fields such as publisher-name, publisher-password, mode, num-txns, and notify-email are shared for the request and are not suffixed.

Example Structure

card-name-1
card-number-1
card-cvv-1
card-address-1
card-amount-1

card-name-2
card-number-2
card-cvv-2
card-address-2
card-amount-2

Example Request String

publisher-name=yourPnPUsername&
publisher-password=yourRemoteClientPassword&
mode=batchauth&
num-txns=2&
card-amount-1=129.95&
card-name-1=John Smith&
card-number-1=4111111111111111&
card-exp-1=01/21&
card-amount-2=234.56&
card-name-2=Mary Jane&
card-number-2=4111111111111111&
card-exp-2=01/21

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 login password used in the admin interface.
`mode`	Mandatory	string	N/A	`batchauth`	Specifies the batch authorization operation.	Must be set to `batchauth`.
`num-txns`	Mandatory	integer	N/A	`3`	Number of transactions included in the request.	Each transaction must be sequentially numbered.
`notify-email`	Optional	string	39	`user@example.com`	Email address used for transaction error or alert notifications.

For each transaction X (from 1 to num-txns), supply the same authorization fields defined in Section 1. Remote Authorization, with -X appended to the field name (for example, card-number-1, card-exp-1, card-amount-1).

Response Parameters

Variable	Value	Description	Notes
`FinalStatus`	`success`, `problem`, `pending`	Overall batch processing result.	May return `pending` depending on processor behavior.
`success`	`yes`, `no`	Indicates overall request success.	Applies at batch level.
`Mstatus`	`success`, `problem`, `pending`	Legacy status field.	Deprecated in favor of `FinalStatus`.
`aux-msg`	string	Informational message returned upon success.	Example: order marked for settlement.
`MErrMsg`	string	Error message returned for batch-level failures.	May include multiple failure reasons.

Per-Transaction Response Parameters

Each transaction within the batch returns its own indexed response fields.

Variable	Value	Description	Notes
`FinalStatus-X`	`success`, `problem`, `pending`	Status for transaction `X`.	`X` ranges from 1–99.
`MErrMsg-X`	string	Error message for transaction `X`.	Only populated on failure.
`Mstatus-X`	`success`, `problem`	Legacy per-transaction status.	Deprecated in favor of `FinalStatus-X`.
`Duplicate-X`	`yes`, blank	Indicates duplicate transaction submission.	`yes` means prior submission detected; original response returned.