Stripe payment
Integration with Stripe Checkout (a Stripe-hosted checkout page) enables customers to seamlessly make payments after completing product registrations or claims. This integration simplifies the payment
Overview
Integrate with Stripe Checkout to collect payments seamlessly after form submissions. This integration ensures a smooth and secure transaction experience for your customers.
Key Steps to Set Up the Integration
Obtain the API key from the Stripe admin dashboard.
Customize the Stripe Checkout page in the Stripe admin.
Create a new form for testing purposes.
Add a payment field to the form via the Form's Design section and configure it.
Save the form design.
Test the entire flow from the customer's perspective.
Deploy the integration on a live form once testing is successful.
Tip: Always test thoroughly before going live!
How to Obtain the Stripe API Key
Sign up for a Stripe account if you don’t already have one.
Access the API key in the Stripe dashboard:
Navigate to Developers > API Keys.
Follow the latest Stripe documentation to retrieve your key.
While in the Stripe dashboard, customize the payment checkout page:
Go to Settings > Payments > Checkout.
Configure branding and appearance to match your needs.
Setting Up the Integration
Once you have the Stripe API key, navigate to App Admin > App Settings > Integration > Stripe Payment in your app.
Enter and validate the API key.
Adding the Payment Field
Add the payment field to the form. Note: Only one payment field is allowed per form.
Required Payment Field Details
Product Name: The name displayed to customers on the Stripe Checkout page.
Price: The amount to be charged.
Currency: The currency for the transaction.
You can also configure success and cancellation messages in the payment field options. Once configured, save the form design.
Customer Experience
After saving the form, customers will:
Fill out the form as usual.
Be redirected to the Stripe-hosted payment checkout page upon submission.
Complete the payment using their preferred method (e.g., credit card).
See a success or cancellation message based on the payment outcome.
Note: The product name, price, and description displayed on the checkout page are configured in the payment field.
Emails and Statuses
By default, form submissions are assigned the Requested status (this can be changed in the form's settings).
An email is automatically sent to the customer upon submission (customizable or disable-able in the form's settings).
Payment-Specific Statuses
Once payment integration is enabled, two new statuses are added:
Paid: Automatically assigned when payment is successful.
Unpaid: Assigned when payment fails or is canceled.
To send emails based on payment outcomes, customize the email templates under App Settings > Statuses > Paid/Unpaid.
Why Use Payment Integration?
Payment integration is useful in various scenarios, such as:
Charging for registrations.
Collecting partial payments for claims.
Covering shipping costs for claims.
This integration streamlines the payment process, enhancing both customer experience and operational efficiency.
Last updated