Square Payment Module for Zen Cart [Support Thread]

[dallison]

New store with 1.5.6c version of Zencart. Square payments stopped working with no changes to the site with an error in step 2 of checkout below
"Sorry, we are not accepting payments from your region at this time. Please contact us for alternate arrangements."

I checked the module under admin payments and found a notice there that there was a newer version of the Square login available so I checked my php level and it was 7.2 and installed the new version of the plugin for 5/28/20. After install the button next to the Square Module is yellow not green but shows no errors anywhere and does not ask for anything to be updated. Everything appears to be correct but I still get the same error at checkout.

[DrByte]

"Sorry, we are not accepting payments from your region at this time. Please contact us for alternate arrangements."

That message appears when none of the installed payment modules passes the required checks to be displayed.
Those checks are:
1. Compare the customer's address against any address-restrictions you've set in the module (eg: Payment Zone Restrictions, if it's not set to "(None)": best to leave it at "(None)"). If the setting is not None then the icon will show yellow.
2. The module's status is set to True or Enabled. (It's the first setting in each payment module's configuration settings.) If not set to True then the icon will show yellow.
3. The module's internal checks don't pass, such as perhaps with Square you haven't clicked Edit and chosen your store's defined Location from the dropdown?
4. The customer is shopping in a currency that the module cannot use because the Square Location you set doesn't support any currencies in your Zen Cart store.
5. The module's configuration token has expired (or hasn't been set). Usually you'll see an error in the module settings showing a button to click to re-authorize the module just like during initial setup.

[dallison]

That message appears when none of the installed payment modules passes the required checks to be displayed.
Those checks are:
1. Compare the customer's address against any address-restrictions you've set in the module (eg: Payment Zone Restrictions, if it's not set to "(None)": best to leave it at "(None)"). If the setting is not None then the icon will show yellow.
2. The module's status is set to True or Enabled. (It's the first setting in each payment module's configuration settings.) If not set to True then the icon will show yellow.
3. The module's internal checks don't pass, such as perhaps with Square you haven't clicked Edit and chosen your store's defined Location from the dropdown?
4. The customer is shopping in a currency that the module cannot use because the Square Location you set doesn't support any currencies in your Zen Cart store.
5. The module's configuration token has expired (or hasn't been set). Usually you'll see an error in the module settings showing a button to click to re-authorize the module just like during initial setup.

Thank you very much for the information. Nothing appears to have changed since the upgrade. Customer address is good, module is set to true, location has been selected as default as physical in the square account and as non in the module, as shopping is in USD, there is not message that the token has expired or any mention of it in the module under the Edit or Remove Module Buttons. Should I replace the token within my Square Account and look for a reset message within the module?

[DrByte]

Should I replace the token within my Square Account and look for a reset message within the module?

If the Locations dropdown is not empty when you click Edit on the module, then usually that means the token is fine.
You can also just visit https://your_site.com/square_handler.php in your browser and it will auto-refresh the token if possible. If it fails then in the module Admin page the green "login and authorize" button will appear and the module's status will be set to false.

[dallison]

I reset the token in my square account but don't see anything needed related to this in the admin page for the module. When I did this it did not seem to change anything.
Everything appears to be setup correctly but I have a yellow indicator on the module but all the steps above appear correct. Should I regenerate and replace the application ID and application secret?

[dallison]

I reset the token in my square account but don't see anything needed related to this in the admin page for the module. When I did this it did not seem to change anything.
Everything appears to be setup correctly but I have a yellow indicator on the module but all the steps above appear correct. Should I regenerate and replace the application ID and application secret?

I'm completely stumped here. No idea why the Square app. stopped working with no changes to the site or what to do to get it back up and taking payments. The indicator on the app. is yellow and lists the app as processing and there is no buttons to reset the token or anything, location is set to none. Https is working correctly in checkout. Any help is appreciated. Cannot sell at this point at all.

[DrByte]

I'm completely stumped here. No idea why the Square app. stopped working with no changes to the site or what to do to get it back up and taking payments. The indicator on the app. is yellow and lists the app as processing and there is no buttons to reset the token or anything, location is set to none. Https is working correctly in checkout. Any help is appreciated. Cannot sell at this point at all.

Why it "suddenly stopped" is definitely a mystery. As I wrote earlier, there's only 4 reasons for it to not work:
- wrong credentials or no Location chosen
- no token (button shows with message saying click to get a new token)
- restriction zone set instead of leaving it at none (yellow dot)
- module status set to false/off/disabled (red dot)

Here's what the default settings look like for me:
https://share.getcloudapp.com/xQuLl4W7

[DrByte]

New store with 1.5.6c version of Zencart. Square payments stopped working with no changes to the site with an error in step 2 of checkout below
"Sorry, we are not accepting payments from your region at this time. Please contact us for alternate arrangements."

Questions:
You say "new store", which on the face sounds like "created a new store, which hasn't sold anything yet".
But then you say "payments stopped working".
Granted, you do at least say "... with no changes to the site", which suggests you're thinking the same as me: "if it 'was' working but suddenly 'stopped', what changed?".

The "Sorry, we are not accepting payments from your region at this time. Please contact us for alternate arrangements." message appears when no payment modules are available according to the Store's configuration. This could be because modules aren't installed, or any that are installed are disabled intentionally, or disabled due to misconfiguration (eg expired/missing token, broken communications (curl not available)), or ruled themselves out because the module is configured to only work for certain address zones and the current customer is not in one of those allowed zones.

As discussed, the yellow dot suggests that the module is potentially ruling itself out either because it has zone restrictions specified or because the module has determined its configuration is not complete or accurate (eg: token issues, communications capability issues, no Location set, Location doesn't support the store's default currency).

Things you can check:

1. Token has been set. How to do that? that's all explained on-screen in the module's admin area already. And in the documentation for the module, see the link below.

2. Handler script. The square_handler.php script is used by Square to interact for exchanging tokens. It can also be used by a cron job to keep the token fresh. For troubleshooting you can visit your_site.com/square_handler.php -- it will normally show a blank page, but if you temporarily change the "$verbose=false;" to say true on around line 12 of the file it will tell you tiny clues about what is/isn't happening. It's intentionally very silent when run from a browser, in order to avoid exposing anything that a malicious visitor might want to learn about your site. But if you run it from the command-line (cron job) it'll tell you more about what's happening. It also logs to the /logs/ directory if it has communications problems.

3. Uninstall and Re-install the module using the buttons in the Admin->Modules->Payment screen. Uninstalling using the Remove button should remove all its configuration settings. Then click Install to re-configure all the settings. You'll need to paste all the settings back in again from your Square account, and use the green button to do the token exchange with Square. Then be sure to set the Location by exiting the Admin and then going back in and Editing the module settings to choose the Location from the dropdown and Saving.

Additional troubleshooting can be seen in the module's documentation: https://github.com/zencart/square_pa...ster/README.md

[dallison]

I uninstalled and reinstalled from inside the module and all is solved.
Thank you very much. Everything was installed correctly but something must have corrupted in the installation. Everything works now so far.

[royaldave]

I uninstalled and reinstalled from inside the module and all is solved.
Thank you very much. Everything was installed correctly but something must have corrupted in the installation. Everything works now so far.

I had been running on 0.97 for two years now and, today, in one foul swoop, finally upgraded all the way to 1.5 in one go. I had the same issues you did and thank you for your post because that is what solved it for me as well.

It would be worth including in the upgrade section of the documentation.