v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

CHECKOUT

Create checkout

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.

post/invoicingcheckoutservice/v1/checkouts

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Merchant-Idstring required

Clover merchant identifier (mid).

Request body

pageConfigUuidstring

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.

Response

Successful response. Checkout session created successfully.

hrefstring

Hosted reference identifier (ID).

checkoutSessionIdstring uuid

Checkout session identifier.

createdTimestring date-time

Time of checkout.

expirationTimestring date-time

Checkout session expiry time.

deletedTimestring date-time

Time when checkout was deleted.