We give merchants and developers the power to generate numerous, flexible reports. Merchants can review complete transaction details for a particular transaction ID, or access basic summary order information using specific search and sort functions.
Definition
GET /v1/payments HTTP/1.1
Request
curl https://api.na.bambora.com/v1/payments/{transactionId} \
-H "Authorization: Passcode MzAwMjAwNTc4OjRCYUQ4MkQ5MTk3YjRjYzRiNzBhMjIxOTExZUU5Zjcw" \
You can retrieve a previous transaction using this method. All you need is the transaction ID.
You must use the correct API key for this method.
Definition
POST /v1/reports HTTP/1.1
Request
curl https://api.na.bambora.com/v1/reports \
-u "284000000:30c9dbd6505a4c8e960451feba6f036a" \
-d '{
"name": "Search",
"start_date": "2012-01-01T01:01:03",
"end_date": "2014-06-05T16:05:00",
"start_row": "1",
"end_row": "2",
"criteria": [
{
"field": "1",
"operator": "%3C%3D",
"value": "10000001"
}
]
}'
With the Reporting API you can access basic summary order information using simple search functions.
Each search can be performed using a date range and an optional number of search criteria, to narrow down the search.
Notes: * Make sure you are using the Reporting API key gathered from the member area in your account. * Paging limit is set to 500 records
There are several parameters that are required to perform a search:
The search criteria require 3 parameters: field, operator, and value. You can supply as many criteria as you wish and each Criteria will be ANDed together eg. CriteriaA AND CriteriaB AND CriteriaC
The criteria operate on over 20 different fields of a transaction record. Each field is specified by a numeric value, in order starting from 1. The SDKs will handle this mapping for you, but if you are using REST directly then you will want to take note of this table:
Index | Field Name |
---|---|
1 | TransactionId |
2 | Amount |
3 | MaskedCardNumber |
4 | CardOwner |
5 | OrderNumber |
6 | IPAddress |
7 | AuthorizationCode |
8 | TransType |
9 | CardType |
10 | Response |
11 | BillingName |
12 | BillingEmail |
13 | BillingPhone |
14 | ProcessedBy |
15 | Ref1 |
16 | Ref2 |
17 | Ref3 |
18 | Ref4 |
19 | Ref5 |
20 | ProductName |
21 | ProductID |
22 | CustCode |
23 | IDAdjustmentTo |
24 | IDAdjustedBy |
There are 6 operators available. They must be encoded:
Operator | Encoded |
---|---|
= | %3D |
< | %3C |
> | %3E |
<= | %3C%3D |
>= | %3E%3D |
Start With | START%20WITH |
This is the value you want to match against.
You can read the errors returned by the API here.