Embedded Checkout

Activate Session

Changed on Oct 8, 2026

Activate a session and bind it to the current browser tab. Returns browser_token. Subsequent calls are rejected.

post/api/v1/embedded/session/activate

Request

Base URL
https://api.paylox.io
Auth
none declared
TypeScript
https://skmtc.dev/jetcheckout/apis/jet-checkout/docs/api/v1/embedded/session/activate/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

session_idstring required

Session identifier to activate

Example request

{
  "session_id": "ses_abc123def456"
}

Response

Successful Response

statusinteger required

Response code, 0 means success

messagestring required

Response message

browser_tokenstring

Browser token for single-tab binding

session_idstring

Session identifier

order_idstring

Merchant order identifier resolved from session metadata

return_urlstring

Trusted merchant return URL resolved from session metadata

amountinteger

Amount in minor units

currencystring

ISO currency code

languagestring

Language code

customerobject

Customer information

basket_itemsobject[]

Original basket items

customer_basketobject[]

Gateway payment customer basket

submerchant_external_idstring

Primary submerchant external identifier

is_submerchant_paymentboolean

Whether payment should be routed as submerchant

campaign_namestring

Campaign name for payment request

billing_tax_officestring

Billing tax office

billing_tax_numberstring

Billing tax number

success_urlstring

Merchant success callback URL

fail_urlstring

Merchant fail callback URL

merchant_namestring

Name of the merchant

environmentstring

Resolved execution environment: sandbox or production

execution_modestring

Resolved payment execution mode: psp or simulator

sandbox_scenariostring

Deterministic simulator scenario when simulator is active

simulatedboolean

Whether payment execution is simulated

Example response

{
  "message": "Success",
  "browser_token": "tok_abc123def456",
  "payment_methods": [
    {
      "id": 1,
      "name": "Kredi Kartı",
      "payment_type": "creditcard",
      "sequence": 10
    }
  ],
  "merchant_config": {
    "api_base_url": "https://api.jetcheckout.com/api/v1",
    "mode": "test"
  },
  "checkout_options": {
    "checkout_design": "full"
  }
}

Changes

Oct 8, 2026778cc9abd25b Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history