This section contains information about batch processing procedures and the required variables for each response file. Use this integration method to process large numbers of transactions in a batch across multiple accounts by specifying the source key for each transaction in the request.
x = Incrementing Sequence Number
Numbers can be skipped, but they must always be greater than the previous file.
Files with older or invalid sequence numbers are ignored.
Sequence Number Max Value = 999999999 (9 digits)
KVP = URL Encoded Key-Value-Pair
Note: Ensure that all values are URL encoded.
Batch Upload Lifecycle
Client uploads Request/REQUEST_X.KVP
Client uploads Request/PROCESS_X.KVP
Batch process is triggered when Request/PROCESS_X.KVP is received
Gateway saves Response/RESPONSE_X.KVP
Gateway saves Response/COMPLETE_X.KVP
Client polls and parses Response/COMPLETE_X.KVP
If xStatus=Success then Client downloads and parses Response/RESPONSE_X.KVP
Client deletes all files from Response folder
Request Data File
Filename Format: REQUEST_X.KVP
Each line contains an individual transaction in KVP format. Any transaction that can be executed via the standard API can be submitted in the Request Data File.