List all Transactions objects for any individual Account.
Note. This endpoint counts towards your API usage limit for the Transactionz product, as one call.
Headers
| Name | Value |
|---|---|
| Authorization | Bearer {token} |
URL Parameters
| Key | Required | Comment |
|---|---|---|
| fromDate | No. Default to 2018-01-01. | String. Date in format YYYYMMDD (or YYYYMMDDhhmmss), UTC. |
| toDate | No. Default to current UTC timestamp. | String. Date in format YYYYMMDD (or YYYYMMDDhhmmss), UTC. |
| limit | Defaults to 100. | Int. Maximum number of results. Disabled in sandbox. |
| offset | Defaults to 0. | Int. To paginate the results. Disabled in sandbox. |
| pending | No | Boolean. To exclude pending transactions from the response, set it to false. Default is true. |
Response
| Name | Value |
|---|---|
| total | int. Can be used for pagination. |
| transactions | List of JSON objects. |
| transactions[].amount | Float. Amount of the transaction. |
| transactions[].transactionId | String |
| transactions[].description | String. The text descriptor of the transaction. |
| transactions[].merchantName | String. This field is optional. |
| transactions[].category | list of string. Values in the list can be, e.g., “restaurants”, “electronics”. |
| transactions[].currency | String. |
| transactions[].pending | Boolean. |
| transactions[].location | JSON object. |
| transactions[].location.postal_code | string (not always available) |
| transactions[].location.city | string (not always available) |
| transactions[].location.state | string (not always available) |
| transactions[].location.country | string |
| transactions[].location.address | string (not always available) |
| transactions[].datetime | String. Date in format YYYYMMDDhhmmss, UTC. |
Status Code
| Code | Comment |
|---|---|
| 200 | Request OK. |
| 400 | Input data not correct. |
| 401 | User not authorized. |