The Batch Report API allows you to query the status of your batches of bank-to-bank (EFT/ACH) transactions and the status of the individual transactions within those batches.
The API supports bank-to-bank payments only. Batched credit card transactions are processed as individual transactions and can be viewed through the standard merchant portal reports (as distinct from our Batch Report API).
There are three distinct report types:
The batch payments reports represent all of the payment entries uploaded in the batch, while the batch settlement report is the balancing bank transfer between Bambora and your merchant bank account.
The settlement report will be empty until the batch is settled. You can query the date that a batch is due to settle using the BatchPaymentsEFT or BatchPaymentsACH report. You can then query the amount that was settled using the BatchSettlement report. The current version of the API is: 2.0
All requests to the Report API must be authorized. You can authorize a request by passing your merchant ID and API passcode in the body of the request with the merchantId and passCode parameters.
You can generate an API key for the Report API in the Member Area. After logging in, select administration, then account settings, and finally order settings.
On the Order Settings page, you'll find the Report* section. Here you can set an API access code by clicking the Generate New Code button. Once you have a new code, click Update at the bottom of the page.
If you have a partner account with us, you can authorize the request with the partner account's passcode and specify the sub-merchant account on which to report using the rptMerchantId parameter.
You can also generate a report across all of your live sub-merchant accounts with the single API call by setting the rptMerchantId value to “AllLive”.
A report request is a HTTPS request using the application/xml content type. All parameters are passed in the body of the request.
The response can be returned in either JSON, XML, TSV, CSV, or XLS formats. The content type of the response is relative to the value of the rptFormat parameters in the request. The JSON and XML response object contains a "code" property indicating the success of the request. This will be a number between 1 and 8, inclusive, where "1" indicates success. It also has a message property with a description of the code.
A successful request returns an array of transaction/record objects. The most important properties on these objects are status, state and returns.
You can read a full list of properties in the API reference doc.
curl -X POST \
https://api.na.bambora.com/scripts/reporting/report.aspx \
-H 'content-type: application/xml' \
-d '<?xml version="1.0" encoding="utf-8"?>
<request>
<rptVersion>2.0</rptVersion>
<serviceName>BatchPaymentsEFT</serviceName>
<merchantId>your_merchant_id</merchantId>
<passCode>your_report_api_passcode</passCode>
<sessionSource>external</sessionSource>
<rptFormat>JSON</rptFormat>
<rptFromDateTime>2012-03-03 00:00:00</rptFromDateTime>
<rptToDateTime>2019-03-03 23:59:59</rptToDateTime>
<rptFilterBy1>batch_id</rptFilterBy1>
<rptOperationType1>EQ</rptOperationType1>
<rptFilterValue1>10000020</rptFilterValue1>
</request>'
{
"response": {
"version": "1.0",
"code": 1,
"message": "Report generated",
"records": {
"total": 3
},
"record": [
{
"rowId": 1,
"merchantId": 300202779,
"batchId": 10000000,
"transId": 1,
"itemNumber": 1,
"payeeName": "General Motors",
"reference": "1000070001",
"operationType": "C",
"amount": 10000,
"stateId": 2,
"stateName": "Scheduled",
"statusId": 1,
"statusName": "Validated/Approved",
"bankDescriptor": "",
"messageId": "",
"customerCode": "",
"settlementDate": "2017-08-09",
"returnedDate": "",
"returnType": "",
"eftId": 0
},
{
"rowId": 2,
"merchantId": 300202779,
"batchId": 10000000,
"transId": 2,
"itemNumber": 2,
"payeeName": "Paul Randall",
"reference": "1000070002",
"operationType": "C",
"amount": 20000,
"stateId": 2,
"stateName": "Scheduled",
"statusId": 1,
"statusName": "Validated/Approved",
"bankDescriptor": "",
"messageId": "",
"customerCode": "",
"settlementDate": "2017-08-09",
"returnedDate": "",
"returnType": "",
"eftId": 0
}
]
}
}
curl -X POST \
https://api.na.bambora.com/scripts/reporting/report.aspx \
-H 'content-type: application/xml' \
-d '<?xml version="1.0" encoding="utf-8"?>
<request>
<rptVersion>2.0</rptVersion>
<serviceName>BatchPaymentsACH</serviceName>
<merchantId>your_merchant_id</merchantId>
<passCode>your_report_api_passcode</passCode>
<sessionSource>external</sessionSource>
<rptFormat>JSON</rptFormat>
<rptFromDateTime>2012-03-03 00:00:00</rptFromDateTime>
<rptToDateTime>2019-03-03 23:59:59</rptToDateTime>
<rptFilterBy1>batch_id</rptFilterBy1>
<rptOperationType1>EQ</rptOperationType1>
<rptFilterValue1>10000020</rptFilterValue1>
</request>'
{
"response": {
"version": "1.0",
"code": 1,
"message": "Report generated",
"records": {
"total": 3
},
"record": [
{
"rowId": 1,
"merchantId": 300210999,
"batchId": 10000000,
"transId": 1,
"itemNumber": 1,
"payeeName": "Patrick Star",
"reference": "0",
"operationType": "C",
"amount": 10000,
"bankAccountType": "PS",
"secCode": " ",
"stateId": 2,
"stateName": "Scheduled",
"statusId": 2,
"statusName": "Rejected/Declined",
"bankDescriptor": "",
"messageId": "59",
"customerCode": "",
"settlementDate": "2017-09-05",
"returnedDate": "",
"eftId": 0,
"nocDate": "",
"nocAccountType": "",
"nocRoutingNumber": "",
"nocAccountNumber": ""
},
{
"rowId": 2,
"merchantId": 300210999,
"batchId": 10000000,
"transId": 2,
"itemNumber": 2,
"payeeName": "Spongebob Squarepants",
"reference": "0",
"operationType": "C",
"amount": 20000,
"bankAccountType": "PC",
"secCode": " ",
"stateId": 2,
"stateName": "Scheduled",
"statusId": 2,
"statusName": "Rejected/Declined",
"bankDescriptor": "",
"messageId": "59",
"customerCode": "",
"settlementDate": "2017-09-05",
"returnedDate": "",
"eftId": 0,
"nocDate": "",
"nocAccountType": "",
"nocRoutingNumber": "",
"nocAccountNumber": ""
}
]
}
}
curl -X POST \
https://api.na.bambora.com/scripts/reporting/report.aspx \
-H 'content-type: application/xml' \
-d '<?xml version="1.0" encoding="utf-8"?>
<request>
<rptVersion>2.0</rptVersion>
<serviceName>BatchSettlement</serviceName>
<merchantId>your_merchant_id</merchantId>
<passCode>your_report_api_passcode</passCode>
<rptFormat>JSON</rptFormat>
<rptFilterBy1>batch_id</rptFilterBy1>
<rptOperationType1>EQ</rptOperationType1>
<rptFilterValue1>1600</rptFilterValue1>
</request>'
{
"response": {
"version": "1.0",
"code": 1,
"message": "Report generated",
"records": {
"total": 1
},
"record": [
{
"rowId": 1,
"merchantId": 300210999,
"batchId": 10000,
"settlementId": 1000000,
"operationType": "C",
"amount": 100,
"secCode": "",
"stateId": 4,
"stateName": "Complete",
"statusId": 1,
"statusName": "Approved",
"bankDescriptor": "Your descriptor",
"messageId": "",
"customerCode": "",
"settlementDate": "2017-08-30",
"returnedDate": "",
"eftId": 32000000,
"nocDate": "",
"nocAccountType": "",
"nocRoutingNumber": "",
"nocAccountNumber": ""
}
]
}
}