Skip to main content
This object represents a checkout session that can be created to make a payment. You can Create a Checkout Session using the id generated when the Customer resource was created.
Create a checkout session is only required for flow SDK_CHECKOUT.
Only one payment is supported per each checkout session. A checkout session expires 2.5 hours after it is created. The expiry cannot be changed through the API, and updating a checkout session does not extend it.
In the sandbox environment, a checkout session expires 3.5 hours after it is created.

Attributes

string
The unique identifier of the checkout session (MAX 64; MIN 36).Example: 9104911d-5df9-429e-8488-ad41abea1a4b
string
The unique identifier of the customer (MAX 64; MIN 36).Example: 9104911d-5df9-429e-8488-ad41abea1a4b
string
The unique identifier of the customer’s order (MAX 255; MIN 3).Example: 1234
string
The description of the payment (MAX 255; MIN 3).Example: Purchase in Pepito market
string
The URL where to redirect the customer after the payment (MAX 526; MIN 3).Example: https://www.company.com/customer_1231324
enum
Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1 ).Possible enum values: Check the Country reference.
timestamp
Checkout Session creation date and time (MAX 27; MIN 27; ISO 8601 ).Example: 2022-05-09T20:46:54.786342Z
object
Specifies the payment amount object, with the value and currency.
array of objects
Specifies a list of metadata objects. You can add up to 50 metadata objects. When a routing rule has a metadata condition, this metadata decides which payment methods and installments the session lists. Payment routing does not read it: set the metadata on the payment or on the customer too.
array of objects
[Optional] The object to send the installment plan created in Yuno to show customers and let them choose from. This optional field is used in case a particular installments plan needs to be used in the session. If not sent, the installment plan created for the account is displayed for each scenario, if any.
object
[Optional] Limits which cards the customer can select in the Apple Pay payment sheet. Cards that do not match are shown greyed out. Every field is optional; a field that is not sent keeps the default behaviour. It can only be set when the checkout session is created. See Filter eligible cards.