Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 2.83 KB

Checkout.md

File metadata and controls

21 lines (16 loc) · 2.83 KB
Raw

SquareConnect.Checkout

Description

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

Properties

Name Type Description Notes
id String ID generated by Square Checkout when a new checkout is requested. [optional]
checkout_page_url String The URL that the buyer's browser should be redirected to after the checkout is completed. [optional]
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`. [optional]
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. [optional]
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. [optional]
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. [optional]
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. [optional]
order Order Order to be checked out. [optional]
created_at String The time when the checkout was created, in RFC 3339 format. [optional]
additional_recipients [AdditionalRecipient] Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration. [optional]