​
Overview

A Checkout Session is dynamically generated through the POST Session API. The API provides a time-limited link to a Clink-hosted checkout page with pre-filled customer information. We recommend creating a new Session for each customer payment intention. Each checkout session can accommodate multiple payment attempts until a successful transaction is completed. Successful transactions can represent either one-time purchases or subscriptions.

​
Session Data

​
Status

  • Open: The checkout session is created but no successful payment has been received
  • Complete: The checkout session has concluded with a successful payment
  • Expired: The checkout session has expired and no further payment attempts are allowed

​
Product & Price

If you have configured products and prices in the dashboard, you can simply reference them using their IDs. For subscription-based recurring payments, pre-created products are mandatory. For one-time purchase products, you can define product details (name, unit price, quantity, etc.) in the priceDataList. The checkout session will display these product details accordingly.

​
Customer

Checkout sessions include pre-filled customer information. You can reference existing customers using their customer ID if they were previously created through the dashboard or API. For new customers, simply provide their email address, and Clink will automatically create a customer profile. The newly created customer ID will be included in the API response.

​
URLs

While optional, we strongly recommend providing success and cancel URLs for post-checkout navigation.

​
Merchant Reference

The merchant reference serves as your internal identifier for tracking purposes. This reference will be recorded on orders created through the checkout session.
Idempotency: Clink does not maintain idempotency based on merchant reference IDs.
These IDs are solely for reconciling Sessions with your internal systems. Multiple checkout sessions created with the same merchant reference ID will be treated as distinct sessions.

​
Return URL

When a success URL is provided during checkout session creation, Clink will redirect customers to the specified address after successful payment. During redirection, Clink appends the session ID as a URL parameter, allowing you to retrieve session data via the Session#Get API. Example return URLs:
  • https://your_success_url.com?sessionId=sess_randoms
  • https://your_success_url.com?custom=xxxxxxxx&sessionId=sess_randoms

​
Customer Experience

Clink provides a streamlined solution with a standardized checkout experience. While customization options are limited, the interface maintains a clean, professional design. Merchant information and the cancel URL are accessible from the top left. Product and price information is displayed based on either dashboard configurations or API inputs. Available payment methods and currencies adapt automatically based on:
  • Purchase type (one-time or subscription)
  • Customer’s geographical location

​
Quick Start Examples

Reference these code snippets to get started: