This transaction type is a query transaction type only. It returns a list of orderID’s of transactions that have been previously authorized but not yet settled or voided. This transaction would typically be used in conjunction with a Commit Batch transaction.
Transaction Administration - Assemble Batch
Overview
The Assemble Batch operation allows you to query the gateway for transactions that are currently waiting to be batched and marked for settlement.
Request Parameters
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description | Notes |
|---|---|---|---|---|---|---|
publisher-name |
Mandatory | string | N/A | Example: testgateway |
Gateway account username issued to you. | |
publisher-password |
Mandatory | string | N/A | Example: password123 |
Remote Client Password associated with the gateway account. | This is different from the password used to log in to the administrative interface. |
mode |
Mandatory | string | N/A | batchassemble |
Specifies the requested operation. | Must be set to batchassemble. |
startdate |
Mandatory | string | 8 | 20240101 |
Beginning date for transactions to be assembled. | Format: YYYYMMDD. |
enddate |
Optional | string | 8 | 20240131 |
Ending date for transactions to be assembled. | Format: YYYYMMDD. |
accttype |
Optional | string | 8 | checking, savings, credit |
Filters transactions by account type. | Defaults to credit when omitted. |
cardtype |
Optional | string | N/A | Example: vi, mc, ax, ds |
Filters transactions by card type. | |
txntype |
Mandatory | string | N/A | auth |
Transaction type to assemble. | Must be set to auth. |
notify-email |
Optional | string | 39 | user@example.com |
Email address that will receive notifications regarding transaction processing issues. |
Response Parameters
| Variable | Value | Description | Notes |
|---|---|---|---|
FinalStatus |
success, problem |
Overall status of the request. | Preferred status field. |
success |
yes, no |
Indicates whether the request completed successfully. | |
Mstatus |
success, problem |
Legacy status field. | Deprecated in favor of FinalStatus. |
aux-msg |
string | Additional informational message returned by the system. | May not always be present. |
MErrMsg |
string | Error message returned when the request cannot be completed successfully. | |
aXXXXX |
URL-encoded string | Contains transaction data for each matching transaction record. | XXXXX will be a number from 00000 through 99999. |
Transaction Record Format (aXXXXX)
Each aXXXXX response field contains a URL-encoded transaction record. The order of fields within the record is not guaranteed.
Example:
trans_date=data&
operation=data&
FinalStatus=data&
card-amount=data&
card-name=data&
card-address1=data&
card-city=data&
card-state=data&
card-zip=data&
card-country=data&
card-number=data&
card-exp=data&
result=data&
MErrMsg=data&
acct_code=data&
acct_code2=data&
acct_code3=data&
acct_code4=data&
auth-code=data&
avs-code=data