The donations API provides several methods to retrieve information about previously submitted transactions.
The following API methods all require standard API authentication headers as described in the main donations API documentation.
Request information about a specific transaction. A transaction Id is provided as an input parameter and the result is the information about the associated transaction. Only transactions which were originally submitted by the authenticated API key can be looked up. A transaction Id which does not exist or that was not created by the requesting user will result in identical 404 failure responses.
GET Input Values
- transactionId – The id of the transaction returned by the original donation POST.
GET Response Values
The possible response fields closely mirror those input from the /donation/creditcard method. Not all possible fields may be returned. E.g., fields which weren’t provided in the original donation request or sensitive credit card information (the FirstGiving donations API never stores client card data). Responses also include fields with information about disbursement (status, paymentStatus, postingDate) and the breakdown of fees for the transaction (commissionFees, ccFees, totalFees, netToOrganization). If the transaction has not been completely processed, these fields may contain a simple string value of ‘FG_UNAVAILABLE’.
It is also possible to get a list of all transaction Id’s.
A maximum of 100 transaction Id’s at a time will ever be returned by this method. If the application has more transactions than this, there is a pagination feature which can be used to return the other transaction Id’s.
Get Input Values
- page – specify the page number to return. The first page number is 1.
- page_size – the maximum number of records to be included in each response (must be smaller than 100)
- date_from – return only transactions created on or after this date. The format of the parameter is a unix timestemp.
- count – this parameter with a value of ‘on’ will return the total number of transaction Id’s rather than the Id’s themselves.
Example /transaction/list with ‘count=on’: