Contribution flow
The contribution flow is how users support a community on Donate PR. The Contribution flow can be directly accessed via this link: e.g. https://donatepr.com/cai/donate
Replace 'webpack' with your community slug to generate your own.
URL parameters
The contribution flow supports many URL parameters to pre-fill the contribution.
Example: https://donatepr.com/cai/donate/profile?amount=66.66&interval=month.
This link will bring you directly to the profile step of the contribution flow for webpack, with a monthly contribution of $66.66.
| name | type | description | default | example |
|---|---|---|---|---|
| amount | Default contribution amount |
| |
| integer | Default number of units (for products and tickets only) | 1 |
|
| interval | The contribution interval (must be supported by the selected tier, if any) |
| |
| string | ID of the payment method to use. Will fallback to another payment method if not available. | ||
| string | Slug of the default profile to use to contribute | Logged in user personal profile | |
| string | Guest contributions only: The email to use to contribute |
| |
| string | Guest contributions only: The name to use to contribute |
| |
| string | Guest contributions only: The legal name to use to contribute |
| |
| comma-separated list | To disable specific payment method types |
| |
| string | The URL to redirect to after a successful contribution |
| |
| comma-separated list | Some tags to attach to the contribution |
| |
| boolean | To hide the steps on top. Will also hide the "previous" button on step payment | ||
| string | Cryptocurrency type; BTC, ETH etc | ||
| float | Cryptocurrency amount | ||
| boolean | Embed only: Whether we need to hide the right-column FAQ | false |
|
| boolean | Embed only: Whether we need to hide the contribution flow header | false |
|
| color | Embed only: A custom color to use as the background color of the contribution flow |
| |
| boolean | Embed only: Whether to use the community theme (custom colors) | false |
|
| boolean | Embed only: Whether to redirect the parent of the iframe rather than the iframe itself. The | ||
its | ||||
| alias | Deprecated: Use |
| |
| alias | Deprecated: Use | ||
| alias | Deprecated: Use |
Embed Contribution flow
To integrate a "Contribute" option directly on your website
The embed contribution flow is a way to integrate Donate PR on your own website. Visitors will be able to contribute directly, by simply providing an email address.
General considerations
The widget will look better if it has some space, ideally the full page height & width
Some parameters can be used to customize the UI. See URL Parameters above
Embed the default tier (Donate)
The simplest way to embed the contribution flow is by using the /donate URL (e.g. https://donatepr.com/babel/donate). Just replace COLLECTIVE_SLUG by your community slug below:
Embed a specific tier
To embed a specific tier, you'll need to know its ID. For that, go to your profile page, click on "Contribute" for the tier you want to embed then check the URL. It should look like https://donatepr.com/COLLECTIVE_SLUG/contribute/TIER_SLUG-TIER_ID/checkout
From this URL, you can deduct the embedded one (prefix with embed and removes /checkout):
Embed an event ticket
Embedding for event tickets uses the same route as regular tiers. you must make sure to remove the parent community path and to include a slug. The slug can be anything, so if you're not sure feel free to put any value in there. For example, this path:
https://donatepr.com/mautic/events/test/order/32898
can be embedded as:
https://donatepr.com/embed/test/contribute/general-access-ticket-32898
Last updated