Create a checkout session

post https://api.elements-sandbox.io/api/v1/checkout/sessions

Body Params

return_url

string

required

the destination we redirects the customer to upon the completion of the checkout session

cancel_url

string

required

the destination we redirects the customer to upon the cancellation of the checkout session

customer_id

string

your reference to the customer

payment_method_types

array of strings

required

the payment methods you want to enable for the checkout session, you can add one or many from card, apple_pay, google_pay. Example: "payment_method_types": ["google_pay", "apple_pay", "card"]. Please note apple pay only works with Safari browser

payment_method_types*

line_items

array

required

one or many line_item objects. A line_item object has 7 attributes: name, quantity, type, currency, unit_amount_subunit, image_url, description. Example: "line_items": [ {"name": "some product", "quantity": "1","type": "product", "currency": "USD","unit_amount_subunit": "1999", "image_url": "https://xxxx.jpg", "description": "This is something"}, { "name":"some product", "quantity": "1", "type": "product", "currency": "USD","unit_amount_subunit": "1999", "image_url": "https://xxxx.jpg","description": "something" }, {"name": "Sales Tax(15%)","type": "tax", "currency": "USD", "unit_amount_subunit": "899"}]

line_items*

mode

string

Defaults to payment

payment mode means create a checkout session aiming to complete an open order, while vault mode means let your customer submit their payment method details for future use.

Response

Language

Credentials

Header

Request


xxxxxxxxxx
30
1
curl --location --request POST 'https://api.elements-sandbox.io/api/v1/checkout/sessions' \
2
--header 'Authorization: Bearer xxxxxxx' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
    "cancel_url": "https://example.com/cancel",
6
    "success_url": "https://example.com/success",
7
    "customer_id": "123eqwadsasd",
8
    "payment_method_types": [
9
        "google_pay", "apple_pay", "card"
10
    ],
11
    "line_items": [
12
        {
13
            "name": "NEMO CUBING BOT",
14
            "quantity": "1",
15
            "type": "product",
16
            "currency": "USD",
17
            "unit_amount_subunit": "1999",
18
            "image_url": "https://xxxxx.jpg",
19
            "description": "This is NEMO CUBING BOT"
20
        },
21
        {
22
            "name": "Sales Tax(15%)",
23
            "type": "tax",
24
            "currency": "USD",
25
            "unit_amount_subunit": "899"
26
        }
27
    ],
28
    "mode": "payment",
29
    "client_reference_id": "client_reference_id_xx"

Choose an example:

application/json

200200