Skip to main content
POST
This request creates a checkout session using the unique identifier generated when the customer resource was created.
If your workflow requires sending the additional_data object, it can be sent as part of the checkout session.

Authorizations

​
public-api-key
string
header
default:<Your public-api-key>
required
​
private-secret-key
string
header
default:<Your private-secret-key>
required

Body

application/json
​
merchant_order_id
string
required

The unique identifier of the customer's order (MAX 255; MIN 3).

​
payment_description
string
required

The description of the payment (MAX 255; MIN 3).

​
country
string
required

Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1).

​
account_id
string
required

The unique identifier of the account. You find this information on the Yuno dashboard (UUID, 36 chars).

​
customer_id
string

The unique identifier of the customer, created using the Create Customer endpoint (UUID, 36 chars).

​
callback_url
string

The URL where we will redirect your customer after making the purchase. Required for alternative payment methods with redirection. (MAX 526; MIN 3)

​
amount
object

Specifies the payment amount object, with the value and currency.

​
alternative_amount
object

Alternative currency representation of the transaction amount.

​
shipping_methods
object[]

Delivery options the customer can pick from inside a wallet widget (Fast Checkout). The first method is preselected. The currency of every amount must match the session currency.

​
metadata
object[]

Specifies a list of metadata objects. You can add up to 120 metadata objects.

​
workflow
enum<string>

Checkout workflow type.

Available options:
SDK_CHECKOUT,
CHECKOUT,
SDK_SEAMLESS
​
installments
object

The object to send the installment plan created in Yuno to show your 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, we will display the installment plan created for the account for each scenario, if any.

​
recurring_payment
object

Optional object to enable and configure recurring payments (subscriptions).

​
checkout_id
string

The unique identifier (UUID) of the Custom Checkout to use for this session. Optional. When omitted, the session uses the account's default checkout.

​
wallet_card_acceptance
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. Values must be uppercase, and an empty list is rejected with 400 INVALID_PARAMETERS. It can only be set when the session is created.

Response

200

​
merchant_order_id
string
Example:

"1717681150"

​
checkout_session
string
Example:

"d313047b-4f96-44ef-bbad-caf1d7ba4c2b"

​
country
string
Example:

"US"

​
payment_description
string
Example:

"Test Cards"

​
customer_id
string
Example:

"a577ad8f-08f1-4590-9cf1-e7679b15ee84"

​
callback_url
string
Example:

"https://www.example.com/callback"

​
amount
object
​
created_at
string
Example:

"2024-06-06T13:39:10.932297Z"

​
metadata
any
​
workflow
string
Example:

"SDK_CHECKOUT"

​
installments
object
​
checkout_id
string
Example:

"6822f80c-684e-41a3-8628-78963d3d60f7"