Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Create Checkout Session

post/checkout/sessions

Request body

customer_idstring

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

merchant_order_idstring required

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

payment_descriptionstring required

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

callback_urlstring

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

country'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'CR' | 'EC' | 'SV' | 'GT' | 'HN' | 'MX' | 'NI' | 'PA' | 'PY' | 'PE' | 'US' | 'UY' required

The customer's country (MAX 2; MIN 2; ISO 3166-1).

account_idstring required

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

workflow'SDK_CHECKOUT' | 'CHECKOUT' | 'SDK_SEAMLESS'

Checkout workflow type.

checkout_idstring

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

Response

200

OR

Example response

{
  "merchant_order_id": "1717681150",
  "checkout_session": "d313047b-4f96-44ef-bbad-caf1d7ba4c2b",
  "country": "US",
  "payment_description": "Test Cards",
  "customer_id": "a577ad8f-08f1-4590-9cf1-e7679b15ee84",
  "callback_url": "https://www.example.com/callback",
  "amount": {
    "currency": "USD",
    "value": 520
  },
  "created_at": "2024-06-06T13:39:10.932297Z",
  "workflow": "SDK_CHECKOUT",
  "checkout_id": "6822f80c-684e-41a3-8628-78963d3d60f7"
}