---
title: Checkout URL - Square
slug: payments/checkout-url-square
docTags: 
createdAt: 2023-11-28T13:52:51.606Z
---

The following properties can be provided to create a Checkout URL in Square. Those marked with <font color="#eb144c">*</font> are required.

### Square Checkout URL&#x20;

| **Field Name**                               | **Data Type** | **Description**                                                                                                                                                                                                                                                                                                                                 |
| -------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ProcessorId<font color="#eb144c">*</font>    | string        | Square Processor Id.                                                                                                                                                                                                                                                                                                                            |
| Action <font color="#eb144c">*</font>        | string        | This will be “*createCheckoutURL*"                                                                                                                                                                                                                                                                                                              |
| locationId<font color="#eb144c">*</font>     | string        | If blank, we will request the “main” location by using this [Retrieve-location](https://developer.squareup.com/reference/square/locations-api/retrieve-location)                                                                                                                                                                                |
| checkoutType<font color="#eb144c">*</font>   | 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)&#x9;
- 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.](https://developer.squareup.com/docs/customers-api/what-it-does#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                        |

