Create Checkout Session

Creates a new checkout session to initiate a user payment experience.

Idempotency-Keystring required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Request body

namestring required

Title or label for the checkout session. Used for display in customer-facing UIs.

descriptionstring nullable

Optional long-form description explaining the purpose or context of the checkout session.

cancelUrlstring url

The URL to redirect the customer to if they cancel the checkout process before completing payment. This typically returns the user to your site or app with context about the cancellation.

successUrlstring url

The URL to redirect the customer to after successfully completing the checkout. Typically used to confirm the order or show a success message on your site or app.

callbackStatestring nullable

Opaque value sent back via callback for correlating the session. Never exposed in read APIs.

referencestring nullable

Optional external reference identifier (e.g., order ID) used to link this session with the developer’s backend system.

financialAccountIdstring nullable

Financial account where collected funds are settled. Defaults to the main account if omitted.

metadataobject nullable

Key-value pairs for attaching contextual metadata.

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true

v1

Create Checkout Session

Headers

Request body

Response

Use Cases