API reference · Donations
Get a donation
GET/v1/donations/{donationId}
Retrieve information about a donation.
Requires a Bearer access token.
Parameters
1 of 5 fields has no description in the spec.
donationId#stringin pathrequiredincludeUrl#booleanin queryInclude the url to the page where the donation can be claimed
includeAssets#booleanin queryInclude dynamic assets such as donation cards and QR code
includeDonor#booleanin queryInclude the donor information
includeChildDonations#booleanin queryInclude the child donations i.e the matched donations to this donation.
Response
200 · DonationNo field is described in the spec.
donationId#stringalways returnedamount#integer (int64)externalId#stringuniqueExternalId#stringstatus#DonationStatusalways returnedPENDINGDONEPROCESSEDCANCELEDsecret#stringalways returnedwithFiscalReceipt#booleanalways returnedhasBeenCharged#booleanalways returnedclaimedAt#string (date-time)validatedAt#string (date-time)processedAt#string (date-time)billingStatus#BillingStatusalways returnedPENDINGBILLEDPAIDhideAmount#booleanalways returnedbilledOn#DonationBilledOnalways returnedCREATIONCLAIMautoAssigned#booleanexpiryDate#string (date-time)sendingMode#CampaignSendingModealways returnedMANUALEMAILPHYSICALSLACKPOSTALsendingDate#string (date-time)sendingStatus#DonationSendingStatusalways returnedPENDINGFAILEDDONEexternalSendingId#stringlastReminderId#stringmessage#stringreminderMessage#stringfrom#stringlanguage#Languagealways returnedfrenptoType#PaidTimeOffTypealways returnedNONEPAID_TIME_OFFWORKING_TIME_REDUCTIONaccountId#stringalways returnedcampaignId#stringalways returnedcharityId#stringrecurringDonationId#stringtransactionId#stringdonorId#stringorderPlatformUserId#stringusageId#stringparentDonationId#stringparentVoteId#stringparentRecurringDonationId#stringcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returned
Errors
400A field is missing, has the wrong type, or is not part of the request schema.
Every request with a body or query is validated.
{ "statusCode": 400, "message": [ "amount must not be less than 1", "property foo should not exist" ], "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }404Not Found
{ "statusCode": 404, "message": "Not Found" }
curl -X GET https://api.sandbox.charitips.com/v1/donations/<donationId> \ -H "Authorization: Bearer $CHARITIPS_TOKEN"Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.