Checkout URL - Square

2min

The following properties can be provided to create a Checkout URL in Square. Those marked with * are required.
Square Checkout URL 
Field Name
Data Type
Description
ProcessorId* 
string
Square Processor Id.
Action * 
string
This will be “createCheckoutURL"
locationId* 
string
If blank, we will request the “main” location by using this Retrieve-location﻿
checkoutType*  
string
Checkout URLs can be of two types: quick_pay checkout and order_checkout. To differentiate the type of checkout, this field is required.
allowTipping
boolean 
To add tips while creating a payment.
customerId
string
Square Customer Id (Processor Customer Id)	
If specified corresponding transactions will be explicitly linked to the customer
If ignored, the transactions will not be linked to any customer and will result in the creation of instant profiles.﻿
lineItems
object
list of line items (see below) At least one line item is required to create checkout.
Line Items
Field Name
Data Type
Description
Quantity 
string
Quantity
UnitPrice
string
base_price_money.amount
ItemCurrency
string
base_price_money.currency
Name
string
Name
Note
string
Note
﻿

Field Name	Data Type	Description
ProcessorId*	string	Square Processor Id.
Action *	string	This will be “createCheckoutURL"
locationId*	string	If blank, we will request the “main” location by using this Retrieve-location
checkoutType*	string	Checkout URLs can be of two types: quick_pay checkout and order_checkout. To differentiate the type of checkout, this field is required.
allowTipping	boolean	To add tips while creating a payment.
customerId	string	Square Customer Id (Processor Customer Id) If specified corresponding transactions will be explicitly linked to the customer If ignored, the transactions will not be linked to any customer and will result in the creation of instant profiles.
lineItems	object	list of line items (see below) At least one line item is required to create checkout.

Field Name	Data Type	Description
Quantity	string	Quantity
UnitPrice	string	base_price_money.amount
ItemCurrency	string	base_price_money.currency
Name	string	Name
Note	string	Note

Updated 22 Dec 2023

Did this page help you?

Create