| Authentication | |
| Yes | PRIVATE API Token |
| URI Parameters | |
| status | Status of the transaction, will accept any combination of the following separated by commas: collected, voided, refunded, pending |
| transaction_type | Type of the transaction, will accept any combination of the following separated by commas: sale, credit, offline, recurring, non-payment. Will also accept unique paramater of “errors” which returns transactions with error statuses – “errors” must be the only transaction_type set in the request |
| keyword_type | Type of keyword associated with the transaction, will accept only one of the following: pledging, crowdfunding, social |
| start_date | Date in %m/%d/%y format, will filter transactions to all created on or after start_date |
| end_date | Date in %m/%d/%y format, will filter transactions to all created on or before end_date |
| amount_min | Minimum amount for transactions, accepts decimal format, will filter transactions to all with settled amount greater than or equal to amount_min |
| amount_max | Maximum amount for transactions, accepts decimal format, will filter transactions to all with settled amount less than or equal to amount_max |
| keyword | Keyword associated with the transaction, will perform substring matching |
| phone | Phone number associated with the transaction, will perform substring matching |
| campaign | Campaign associated with the transaction, will perform substring matching |
| last_name | Last name associated with donor on the transaction, will perform substring matching |
| first_name | First name associated with donor on the transaction, will perform substring matching |
| last_4 | Last 4 digits of the credit card associated with the transaction, exact matches only |
| Response Parameters | |
| transaction | |
| Shortcode | |
| Keyword | |
| Type | Type of keyword |
| Volunteer Fundraiser | Name of volunteer fundraiser, if applicable |
| Transaction Date | Date the transaction is authorized with payment processor |
| Donation Date | Date the transaction process began |
| IP Address | IP address of transaction |
| Collected Amount | |
| Pledges Amount | Amount specified in the original text message, should it differ from Collected |
| Cc type | Donor card type (i.e. Visa, Discover, etc) |
| Phone | |
| First name | |
| Last name | |
| Street Address | |
| City | |
| State | |
| Zip | |
| Billing status | Corresponding column for status in params |
| Billing type | Corresponding column for transaction_type in params |
| Donation | Unique ID assigned to the original Donation – recurring transactions from the same Donation will have the same value in this column |
| Billing transaction | Unique ID for the transaction |
| Source | Source of collection (i.e. Paid via Mobile Web, Call Center) |
| Fulfillment Calls | Number of collection phone calls made to donor prior to collection |
| Fulfillment Texts | Number of collection text messages sent to donor prior to collection |
| Memo | Notes taken by call center attendee regarding the collection. Notes from mobile app. |
| Frequency | Frequency of the transaction (i.e. One Time, Monthly, Quarterly, Annually) |
| Anonymous | Yes or No depending on Anonymous checkbox being selected during collection process |
| Custom Columns | Any custom fields that appear on your Forms will appear as columns with the same name |
WINDOWS USERS – Please see note at the end
In order to prevent timeouts we use an asynchronous system – making the API call will return a report ID which you can use to retrieve the report asynchronously
curl -v -D - -H 'Authorization: Token token="[private_api_token_here]"' -H "Accept: application/json" -H "Content-type: application/json" -X GET -d ' {"status":"collected,pending","transaction_type":"sale,credit","amount_min":"50.00"}' "https://fundraise.givesmart.com/api/v2/reports/transactions.json?"
Will return:
{ "id": "[report_id_here]" }
The ID can then be passed like so:
curl -v -D - -H 'Authorization: Token token="[private_api_token_here]"' -H "Accept: application/json" -H "Content-type: application/json" -X GET -d ' {"id":"[report_id_here]"}' "https://fundraise.givesmart.com/api/v2/reports/results.json?"
Please note that the .json suffix here can be replaced with .xml or .csv to have the payload delivered in the desired format
By default these commands will not work on the Windows command prompt as it does not escape double quotes properly. Windows users can use Cygwin to have a Unix-like command prompt, or they can structure the calls to escape the quotes like so:
curl -H "Authorization: Token token=\"[private_api_token_here]\"" -H "Accept: application/json" -H "Content-type: application/json" -X GET -d " {\"status\":\"collected,pending\",\"transaction_type\":\"sale,credit\",\"amount_min\":\"50.00\"}" https://fundraise.givesmart.com/api/v2/reports/transactions.json?
and
curl -H "Authorization: Token token=\"[private_api_token_here]\"" -H "Accept: application/json" -H "Content-type: application/json" -X GET -d " {\"id\":\"[report_id_here]\"}" https://fundraise.givesmart.com/api/v2/reports/results.json?