Support avatar
Written by Support
Updated over a week ago

September 30, 2019

UPDATED March 1, 2020

To configure  Square Gateway into your sticky.io CRM, you will go to Payments>Gateways, under ACTIONS select Add New Provider Profile.Select the type = Payment/Gateway and select Square from the drop down.Fill out the gateway parameters which are outlined below and click “Save”.

For more information on this Gateway click here https://squareup.com

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 sticky.io's Sandbox Application ID.

The Application ID used in the javascript file used to create the nonce in the checkout page should be sticky.io's Sandbox Application ID: sandbox-sq0idb-wP-devHNBKwM66GNJt12yA

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.

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 CRM access. 

Step 3: Once you 'Allow' access, you will be redirected back to sticky.io, to the Providers page where your profile is configured, and you will need to select the Location ID from the drop-down list.

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/reference/sdks/web/payments

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

Sticky.io 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.


-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.


There are 2 Required Fields on the Merchant Account Details tab. *Descriptor - This will be the MID Descriptor *Customer Service Number - The customer service number assigned to the MID

There is 1 Required Field on the Limits and Fees tab *Global Monthly Cap - This will be the sales amount allowed monthly on this MID

To maximize the efficiency of sticky.io Reporting Analytics we suggest you take a moment and fill out the rest of the fields. These will all be used in sticky.io’s profitability reports.

For field definitions on all of the fields on the Merchant Account Details Tab and the Limits & Fees Tab - click here- overview of gateway providers

Once your gateway profile has been created, then you will go through your campaigns and assign the gateway to the corresponding campaign(s).

Limits and Fees

The Global Monthly Cap is required.The other fields are used by Analytics to give you the best monetary reporting possible.But you need to fill out the fields to capitalize on these reports.These parameters are briefly described here for your reference:

Processing Rate for Visa, MasterCard, Discover, AmEx and Other -This is the percentage charged by the Gateway for each transaction processed.

CVV - Select the Requirement of CVV based on the settings used in your Gateway

Global Monthly Cap - REQUIRED - Maximum amount you can process through this MID per month

Monthly Fee - Set monthly fee charged for statements, processing etc Batch Fee - the fee that is charged when you Settle Daily Transaction Fee - a fixed fee charged for each transaction Chargeback Fee - The Fee that applies when a chargeback is filed Refund Processing Fee - the gateway fee that applies when a refund is processed Reserve Percent - A portion of the credit card volume processed will be secured to cover risk.

Reserve Term - The period of time that volume processing withheld to mitigate risk Reserve Term Days - the number of Days the Reserve is held

Reserve Cap - The maximum amount held in Reserve

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

Did this answer your question?