Happy hour: donations with the Charitips API

A restaurant's charity happy hour puts 5 % of each order into the evening's pot for a named charity. At 8 pm, the till sends the pot as one donation; the restaurant pays.

Who paysYour company
Starts withA purchase
Tax receiptIn your company's name

Needs API access on a validated account. Plans

One variant of A campaign for a date · Hotels and restaurants

5 % of the evening's happy-hour sales

See every variant

Device

order.your-restaurant.example

Step by step

Click through the site. Each step shows what your customer does, what your server sends and what Charitips answers.

1With each order
To come
Your customer does…
Clicks “Send the order”.
Your server sends…
No call: your side saves it.
Charitips answers…
Nothing: Charitips is not called at this step.
2At the end of happy hour
To come
Your customer does…
Clicks “Skip to 8 pm”.
Your server sends…
Creates a 62,80 € donation for happy hour evening 412 on the campaign “Your restaurant”, for the charity your customer picks.
POSTcreate-donation
Reads the campaign's totals.
GETget-campaign-metrics
Charitips answers…
Charitips records the donation and returns its id: it goes to the charity your customer picks at once.
Charitips returns the total given, the number of donations and the most chosen charities.
Charitips will then tell your server the donation was created.

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.

Build spec

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

Callscreate-charities-selection create-campaign activate-campaign create-donation get-campaign-metrics

Webhooksdonation_create

Once, 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
With each order
Button: Send the order
No call: this screen only shows the result.
02
At the end of happy hour
Button: Skip to 8 pm
Your server calls:
- POST /v1/donationsCreate a donation: from your server, when it happens; amount in cents
- GET /v1/campaigns/{campaignId}/metricsGet campaign metrics: what the campaign has received so far, for the gauge
Charitips then sends the donation_create webhook 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.

RetailA date with a budgetA store runs a one-day campaign with a fixed budget, for example 10 000 € on Earth Day. Each order of the day gives 5 €, billed at activation, until the budget runs out.A fixed budget spent on the orders of Earth DayTry the demoA campaign for a date: A date with a budget
RetailFlash saleDuring a two-hour flash sale, a shop gives 5 % of each order into a capped pot. The buyer picks the charity after payment; the shop pays and the price does not change.5 % of the sales during the slotTry the demoA campaign for a date: Flash sale
Software and appsIn-game charity eventA game runs a timed charity event: each challenge cleared adds 0,10 € to a pot for a named charity, up to a set budget. The server sends each hour's pot; the studio pays.0,10 € per challenge, into a capped potTry the demoA campaign for a date: In-game charity event

One variant of A campaign for a date · Hotels and restaurants

How it works

Once, before the first customer

With each order

At the end of happy hour

Other ways to run it