!!! Payments & Donations module works for the Adventisten.de design. (2024.11.12)
Notes:
- This document assumes a website has been created! If there's no existing website see creating a website.
- For this module to function, the entity needs to have a working Stripe account.
- The Stripe account can be set in "test" mode initially to make sure everything is working correctly. Then after the testing is completed, move to production mode to receive the real payments.
Steps for setting up for donations
Note: Log into your Stripe account before starting the following work.
In the AWE backend:
Before beginning the work on the Donations module:
- In the entity switcher, click on "Manage your entity"
- Click on the Configuration tab
- Go to the bottom of the tab, section for "Currencies"
- Set the Label to the full description of the currency
- Add the standard Code for the currency
- Click on Update
Setup and Configure the Donations module:
- Expand the menu under Payments & Donations module
- Click on Settings
- Under "Add Payment Method" click on Stripe
- Click on the newly added Stripe payment option, to expand it.
- Fill out the fields of the Payment method:
- Payment Method Name: Provide a name here
- Secret Key: Add secret key from Stripe (search for "api", look for "Developers > API Keys")
- Public Key: Add public key from Stripe
- Setup webhook in Stripe (in Web Engine, follow directions under "Important" section).
- if this is NOT the initial setup of the account, skip to section below "Webhook notes", then come back to these notes!
- Webhook Secret:
- Currency: [Pick currency from the list]
- Maximum donation limit (in cents, pence or equivalent): _(pay attention to in-line help!)_
- Minimum donation limit (in cents, pence or equivalent): _(pay attention to in-line help!)_
- Enable Gift Aid: (for the UK, enable only if it applies)
- Note: For the Email Sender field to be updated, the entity IT admin needs to connect with the HME developers to configure the email settings.
- Email Sender: transactions notifications go to this email, all email to users come from this email.
- Email From Name: overwrites the entity name as it would appear in the email. Also, if website settings for email are set, then the website settings could be used as the title.
- Example: Email Preview: South England Conference <g.smith@adventist.org>
- South England Conference
- <g.smith@adventist.org>
- Click on "Save" button
- Webhook notes: There should be an initial prompt to set this up when you setup the account. After that initial setup, look at the lower left corner for a "Developers" icon. Click on this and click on Workbench > Webhook
- Click on the "Add destination" button in the upper right corner.
- Add the events to the Payment intent section listed under the "Important" section.
- Click on "Continue" button
- Leave the focus on Webhook endpoint and click "Continue" button
- Add the endpoint URL from AWE into the Endpoint URL field
- Click on "Create destination" button
- Webhook secret: On the next screen, find "Signing secret", click on "Reveal" link, paste into field
Projects
Once the Settings for the P&D module are configured, Projects can be added
- Click on the Projects title
- Click on "Add Project" button
- Fill out the fields:
- Title: provide a clear title for what people are donating to
- Code: is automatically filled out:
- Note: Code fields have to be unique across all projects for the entity
- Image: upload a nice image:
- Image format: 4x3 featured, 16x9 non-featured, 4x3 will be cropped when used for non-feature
- Featured: feature the most important projects, or the projects loose revelence
- Church Required: depending on the project, it might be required to select a church.
- Click on "Create" button
Website pages setup
As noted above: The Payments & Donations module currently works only for the Adventisten.de design. Therefore the website must implement the the Adventisten.de design.
On the page where donations should be accepted:
- Locate the container block on the page, where the list of projects should be placed.
- Expand the Payments block. Drag and drop "Cart Donation" into the container block. Then save the page.
- Click on the Cart Donation block.
- Payment Method: select the proper payment method you created.
- Set the redirect page: Redirect to a confirmation page that shows your appreciation and some additional information.
- Gift Aid: _(only displays if checkbox marked)_ Set the Register Page. Add label texts if desired.
- Block labels: use these if you want to override the standard text.
- Confirmation Email Labels: use these if you want to override the standard text.
- Click on page save button.
Testing donations!
- Check the donations page in the frontend to ensure everything is working correctly.
- Verify the amount arrives in the Stripe test account. (use an distinct donation amount)
- For testing:
- Card number: 4242 4242 4242 4242
- Expiration date: 01 / 29 (can be any date after current day)
- Security code: 333 (can be any three digits)
- Test Card numbers: https://docs.stripe.com/testing#cards