With the Batch Processing API, the merchant can integrate the Bambora Batch Processing Service into their application without the need to manually log into their Bambora account. This is ideal for integrators that want to use the Bambora batch system as part of their standalone software system.
The Batch Processing API accepts multipart/form-data HTTPS requests for the submission of Batch Files to a Bambora Membership account. The API must be accessed securely using a Secure Socket Layer HTTPS request.
The API requires that both POST and GET data is passed in the request. The batch file contents must be passed in the POST data of the request using multipart/form-data as the encoding type. Additional parameters for authentication, scheduling dates, and service versions must be passed as GET data within the query string of the URL.
The Batch Processing API service URL is: https://na.bambora.com/scripts/batch_upload.asp
Batch file API request parameters
These request parameters must be passed as query string variables to the Batch Processing API for a successful file upload. These parameters must be passed using a multipart/form-data encoding type, along with the posted batch file contents. See also Batch File API Response Parameters.
|serviceVersion||R||Specify 1.1||Current version of the batch processing API: 1.1.|
|loginCompany||R||Alphanumeric||Include the unique company login name associated with the merchant’s Bambora account. Note: Case-sensitive.|
|Important! The next three parameters are used to submit request authorizations in the body of the request. There are two methods, using passCode alone OR using loginUser with loginPass|
|passCode||O (Recommended)||Alphanumeric||Set this passCode in the Online Member Area.|
|loginUser||O||Minimum 6 alphanumeric characters||Include the user login name. Case-sensitive. This value must match a staff member account username as stored in the Bambora member area.|
|loginPass||O||Minimum 6 alphanumeric characters||Include the password associated with the staff login name. Case-sensitive. At least two numbers must be included in each password. Passwords expire every 90 days.|
|processDate||R||Alphanumeric||Date the batch file starts processing. Format YYYYMMDD. See Selecting an EBP/ACH Processing Date
Credit card batch files run automatically early in the morning Pacific Standard Time. The default processing date for credit card batch files is the following business day. You have the option to schedule your file for any other date up to 30 days in the future. After you add your file and select a processing date, click Upload to import the file into the Bambora system.
If you need to process your credit card file immediately, you can do it AFTER uploading the file with the default processing date.
|processNow||R||Numeric (1 or 0)||
For credit card transactions only–used to bypass the processDate parameter so that Bambora processes all transactions immediately upon receipt of a credit card file.
Batch file API response parameters
The Batch Processing API responds with an XML formatted message containing a response code, a text description of the response code, and a batch ID number. The 8-digit batch ID number can be used as a reference to look up the item in the Bambora system. If the batch fails to upload, an ID number is not issued.
<?xml version="1.1" encoding="ISO-8859-1"?>
<message>File successfully received.</message>
The API response messages only indicates when a file was successfully received by the Bambora system. Use the batch processing report in the Online Member Area to review the status of individual items in the file. Even though a batch file was received successfully, data errors within the file can prevent items from processing.
To view the Batch report, go to processing> batch processing in the menu.
The following table lists all response codes and text descriptions for the batch upload API.
Table of Batch File API Response Parameters
|1||File successfully received|
|2||Secure connection required|
|3||Service version not supported|
|4||Invalid login credentials|
|5||Insufficient user permissions|
|6||Batch Processing service not enabled|
|7||Invalid processing date|
|8||Service is busy importing another file. Try again later|
|9||File greater than maximum allowable size|
|11||No batch file received in request|
|12||Merchant account status cannot be Disabled or Closed for operation|
|13||Upload rejected. File name is limited to 32 characters in length, including file type extension|
|14||You cannot access your account from this workstation|
|15||File rejected. Maximum batch file upload limit was reached|
|16||Service is temporarily unavailable|