Overview

Square payment link functionality has been added to SalesPad as of version 5.4.14.  This allows users to generate and send Square payment links to customers for their sales orders.  The customer can complete their purchase by following the payment link to a Square checkout page, where they can enter their payment information into Square’s secure webpage.  Once their checkout steps are completed, the payment information is retrieved by SalesPad and used to create a corresponding payment for that sales order.

Review the Get Started with Square Payment Links guide for more information.

Configuration

This guide is for configuring Square payment links.  Please review the Square Integration documentation for general Square configuration in SalesPad.

Security Editor

Sales Document Payments

Open the Security Editor in SalesPad and filter to “sales document payments”. Set the Allow Payment Links sub-security to true and save all changes. Log off and back into SalesPad for the changes to take effect.

Sales Document Entry Plugins

Open the Security Editor and filter to “payment link” to review securities for the following Sales Document Entry plugins:

• Square Create Payment Link

• Square Retrieve Payment Link

• Square Cancel Payment Link

• Square Move Payment Link To History

These plugins can be configured to run automatically in workflow, so each plugin also has a Failed Transaction Queue sub-security.  Documents that fail plugin processing when forwarding through workflow will be moved to this queue for review.

The Square Move Payment Link To History plugin has a Can Move Links Awaiting Payment sub-security.  When enabled, payment links can be moved to history even if they are still awaiting payment.

Make sure the desired plugins are enabled, save your changes, and log off and back into SalesPad for the changes to take effect.

Settings

Open Settings in SalesPad and filter to “Square payment link” to review payment link settings:

Allow Apple Pay - Indicates whether Apple Pay is accepted at checkout. Defaults to false.

Allow Google Pay - Indicates whether Google Pay is accepted at checkout. Defaults to false.

Default Cash Receipt Batch ID - Default Batch ID to be used when creating a cash receipt through the Square payment link.

Default Currency ISO Code - Default ISO Code sent if the document currency is not found. Defaults to USD.

Link Name Format - Format of the link name that will be displayed to the end-user. Defaults to ({Sales_Doc_Type}) {Sales_Doc_Num}.

Order Credit Card Payment Type - The payment type to use for payment link credit card payments for sales orders. Defaults to Credit Card Payment.

Square Authorization

Square payment links require ORDERS_READ and ORDERS_WRITE permissions. It may be necessary to grant access by requesting a new access token in the application settings. If these permissions are not granted, an insufficient permissions error message will appear:

Sending Payment Links

Square currently does not handle automatic emailing of payment links.  SalesPad must be configured to send Square payment links using the Email Template Editor and Smart Printing Maintenance.

Email Template Editor

Open the Email Template Editor screen in SalesPad and create a new sales document email template or select an existing sales document email template.

Click the Insert Sales Document Merge Field dropdown button, select the Square Payment Link option, and select the Link_URL or Link_Long_URL field to add to the template.

Once the field has been added, it will appear in the template:

Save all changes and close the Email Template Editor.

Smart Printing Maintenance

Open the Smart Printing Maintenance screen in SalesPad and create a new configuration or modify an existing configuration.  In the Email Template dropdown, select the email template that was configured in the previous step.  Save all changes and close Smart Printing Maintenance.

Processing Payment Links

Payment Entry Link Creation and Retrieval

In Sales Document Entry, open the Payments window by clicking the Accept Payment button.  Switch to the Square tab if needed, then click the Create Payment Link button to create a new payment link for this sales document.

NOTE: Only one payment link can be created for a sales document at a time.

A prompt will request the amount for the payment link:

Enter the desired amount and click OK to create the link.

Click the Retrieve Payment Link button to retrieve the payment information associated with the payment link.

NOTE: Payment links that are still awaiting payment cannot be retrieved.

Once the payment link is retrieved successfully, the payment will be automatically applied to the sales document, and the payment link information will be sent to history.

Sales Document Entry Plugins

Create Payment Link

The Square Create Payment Link plugin creates a new payment link for the sales document.  Simply select the Square Create Payment Link plugin in Sales Document Entry.  SalesPad will display a notification for whether the payment link creation was successful.

Retrieve Payment Link

The Square Retrieve Payment Link plugin retrieves the payment link information for the sales document from Square, which will update the sales document with payment information if the payment link has been paid.  To manually retrieve an existing sales document payment link, select the Square Retrieve Payment Link plugin in Sales Document Entry.  SalesPad will display a notification for whether the payment link retrieval was successful.

Note: Payment links that are still pending will notify that they are awaiting payment.

Cancel Payment Link

The Square Cancel Payment Link plugin cancels the existing payment link for the sales document.  Simply select the Square Cancel Payment Link plugin in Sales Document Entry.  SalesPad will display a notification for whether the payment link cancellation was successful.

Move Payment Link To History

The Square Move Payment Link To History plugin manually moves payment link information from the open spSquareSalesDocumentPaymentLink table to the historical spSquareSalesDocumentPaymentLinkHistory table and sets the status as Completed.

Simply select the Square Move Payment Link To History plugin in Sales Document Entry.  SalesPad will display a notification for whether the payment link update was successful.

IMPORTANT: Upon successful completion, the Square Retrieve Payment Link and Square Cancel Payment Link plugins will automatically move the payment link to history with the Completed or Canceled status respectively. There is no need to use this plugin unless you cannot complete or cancel an existing payment link and need to create a new one.

Square Checkout

When a customer follows the payment link, they will be greeted with a Square checkout page:

This displays the total amount due for the sales document, and it provides checkout fields for the customer to fill out.  Once the customer completes the payment, the payment link information can be retrieved in SalesPad.

Workflow

The Square payment link plugins can also be triggered automatically in the sales document workflow.  Open the Sales Document Workflow Setup screen in SalesPad and select the document type and ID. For the queue where the action should be triggered, select the desired Square payment link plugin from the Plugin dropdown menu.  Make sure to save all changes.

Automation Agent

Automation Agent has a Square Payment Link job that can be configured to retrieve payment link information from Square automatically on a set schedule.

Open the Automation Lookup screen (requires the Automation Agent DLL) in SalesPad and click the New Automation button.  Select the Square Payment Link platform and click OK to create the job.

The following settings can be configured for the Square Payment Link job:

Audit Awaiting Payment Message - When enabled, the awaiting payment message will be logged to the sales document audit log.  Do not enable this setting if the payment link job is running frequently to avoid unnecessary sales document audit entries.  Defaults to false.

Batches - Semicolon-delimited list of sales document batches that this task will process.  Leave blank to not process open sales documents.

Payment Wait Duration - Duration in days until payment links still awaiting payment are logged to the Action Center.  Set to -1 for an unlimited number of days.  Defaults to 30 days.

Process Historical Invoices - When enabled, historical invoices with payment links will be processed. Defaults to false.

Send To Batch On Fail - Name of the batch to move open sales documents into when the payment link cannot be retrieved.  Leave blank to not move failed sales documents.

Note: After payment links are successfully retrieved by the Square Payment Link job, open sales documents will be automatically forwarded through the workflow.