Embedded Checkout API Specification

Embedded Checkout

Sessions

Create and manage checkout sessions, verify tokens, and read session status.

Verify a session token

get /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

500 Internal server error

Get session status and payment response data

get /api/sessions/status

Returns the current status of the session and any payment response data from the cache

Example Response

200 Session status retrieved successfully

400 RequestId not found in session

401 Unauthorized - Invalid or missing authentication token

404 Session data not found

500 Server error or invalid session data format

Create a new session

post /api/sessions

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

Request Schema

checkoutId required

Type

string

profileId required

Type

string

metadata

Type

string

products

Type

array

amount required

Type

number

Range

0 to 99999999999

tax

Type

number

Range

0 to 99999999999

serviceFee

Type

number

Range

0 to 99999999999

Example Request

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

Example Response

201 Session created successfully

400 Invalid request

401 Unauthorized - Invalid or missing API key

404 Checkout not found

500 Server error