Create checkout

post

https://scl-sandbox.dev.clover.com/invoicingcheckoutservice/v1/checkouts

Note: To use this endpoint, please select the API Sandbox server (https://apisandbox.dev.clover.com) from the Base URL dropdown in the right panel.

Creates a hosted checkout payment object to connect an application. Use this endpoint to request a new checkout session for a customer transaction. For more information, see Create a Hosted Checkout session request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Object used to initiate a hosted checkout session.

pageConfigUuid

string

Optional. The universally unique identifier (UUID) for the page configuration. This is especially useful for merchants who operate multiple locations and need a distinct checkout experience for each location. If you do not provide this parameter, the page uses the default configuration for the merchant.

customer

object

Customer details for the checkout.
Note:
1- If merchant uses hosted checkout with the customer information feature enabled (HCO_CUSTOMER_INFO_FEATURE_ENABLED), then it is mandatory to enter the customer’s firstname, lastname, and email address information to create a hosted checkout session. The merchant can also customize which fields are required on the Merchant Dashboard > Account & Setup > Hosted Checkout > Customer Information > Customize.
2- If the merchant uses hosted checkout without enabling the customer information feature, then only the customer's first name or last name or email address is required to create a hosted checkout session.

redirectUrls

object

shoppingCart

object

required

Headers

User-Agent

string

required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

X-Clover-Merchant-Id

string

required

Clover merchant identifier (mid).

Responses

200Successful response. Checkout session created successfully.

defaultUnexpected error.