Pro, Business, and Enterprise plans
Setting up a payment gateway is an admin task. Once set up, form authors can add the payment field to forms using existing gateways.
Before you can take payments through a form, you'll need to set up a payment gateway. The payment gateway connects your site and the financial provider so online transactions can be completed in real time.
To use a payment gateway, you must first sign up with your chosen provider to receive the details you need to set it up in OpenForms. After setting up, you and your form authors can add payments to your forms.
Sign Up for a Payment Gateway
There are several payment gateway providers that OpenForms accepts. When you sign up with them, they should provide you with the information you need when setting up in OpenForms. The table below details which providers are available per region, and what information you need from them to set up the gateway.
Financial provider
|
US region
|
ANZ region
|
Set up information
|
ANZ eGate
|
|
✓
|
- Merchant ID
- Merchant access code
- Currency code
|
Authorize.net
|
✓
|
✓
|
- API Login ID
- Transaction key
- Currency code
- Mode - allows your developers to switch between live and test environments. Please contact Authorize.net for this option.
|
BridgePay
|
✓
|
|
- Username
- Password
- Merchant ID
- Merchant Account Code
- Mode - allows your developers to switch between live and test environments. Please contact BridgePay for this option.
To move from a test to a live BridgePay environment, you'll need specific OpenForms transaction information that we can provide to you. BridgePay will let you know the information you need when you request live credentials.
|
Certified Payments
|
✓
|
|
- Bureau Code - determines which sets of additional field mappings (court/property/vehicle) you can use.
- Client ID
- Client Secret
- Mode - allows your developers to switch between live and test environments. Please contact Certified Payments for this option.
|
|
Commbank BPoint
(BPoint Checkout and BPoint Enterprises)
|
|
✓
|
- Merchant Number
- Username
- Password
- Biller code (optional)
- Surcharge percentage applied to all payments (optional)
- Currency code
- Mode - allows your developers to switch between live and test ("UAT") environments. Please contact Commbank BPoint for this option.
|
eWay
|
|
✓
|
- API key
- API password
- Client-side encryption key
- Mode - allows your developers to switch between live and test ("sandbox") environments. Please contact eWay for this option.
|
NAB Transact
|
|
✓
|
- Merchant Id
- Password
- Currency code
- Mode - allows your developers to switch between live and test ("demo") environments. Please contact NAB Transact for this option.
|
Pay Now
|
|
✓
|
- API Username
- API Secret
- PayNow URL
- Payment Message
|
|
Paymentus
(Payments only)
|
✓
|
|
- TLA
- Host name (for example: secure1.paymentus.com)
- Crypt Key
- You must request that Paymentus whitelist our IP addresses for your account. You can find the full list on the Paymentus connector page in OpenForms.
|
|
PayPal
(Paypal Checkout only)
|
✓
|
✓
|
- Client ID
- Client Secret
- Currency code
- Button style
- Mode - allows your developers to switch between live and test environments. Please contact PayPal for this option.
|
Point & Pay
|
✓
|
|
- Partner code
- Product ID
- Username
- Password
- Mode - allows your developers to switch between live and test environments. Please contact Point & Pay for this option.
|
|
POLi
(POLi Checkout only)
|
|
✓
|
- Merchant code
- Authentication code
- Currency code
- Mode - allows your developers to switch between live and test environments. Please contact POLi for this option.
|
|
SecurePay
(Online payments only)
|
|
✓
|
- Merchant ID
- Transaction Password
- Currency code
- Mode - allows your developers to switch between live and test environments. Please contact SecurePay for this option.
|
|
Stripe (legacy)
(Payments only)
|
✓
|
✓
|
- Secret API key
- Currency code
Soon to be deprecated - please use the new Stripe connector below and update your legacy Stripe payment connector to the new one.
|
|
Stripe (new)
(Payments only)
|
✓
|
✓
|
- Publishable API key
- Secret API key
- Currency code
This gateway only supports credit card payment method. To specify this connector in your payment field settings, select the connector in Ways to pay > By another method.
|
Westpac PayWay API
|
|
✓
|
- Username and password from API security settings in PayWay API Portal
- Merchant ID
- Currency code
- Certificate file - please upload the Microsoft .NET (v1.x) API Security Certificate from your PayWay API Portal
- Add our IP addresses to the API security address list within Westpac PayWay Portal. The complete list of IP address is displayed on the Westpac connector page in OpenForms.
If you're using a receipt number prefix in your forms, this must be unique for each form using the Westpac PayWay API.
|
|
Windcave PxPay & Pxpost
(formerly Payment Express)
|
✓
|
✓
|
- User ID - PxPay only
- Key - PxPay only
- Username
- Password
- Currency code
- Mode - allows your developers to switch between live and test environments. Please contact PxPay for this option. - PxPay only
|
Set Up the Payment Gateway in OpenForms
Once you have signed up for a payment gateway and the financial provider has given you the relevant information, you can set it up in OpenForms.
- Go to Integrations > Connectors > Payment gateways.
- Select the payment gateway you want to connect with and select Add.
- Enter the information your provider gave you and any additional transaction data or settings.
Some payment gateways provide an optional Address Verification Service (AVS) as additional transaction validation. If you choose to use it, you must set up your form fields to collect address information and configure the form's payment field to map the address fields to the gateway's custom fields.
- Select Add and it will be listed under Active connections.
- To edit a gateway, select it in the list of Active connections and then make and save your changes. You can also see how many forms are using the connection and select See all to view a searchable list of forms.
With your gateway set up, you and your form authors can add it to your forms using the Payment field.
We recommend testing the gateway by submitting a payment through a preview of your form while logged in as a form author. This will provide you with additional details if the payment fails that you can use to troubleshoot issues. Please note that test payments are still processed, so it's best to test forms with a very small payment.