Omeda Stripe Connect Payment Gateway Integration Guide
Welcome to the Omeda Stripe Connect Payment Gateway Integration Guide. This detailed document aims to help you set up and effectively use our Stripe Connect integration, enabling you to accept payments seamlessly within your Omeda account. If you have not yet begun the process, please reach out to your Client Success Manager (CSM) or email sales@omeda.com to start your onboarding. Below, you will find a FAQ section that offers additional insights into frequently asked questions.
Omeda with Stripe Connect Integration Overview
Omeda’s integration with Stripe Connect provides a modern payment gateway that supports all major credit cards and digital wallets like Apple Pay and Google Pay. You can manage everything directly from your Omeda account, including:
Onboarding and applying for a payment gateway
Accessing payment gateway reporting tools
Managing and responding to disputes
Most users can be onboarded and start accepting payments within minutes of completing the application. A dashboard tool is also available for those who prefer a Stripe-hosted dashboard. If you currently use Stripe with our HostedPCI option, you'll need to onboard to Stripe Connect, but we can assist in transferring your PAN data. Please reach out to our support team for information on how to get started with Omeda’s Stripe payment integrations offering.
Customers interested in getting start with our Omeda/Stripe Connect integration can reach out to their account manager or to sales@omeda.com for more information. Once enabled for an customer, admin users on that account can enable access for team members through the "Manage Users" settings. Permissions can be adjusted at varying levels, allowing for controlled access to the feature based on user roles. This ensures that only authorized personnel can utilize the payment processing tool while maintaining oversight and security, while also preventing a single point of failure in case the admin leaves the organization.
Omeda with Stripe Connect FAQs
Onboarding and Gateway Setup
Step 1: Access Self-Service Menu
Click on your name in the upper right corner.
Select Manage Databases from the dropdown menu to access the Self-Service screen.
Users will see a “Manage Database” option in the top right corner when clicking on their user name.
Step 2: Navigate to Payment Gateways
On the left-hand menu, look for Payment Gateways.
Available to users with appropriate permissions, which can be set by Admin users under the “Mange Users” option. If you are using our Stripe Connect gateway and are unable to access this page, please reach out to your CSM or support to confirm you have the correct permissions enabled.
Step 3: Create a Payment Gateway
On the Payment Gateways page, click the Create button in the top right corner.
Upon clicking the “Create” button, users will be prompted to select a specific product or set up their entire database to use this particular gateway. If you need different gateways for each product, you can complete the application workflow and then create additional gateways and configure those with specific products.
a. Additionally, users can update an existing gateway configuration to a different product or apply it to their entire database by clicking the kabab menu (three stacked dots) on the right hand-side of the gateway listing and selecting “Gateway Configuration”:
Complete the application form, which is required for identity verification. This form is managed and secured by Stripe.
You will first be asked for your email and phone number for a two-factor authorization verification system. Once you receive your passcode, make sure to save it. You will use this to re-access the application if need be and to access the gateway reporting. dashboard initially and invite other users.
Prepare to provide information about your business (e.g., business type, ownership structure, etc..) and personal information for the individual completing the application.
The person signing the application at the end should be listed as the representative, this is a legal requirement for verification of identity.
Step 4: Save and/or Submit Application
You can save and exit the application at any time if you need to return later. The application will save information that has been entered every time you click Continue after completing a section of the application. Clicking the “Return to Omeda” button will exit the application and take you back to the Omeda Manage Databases screen.
Once you fill out the application, click Submit. Most applications are approved quickly, but additional information may be requested. If additional information is needed, Omeda and Stripe will both communicate this to you via email or in-app notifications and you will be able to go in and add the missing/requested information.
Step 5: Manage An In-Progress Application
If additional information is needed, click Continue to re-enter and update your details and finish filling out your application.
If you wish to start over, you can delete your in-progress application by clicking Delete.
Step 6: Confirm Gateway Activation
After submission and approval, your Payment Gateways page will display the newly created gateway and its status. Once you have completed set up, please reach out to your CSM to confirm if you have any questions.
An in-progress status is listed for accounts that have not submitted an in-progress application. An active status indicates that the gateway has been approved and is ready for use. You will see your account ID, gateway name, and additional management options. Most customers should see their status update almost instantly upon submission of a completed application.
If you wish to remove an active gateway, please reach out to our customer service team.
Accessing the Stripe Connect Express Reporting Dashboard
Users utilizing our Stripe Connect Gateway option have access to a Stripe-hosted reporting dashboard in addition to the existing reporting tools within our app.
Initial Setup
Passcode: When first creating your gateway, a passcode was set up for accessing your dashboard. Please make sure to note this passcode for future reference. If you cannot remember this passcode, please use the “Forgot Passcode” link for assistance.
User Management: After logging into the Express Dashboard, users can create additional profiles and grant dashboard access to team members. This practice is highly recommended to ensure continuous access in cases of staff changes or forgotten passcodes. This is further outlined below in the “Adding Additional Users” section.
How to Access the Express Dashboard
Navigate to the Payment Gateways page.
Click the kebab menu (three vertical dots) on the right-hand side for the gateway.
Select the Express Dashboard button to access the dashboard for your Stripe account.
Adding Additional Users
Click on the profile icon in the top right corner.
Select the option to Edit the Invite/Remove Team Members section to add additional users to your gateway dashboard.
Add email/phone and name for the team member, then trigger the email invite for them to set up their own login.
Please note, anyone that has access to the dashboard can edit or remove account details.
Account Settings
In the settings area, users can update essential account information, including:
Bank account details
Business information
Signer / Business representative Information
Other relevant account settings
In the settings, customers can also make any required updates if Stripe requests more information from them in order to resume payouts. We have set onboarding up to collect all necessary information, but on rare occasions Stripe might require some additional information to fully validate an account. In these instances, customers will still be able to take payments via Stripe, but the payouts to their bank account will be paused until they provide the outstanding information. Customers will be notified on their dashboard and via email of any outstanding requirements:
Dashboard Features
Once inside the dashboard, users will have access to the following features:
Earnings Overview: View earnings, transaction details, fees, and payout schedules to track performance and understand cash flow.
Payout Management: Access insights into upcoming payouts, including estimated amounts and timing, and manage bank account details for smooth fund transfers.
Transaction History: Review a detailed transaction history, including individual payments, refunds, and disputes for better record-keeping and financial reporting.
Exporting Reports: Users will be able to export a balance and transaction report, and customize which of the available fields they would like to include in that exported report.
Account Settings: Manage personal and business information, updating legal entity details, contact information, and tax settings.
Support Resources: Access support and documentation to troubleshoot issues or learn more about Stripe’s dashboard features.
Customization Options: Personalize the dashboard experience by selecting preferred information displays.
Notifications: Receive alerts and updates regarding account activities, payout statuses, and important changes to stay informed.
Mobile Accessibility: Enjoy a mobile-friendly dashboard that allows account management and information access on the go.
In-App Payments and Disputes Reporting Tool Walkthrough
Navigate to the Payment Gateways Page:
Log in to your account and click on your name in the top right-menu.
Click on Manage Databases.
Select the Payment Gateways page.
Select Your Payment Gateway:
Locate the payment gateway for which you wish to view payments or reports.
Click on the kebab menu (three vertical dots) on the right side of the gateway.
Open the Payments and Disputes Module:
From the dropdown menu, select Payments and Disputes.
A module will pop up displaying a list of recent transactions and disputes management options.
Understanding the Payments and Disputes Module
The module contains two tabs and expanded payment details:
All Tab
Displays all transactions, including:
Successful
Failed
Refunded
Disputed
Pending
Click on any transaction to view detailed information.
This includes details on who made the transaction, the contact information, address information, and and option to refund the payment if needed (more on this below).
Disputes Tab
Shows only transactions that are under dispute currently, along with historical disputes and their resolution details.
Disputes that need a response will prompt you via the module (and also an email to users set up with access to the Stripe Express Dashboard):
Click on a dispute to manage or respond to it.
The module will walk you through responding to disputes:
Transaction Details
When you click on a transaction or dispute, a details window will appear, providing:
Payer information
Response from the card network (if applicable)
Status of disputes (needs response, in-progress, resolved)
Managing Disputes
To manage a dispute:
Click on the dispute you wish to respond to.
Follow the Stripe-hosted workflow to provide your response.
If you have evidence to challenge the dispute, you can upload information directly within the module, completing the dispute management process in-app.
Note: If a dispute is lost and a refund is automatically issued, the customer does not need to update their Omeda database. You would only need to update the customer record in Omeda if you manually refund via the refund button here.
Filtering and Exporting Data
Both the All and Disputes tabs allow you to:
Filter transactions by:
Date ranges
Transaction type
Export transaction data using the available options for each tab.
You can select which of the available fields you would like to include in your export.
Refunding Payments
You can initiate a refund through the Payments and Disputes module.
However, please note that to update the payment status to refunded, you will need to:
Access your Omeda customer record.
Update the payment status for the refunded payment as refunded offline, as the refund option in the module is linked to the gateway payment record and not directly to the Omeda customer record. Refunding a card payment via other refund tools in Omeda will refund on both systems, as normal.
Using the In-App Stripe Connect Account Management Tool
With the Stripe Connect integration, users who possess the necessary view and edit permissions can conveniently modify any Stripe account information directly within the Omeda app. This can be done on the Payment Gateways settings page by navigating to the Manage Account section.
Upon clicking Manage Account, a module will pop up asking the user to login via their Stripe passcode. This is a passcode set up during onboarding or by any user who is added into the Stripe account. It is unique to the user and used by Stripe as an additional security layer. Stripe user access be set up via your Express Dashboard if a user needs to be able to edit account information.
Once you confirm your passcode and log in, the module will reload and show you the individual sections of your account you can edit and update information for. Users will be able to update the professional/business details, the public business information, their personal information, update the payout bank, or enable/disable payout banks.
If any assistance is needed, please reach out to your CSM or our support team.
Using Stripe Payment Element in Form Builder
With the Stripe Connect integration, you can add a direct Stripe checkout option in your Form Builder. Products linked to a Stripe Connect gateway can utilize the new Stripe Payment option, allowing customers to pay via credit card or digital wallets like Apple Pay and Google Pay.
Adding Payment Options
Add the Stripe Payment Element field in your form - for instructions on using form builder, please see the Form Builder Overview help document.
The new element can be found in the left hand accordion under Paid → Payment Fields → Stripe Payment
Drag this element on the form where you want the payment fields to appear
Make sure to include a payment rate on the form as well
Customers will automatically see options for Apple Pay and Google Pay when available (see below for more details).
Using Apple Pay and Google Pay
Apple Pay is available on most modern Apple devices. Customers using Mac with Safari will see this option, as will iPhone and iPad users with iOS 16 or later. For more details, please visit: Apple Pay Support.
Google Pay functions on most Android devices and major browsers. However, it's not supported on some versions of Firefox mobile. Users must be logged into their Google Account and have Google Pay set up to see this option.
Apple Pay and Google Pay require domain registration for webforms. For Omeda forms, simply provide the URLs of the pages you want to enable these options, and we will handle the registration and required files for you. If you are migrating from an existing setup, let us know which URLs to pre-register.
Considerations
Testing Forms with Stripe
Testing a form in a Staging environment: Users can use a dummy credit card when testing both Test and Live forms for the Credit Card fields. Please use: 4242424242424242. Users will have to use real credit cards to test Apple Pay and Google Pay. No charges will be applied to the credit card.
Testing a form in Production: Users will have to use a real credit card number when testing both Test and Live forms for the Credit Card fields, Apple Pay, and Google Pay. No charges will be applied when filling out a Test form.
Stripe payment will only appear on the form if the form is built over a product that is linked to a Stripe Connect gateway.
If you add Stripe Payment to a form that is built over a product that is not setup for Stripe, expect to see the follow error on your form:
Stripe in Audience Search and Customer View
Customers with a Stripe Connect gateway will see the card fields dynamically update to the new Stripe fields when using Audience Search in Paid Mode or Customer View, making off-session transactions through Stripe seamless. For more information about using Audience Search, please see the Audience Search help article. If you have any questions or need further assistance, feel free to reach out to our support team.
Apple Pay and Google Pay options are not available for purchases configured through the Audience Search paid entry mode. Digital wallet options like Apple Pay and Google Pay require the user to authorize the payment at point of service, or if there is a change in term. Apple Pay and Google Pay will work for renewals set up via an online form, they just cannot be used to create new subscriptions or change the payment amount for an existing subscription without the users approval. This is not an Omeda limitation, but rather a security feature implemented by Apple and Google for their digital wallet users.
Table of Contents
- 1 Omeda with Stripe Connect Integration Overview
- 2 Omeda with Stripe Connect FAQs
- 3 Onboarding and Gateway Setup
- 4 Accessing the Stripe Connect Express Reporting Dashboard
- 5 In-App Payments and Disputes Reporting Tool Walkthrough
- 6 Using the In-App Stripe Connect Account Management Tool
- 7 Using Stripe Payment Element in Form Builder
- 8 Stripe in Audience Search and Customer View