Create a checkout session

This API endpoint creates a checkout session for users to make payment for their purchases.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

A unique string to reference the checkout session. This can be an order ID, a cart ID, or something similar generated by the merchant’s side.

paymentMethod
object

The payment method used by the user.

subMerchant
object

⚠️ Required for third-party acquirers. Stores partner's merchant information (lowest level merchant). This will be used to display on our checkout page and e-receipt.

boolean
Defaults to true

An identifier to see if the transaction is a captured transaction. For more information on this capture transaction please refer to the Holding and capturing payments page.

string
required

The total price amount of all items after discounts and taxes are applied.

string
required
Defaults to MYR

The three-letter ISO currency code of the payment. Currently, it only supports MYR.

referenceMeta
object

A class to store additional information about the transaction (e.g: order details, etc.).

customer
object

A class that contains all of the merchant customer’s details.

string

Stores the name of the location or region. Accepted values are: 'en' (English), 'ms_my' (Bahasa Melayu), 'ta' (Tamil), zh_hans (Chinese Simplified), zh_hant (Chinese Traditional).

redirect
object
required

A class that stores URLs to redirect the customer when a session is completed.

webhook
object

The webhook URL to store session information.

string

Additional information provided by partners about the transaction.

string
enum
Defaults to external-service

An identifier to determine the type of transaction or service related to this session.

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json