Solidarity sale: donations with the Charitips API

A marketplace seller marks a listing as a charity sale and gives 3 % of the price. The buyer picks the charity after paying and can add an extra; each pays on their own account.

Who paysYour business customers
Starts withA purchase
Tax receiptIn each business customer's name

Needs API access, the B2C use case and the account hierarchy feature on a validated account. Plans

One variant of A sale split between seller and buyer · Retail

3 % of the sale, split between seller and buyer

See every variant

Device

Charities shown as

Outline widget

listings.your-marketplace.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 listing goes live
To come
Your customer does…
Clicks “Publish the listing”.
Your server sends…
No call: your side saves it.
Charitips answers…
Nothing: Charitips is not called at this step.
2When the order is paid: the seller's part
To come
Your customer does…
Clicks “Pay 65,80 €”.
Your server sends…
Creates a 0,90 € donation for order 20931 seller on the campaign “Charity sales”.
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.
3When the order is paid: the buyer's extra
To come
Your customer does…
Clicks “Pay 65,80 €”.
Your server sends…
Creates a 0,90 € donation for order 20931 buyer on the campaign “Charity sales”, paid by Camille Martin with a fiscal receipt in their name.
POSTcreate-donation
Charitips answers…
Charitips records the donation and returns its id: it waits for your customer to pick a charity, and the fiscal receipt will be in Camille Martin's name.
Charitips will then tell your server the donation was created.
4When the charity is chosen
To come
Your 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.
5The buyer's extra follows the same choice
To come
Your customer does…
Sees “The buyer's extra follows the same choice”.
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.

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-child-account create-donation claim-donation

Webhooksdonation_createdonation_update

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
- POST /v1/accounts/{accountId}/child-accountsCreate a child account: once per seller: their own account under yours
- 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 listing goes live
Button: Publish the listing
No call: this screen only shows the result.
02
When the order is paid: the seller's part
Button: Pay 65,80 €
Your server calls:
- POST /v1/donationsCreate a donation: from your server, when it happens; amount in cents
Charitips then sends the donation_create webhook to your endpoint.
03
When the order is paid: the buyer's extra
Button: Pay 65,80 €
Your server calls:
- POST /v1/donationsCreate a donation: from your server, when it happens; amount in cents
Charitips then sends the donation_create webhook to your endpoint.
04
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_update webhook to your endpoint.
05
The buyer's extra follows the same choice
Button: Start again
Your server calls:
- POST /v1/donations/{donationId}/claimClaim a donation: donationId from the create-donation response
Charitips then sends the donation_update 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.

RetailIndependent maker's saleAn independent maker on a marketplace gives 5 % of a piece's price from their studio. The buyer picks the charity at checkout and can add their own extra, on a separate account.5 % of the price from the studio, plus the buyer's extraTry the demoA sale split between seller and buyer: Independent maker's sale

One variant of A sale split between seller and buyer · Retail

How it works

Once, before the first customer

When the listing goes live

When the order is paid: the seller's part

When the order is paid: the buyer's extra

When the charity is chosen

The buyer's extra follows the same choice

Other ways to run it