The Donation Campaigns API creates campaign entities but doesn't process payments. To accept donations, integrate with the eCommerce Cart and Checkout APIs.
Use the Wix eCommerce APIs when you want to customize the donation process, control the checkout experience, or create custom donation flows. This approach provides the same donation features as the built-in Wix Donations app form but with greater flexibility.
Use the eCommerce APIs as much or as little as you need. For example, you can call Add To Cart to add a donation to the cart and let Wix eCommerce handle the rest of the checkout flow by calling Navigate To Cart Page, or you can build a fully custom experience.
To integrate donation campaigns into an eCommerce cart, checkout, or order, use the catalogReference object structure as part of the lineItems array in the following eCommerce API methods:
The catalogReference object for donation campaigns includes the following fields:
| Field | Type | Description |
|---|---|---|
catalogItemId | String | Required. This is the donationCampaignId. |
appId | String | Required. Use the Wix Donations app ID: "333b456e-dd48-4d6b-b32b-9fd48d74e163" |
options | Object | Required. Contains donation-specific settings. |
The options object contains the following fields:
| Field | Type | Description |
|---|---|---|
amount | Number | Required. The donation amount. Must be greater than 0. |
frequency | String | Optional. The recurring donation frequency. Omit this field for one-time donations. See supported frequency values. |
For recurring donations, use 1 of the following frequency values:
| Value | Description |
|---|---|
WEEK | A weekly recurring donation. |
MONTH | A monthly recurring donation. |
YEAR | A yearly recurring donation. |