Energy contract referral: donations with the Charitips API
An energy supplier gives 10 € once a referred friend's contract is active, after the cooling-off period. The referrer picks the charity on their referrals page; the supplier pays.
- Who paysYour company
- Starts withA customer action
- Tax receiptIn your company's name
Needs API access on a validated account. Plans
One variant of A donation for an achievement · Energy
10 € once the referred contract is active
See every variantreferrals.your-energy.example
Step by step
Click through the site. Each step shows what your customer does, what your server sends and what Charitips answers.
1When the friend's contract goes live
To comeYour customer does…
Clicks “Activate Léa's contract”.
Your server sends…
Creates a 10 € donation for referral #871 on the campaign “Your energy supplier”.
POSTcreate-donation
Charitips answers…
Charitips records the donation and returns its id: it waits for your customer to pick a charity.
Charitips will then tell your server the donation was created.
2When the charity is chosen
To comeYour customer does…
Clicks “Choose the charity”.
Your server sends…
Assigns that donation to the charity your customer picks.
POSTclaim-donation
Charitips answers…
The donation now goes to the charity your customer picks.
Charitips will then tell your server the donation was updated.
How to read this demo: the site shows what your customer does, and the panel what your server sends and what Charitips answers, step by step.
The site is made up and nothing is sent. The endpoints, fields and webhook events are the real ones, and so are the charities.
How it works
The screens of the demo in order, with the calls your server makes at each one. Its build spec
donation_createdonation_updateOnce, before the first customer
- POST /v1/charities-selectionsCreate a charities selection: once: the charities you offer, from the catalog
- POST /v1/campaignsCreate a campaign: once: the campaign the donations go to
- POST /v1/campaigns/{campaignId}/activateActivate a campaign: once: the campaign starts taking donations
01
When the friend's contract goes live
Button: Activate Léa's contract
Your server calls:
- POST /v1/donationsCreate a donation: from your server, when it happens; amount in cents
Charitips then sends the
donation_createwebhook to your endpoint.02
When the charity is chosen
The customer picks a charity from your selection. Button: Choose the charity
Your server calls:
- POST /v1/donations/{donationId}/claimClaim a donation: donationId from the create-donation response
Charitips then sends the
donation_updatewebhook to your endpoint.
Other ways to run it
The same calls in other sectors and products. Each card opens its own page, with its demo.
- Software and appsCustomer referralA product gives 10 € when a referred friend signs up. The referrer picks the charity upfront, so every invite names it; the friend's own welcome gift waits for their choice.10 € when the friend signs upTry the demoA donation for an achievement: Customer referral
- Professional servicesLease signed onlineA rental agency gives 3 € for each lease signed online. On the last step before the keys, the tenant signs and picks the charity on the success screen; the agency pays.3 € for each lease signed onlineTry the demoA donation for an achievement: Lease signed online
- EducationCertification passedA training provider gives 5 € for each certification passed. When the jury publishes the results, the certified candidate picks the charity on their results page.5 € for each certification passedTry the demoA donation for an achievement: Certification passed
- Software and appsSurvey completedA SaaS gives 0,50 € for each in-app survey completed. Three questions, two minutes, then the user picks the charity on the thank-you screen; the company pays.0,50 € for each survey completedTry the demoA donation for an achievement: Survey completed
- Travel and mobilityUnused rental kilometresA car rental company gives 5 cents for each kilometre left in the allowance at return. The renter picks the charity on the return screen; the rental company pays.0,05 € per kilometre not drivenTry the demoA donation for an achievement: Unused rental kilometres
- Hotels and restaurantsUnused buffet portionsA caterer counts the portions not served after a seminar and gives 1 € for each. The client approves the buffet report and picks the charity; the caterer pays.1 € per portion saved, after the eventTry the demoA donation for an achievement: Unused buffet portions
- Banking and insuranceInsurance deductible settledAn insurer gives 5 % of the excess when the policyholder pays it to close a claim. The policyholder picks the charity on the claim's closing screen; the insurer pays.5 % of the deductible, on each settled claimTry the demoA donation for an achievement: Insurance deductible settled
- Hotels and restaurantsHousekeeping skippedA hotel gives 1 € for each day a guest skips housekeeping. At check-out the guest sees the total and picks the charity; the hotel pays and nothing appears on the bill.1 € per day without housekeeping, at check-outTry the demoA donation for an achievement: Housekeeping skipped
- Travel and mobilityShared ride completedA ride-hailing app gives 0,50 € each time a passenger shares the ride. On arrival, the passenger picks the charity on the receipt screen; the platform pays.0,50 € per shared rideTry the demoA donation for an achievement: Shared ride completed
- Software and appsNew seller's first listingA marketplace gives 5 € when a new seller publishes a first listing within a week. The seller picks the charity on the publish confirmation; the marketplace pays.5 € when a new seller lists within a weekTry the demoA donation for an achievement: New seller's first listing
- Professional servicesCharity clause in a contractA law firm adds a charity clause to its contracts: article 14 names the charity, and each signature gives 2 €. The donation is created already assigned; the firm pays.2 € per contract signed, to the charity the clause namesTry the demoA donation for an achievement: Charity clause in a contract
- Culture and eventsFestival ticketsA festival gives 1 € per ticket sold, paid by the festival. Right after payment, the buyer picks the charity on the order confirmation; the ticket price does not change.1 € per ticket, chosen after paymentTry the demoA donation for an achievement: Festival tickets
- Professional servicesProperty sale completedAn estate agency gives 1 % of the sale price at completion, taken from its own fee. The seller picks the charity on the completion page; what they receive does not change.1 % of the sale price, from the agency's feeTry the demoA donation for an achievement: Property sale completed
- Software and appsProject milestones delivered earlyA project tool gives 10 € each time a team delivers a milestone ahead of its date. The team picks the charity when the milestone closes; the company pays.10 € per milestone delivered earlyTry the demoA donation for an achievement: Project milestones delivered early
- Software and appsStand-up streakA team tool gives 5 € when a team holds 10 daily stand-ups in a row on time. The team picks the charity when the streak milestone is reached; the company pays.5 € for every 10 stand-ups on timeTry the demoA donation for an achievement: Stand-up streak
