checkout.md

Checkout

Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareup.com.

Structure

Checkout

Fields

Name	Type	Tags	Description
id	string | undefined	Optional	ID generated by Square Checkout when a new checkout is requested.
checkoutPageUrl	string | undefined	Optional	The URL that the buyer's browser should be redirected to after the checkout is completed.
askForShippingAddress	boolean | undefined	Optional	If true, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: false.
merchantSupportEmail	string | undefined	Optional	The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set.
prePopulateBuyerEmail	string | undefined	Optional	If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set.
prePopulateShippingAddress	Address | undefined	Optional	Represents a postal address in a country. For more information, see Working with Addresses.
redirectUrl	string | undefined	Optional	The URL to redirect to after checkout is completed with checkoutId, Square's orderId, transactionId, and referenceId appended as URL parameters. For example, if the provided redirect_url is http://www.example.com/order-complete, a successful transaction redirects the customer to: http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.
order	Order | undefined	Optional	Contains all information related to a single order to process with Square, including line items that specify the products to purchase. Order objects also include information about any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data.
createdAt	string | undefined	Optional	The time when the checkout was created, in RFC 3339 format.
additionalRecipients	AdditionalRecipient[] | undefined	Optional	Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration.

Example (as JSON)

{
  "id": null,
  "checkout_page_url": null,
  "ask_for_shipping_address": null,
  "merchant_support_email": null,
  "pre_populate_buyer_email": null,
  "pre_populate_shipping_address": null,
  "redirect_url": null,
  "order": null,
  "additional_recipients": null
}