Object Index / Definition

You are viewing an old version of the API
Checkout

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

Properties

Name Description
id
string

ID generated by Square Checkout when a new checkout is requested.

additional_recipients
Additional​Recipient [ ]

Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration.

ask_for_shipping_address
boolean

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.

checkout_page_url
string

The URL that the buyer's browser should be redirected to after the checkout is completed.

created_at
string

The time when the checkout was created, in RFC 3339 format.

merchant_support_email
string

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.

order
Order

Order to be checked out.

pre_populate_buyer_email
string

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.

pre_populate_shipping_address
Address

If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields.

Default: none; only exists if explicitly set.

redirect_url
string

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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?