Embedded Checkout

Get Config

Get checkout configuration for an active session. Requires X-Browser-Token header.

get/api/v1/embedded/config/{session_id}

Path parameters

session_idstring required

Headers

x-browser-tokenstring required

Response

Successful Response

statusinteger required

Response code, 0 means success

messagestring required

Response message

session_idstring

Session identifier

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

themeobject

Checkout theme configuration

merchant_namestring

Name of the merchant

Example response

{
  "message": "Success",
  "session_id": "ses_abc123def456",
  "amount": 1000,
  "currency": "TRY",
  "language": "tr",
  "payment_methods": [
    {
      "id": 1,
      "name": "Kredi Kartı",
      "payment_type": "creditcard",
      "sequence": 10
    }
  ],
  "merchant_name": "My Store",
  "merchant_config": {
    "api_base_url": "https://api.jetcheckout.com/api/v1",
    "mode": "test"
  },
  "checkout_options": {
    "checkout_design": "full"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.