Payment Gateway: Difference between revisions

Revision as of 08:28, 12 January 2023

The Payment Gateway module, located in the Integrations group, allows Fishbowl to process credit cards using the Stax Pay gateway. The legacy gateways are hidden by default. The Stax Pay gateway will provide many new benefits and features to customers. The setup process is being streamlined and exciting new features are being added.

Setup

Open the Payment Gateway module, located in the Integrations group, and click the Stax Pay logo.
File:Stax Pay button.png
If you already have an active Stax Pay account, click the link at the bottom of the form and then skip to Step 9.
File:Stax Pay setup.png
If you haven't created a Stax Pay account yet, verify the pre-populated data in the form and then click Sign Up.
A browser window will open. Click Reset your password and then enter the email address from the previous step.
File:Stax Pay reset password.png
You will then receive an email that allows you to create a new password and begin your application.
The current status of your application will be displayed inside Fishbowl.
File:Stax Application Status 1.png
If the Underwriting Status is marked as Pended, please click the provided link to add the requested information.
File:Stax Application Status 2.png
When the Underwriting Status is Approved and the Account Status is Active, you will be able to move on to the next step.
After your account is approved, verify that Stax Pay is listed at the top of the module.
File:Stax Pay configured.png
Credit card payments in Fishbowl will now be processed using the Stax Pay gateway.
File:Stax Pay payment.png
Cards can be securely remembered by selecting Store Card on File after entering the card details. That card will then be viewable on the Card on File tab of the Customer module and can be selected when processing future payments.
File:Stax Pay stored card.png
You can also generate payment links to send to your customers, or include on invoices and reports.

Payment links

To generate payment links verify that your Stax Pay account is active and then follow the steps below.

File:Stax Module Options.png

Open the Payment Gateway module, click the Tools menu at the top, and then select Module Options.
Verify that Enable Payment Links is checked and then review the following options:
- Payment Link Invoice Settings - Options related to the online payment page that customers will see
- Allowed Payment Methods - Users can define what type of payment methods their customers can use when a payment is taken online.
- Allow Partial Payments - Users can allow their customer to make a partial payment on the online payment page. This gives the end customer flexibility to pay at different times.
- Allow Tips - Users can allow their customer to add a tip to their payment.
- Payment Link Import - Settings for importing payment data collected on the online payments portal back into Fishbowl Advanced.
- Scheduled Import of Payments into Fishbowl/Time of Day - Users can select a specific time of day that they want payment data retrieved from the payments portal and imported into Fishbowl Advanced.
  Users can also manually run the scheduled task in the Schedule module module at any time.
- Payment Method for Imported Payments - Payments imported will be classified as a particular payment method. This option allows the user to determine which payment method they want to see the payment classified as in Fishbowl.

Troubleshooting

During the setup process, your Stax Pay account information is automatically copied into the Setup window. Below are the steps to manually find this information.

If you need to manually obtain your Stax Pay account information, click here to open the Settings > Account tab in your Stax Pay portal.
File:Stax Pay Merchant ID.png
Copy the Platform ID and paste it into the Merchant ID field in Fishbowl.
Click here to open the Apps > API Keys in your Stax Pay portal.
Click the ADMIN button to expand the main-key.
File:Stax Pay Key.png
Press the Copy button and paste the key into the API Key field in Fishbowl.
On the same page of your Stax Pay portal, copy the Web Payments Token and paste it into the Payment Token field in Fishbowl.

Legacy Gateways

The legacy gateways are hidden by default. For more information about Intuit Payments, Square, Clover Connect, or Authorize.Net, see Legacy Gateways.

@@ Line 11: / Line 11: @@
 # If the '''Underwriting Status''' is marked as '''Pended''', please click the provided link to add the requested information.<br>[[File:Stax Application Status 2.png]]
 # When the '''Underwriting Status''' is '''Approved''' and the '''Account Status''' is '''Active''', you will be able to move on to the next step.
-# {{anchor|Approved}} Now that your account it active, you will copy a few fields from Stax Pay into Fishbowl, as described in the following steps.<br>[[File:Stax Pay account info.png]]
+# {{anchor|Approved}} After your account is approved, verify that '''Stax Pay''' is listed at the top of the module.<br>[[File:Stax Pay configured.png]]
-# Click [https://app.staxpayments.com/#/settings/account here] to open the '''Settings''' > '''Account''' tab in your '''Stax Pay''' portal.<br>[[File:Stax Pay Merchant ID.png]]
+# {{anchor|Card}} [[Sales_Order#Take_a_payment|Credit card payments]] in Fishbowl will now be processed using the '''Stax Pay''' gateway.<br>[[File:Stax Pay payment.png]]
+# Cards can be securely remembered by selecting '''Store Card on File''' after entering the card details. That card will then be viewable on the '''Card on File''' tab of the {{Module|Customer}} and can be selected when processing future payments.<br>[[File:Stax Pay stored card.png]]
+# You can also generate [[#Payment links|payment links]] to send to your customers, or include on invoices and reports.
+==Payment links==
+To generate payment links verify that your Stax Pay account is active and then follow the steps below.[[File:Stax Module Options.png|right]]
+# Open the {{Module|Payment Gateway}}, click the '''Tools''' menu at the top, and then select '''Module Options'''.
+# Verify that '''Enable Payment Links''' is checked and then review the following options:
+#* '''Payment Link Invoice Settings''' - Options related to the online payment page that customers will see
+#* '''Allowed Payment Methods''' - Users can define what type of payment methods their customers can use when a payment is taken online.
+#* '''Allow Partial Payments''' -  Users can allow their customer to make a partial payment on the online payment page. This gives the end customer flexibility to pay at different times.
+#* '''Allow Tips''' - Users can allow their customer to add a tip to their payment.
+#* '''Payment Link Import''' - Settings for importing payment data collected on the online payments portal back into Fishbowl Advanced.
+#* '''Scheduled Import of Payments into Fishbowl/Time of Day''' -  Users can select a specific time of day that they want payment data retrieved from the payments portal and imported into Fishbowl Advanced.<br>Users can also manually run the scheduled task in the {{Module|Schedule}} module at any time.
+#* '''Payment Method for Imported Payments''' - Payments imported will be classified as a particular payment method. This option allows the user to determine which payment method they want to see the payment classified as in Fishbowl.
+==Troubleshooting==
+During the [[#Setup|setup process]], your Stax Pay account information is automatically copied into the '''Setup''' window. Below are the steps to manually find this information.
+# If you need to manually obtain your Stax Pay account information, click [https://app.staxpayments.com/#/settings/account here] to open the '''Settings''' > '''Account''' tab in your '''Stax Pay''' portal.<br>[[File:Stax Pay Merchant ID.png]]
 # Copy the '''Platform ID''' and paste it into the '''Merchant ID''' field in Fishbowl.
 # Click [https://app.staxpayments.com/#/apps/apikeys here] to open the '''Apps''' > '''API Keys''' in your '''Stax Pay''' portal.
@@ Line 18: / Line 39: @@
 # Press the '''Copy''' button and paste the key into the '''API Key''' field in Fishbowl.
 # On the same page of your '''Stax Pay''' portal, copy the '''Web Payments Token''' and paste it into the '''Payment Token''' field in Fishbowl.
-# Click '''OK''' in Fishbowl to complete the integration and then verify that '''Stax Pay''' is listed at the top of the module.<br>[[File:Stax Pay configured.png]]
-# {{anchor|Card}} [[Sales_Order#Take_a_payment|Credit card payments]] in Fishbowl will now be processed using the '''Stax Pay''' gateway.<br>[[File:Stax Pay payment.png]]
-# Cards can be securely remembered by selecting '''Store Card on File''' after entering the card details. That card will then be viewable on the '''Card on File''' tab of the {{Module|Customer}} and can be selected when processing future payments.<br>[[File:Stax Pay stored card.png]]
 ==Legacy Gateways==
 The legacy gateways are hidden by default. For more information about Intuit Payments, Square, Clover Connect, or {{Authorize.Net}}, see [[Legacy Gateways]].