User Interface: Settings

This tab allows you to fine-tune the behavior of the Square extension. It holds the following options:

1. Connection Settings

  • Square Application ID: Your Square application ID, located in your Square dashboard. Please refer to the Integration Settings page for more information.
  • OAuth Application Secret: The authentication secret associated with your Square application, located in your Square dashboard. Please refer to the Integration Settings page for more information.
  • Square OAuth Redirect URL: You cannot modify this setting; it is provided to help you setup your Square application. Please refer to the Integration Settings page for more information.

2. Cron Job Settings

  • CRON methods: Configuration for setting up a CRON job. Please refer to the CRON page for more information.
  • Setup confirmation: Check to confirm that you have setup the CRON job. The extension will not be functional without this confirmation.
  • Send e-mail summary: Enable or disable an e-mail with a summary of actions performed by the CRON job.
  • Send task summary to this e-mail: The e-mail address to which to send the summary e-mail.

3. Basic Settings

  • Location: This setting allows you to select which location from your Square account should be used for all transactions. The extension will not work if you have not setup any locations capable of online card processing.
  • Transaction type: This setting controls whether transactions are carried out automatically upon checkout or whether they require manual capture. Selecting Sale will result in charges being done automatically, while Authorize will result in the store only authorizing the charge, and transactions will need to be captured manually.
  • Order status for Authorized: The status applied to orders when the card transaction has been authorized but not yet captured.
  • Order status for Captured: The status applied to orders when the card transaction was authorized and subsequently captured (i.e., completed).
  • Order status for Voided: The status applied to orders when the card transaction was authorized and subsequently voided (i.e., canceled).
  • Order status for Failed: The status applied to orders when the card transaction failed.
  • Order status for Partially Refunded: The status applied to orders when they have been partially refunded.
  • Order status for Fully Refunded: The status applied to orders when they have been fully refunded.

The order statuses are displayed on OpenCart's administrator order page, under the Square tab.

order_history

4. Extension Status

  • Status: Enable or Disable the Square extension.

5. Advanced Settings

  • Payment method name: This text is the name of the payment method your customers will see during checkout. Default: Credit / Debit Card.
  • Total: The checkout total the order must reach before this payment method becomes active.
  • Geo Zone: Specify the geo zone for which this payment method will be active.
  • Sort Order: The sort order of this payment extension relative to your other active payment extensions.
  • Debug Logging: Use this only for debugging purposes. Enabling this will log the following to your OpenCart error log: notification data, REST API requests, REST API responses.
  • Enable sandbox mode: This settings controls whether the extension should operate in a testing mode, in which no transactions will be carried out and test card numbers will be accepted. Disabling this setting will hide the additional sandbox settings.
  • Sandbox Location: The sandbox location to use for testing.
  • Sandbox Application ID: Your Square application sandbox ID, located in your Square dashboard. Please refer to the Integration Settings page for more information.
  • Sandbox Access Token: The Square sandbox application token, located in your Square dashbord. Please refer to the Integration Settings page for more information.
  • Merchant name: You cannot modify this setting; it is provided for you to verify that you have connected the extension to the Square account you inteded to.
  • Access token expires: You cannot modify this setting; it is provided to let you know when the access token used by the extension to make authenticated calls to Square will expire. If you have not enabled automatic renewal of this token with the CRON job, you will see a warning 5 days before it expires and will have to refresh it manually.