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.
The methods allowed for buyers during checkout.
Indicates whether the payment allows tipping.
The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller.
The amount cannot be more than 90% of the total amount of the payment.
The amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see Working with Monetary Amounts.
The fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. For more information about the application fee scenario, see Take Payments and Collect Fees.
To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see Permissions.
Indicates whether to include the address fields in the payment form.
The title of the custom field.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
The email address that buyers can use to contact the seller.
The confirmation page URL to redirect the buyer to after Square processes the payment.
The fee associated with shipping to be applied to the Order as a service charge.
The ID of the subscription plan for the buyer to pay and subscribe.
For more information, see Subscription Plan Checkout.
A description of the payment link. You provide this optional description that is useful in your
application context. It is not used anywhere.
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.
For more information, see Idempotency.
Describes the Order for which to create a checkout link.
For more information,
see Square Order Checkout.
A note for the payment. After processing the payment, Square adds this note to the resulting 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 first line of the address.
Fields that start with address_line provide the address's most specific
details, like street number, street name, and building name. They do not
provide less specific details like city, state/province, or country (these
details are provided in other fields).
The second line of the address, if any.
The third line of the address, if any.
A civil entity within the address's country. In the US, this
is the state. For a full list of field meanings by country, see Working with Addresses.
A civil entity within the address's administrative_district_level_1.
In the US, this is the county.
A civil entity within the address's administrative_district_level_2,
The address's country, in the two-letter format of ISO 3166. For example, US or FR.
Optional first name when it's representing recipient.
Optional last name when it's representing recipient.
The city or town of the address. For a full list of field meanings by country, see Working with Addresses.
The address's postal code. For a full list of field meanings by country, see Working with Addresses.
A civil region within the address's locality, if any.
A civil region within the address's sublocality, if any.
A civil region within the address's sublocality_2, if any.
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.
The type of currency, in ISO 4217 format. For example, the currency
code for US dollars is USD.
// No response received yet.