Returns a collection of transactions.
Important: transactions vs. donations
If you would like to retrieve donation data please use donations.json! This transactions.json is only suitable for some special cases if you need data immediately after the donation.
While a transaction offers raw data from the donation form donations have a higher data quality and are available for manual created donations as well.
Pagination
Maximum is 100 entries, use the page parameter to get the next results.
(with pagination: /transactions.json?page={page_number})
Filter by criteria
GET /transactions.json?amount_min={value}&page={page_number}
Returns a collection of transactions that fits to a given criteria.
These criteria are currently available:
Criterion | Description | Type |
|---|---|---|
token | The unique token of a transaction | string |
amount_min | Minimum amount | float |
amount_max | Maximum amount | float |
date_min | Minimum creation date | date |
date_max | Maximum creation date | date |
fb_type_id | The ID of a payment type | integer |
fb_source_id | The ID of a source | integer |
fb_payment_form_configuration_id | The ID of a payment form | integer |
status | The status | Enum ("awaiting", "confirmed", "processing", "reversed", "failed") |
recurring | 1 when only transactions by recurring should be returned. 0 when only transactions with no recurring should be returned. | boolean |
meta_info | Some content included in the meta information | string |
Example
You can find a transaction by its token with the following request:
GET /transactions.json?token={value}
Meta infos
The data could offer some so called "meta infos". These meta info can contain some useful additional informations. Please take a look at the meta-info section for more details.
Empty result
If no transaction with these criteria exist, an empty transaction container will be returned.