Embedded Checkout API Specification

Embedded Checkout

Sessions

Session management endpoints for creating and verifying checkout sessions

Verify a session token

get /public/api/sessions/verify

Verifies a session token from the authorization header and returns session and checkout data

Example Response

200 Session verified successfully

400 Session has expired

401 Unauthorized - Invalid or missing authentication token

404 Checkout not found

Create a new session

post /public/api/sessions

Creates a new session that expires in 30 minutes from creation time.

Request Schema

checkoutId required

string

profileId required

string

metadata

string

products

array

amount

number

Example Request

{
  "checkoutId": "string",
  "profileId": "string",
  "metadata": "string",
  "products": {
    "name": "string",
    "price": "number",
    "quantity": "integer",
    "logoUrl": "string"
  },
  "amount": "number"
}

Example Response

201 Session created successfully

400 Invalid request

401 Unauthorized - Invalid or missing API key

404 Checkout not found

500 Server error