Creates a Square-hosted checkout page.
Open in API Reference
Describes optional fields to add to the resulting checkout page. For more information, see Optional Checkout Configurations.
A description of the payment link. You provide this optional description that is useful in your application context. It is not used anywhere.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
A unique string that identifies this CreatePaymentLinkRequest request. If you do not provide a unique string (or provide an empty string as the value), the endpoint treats each request as independent.
CreatePaymentLinkRequest
For more information, see Idempotency.
Describes the Order for which to create a checkout link. For more information, see Square Order Checkout.
Order
A note for the payment. After processing the payment, Square adds this note to the resulting Payment.
Payment
Describes fields to prepopulate in the resulting checkout page. For more information, see Prepopulate the shipping address.
The buyer address to prepopulate in the payment form.
The buyer email to prepopulate in the payment form.
The buyer phone number to prepopulate in the payment form.
Describes an ad hoc item and price for which to generate a quick pay checkout link. For more information, see Quick Pay Checkout.
The ID of the business location the checkout is associated with.
The ad hoc item name. In the resulting Order, this name appears as the line item name.
The price of the item.
The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.
currency
USD
amount
The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
// No response received yet.