---
title: "Payment Gateway"
canonical: "https://bizcore.refined.site/space/BCKB/1830322183/Payment%20Gateway"
format: markdown
---
> Macro (toc)

# **Overview**

The Payment Gateway allows users to share with their customers an easily accessible online portal to make secure payments. Depending on their business needs, users can simply allow once-off transactions or the creation of recurring payment plans as well.

Users can share a link to their Payment Gateway directly with customers, or effortlessly embed it within their existing website.

The Payment Gateway lets individual customers choose the amount and the frequency of their payment.

> ℹ️ In order to share the Payment Gateway with customers, users must have an active API Key. Check [How to Enable an API Key](https://bizcore.refined.site/space/BCKB/1948090409/How+to+Enable+an+API+Key) for help setting it up.

---

# **Payment Gateway Setup**

To setup the Payment Gateway use the sidebar and navigate to **Settings → Payments Module → Payment Gateway**:

![accessing-payment-gateway.gif](media://63bdd74e-b21f-44f5-8db6-9b40f1f79cc1)

## **Create a Payment Gateway**

From this page users can configure the payment gateway, each field is explained below:

- **Payment Page Title**: Users can enter a title that will appear at the top of the Payment Gateway, typically used to display the name of the organisation:

![payment-gateway-page-title.png](media://89eef267-2a65-490c-90ca-51cbbd3656e5)

- **Once Off or Once Off/Recurring**: Users can switch the toggle to alternate between allowing only Once Off payments or both Once Off and Recurring:

![image](media://cda1d992-ff48-4dec-955e-7c133c7c289b)

- **Redirect URL**: Optionally, users can enter a URL where the customer will be redirected to after completing their payment, this could be the organisations homepage, or it can be left blank.

Once users have completed the Payment Gateway setup, they can click **SAVE**, this will briefly display a **Generating URL **loader, once this has finished the Payment Gateway is ready to share:

![image](media://8021bf20-8522-4d2c-84b2-442ca26d1377)

## **Share The Payment Gateway**

From inside the same Payment Gateway settings menu:

- Users click the **Copy URL** icon to add the link to their clipboard:

![image](media://3820aead-bf17-4dee-9b4d-06df5ab37218)

- Users will receive a confirmation message after successfully copying the Payment Gateway URL to their clipboard:

![image](media://94e63e7f-527f-4624-adb5-5b0c9f35ee4a)

Users can now paste this link anywhere to share the Payment Gateway with their customers, such as:

- Social media: Users can post the link directly on social media platforms like Facebook, Twitter, LinkedIn, or Instagram.
- Website integration: Users can attach the link to a button or hyperlink on their website. This enables visitors to easily access the Payment Gateway with a single click.
- QR code: [Generate a QR code](https://www.qr-code-generator.com/) using the link and include it on physical materials, such as brochures, flyers, or posters. When scanned with a smartphone or QR code reader, it will redirect users to the Payment Gateway.

## **Embed The Payment Gateway**

> ℹ️ Users may need to consult with someone who has HTML and/or JavaScript experience for assistance with this step.

With a few simple steps Biz Core will automatically generate the necessary code to embed the Payment Gateway into an existing webpage, using HTML or JavaScript.

From inside the Payment Gateway settings menu:

- Users can click on the Copy Embed Code to generate a HTML `<iframe>` and add it to their clipboard:

![image](media://483fbf0e-764c-40ef-b53e-6f08989e402a)

- Alternatively, you users also copy the Embed JavaScript code. This method ensures that the embedded Payment Gateway will automatically adjust its size to display all the relevant information on the customer's screen without any cropping or scrolling.
- Users will receive a confirmation message after successfully copying either Payment Gateway embed code to their clipboard:

![image](media://b2e01565-a5c2-43cc-8928-1b8dbc5895eb)

![image](media://0d017f40-eefd-48d7-b09a-52ad59537b6e)


Users can now embed the **Payment Gateway** into their existing HTML documents, using `<iframe>` or `<script>` elements or external .js files.

---

# **Using the Payment Gateway**

New or existing customers can now use the Payment Gateway to make secure payments and view or close their active agreement.

Whether users are sharing a URL link or have the portal embedded into their website, this is the process customers will follow while using the Payment Gateway. 

> ℹ️ The order of steps will be slightly different for customers who already have an existing record within Biz Core, and those who are brand new.

## **New Customers**

### **Page 1 - Enter Email/Mobile**

- Customers will first enter their email address or mobile phone number into the text field:

![image](media://3922b20d-d1cc-4afc-8430-ed53698680cb)

### **Page 2 - Register Details**

- New customers will then be required to enter their personal details and contact information, then click **SUBMIT** to proceed:

![image](media://8693bd53-5ff6-454e-b8d8-52c042a29811)

### **Page 3 - Verification**

- Next, new customers will need to verify either their email address or mobile phone number to continue:

![image](media://261a5abd-51bc-4009-b234-e9a26c7e65e1)


- After clicking **SEND SMS **or **SEND EMAIL **they will receive a 6 digit number to enter in the Verification Code field, before finally clicking **VERIFY CODE** to proceed.

### **Page 4 - Setting Up a New Payment**

- Now they are verified, customers will be able to setup the details of their payment agreement. Once Off payments will require the customer to enter the Scheduled Date and the dollar amount of their debit agreement before clicking **ENTER PAYMENT DETAILS** to proceed:

![image](media://79766b7b-0465-4238-888d-4cb0dd3785fb)

- If users have enabled Recurring payments in the Payment Gateway settings, customers can select between Once Off and Recurring:

![image](media://386bfb87-c03a-4f7c-afec-665a90aef492)

- To create a Recurring payment, customers can enter the details of their agreement, inputting a Payment Amount, selecting the Payment Frequency from the dropdown box, and choosing the First Payment Date, before clicking **ENTER PAYMENT DETAILS** to proceed to the next page:

![image](media://38a26ee1-1d96-4bd4-b11c-a136a65ee35c)

- Optionally, they can also input an End Date or No. Payments into the fields to cease the Recurring agreement at a specific date or after a certain number of payments.

### **Page 5 - Payment Details**

- Next customers can select their preferred Payment Method from the dropdown box:

![image](media://7392c341-f54a-45c6-a52d-b50828095aa9)

- Those opting to use a Bank Account will need to enter the details and click **SUBMIT**:

![image](media://7c8972bb-6885-4001-a4aa-11eb16920eed)

- Alternatively, if a customer selects Card from the dropdown box, a secure card payment gateway will appear and allow them to enter their card details, as well as view and agree to the Terms and Conditions, and click **SUBMIT**:

![image](media://1f4b07f3-049e-453b-8b8f-81ddfbaf7700)

> ℹ️ Card payment integration is required. To enable this feature, please contact [support@bizcore.com.au](mailto:support@bizcore.com.au)

### **Page 6 - Review and Complete**

- After submitting their Bank Account details, customers will be able to review a summary of the payment plan, personal information, and payment source. Once they have confirmed their payment is correct they can click the **AGREE** button, which will then prompt them to **SIGN NOW**:

![image](media://6a3abe09-3432-4338-9e53-580e051e319c)

- Customers using a Card will see a similar screen where they can review a summary of their payment agreement, their details and payment source information. Once they’ve confirmed the accuracy of the plan they can click **COMPLETE SETUP** to finish.

![image](media://e7b44af5-4113-4d1e-a25e-cbf85dcc9935)

- Should any of the Payment Plan, Customer or Payment Source details be incorrect, they can click **CANCEL** to start again.

> ✅ Customers who are opting to pay by Card have completed their setup. Any payments scheduled for today will be processed immediately.

### **Page 7 - Payment Authorisation (Direct Debit Only)**

- Customers using their Bank Account as a Payment Method will need to sign a Direct Debit Request Agreement Form. The form will be shown in their browser where they can read it or download a PDF for their reference. Customers then need to tick both checkboxes to confirm they consent to the Terms and Conditions and provide an E-Signature, before finally clicking **SIGN**:

![image](media://65dcf4cd-98b2-459b-8efe-7356aefdd5e1)

> ✅ After clicking **SIGN** customers have completed the setup their Payment Agreement.

### **Page 8 - Success**

New customers will now see a Success message, clicking **FINISH** will take the user to the Redirect URL users have entered in the Payment Gateway settings: 

![image](media://24846260-ed79-46a1-a2e9-e0cbac53c5cf)

## **Existing Customers**

### **Page 1 - Enter Email/Mobile**

- Customers will first enter their email address or mobile phone number into the text field:

![image](media://3922b20d-d1cc-4afc-8430-ed53698680cb)

- Biz Core will match the details entered to an existing record within the portal.

### **Page 2 - Verification**

- To maintain security, the customer will be prompted to verify themselves with Two-Factor Authentication (2FA) by sending a Verification Code to either their mobile phone number or email address:

![image](media://300f9b31-adb0-4214-9c03-7cee7874e057)

- After clicking either the **SEND SMS** or **SEND EMAIL** buttons, the customer will receive a 6 digit number to enter into the Verification Code field, and click the **VERIFY CODE** button to proceed:

![image](media://2174a662-d60b-4b9f-9deb-9cb84887485e)

### **Page 3 - View Existing Payment Agreement(s) and Make Once-Off Payment**

- Once they are verified existing customers can view the Reference number of their current agreement, or if they have multiple, select each of them from the dropdown box to view the details:

![image](media://fc869081-a048-4a38-b43c-6b520b5caa63)

- Customers with ongoing existing agreements are only able to make Once-Off payments, or close the current arrangement to create a new one with different recurring details. They will receive a message explaining this, and be able to click the **CANCEL PAYMENTS **button to create a new agreement while closing their existing one:

![image](media://21ead2c1-756e-43bb-8900-79d5463b9209)

> ℹ️ Once a customer has cancelled their existing recurring agreement, they will be able to re-enter the portal to create their new Direct Debit Agreement, by following the process for a **New Customer**.

- To make a Once-Off payment from this page, customers can use the Toggle to switch between the default option of paying using their existing card or bank details, or using a new method of payment. Importantly, by opting to pay with a new card or bank account, all future recurring payments within their existing agreement will also debit from the new method of payment:

![image](media://cf2f4b3e-7e8f-467c-b603-ae47d64d91cb)

- Furthermore, customers with multiple existing payment sources can select any of these from the dropdown box, or simply leave it set to their default method of payment:

![image](media://6d8b6d43-03e7-4991-8d00-72e2e5c7cb83)

- Finally, they can enter the Scheduled Date for the Once-Off Payment, and the Amount, before clicking **VIEW PAYMENT SUMMARY** to proceed:

![image](media://b74a1bc3-6bda-43e3-ad52-182d4eb8b092)

- Alternatively, customers opting to pay with a new bank account or card will be required to click **ENTER PAYMENT DETAILS** after entering the Scheduled Date and Amount:

![image](media://ed99cd13-5b69-4f11-98ad-1954b8ad0ac5)

- They will then be required to enter their Bank Account information or Card details, before clicking **SUBMIT**:

![image](media://7c8972bb-6885-4001-a4aa-11eb16920eed)

![image](media://1f4b07f3-049e-453b-8b8f-81ddfbaf7700)

### **Page 4 - Review and Complete**

- Existing customers making a Once-Off Payment will now be able to review the Payment Plan Details, their Customer Details and the Payment Source information:

![image](media://6a3abe09-3432-4338-9e53-580e051e319c)

- Those using a Card to make the payment will simply be able to click **COMPLETE SETUP**.

> ✅ Customers who are opting to pay by Card have completed their setup. Any payments scheduled for today will be processed immediately.

- Alternatively, customers using a Bank Account will need to click **AGREE** then **SIGN** to be provided with a new Direct Debit Agreement Form.

### **Page 7 - Payment Authorisation (Direct Debit Only)**

- The form will be shown in their browser where they can read it or download a PDF for their reference. Customers then need to tick both checkboxes to confirm they consent to the Terms and Conditions and provide an E-Signature, before finally clicking **SIGN**:

![image](media://65dcf4cd-98b2-459b-8efe-7356aefdd5e1)

> ✅ After clicking **SIGN** customers have completed the setup their Payment Agreement.

### **Page 8 - Success**

Existing customers will now see a Success message, clicking **FINISH** will take the user to the Redirect URL you have entered in the Payment Gateway settings: 

![image](media://24846260-ed79-46a1-a2e9-e0cbac53c5cf)