Create Checkout Session

Body Params
string
enum
Defaults to payment
Allowed:
int32
required
Defaults to 1000

Amount to pay, represented as an integer. This value must always be greater than 0 and less than 7,000,000, which is the maximum amount allowed by any bank.

string
required
Defaults to CLP

Currency ISO code. For now, we only support CLP and MXN.

string
Defaults to [email protected]

A customer email linked to a Checkout Session. This is used to notify a user in case of a refund.

string

ISO 8601 format (YYYY-MM-DD) timestamp that indicates when the session will expire

json
Defaults to {"order":"123456"}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

string
Defaults to https://merchant.com/success

URL to redirect the user in case of payment succeeded. Required if you want to use the redirection payment flow.

string
Defaults to https://merchant.com/cancel

URL to redirect the user in case they decide to cancel the payment and return to your website. Required if you want to use the redirection payment flow.

customer
object

Information about the customer of the session

payment_method_types
array of strings

Optional definition of the available payment method(s) for the session. Methods current available are bank_transfer and card

payment_method_types
payment_method_options
object

Optional list of settings to configure the payment method used to complete the payment

business_profile
object

Enrolled merchant identifier used for category-based billing. It can be set as required in your organization's billing configuration.

line_items
array of objects

Optional list of items being purchased. When provided, amount must not be sent — the total is calculated from the items. Each item includes price_data (with currency, unit_amount, and product_data) and quantity.

line_items
Responses

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