Configuring Square Gateway

To configure the Square Gateway into your LimeLight CRM, you will need to follow a few steps that are described below. 

Step 1: Go to Settings > Providers, click on the 'Actions' drop-down arrow and select "Add New Provider Profile". Click on "Payment" as the provider type and then select Square from the Provider drop-down list. You will then need to fill out the required parameters.

Square_provider_profile.png

These parameters are briefly described here for your reference:

Alias: This will be the name of your profile and will help you identify it among other gateway profiles.

 

Location ID: You will manually need to obtain this from your Square interface.  Please see details below.

Capture On Shipment: This is an optional feature. Set to YES if you will be completing the monetary transaction at the time the order is shipped. Set to NO if you want the standard authorization and capture process for your orders.

Currency: Currently this integration supports: AUD, CAD, GBP, USD, and JPY.

Test Mode : ONLY SELECT if you have a SandBox Account with Square. If set to YES, you must use Limelight's Sandbox Application ID.

  • The Application ID used in the javascript file used to create the nonce in the checkout page should be Limelight's Sandbox Application ID: sandbox-sq0idp-daKjieXHzkmQt4JV2pS3Cg

Once you have configured the profile, you will then need to select 'SAVE.' 

Step 2: Once the profile is saved, you will automatically be redirected to Square where you will need to login:

Square_login_page.png

 

 After entering in your login information and 'Sign In', a new 'Permissions' box will pop up where you will need to click 'Allow' to provide Limelight access. 

Step 3: Once you 'Allow' access, you will be redirected back to Limelight, to the Providers page where your profile is configured, and you will need to enter in the Location ID.  To obtain the 'Location ID', you'll need to navigate to your Square interface, and navigate to Account & Settings > Business > Locations.  The Location ID will shown within the URL as shown below:

Square_location_id.png

Enter the 'Location ID' into your profile in Limelight and then SAVE.   Your profile is now complete, and you can move on to step 4.

Step 4: You will need to insert a Javascript onto your checkout page that you will need to obtain from Square: https://developer.squareup.com/docs/payment-form/payment-form-walkthrough?origin_team=T044SPD88 

Within this Javascript, you will need insert Limelight's Application Key into the 'SqPaymentForm' snipped.

Limelight Production Application ID: sq0idp-daKjieXHzkmQt4JV2pS3Cg 

Once your checkout page has been updated with the Javascript, you can move on to the last step.

Step 5: Add the gateway to your campaigns. To do so, you will need to navigate to Products > Campaigns, and select 'Square' from the 'Credit Card Gateway' drop down within the Gateway Configuration section.

 

 

API NOTES

  • In the NewOrder API request, you will exclude the credit card parameters, but you must submit the parameter "square_token" with the nonce value that you'll get in return from Square in your checkout page.

 

 

ADDITIONAL SQUARE NOTES

  • Payment Routing is supported when using all Square gateways only.
  • Forcing of orders is not supported with this gateway.
  • Cascading is only supported when cascading to and from Square gateways only.