We are excited to announce our newest eCommerce gateway - Digital Wallet.
If you are looking for easier and more modern ways to let your constituents pay through Encompass, then Digital Wallet is the key.
All Digital Wallet offerings now live under the new "Digital Wallet" Gateway Account.
Currently, Digital Wallet includes 2 merchants.
- PayPal
- Stripe
PayPal provides constituents the ability to pay using their PayPal or Venmo accounts.
Stripe provides constituents the ability to pay using Apple Pay, Google Pay as well as payment methods attached to your browser's autofill options (in Chrome and Edge).
Note: Currently, only Donations/Events/Commerce forms support Digital Wallets for both Stripe and PayPal. Membership supports only Digital Wallet Stripe but not Digital Wallet PayPal.
TABLE OF CONTENTS
- System Requirements
- Mandatory Steps to be Taken on the Day of Release by Existing Customers Who are Using Stripe checkout
- Benefits of Digital Wallets
- Configuring Apple Pay at Stripe
- Configuring Google Pay to Display in Encompass
- Configuring Apple Pay to Display in Encompass
- Saving Credit/Debit Card with Google Chrome to display in Encompass
- Configuring Digital Wallet as a Payment Gateway in Encompass
- Digital Wallet – Primary Vs. Secondary Gateway
- Canceling Recurring Payments
- Branding Stripe Checkout
- FAQs
System Requirements
Digital Wallet Type |
Primary Gateway |
Secondary Gateway |
Apple Pay |
Mac:
iOS:
|
Mac:
iOS:
|
Google Pay |
Desktop / Laptop:
Android Device:
|
Desktop / Laptop:
Android Device:
|
Chrome Pay |
Desktop / Laptop
|
Desktop / Laptop
|
Mandatory Steps to be Taken on the Day of Release by Existing Customers Who are Using Stripe Checkout
Digital Wallet is one of the biggest features releasing in Encompass on the 63.3.0 version. Digital Wallet merges all Digital Wallets into a single gateway. Stripe Checkout and PayPal are now merged in this new gateway.
To successfully implement Digital Wallet, both Encompass and Customers have a certain task to do.
On the day of release follow the below steps (this is specific for Stripe Checkout migration to Digital Wallet):
Customers need Admin access to Stripe along with Encompass to carry out the below steps.
- Encompass team runs the script to successfully merge legacy Stripe Checkout with Digital Wallet.
- Encompass team (Customer Support) adds the URI link https://XYZ/iDBMS/StripeConnectWebhook.aspx, where XYZ is the University base URL that needs to be added in order to connect the Digital Wallet Stripe account for the production URL.
Note: Stripe only support HTTPS. - After a successful merger, Stripe Checkout gets replaced with Digital Wallet in the Gateway Account dropdown.
- Existing customers using Stripe Checkout have to go to the Gold Key Menu > Manage Payment Gateway > Accounts and find the existing Stripe Checkout gateways.
- Click Edit. This opens up the Create a Payment Gateway Account you can see the Payment Gateway is already changed to Digital Wallet.
- Click Enable Stripe and click Save. Save closes the window.
Note: Saving the Payment Gateway before connecting to Stripe is MANDATORY. - Find the same Digital Wallet Payment Gateway Account Name from the list and click Edit at the top right of the Payment Gateway Accounts configuration tab.
- Click Connect with Stripe to connect with your respective Stripe account. This opens up the Stripe page.
- After a successful connection, you are redirected back to Encompass. You see the Connected message next to the Connect with Stripe.
- Click Save, now, you are successfully migrated to the new Digital Wallet.
For more details refer to Configuring Digital Wallet as a Payment Gateway in Encompass.
Benefits of Digital Wallets
The recent updates to Stripe and PayPal utilize the newest connection methods and security protocols. This ensures that Encompass can provide transaction methods that are both PCI and SCA compliant.
Notes: EU/EEA customers, who want to meet certain compliance guidelines due to their geographical location should work with their Stripe Account Manager and Anthology CEM to ensure that you are set up in the best way to meet all rules and regulations.
When Setting up Digital Wallet as your Primary Gateway you are going to:
- Utilize Stripe Checkout which streamlines the online payment process.
- Provides Credit Card, Debit Card, Apple Pay, Google Pay, and saved browser payment methods as different payment options.
- Handles the entire transaction; the transaction takes place within Stripe, and reports back to Encompass.
When setting up Digital Wallet as a Secondary Gateway you are going to:
- Continue to utilize the Encompass workflow when it comes to billing.
- The final step in a donation form displays PayPal (if activated), otherwise, the user gets advanced to the billing page which allows a Credit Card number or shows any Digital Wallets compatible based on the donor's device and Operating Systems.
- Keep transaction details and recurring payment triggers inside of Encompass (Applicable only for Stripe).
To know more about benefits, refer to:
Configuring Apple Pay at Stripe
To add Apple Pay as one of the payment options, you need to configure Apple Pay from Stripe.
To configure:
- Login to your Stripe account with an Admin credential. If an Admin account is not created, you should create the Admin account first.
- Go to Settings from your Stripe Dashboard, from the Payments section click Payment methods.
This takes you to the page where you see a list of payment options provided by the different Payment Gateways. - Find Apple Pay from the list and click Configure.
- Select Add New Domain in the top right and add your domain as step 1 in the form.
As Encompass uses different URL's depending on the form you are in, you need to add two new domains: - One for your site domain (collegex.anthology.com)
- Another for the secure domain (note: this will be securelb.imodules.com (US)/ secureca.imodules.com (CA)/ secureau.imodules.com (AU) for customers with non-branded sites, and the individual secure branded domain for customers using branded sites).
- Ignore steps 2 and 3 and click Save. Anthology hosts all customer sites and has the Stripe verification file stored on our servers.
Once you have added the domain to your Stripe Dashboard, Stripe will reach out to Anthology servers to validate that the file is present.
The validation should be completed instantaneously. After successful validation, you should see the Apple Pay option appear as a payment option when you try to complete a transaction through Encompass.
To use Apple Pay, you should be using a compatible Apple Device, running a compatible OS, and using the Safari browser.
The compatibility document can be found here.
Note: Although Encompass has taken steps to ensure all customers can activate Apple Pay with no impediments, there may be some cases where domains are not verified. For these cases, a bug should be created. Encompass Development team will make the necessary changes and a hotfix will be deployed to resolve the issue.
Configuring Google Pay to Display in Encompass
To add Google Pay as one of the payment options, you need to configure your Chrome browser.
Adding Google Pay gives you the flexibility to donate/pay from Google Pay along with your cards.
To configure Google Pay, you must use Google Chrome browser and follow the below steps:
- Open Google Chrome on your computer.
- Sign in with your Google Account.
- At the top right, click Profile > Payment methods . Or go to chrome://settings/payments
- Click Google Account Under Payment methods, You are now redirected to the Google payment center.
- Click Payment methods, you can see an option to +Add a payment method.
- Select the different payment methods from the list and click Save to continue.
Once you successfully add your card details, you can now donate using your saved card(s).
Configuring Apple Pay to Display in Encompass
Before you start configuring Apple Pay, refer to:
- Supported region Apple Pay supports.
- Supported devices.
- Supported banks.
- The latest version of iOS, watchOS, or macOS.
- An Apple ID signed in to iCloud.
Adding a Card on iPhone
- Go to Wallet and tap .
- Follow the steps on your screen to add a new card.
- Click Next. Your bank/card issuer verifies your information and approves or rejects your request. If your bank/card issuer needs more information to verify your card, you are going to be notified. When you have the information, go back to Wallet and tap your card.
- Click Next after your bank/issuer verifies your card. Your Apple Pay for your iPhone is ready for use.
Refer adding your card to Wallet to know more.
Adding a Card on iPad
- Go to Settings > Wallet & Apple Pay.
- Click on Add Card.
- Follow the steps to add a new card.
- Click Next. Your bank/card issuer verifies your information and approves or rejects your request. If your bank/card issuer needs more information to verify your card, you are going to be notified. When you have the information, go back to Settings > Wallet & Apple Pay and tap your card.
- Click Next after your bank/issuer verifies your card. Your Apple Pay for your iPad is ready for use.
Refer, how to add Apple Card to wallet on your iPad. If you are facing issues adding a card to your wallet, refer here.
Adding a card on Apple Watch
- Open the Apple Watch app on your iPhone, and go to the My Watch If you have multiple watches, choose one.
- Click Wallet & Apple Pay.
- Follow the steps to add a card.
- Click Next. Your bank/card issuer verifies your information and approves or rejects your request. If your bank/card issuer needs more information to verify your card, you are going to be notified. When you have the information, go back to Wallet and Apple Pay and tap your card.
- Click Next after your bank/issuer verifies your card. Your Apple Pay for your Apple Watch is ready for use.
Refer, how to add Apple Card to wallet on your Apple Watch. If you are facing issues adding a card to your wallet, refer here.
Adding a card to your iMac
To add a card to Apple Pay, you need a Mac model with Touch ID. On Mac models without built-in Touch ID, you can complete your purchase using Apple Pay on your eligible iPhone or Apple Watch: On your iPhone, go to Settings > Wallet & Apple Pay and turn on Allow Payments on Mac.
To add a card to your Mac model with Touch ID:
- On your Mac model with Touch ID, go to System Preferences > Wallet & Apple Pay.
- Click Add Card.
- Follow the steps to add a new card.
- Click Next. Your bank/card issuer verifies your information and approves or rejects your request. If your bank/card issuer needs more information to verify your card, you are going to be notified. When you have the information, go back to System Preferences > Wallet & Apple Pay and tap your card.
- After your bank/card issuer verifies your card, click Next. Your Apple Pay for your iMac is ready for use.
Refer, how to add Apple Card to Wallet on your Mac. If you are facing issues adding a card to your wallet, refer here.
Saving Credit/Debit Card with Google Chrome to display in Encompass
To add your credit card/debit card to your Google Chrome as one of the payment options, you need to configure your Google Chrome browser.
Adding a credit card/debit card gives you the flexibility to donate/pay from the Chrome browser.
You must use the Google Chrome browser and follow the below steps:
- On your computer, open Google Chrome.
- Sign in with your Google Account.
- At the top right, click Profile > Payment methods . Or go to chrome://settings/payments.
- Under Payment methods, click Add to add a payment method.
Configuring Digital Wallet as a Payment Gateway in Encompass
To set up Stripe as a Payment Gateway you need to have Payment Gateway Admin rights.
- Hover over the gold key in the top right of Encompass and select Payment Gateways under the Commerce heading.
- Click the Create Payment Gateway Account button under the Accounts tab at the top of the Payment Gateway grid.
- Complete the Payment Gateway Account form as follows:
- Provide a Gateway Account Name.
- Under Payment Gateway, Select Digital Wallets.
You can see two options available as Enable Stripe and Enable PayPal. You can enable any of these two as a part of your Digital Wallet.
Stripe
- Check Enable Stripe and click Save.
Note: You must save the newly created Payment Gateway Account before you connect to Stripe.
Saving closes the Payment Gateway Account window.
- To continue the setup, find the Gateway Account Name from the list and click Edit at the top right of the Payment Gateway Accounts configuration tab.
Clicking Edit opens the Create Payment Gateway Account window.
-
Click the blue Connect with Stripe button.
This redirects you to the Stripe sign-in page where you have to log in with your registered email id and password (admin rights are needed for this connection to be successful). After the successful connection, you are redirected back to the Encompass. You can see your Stripe account is connected with the Payment Gateway. - The country is not a mandatory field and defaults to the US.
- Currency is not a mandatory field and defaults to usd. A list of valid currency options with Stripe can be found here.
Notes: Please note, currency cannot be capitalized. Currency needs to be usd instead of USD.
- Click save, this saves the record and closes the window.
PayPal
- Check Enable PayPal.
- Enter Client ID and Client Secret (refer here to know more).
- Currency is not a mandatory field and defaults to USD.
- Click Save, this saves the record and closes the window.
Stripe and PayPal can both be configured at the same time on the Create Payment Gateway Account page.
After you configure your Digital Wallet Payment Gateway Account, you need to select them as a Primary and/or Secondary Gateway for the form(s) (Donations/Events/Commerce) which is already created.
Notes: Only one Stripe connection you are allowed to connect, if you create a new Stripe Connection, the old Stripe connection goes to WSOD, and any forms connected to the old connections become invalid (as the refresh token is no longer valid). To have both a Stripe and Stripe with PayPal option, you need to copy the Stripe info from the refresh token in the database and add this to your new Stripe account via insert statement (refresh token should be the same).
Customers need to contact Encompass Support team for multiple connections to the same Stripe account. i.e. set up a Digital Wallet with Stripe and another with Stripe & PayPal.
Digital Wallet – Primary Vs. Secondary Gateway
You can see the Apple Pay, or Google Pay button, depending on the device and browser combination supports. If no option is available (this is valid only in the case of Digital Wallets as a Secondary Gateway), you don’t see any button. Supporting Apple Pay requires additional steps by the Encompass Admin, but compatible devices automatically support browser-saved cards, Google Pay, if these are configured by the customer in their browsers.
Apple Pay with the Payment Request Button requires macOS 10.12.1+ or iOS 10.1+.
Primary Gateway |
Secondary Gateway |
Expected Results when Making Transaction |
Digital Wallet ONLY PayPal |
Not Recommended |
Donors/Customers see only the PayPal button for payment. |
Select any Non-Hosted Payment Gateway from the list |
Digital Wallet - ONLY PayPal |
Donors/Customers see both, Primary gateway (selected from the list) and the PayPal button on the Payment options page. |
Digital Wallet - ONLY Stripe |
Not Recommended |
Clicking the Payment button takes Donors to the Stripe page. Stripe Page contains Apple Pay/Google Pay/Debit Card/Credit card options based on the below criteria:
|
Select any Non-Hosted Gateway from the list |
Digital Wallet ONLY Stripe |
You can see the Primary Payment Gateway you have selected along with the Digital Wallet as Secondary Gateways, the results are based on the OS and the browser configuration. Window’s/Android Device Google Pay Configured on Chrome:
Google Pay Not Configured on Chrome but Card details are saved on the browser:
Google Pay Not Configured on Chrome and Card details are not saved in browser:
Google Pay and Card details both are configured and saved on Chrome:
Microsoft Edge:
Apple Device: Customers can securely make payments using Apple Pay on their iPhone, iPad, and Apple Watch. Apple Pay Configured on Safari:
Google Pay Configured on Google Chrome:
Google Pay works only on the Google Chrome browser. Apple Pay/Google Pay Not Configured on Safari or Chrome respectively:
|
Select any Non-Hosted Gateway from the list |
Digital Wallet - both Stripe and PayPal |
By default, the PayPal button is visible in any scenario and any Operating System and devise. Window’s/Android Device Google Pay on Chrome:
Microsoft Edge:
Apple Device: Apple Pay on Safari
Google Pay on Chrome:
|
Digital Wallet - both Stripe and PayPal |
Not Recommended |
|
Points to Remember:
- Donors/customers should have a PayPal account to donate via PayPal.
- If you are adding a Secondary Gateway, the Primary Gateway should be a Non-Hosted/Direct Gateway. You can not select a Hosted Gateway as a Secondary Gateway.
- When the Primary Gateway is Hosted, a secondary Gateway is not supported.
- To know more about the Payment Request button, refer here.
- Once the recurring payment is made using the Digital Wallet Payment Gateways, it is NOT RECOMMENDED to delete the associated Digital Wallet Payment Gateway account from the respective form. For Digital Wallet Stripe, Admin needs to inactive the respective recurring transaction, if not then the recurring transaction will still be in an inactive state, but the recurring transaction won't be processed.
Canceling Recurring Payments
Donors may choose to cancel their recurring payments. If any Donation/Events/Commerce forms have used Digital Wallets, cancellation behaviors are as follows:
Payment Gateways |
Donors/Customers Chose to Cancel Recurring Payment |
Digital Wallet - Stripe |
Donors/Customers can reach out to Institute Admin for inactivation. No cancellation is allowed for Stripe. |
Digital Wallet - PayPal |
Option 1 – Donors/Customers can cancel/inactive the recurring payment from their end by their respective PayPal account. Option 2 – Donors/Customers can reach out to Institute Admin for cancellation/ to inactivate. Note: When Deleting a Digital Wallet PayPal Payment Gateway account, a new warning message now gets displayed. The system is going to ask for deletion confirmation twice. First, when you click Delete, a browser validation pop-up message appears. On confirming OK, a final Warning pop-up message gets displayed. This warning pop-up is going to appear when you are trying to delete Digital Wallet PayPal ONLY (both Primary and secondary Gateways). Clicking the OK button deletes the associated PayPal Payment Gateway account, and cancels all the existing active Digital Wallet PayPal recurring transactions for the respective form. Canceled PayPal recurring transactions cannot be restarted. To restart, Admin needs to create the same Gateway account again with the same configuration of Primary and Secondary Gateway and the donor needs to resubmit the donation form again. |
Any other Payment Gateways |
Donors can reach out to Institute Admin for inactivation. No cancellation is allowed. |
Branding Stripe Checkout
If you would like to make Stripe Checkout more personalized to your institution, you can:
Go to Settings > Checkout Settings > Branding Settings.
This page allows you to upload a logo and icon and customize the color of the Pay button to match your institution’s branding.
By default, the icon is displayed at the checkout. If you want to use your logo, select Use logo instead of icon checkbox under the checkout example.
The next time you make a test transaction and get redirected to your checkout it should now have your institution’s logo and use the color you selected for the Pay button.
You can rebrand:
- Icon
- Logo
- Brand color
- Accent color
- Checkout styling
FAQs
What are the requirements of implementing Digital Wallets as a payment gateway?
You will need the following:
- An active merchant account with Stripe and/or PayPal.
- A bank account belonging to the Institution to link to Stripe and/or PayPal (must be in the same currency you are collecting money in).
- Production Admin user credentials for Stripe.
- Client ID, and Client Secret for PayPal.
For Stripe, being a customer, do I need to do anything to configure the Digital Wallet options?
Encompass currently allows Apple Pay, Google Pay, and saved browser payment methods by default.
No work is needed by you, the customer, to change this. If you want to block Apple Pay or Google Pay, then you can do this from your Stripe Dashboard.
Donors should configure their Chrome browser for Google pay, and Safari browser for Apple Pay (for Apple devices).
For more details refer to:
Can I use PayPal along with Stripe?
Yes. When setting up a Digital Wallet Gateway, you get two merchants to connect to; Stripe and PayPal. Adding your credentials to the PayPal section will allow PayPal to be visible on your payment forms. PayPal either appears on the final step of the form (if using Digital Wallets as Primary Gateway) or under the Payment Methods section on the billing form along with any other compatible Digital Wallets (if using Digital Wallets as Secondary Gateway).
Adding PayPal through the Digital Wallet form pushes payments through PayPal's newer PayPal Express Checkout, vs. the standard PayPal Checkout that is currently in use.
With the newer PayPal Express Checkout feature, users get directed to PayPal from your site, but they don’t complete checkout at PayPal. Instead, users approve a purchase at PayPal, then they are redirected back to your site with a token (this token is passed to your site behind the scenes). The token can be used by your site to submit a final payment to PayPal.
If I want to set up a Stripe account, whom do I contact?
If you wish to set up your Stripe account, please use this link and complete the form. The Stripe Sales team will contact you and walk you through the setup process.
How does reporting differ from other gateways?
When making transactions through the Digital Wallet Gateway, transactions are reported in a similar way to other gateways. The added benefit of Digital Wallets is that we can display the payment type when a transaction runs through Apple Pay, Google Pay pr PayPal.
At my Institution we use Bluefin devices to enter credit card data for processing, is this still an option if we switch to Stripe?
- For customers using Digital Wallets as a Primary Gateway:
- As Stripe is a Hosted Gateway, Bluefin devices are unsupported as the entire transaction takes place within the Stripe checkout form. This is consistent with all other hosted gateways that we support.
- For customers using Digital Wallets as a Secondary Gateway:
- Stripe as a Secondary Gateway only provide access to compatible Digital Wallets (not credit card payments through Stripe). Again, as you are using a Hosted Gateway (Apple Pay or Google Pay) to make the transaction, Bluefin devices are unsupported.
However, you decide to bypass the Stripe payment options and enter credit card information to your Primary Gateway, Bluefin devices will work the same as before (as long as they are on a compatible mode).
For more information on Bluefin devices, please read our support article here.
How can I update my Credit Card details in Stripe?
Stripe has a built-in mechanism for updating credit card details that are expired or have been reported as lost/stolen. All payments made through Stripe are monitored by Stripe and the card details get updated automatically. Because of this, the Manage Card Details form (which allows donors to update their card details when a card expires during a recurring payment schedule) has been disabled for the customers who are using Stripe as their Primary Gateway.
As Stripe is a Hosted Gateway, and all credit card details are encrypted during a transaction, no need to fill out the Manage Card Details form.
If a donor wishes to update/modify their card, and it is not expired or it has not been reported as lost or stolen, then the customers have to reach out to an Admin and complete the transaction again.
I have a Digital Wallet PayPal payment gateway, which has a recurring payment on it, and I mistakenly deleted that. What will happen to the recurring payments which are scheduled?
We DO NOT recommend deleting an existing PayPal payment gateway account that has recurring payment details on it. Doing so, the recurring payment/transaction will get INACTIVATED. If in any case a PayPal payment gateway account gets deleted, Encompass INACTIVATES the existing recurring billing and sends deactivation requests to PayPal. Please note, INACTIVATED transactions cannot be ACTIVATED again.
I have a Digital Wallet Stripe payment gateway, which has a recurring payment on it, and I mistakenly deleted that. What will happen to the recurring payments which are scheduled?
We DO NOT recommend deleting an existing Stripe payment gateway account that has recurring payment details on it. Doing so, the recurring payment/transaction has to MANUALLY INACTIVATE. If in any case a Stripe payment gateway account gets deleted, Admin needs to manually INACTIVATE the existing recurring billing. Admin always has an option to REACTIVATE the INACTIVATED transaction.