API reference · Donations
Delete a donation
DELETE/v1/donations/{donationId}
Delete a donation. Only donations which weren't billed yet can be deleted
Requires a Bearer access token.
Parameters
This field has no description in the spec.
donationId#stringin pathrequired
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
401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Donation already processed
{ "statusCode": 403, "message": "Donation already processed", "error": "Forbidden" }403Donation card already posted
{ "statusCode": 403, "message": "Donation card already posted", "error": "Forbidden" }403Donation already paid
{ "statusCode": 403, "message": "Donation already paid", "error": "Forbidden" }403Donation already invoiced
{ "statusCode": 403, "message": "Donation already invoiced", "error": "Forbidden" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }403Forbidden
Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.
{ "statusCode": 403, "message": "Forbidden" }404Not Found
No resource with this id on your account: the API answers as if it did not exist.
{ "statusCode": 404, "message": "Not Found" }
curl -X DELETE 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.