API reference · Donations
Validate a donation
POST/v1/donations/{donationId}/validate
Validate a donation for withDonationsValidation campaign. Will set the donation status to DONE
Requires a Bearer access token.
Parameters
This field has no description in the spec.
donationId#stringin pathrequired
Body
ValidateDonationDtoamount#integer (int64)minimum 1Donation amount in minor currency unit i.e cents.
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
400Donation not claimed yet
{ "statusCode": 400, "message": "Donation not claimed yet", "error": "Bad Request" }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" }403Forbidden
{ "statusCode": 403, "message": "Forbidden" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }404Not Found
No resource with this id on your account: the API answers as if it did not exist.
{ "statusCode": 404, "message": "Not Found" }409Donation already validated
{ "statusCode": 409, "message": "Donation already validated", "error": "Conflict" }
curl -X POST https://api.sandbox.charitips.com/v1/donations/<donationId>/validate \ -H "Authorization: Bearer $CHARITIPS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "amount": 2000 }'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.