​

Payments#

Payment integrations are one of the provided integrations with Formie, and are used to capture payments (one-time, or subscription) when users fill out the form.

You can create Payment integrations by going to Formie → Settings → Payments. You can pick from a list of providers Formie supports, and provide details for connecting to their respective APIs. You can also create multiple Payment integrations, in case you need to connect to multiple, different providers.

To use payment integrations in your form, add a Payment field to your form and select the configured integration to use.

​

Supported Providers#

Formie integrates with the following providers:

• BPOINT
• Eway
• GoCardless
• Mollie
• Moneris
• Paddle
• PayPal
• Square
• Stripe
• Westpac PayWay

​

BPOINT#

Follow the below steps to connect to the BPOINT API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select BPOINT as the Integration Provider.

​

Step 2. Connect to the BPOINT API#

1. Log in to the BPOINT API Portal.
2. Copy the Username from BPOINT and paste in the Username field in Formie.
3. Copy the Password from BPOINT and paste in the Password field in Formie.
4. Copy the Merchant Number from BPOINT and paste in the Merchant Number field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select BPOINT for the Payment Provider.

The BPOINT payment integration supports only once-off payments.

​

Eway#

Follow the below steps to connect to the Eway API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select Eway as the Integration Provider.

​

Step 2. Connect to the Eway API#

1. Log in to the Eway Partner Portal.
2. Navigate to My Account → API Key.
3. Copy the API Key from Eway and paste in the API Key field in Formie.
4. Copy the Password from Eway and paste in the API Password field in Formie.
5. Copy the Client Side Encryption Key from Eway and paste in the Client Side Encryption Key field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select Eway for the Payment Provider.

​

GoCardless#

Follow the below steps to connect to the GoCardless API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select GoCardless as the Integration Provider.

​

Step 2. Connect to the GoCardless API#

1. Go to the GoCardless Dashboard (or use the sandbox environment for testing).
2. Navigate to Developers → Developers.
3. Click the Create Access Token button.
4. Copy the Access Token from GoCardless and paste in the Access Token field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select GoCardless for the Payment Provider.

​

Mollie#

Follow the below steps to connect to the Mollie API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select Mollie as the Integration Provider.

​

Step 2. Connect to the Mollie API#

1. Go to the Mollie Dashboard.
2. Navigate to Developers → API keys.
3. Copy the Live API key and/or Test API key.
4. Paste the appropriate key into the API Key field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select Mollie for the Payment Provider.

The Mollie payment integration supports only once-off payments.

​

Moneris#

Follow the below steps to connect to the Moneris API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select Moneris as the Integration Provider.

​

Step 2. Connect to the Moneris API#

1. Go to the Moneris Dashboard.
2. Navigate to Admin → Store Settings.
3. Copy the Store ID from Moneris and paste in the Store ID field in Formie.
4. Copy the API Token from Moneris and paste in the API Token field in Formie.
5. Navigate to Admin → Hosted Tokenization.
6. Enter the domain for your site.
7. Click the Create Profile button.
8. Copy the Profile ID from Moneris and paste in the Profile ID field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select Moneris for the Payment Provider.

The Moneris payment integration supports only once-off payments.

​

Paddle#

Follow the below steps to connect to the Paddle API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select Paddle as the Integration Provider.

​

Step 2. Connect to the Paddle API#

1. Go to the Paddle Dashboard.
2. Navigate to Developer Tools → Authentication.
3. Click the New API Key button.
4. Copy the API Key from Paddle and paste in the API Key field in Formie.
5. Navigate to Client-side tokens.
6. Click the New Client-side Token button.
7. Copy the Token from Paddle and paste in the Client Side Token field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select Paddle for the Payment Provider.

The Paddle payment integration supports only once-off payments.

​

PayPal#

Follow the below steps to connect to the PayPal API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select PayPal as the Integration Provider.

​

Step 2. Connect to the PayPal API#

1. Go to your PayPal REST API application settings.
2. Select either Sandbox or Live and click the Create App button.
3. Enter a App Name and select Merchant for the App Type.
4. Copy the Client ID from PayPal and paste in the Client ID field in Formie.
5. Copy the Secret from PayPal and paste in the Client Secret field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select PayPal for the Payment Provider.

The PayPal payment integration supports only once-off payments.

​

Square#

Follow the steps below to connect to the Square API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select Square as the Integration Provider.

​

Step 2. Create API Credentials#

1. Go to the Square Developer Dashboard.
2. Create a new application or choose an existing one.
3. Navigate to Application → Credentials.
4. Copy the Application ID from Square and paste in the Application ID field in Formie.
5. Copy the Access Token from Square and paste in the Access tToken field in Formie.
6. Navigate to Application → Locations.
7. Copy the Location ID from Square and paste in the Location ID field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select Square for the Payment Provider.

The Square payment integration supports only once-off payments.

​

Stripe#

Follow the below steps to connect to the Stripe API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select Stripe as the Integration Provider.

​

Step 2. Connect to the Stripe API#

1. Go to your Stripe Developers - API Keys page in your Stripe dashboard.
2. On the top-right of your screen, ensure the Test Mode lightswitch is in the off position if you wish to use Live details, or on if you wish to use Test details.
3. Copy the Publishable Key from Stripe and paste in the Publishable Key field in Formie.
4. Copy the Secret Key from Stripe and paste in the Secret Key field in Formie.
5. We strongly recommend you use .env variables to store these keys.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Configure Webhooks (for subscriptions)#

1. In order for subscriptions to work, you must populate some settings for webhooks.
2. In Stripe, on the left-hand sidebar menu, click Developers.
3. On the top sub-menu, click Webhooks.
4. Click the Create an event destination button.
5. Copy the Redirect URI from below and paste in the Endpoint URL in Stripe.
6. Click the Select Events button under the "Select events to listen to" heading.
7. We recommend emitting all possible events, but the required events are:
   • customer.subscription.created
   • customer.subscription.deleted
   • customer.subscription.updated
   • invoice.created
   • invoice.payment_failed
   • invoice.payment_succeeded
   • payment_intent.succeeded
   • payment_intent.payment_failed
   • payment_intent.canceled
   • plan.deleted
   • plan.updated
8. Once created look for the Signing secret item and click Reveal Secret.
9. Copy the Signing secret from Stripe and paste in the Webhook Signing Secret field in Formie.

​

Step 5. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select Stripe for the Payment Provider.

The Stripe payment integration supports both once-off payments and subscription-based payments.

​

Westpac PayWay#

Follow the below steps to connect to the Westpac PayWay API.

​

Step 1. Create the Integration#

1. Navigate to Formie → Settings → Payments.
2. Click the New Integration button.
3. Select Westpac PayWay as the Integration Provider.

​

Step 2. Connect to the Westpac PayWay API#

1. Go to your PayWay account.
2. Click on the Settings navigation item in the top-right of the main header navigation.
3. Click the REST API Keys link.
4. Click the Add button, and select Publishable as the API Key type. Click the Save button.
5. Copy the API Key from Westpac PayWay and paste in the Publishable Key field in Formie.
6. Go back and click the click the Add button, and select Secret as the API Key type. Click the Save button.
7. Copy the API Key from Westpac PayWay and paste in the Secret Key field in Formie.
8. Click on the Settings navigation item in the top-right of the main header navigation.
9. Click the Merchants link.
10. Copy the Merchant ID from Westpac PayWay and paste in the Merchant ID field in Formie.

​

Step 3. Test Connection#

1. Save this integration.
2. Click on the Refresh button in the right-hand sidebar.

​

Step 4. Field Setting#

1. Go to the form you want to enable this integration on.
2. Add a Payment field to your form.
3. Select Westpac PayWay for the Payment Provider.

The Westpac PayWay payment integration supports only once-off payments.