PaymentLinks

Lists, Creates, Updates, Deletes payment links.

Table Specific Information

Select

The driver uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the driver.

Retrieve all payment links.

SELECT * from PaymentLinks

Retrieve a particular payment link.

SELECT * from PaymentLinks where id = 'CB45QHA2FDP6C24Q'

Insert

To create a payment link, you will need to specify the Quick Pay columns exposed as pseudo columns.

INSERT INTO PaymentLinks(QuickPayName,QuickPayPriceMoney,QuickPayPriceCurrency,QuickPayLocationId, Description) VALUES('TestPaymentLink@001',350,'USD','92BYHNBR6W77E', 'Hello!!')

Update

To update a payment link, you will need to set current version number of the payment link in the query.

UPDATE PaymentLinks SET Description = 'Demo Description', Version = 4 where Id = 'UN6GN576E3SHVL3R'

Delete

Delete a payment link.

DELETE from PaymentLinks where Id = 'CB45QHA2FDP6C24Q'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Square-assigned ID of the payment link.
Version	Int32	False	The Square-assigned version number, which is incremented each time an update is committed to the payment link.
Description	String	False	The optional description of the payment_link object. It is primarily for use by your application and is not used anywhere.
OrderId	String	True	The ID of the order associated with the payment link.
CheckoutAllowTipping	Boolean	False	Indicates whether the payment allows tipping.
CheckoutCustomFields	String	False	The custom fields requesting information from the buyer.
CheckoutSubscriptionPlanId	String	False	The ID of the subscription plan for the buyer to pay and subscribe.
CheckoutRedirectUrl	String	False	The confirmation page URL to redirect the buyer to after Square processes the payment.
CheckoutMerchantSupportEmail	String	False	The email address that buyers can use to contact the seller.
CheckoutAskForShippingAddress	Boolean	False	Indicates whether to include the address fields in the payment form.
CheckoutPaymentMethodApplePay	Boolean	False	Whether Apple Pay is accepted at checkout.
CheckoutPaymentMethodGooglePay	Boolean	False	Whether Google Pay is accepted at checkout.
CheckoutPaymentMethodCashAppPay	Boolean	False	Whether Cash App Pay is accepted at checkout.
CheckoutPaymentMethodAfterPayClearPay	Boolean	False	Whether Afterpay/Clearpay is accepted at checkout.
CheckoutAppFeeMoneyAmount	Int64	False	The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller.
CheckoutAppFeeMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
CheckoutShippingFeeName	String	False	The name for the shipping fee.
CheckoutShippingFeeChargeAmount	Int64	False	The amount for the shipping fee.
CheckoutShippingFeeChargeCurrency	String	False	The currency for the shipping fee.
CheckoutEnableCoupon	Boolean	False	Indicates whether to include the Add coupon section for the buyer to provide a Square marketing coupon in the payment form.
CheckoutEnableLoyalty	Boolean	False	Indicates whether to include the REWARDS section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.
PrePoulatedDataBuyerEmail	String	False	The buyer email to prepopulate in the payment form.
PrePoulatedDataBuyerPhoneNumber	String	False	The buyer phone number to prepopulate in the payment form.
PrePoulatedDataBuyerAddress	String	False	The buyer address to prepopulate in the payment form.
Url	String	True	The shortened URL of the payment link.
LongUrl	String	True	The long URL of the payment link.
CreatedAt	Datetime	False	The timestamp when the payment link was created, in RFC 3339 format.
UpdatedAt	Datetime	False	The timestamp when the payment link was last updated, in RFC 3339 format.
PaymentNote	String	False	An optional note. After Square processes the payment, this note is added to the resulting Payment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements (unless stated otherwise) and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
QuickPayName	String	The ad hoc item name. In the resulting Order, this name appears as the line item name.
QuickPayPriceMoney	Int64	The price amount of the item, in the smallest denomination of the currency indicated by currency.
QuickPayPriceCurrency	String	The type of currency, in ISO 4217 format.
QuickPayLocationId	String	The ID of the business location the checkout is associated with.

JDBC Driver for Square