{
"errors": [
{
"category": "VALIDATION",
"code": "INVALID_REQUEST",
"message": "The terminal is not active.",
"retriable": false
}
],
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
{
"error": {
"code": "PAYMENT_DETAILS_MISMATCH",
"message": "The request was invalid or malformed",
"timestamp": "2024-12-16T10:30:00.000Z",
"details": {},
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "PAYMENT_DETAILS_MISMATCH",
"message": "The request was invalid or malformed",
"timestamp": "2024-12-16T10:30:00.000Z",
"details": {},
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"errors": [
{
"category": "VALIDATION",
"code": "ENTITY_NOT_FOUND",
"message": "The terminal was not found.",
"retriable": false
}
],
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
{
"error": {
"code": "PAYMENT_DETAILS_MISMATCH",
"message": "The request was invalid or malformed",
"timestamp": "2024-12-16T10:30:00.000Z",
"details": {},
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"errors": [
{
"category": "CONNECTION",
"code": "PROVIDER_UNAVAILABLE",
"message": "The terminal could not be confirmed. Retry the request.",
"retriable": true
}
],
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
The business account to act on, for platform use cases. When sent, that account is the merchant for the request: resources are created under it, reads and 404 checks are scoped to it, and per-merchant uniqueness (such as merchant_reference_id) applies within it. The API key's own account is recorded as the account acting on its behalf. Omit it to act on the API key's own account.
Deprecated and ignored. 3D Secure is enforced per channel; turn it on under Settings, Acceptance, Payment methods in the dashboard. Sending this field still succeeds and has no effect.
Online terminal the session's payment is taken through. Defaults to the business account's default terminal at the time the session is created; later changes to the default do not move it. Business accounts only, and not together with channel_id.
Optional transaction-level split allocations in minor units. The full payment lands in the main acceptance account first; each allocation is then transferred to its destination, and the remainder stays in the main account. The allocations must not total more than amount. If sent, it must contain at least one item. Payment sessions only; rejected on a tokenization session.
Minimum array length: 1
Show child attributes
Response
Checkout session created successfully.
Response returned after creating or updating a checkout session
{
"errors": [
{
"category": "VALIDATION",
"code": "INVALID_REQUEST",
"message": "The terminal is not active.",
"retriable": false
}
],
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
{
"error": {
"code": "PAYMENT_DETAILS_MISMATCH",
"message": "The request was invalid or malformed",
"timestamp": "2024-12-16T10:30:00.000Z",
"details": {},
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "PAYMENT_DETAILS_MISMATCH",
"message": "The request was invalid or malformed",
"timestamp": "2024-12-16T10:30:00.000Z",
"details": {},
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"errors": [
{
"category": "VALIDATION",
"code": "ENTITY_NOT_FOUND",
"message": "The terminal was not found.",
"retriable": false
}
],
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
{
"error": {
"code": "PAYMENT_DETAILS_MISMATCH",
"message": "The request was invalid or malformed",
"timestamp": "2024-12-16T10:30:00.000Z",
"details": {},
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"errors": [
{
"category": "CONNECTION",
"code": "PROVIDER_UNAVAILABLE",
"message": "The terminal could not be confirmed. Retry the request.",
"retriable": true
}
],
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"lite Payments API Reference","colors":{"primary":"#6B4EFF","light":"#8B72FF","dark":"#4B2EDF"},"logo":{"light":"https://mintcdn.com/lite-92e7ad3a/uYpyqnuSvOdBocms/logo/lite-light.svg?fit=max\u0026auto=format\u0026n=uYpyqnuSvOdBocms\u0026q=85\u0026s=7d85c532514181dd38e2af8db58c4f3f","dark":"https://mintcdn.com/lite-92e7ad3a/uYpyqnuSvOdBocms/logo/lite-dark.svg?fit=max\u0026auto=format\u0026n=uYpyqnuSvOdBocms\u0026q=85\u0026s=4973ba29b34352c5f80d669c8cbcb89d"},"favicon":"https://mintcdn.com/lite-92e7ad3a/uYpyqnuSvOdBocms/logo/favicon.svg?fit=max\u0026auto=format\u0026n=uYpyqnuSvOdBocms\u0026q=85\u0026s=29f00b6696a904c17b2d3504480bdbc4","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","typescript","Go","PHP"],"prefill":true},"url":"full"},"footer":{"socials":{"github":"https://github.com/lite-sa"},"links":[{"header":"Company","items":[{"label":"Homepage","href":"https://lite.sa"}]}]},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["claude","download-spec"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lite-92e7ad3a","hasAudioNarration":false,"actualSubdomain":"lite-92e7ad3a","customDomains":["docs.lite.sa"],"gitSource":{"type":"github","owner":"lite-sa","repo":"documentation","deployBranch":"dev","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada395ffd1ebb929e8e112d","collectionId":"152c7e09-bac7-4055-9685-69f8d97293dd","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada395ffd1ebb929e8e112d"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ade46ed4b3b1f0c5edc023f","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Payment Acceptance","count":53},{"language":"default","tag":"Data Models","count":45},{"language":"default","tag":"API Reference","count":43},{"language":"default","tag":"Account Settlement","count":23},{"language":"default","tag":"Guides","count":21},{"language":"default","tag":"Accept Payments","count":19},{"language":"default","tag":"Tokenization","count":13},{"language":"default","tag":"Settlement","count":12},{"language":"default","tag":"Server-to-Server Payments","count":11},{"language":"default","tag":"Integration Options","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/hosted-checkout/create-a-checkout-session","slug":"/api-reference/hosted-checkout/create-a-checkout-session","pageMetadata":{"title":"Create a checkout session","description":"Creates a new hosted checkout session and returns a payment link and client\nsecret for use in the frontend SDK.\n","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /checkout-sessions","href":"/api-reference/hosted-checkout/create-a-checkout-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a new hosted checkout session and returns a payment link and client\\nsecret for use in the frontend SDK.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a checkout session","description":"Creates a new hosted checkout session and returns a payment link and client\nsecret for use in the frontend SDK.\n","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /checkout-sessions","href":"/api-reference/hosted-checkout/create-a-checkout-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"lite.checkout.createSession","summary":"Create a checkout session","description":"Creates a new hosted checkout session and returns a payment link and client\nsecret for use in the frontend SDK.\n","tags":["Hosted Checkout"],"parameters":["3fe89f8c-a5e3-4180-8cdf-b5cbc935c194","edd6fc49-7f7e-4af4-a6f0-3e598e62491e","0bcef10a-49a6-4490-b669-fc5382dc2225"],"requestBody":"bb2ab137-8576-4064-9614-8288d9c6886a","responses":{"201":"66571948-73d4-4427-9e2f-e9412d02d163","400":"d69917d7-5d0a-41cf-a476-8797ba1ac742","401":"55f3665e-3d06-46b8-b27e-f8e17eb69fdb","403":"9bc08ec8-1447-4ae3-af8c-d745b6b73dbb","404":"793c5224-1905-4d59-a605-3aa142e5bad2","500":"b1a17f36-74d2-4a86-a396-900dee8d57ba","503":"332fcd59-3887-474e-913c-34fe00f3dc19"},"method":"post","type":"path","servers":["58372e5d-e9ba-456c-b011-0b2ba37c00ab"],"security":["855f167a-230a-48f4-a5d4-c5db35bd37fd"],"path":"/checkout-sessions","baseUrlOptions":["https://api.lite.sa"],"title":"Create a checkout session","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","typescript","go","php"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.amount":10000,"body.currency":"SAR","body.redirect_urls.success":"https://example.com/success","body.redirect_urls.failure":"https://example.com/failure","body.order.reference":"ORD-123456","body.order.\\items.products.items.0.id":"prod_123","body.order.\\items.products.items.0.price":5000,"body.order.\\items.products.items.0.quantity":2,"body.order.\\items.products.items.0.name":"T-Shirt","body.order.\\items.products.items.0.metadata":{"color":"Blue","size":"L"},"body.order.\\items.vat.amount":750,"body.order.\\items.shipping.amount":1000,"body.order.shipping_address.name":"John Doe","body.order.shipping_address.email":"john@example.com","body.order.shipping_address.street":"123 Main St","body.order.shipping_address.city":"Riyadh","body.order.shipping_address.state":"Riyadh Region","body.order.shipping_address.zip":"12213","body.order.shipping_address.country":"SA","body.order.billing_address.name":"John Doe","body.order.billing_address.email":"john@example.com","body.order.billing_address.street":"123 Main St","body.order.billing_address.city":"Riyadh","body.order.billing_address.state":"Riyadh Region","body.order.billing_address.zip":"12213","body.order.billing_address.country":"SA","body.order.amount":10000,"body.order.currency":"SAR","body.order.description":"Order description","body.expiry":1800,"body.three_ds_required":false,"body.processing_type.oneOf.0":"REGULAR","body.capture_mode.oneOf.0":"INSTANT","body.metadata":{"session_type":"standard"},"body.channel_id":"550e8400-e29b-41d4-a716-446655440000","body.terminal_id":"0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11","body.splits.items.0.amount":9000,"body.splits.items.0.business_account_id":"019859f8-3149-7a55-8211-a8179675d269","body.splits.items.0.account_reference":"main"}],"urlDisplay":"full"},"dependencies":{"parameters":{"3fe89f8c-a5e3-4180-8cdf-b5cbc935c194":{"name":"x-correlation-id","in":"header","required":false,"description":"Unique identifier for request tracing. Generated by the client or server if not provided.","schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":false,"description":"Unique identifier for request tracing. Generated by the client or server if not provided.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"edd6fc49-7f7e-4af4-a6f0-3e598e62491e":{"name":"x-idempotency-key","in":"header","required":false,"description":"Unique key for idempotent request processing. Duplicate requests with the same key are safely ignored.","schema":{"type":"string","format":"uuid","example":"baf6a8e2-0c89-46ef-9ca5-faa65b99bcd5","isRequired":false,"description":"Unique key for idempotent request processing. Duplicate requests with the same key are safely ignored.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"0bcef10a-49a6-4490-b669-fc5382dc2225":{"name":"x-business-account-id","in":"header","required":false,"description":"The business account to act on, for platform use cases. When sent, that account is the merchant for the request: resources are created under it, reads and `404` checks are scoped to it, and per-merchant uniqueness (such as `merchant_reference_id`) applies within it. The API key's own account is recorded as the account acting on its behalf. Omit it to act on the API key's own account.","schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":false,"description":"The business account to act on, for platform use cases. When sent, that account is the merchant for the request: resources are created under it, reads and `404` checks are scoped to it, and per-merchant uniqueness (such as `merchant_reference_id`) applies within it. The API key's own account is recorded as the account acting on its behalf. Omit it to act on the API key's own account.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"description":"Create a new hosted checkout session","content":{"application/json":{"schema":{"type":"object","description":"Request body for creating a new checkout session","required":["amount","currency","redirect_urls","order"],"properties":{"amount":{"type":"integer","minimum":1,"description":"Payment amount in minor units (e.g. 10000 for 100.00 SAR)","example":10000,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"type":"string","description":"Currency code (ISO 4217)","example":"SAR","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"redirect_urls":{"type":"object","description":"Redirect URLs for checkout session","properties":{"success":{"type":"string","format":"uri","description":"Redirect URL on successful payment","example":"https://example.com/success","uniqueKey":"redirect_urls.success","typeLabel":"string\u003curi>"},"failure":{"type":"string","format":"uri","description":"Redirect URL on failed payment","example":"https://example.com/failure","uniqueKey":"redirect_urls.failure","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"redirect_urls","typeLabel":"object"},"order":{"type":"object","description":"Order details","required":["reference"],"properties":{"reference":{"type":"string","description":"Order reference","example":"ORD-123456","isRequired":true,"uniqueKey":"order.reference","typeLabel":"string"},"items":{"type":"object","description":"Order line items","properties":{"products":{"type":"array","description":"Product line items","items":{"type":"object","required":["id","price","quantity"],"properties":{"id":{"type":"string","description":"Item ID","example":"prod_123","isRequired":true,"uniqueKey":"order.\\items.products.items.[INDEX].id","typeLabel":"string"},"price":{"type":"integer","minimum":0,"description":"Item price in minor units","example":5000,"isRequired":true,"uniqueKey":"order.\\items.products.items.[INDEX].price","typeLabel":"integer"},"quantity":{"type":"integer","minimum":1,"description":"Quantity","example":2,"isRequired":true,"uniqueKey":"order.\\items.products.items.[INDEX].quantity","typeLabel":"integer"},"name":{"type":"string","description":"Item name","example":"T-Shirt","uniqueKey":"order.\\items.products.items.[INDEX].name","typeLabel":"string"},"metadata":{"type":"object","description":"Item metadata","example":{"color":"Blue","size":"L"},"uniqueKey":"order.\\items.products.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"order.\\items.products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.products","typeLabel":"object[]"},"vat":{"type":"object","description":"VAT details","properties":{"amount":{"type":"integer","description":"VAT amount in minor units","minimum":0,"example":750,"uniqueKey":"order.\\items.vat.amount","typeLabel":"integer"}},"uniqueKey":"order.\\items.vat","typeLabel":"object"},"shipping":{"type":"object","description":"Shipping details","properties":{"amount":{"type":"integer","description":"Shipping amount in minor units","minimum":0,"example":1000,"uniqueKey":"order.\\items.shipping.amount","typeLabel":"integer"}},"uniqueKey":"order.\\items.shipping","typeLabel":"object"}},"uniqueKey":"order.\\items","typeLabel":"object"},"shipping_address":{"type":"object","description":"Address information","properties":{"name":{"type":"string","description":"Contact name","example":"John Doe","uniqueKey":"order.shipping_address.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email","example":"john@example.com","uniqueKey":"order.shipping_address.email","typeLabel":"string\u003cemail>"},"street":{"type":"string","description":"Street address","example":"123 Main St","uniqueKey":"order.shipping_address.street","typeLabel":"string"},"city":{"type":"string","description":"City","example":"Riyadh","uniqueKey":"order.shipping_address.city","typeLabel":"string"},"state":{"type":"string","description":"State/region","example":"Riyadh Region","uniqueKey":"order.shipping_address.state","typeLabel":"string"},"zip":{"type":"string","description":"Zip/postal code","example":"12213","uniqueKey":"order.shipping_address.zip","typeLabel":"string"},"country":{"type":"string","description":"Country code (ISO 3166 alpha-2)","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","example":"SA","uniqueKey":"order.shipping_address.country","typeLabel":"string"}},"uniqueKey":"order.shipping_address","typeLabel":"object"},"billing_address":{"type":"object","description":"Address information","properties":{"name":{"type":"string","description":"Contact name","example":"John Doe","uniqueKey":"order.billing_address.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email","example":"john@example.com","uniqueKey":"order.billing_address.email","typeLabel":"string\u003cemail>"},"street":{"type":"string","description":"Street address","example":"123 Main St","uniqueKey":"order.billing_address.street","typeLabel":"string"},"city":{"type":"string","description":"City","example":"Riyadh","uniqueKey":"order.billing_address.city","typeLabel":"string"},"state":{"type":"string","description":"State/region","example":"Riyadh Region","uniqueKey":"order.billing_address.state","typeLabel":"string"},"zip":{"type":"string","description":"Zip/postal code","example":"12213","uniqueKey":"order.billing_address.zip","typeLabel":"string"},"country":{"type":"string","description":"Country code (ISO 3166 alpha-2)","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","example":"SA","uniqueKey":"order.billing_address.country","typeLabel":"string"}},"uniqueKey":"order.billing_address","typeLabel":"object"},"amount":{"type":"integer","description":"Order amount in minor units","minimum":100,"example":10000,"uniqueKey":"order.amount","typeLabel":"integer"},"currency":{"type":"string","description":"Currency code (ISO 4217)","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","example":"SAR","uniqueKey":"order.currency","typeLabel":"string"},"description":{"type":"string","description":"Order description","example":"Order description","uniqueKey":"order.description","typeLabel":"string"}},"isRequired":true,"uniqueKey":"order","typeLabel":"object"},"customer":{"type":"object","description":"Customer details for checkout session creation. When provided, `id` is required.","required":["id"],"properties":{"id":{"type":"string","description":"Customer identifier","minLength":3,"example":"cus_a1b2c3d4e5f6","isRequired":true,"uniqueKey":"customer.id","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Customer email","example":"john.doe@email.com","uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"first_name":{"type":"string","description":"Customer first name","example":"John","uniqueKey":"customer.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Customer last name","example":"Doe","uniqueKey":"customer.last_name","typeLabel":"string"},"phone_country_code":{"type":"string","description":"Phone country code","example":"+966","uniqueKey":"customer.phone_country_code","typeLabel":"string"},"phone_number":{"type":"string","description":"Phone number","example":"555123456","uniqueKey":"customer.phone_number","typeLabel":"string"}},"uniqueKey":"customer","typeLabel":"object"},"expiry":{"type":"integer","minimum":60,"maximum":86400,"description":"Session expiry in seconds (default 3600)","example":1800,"uniqueKey":"expiry","typeLabel":"integer"},"three_ds_required":{"type":"boolean","deprecated":true,"description":"Deprecated and ignored. 3D Secure is enforced per channel; turn it on under Settings, Acceptance, Payment methods in the dashboard. Sending this field still succeeds and has no effect.","example":false,"uniqueKey":"three_ds_required","typeLabel":"boolean"},"processing_type":{"oneOf":[{"type":"string","title":"Regular","description":"Standard one-time payment","default":"REGULAR","const":"REGULAR","example":"REGULAR","uniqueKey":"processing_type.oneOf.0","typeLabel":"string"},{"type":"string","title":"Card on File","description":"Payment using previously stored card details","default":"REGULAR","const":"CARD_ON_FILE","example":"REGULAR","uniqueKey":"processing_type.oneOf.1","typeLabel":"string"},{"type":"string","title":"Unscheduled Card on File","description":"Payment using card on file without a fixed schedule","default":"REGULAR","const":"UNSCHEDULED_CARD_ON_FILE","example":"REGULAR","uniqueKey":"processing_type.oneOf.2","typeLabel":"string"},{"type":"string","title":"MOTO","description":"Mail order / telephone order: a merchant agent keys the card on the cardholder's behalf","default":"REGULAR","const":"MOTO","example":"REGULAR","uniqueKey":"processing_type.oneOf.3","typeLabel":"string"}],"uniqueKey":"processing_type","typeLabel":"string"},"capture_mode":{"oneOf":[{"type":"string","title":"Instant","description":"Capture the payment immediately upon authorization","default":"INSTANT","const":"INSTANT","example":"INSTANT","uniqueKey":"capture_mode.oneOf.0","typeLabel":"string"},{"type":"string","title":"Manual","description":"Leave the payment authorized and capture it later through the capture endpoint","default":"INSTANT","const":"MANUAL","example":"INSTANT","uniqueKey":"capture_mode.oneOf.1","typeLabel":"string"}],"uniqueKey":"capture_mode","typeLabel":"string"},"metadata":{"type":"object","description":"Additional metadata","example":{"session_type":"standard"},"uniqueKey":"metadata","typeLabel":"object"},"channel_id":{"type":"string","format":"uuid","description":"Channel ID for the session","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"channel_id","typeLabel":"string\u003cuuid>"},"terminal_id":{"type":"string","format":"uuid","description":"Online terminal the session's payment is taken through. Defaults to the business account's default terminal at the time the session is created; later changes to the default do not move it. Business accounts only, and not together with `channel_id`.","example":"0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11","uniqueKey":"terminal_id","typeLabel":"string\u003cuuid>"},"splits":{"type":"array","minItems":1,"description":"Optional transaction-level split allocations in minor units. The full payment lands in the main acceptance account first; each allocation is then transferred to its destination, and the remainder stays in the main account. The allocations must not total more than `amount`. If sent, it must contain at least one item. Payment sessions only; rejected on a tokenization session.","items":{"type":"object","description":"One transaction-level split allocation.","required":["amount"],"properties":{"amount":{"type":"integer","minimum":1,"description":"Allocation amount in minor units (e.g. 9000 for 90.00 SAR)","example":9000,"isRequired":true,"uniqueKey":"splits.items.[INDEX].amount","typeLabel":"integer"},"business_account_id":{"type":"string","format":"uuid","description":"Business account receiving this allocation. Defaults to the business account the request is made for (`x-business-account-id`) when omitted.","example":"019859f8-3149-7a55-8211-a8179675d269","uniqueKey":"splits.items.[INDEX].business_account_id","typeLabel":"string\u003cuuid>"},"account_reference":{"type":"string","maxLength":64,"default":"main","description":"Acceptance account within the destination business account credited by this allocation. Omitted or empty defaults to `main`.","example":"main","uniqueKey":"splits.items.[INDEX].account_reference","typeLabel":"string"}},"uniqueKey":"splits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"splits","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":10000,"currency":"SAR","redirect_urls":{"success":"https://example.com/success","failure":"https://example.com/failure"},"order":{"reference":"ORD-123456","items":{"products":[{"id":"prod_123","price":5000,"quantity":2,"name":"T-Shirt","metadata":{"color":"Blue","size":"L"}}],"vat":{"amount":750},"shipping":{"amount":1000}},"shipping_address":{"name":"John Doe","email":"john@example.com","street":"123 Main St","city":"Riyadh","state":"Riyadh Region","zip":"12213","country":"SA"},"billing_address":{"name":"John Doe","email":"john@example.com","street":"123 Main St","city":"Riyadh","state":"Riyadh Region","zip":"12213","country":"SA"},"amount":10000,"currency":"SAR","description":"Order description"},"expiry":1800,"three_ds_required":false,"processing_type":"REGULAR","capture_mode":"INSTANT","metadata":{"session_type":"standard"},"channel_id":"550e8400-e29b-41d4-a716-446655440000","terminal_id":"0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11","splits":[{"amount":9000,"business_account_id":"019859f8-3149-7a55-8211-a8179675d269","account_reference":"main"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"66571948-73d4-4427-9e2f-e9412d02d163":{"description":"Checkout session created successfully.","content":{"application/json":{"schema":{"type":"object","description":"Response returned after creating or updating a checkout session","required":["id","session_id","hosted_url","client_secret","status","expires_on","order_id","amount","currency"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique checkout session identifier","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"session_id":{"type":"string","deprecated":true,"description":"Deprecated alias of `id`. Use `id` instead.","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"session_id","typeLabel":"string"},"hosted_url":{"type":"string","format":"uri","description":"URL for the hosted checkout page","example":"https://checkout.lite.sa/ses_a1b2c3d4e5f6","isRequired":true,"uniqueKey":"hosted_url","typeLabel":"string\u003curi>"},"client_secret":{"type":"string","description":"Client secret for frontend SDK authentication","example":"cs_a1b2c3d4e5f6","isRequired":true,"uniqueKey":"client_secret","typeLabel":"string"},"status":{"oneOf":[{"type":"string","title":"Pending","description":"Session is active and awaiting payment","const":"Pending","example":"Pending","isRequired":true,"uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"string","title":"Completed","description":"Session has been completed","const":"Completed","example":"Pending","isRequired":true,"uniqueKey":"status.oneOf.1","typeLabel":"string"},{"type":"string","title":"Expired","description":"Session has expired","const":"Expired","example":"Pending","isRequired":true,"uniqueKey":"status.oneOf.2","typeLabel":"string"},{"type":"string","title":"Cancelled","description":"Session was explicitly cancelled","const":"Cancelled","example":"Pending","isRequired":true,"uniqueKey":"status.oneOf.3","typeLabel":"string"}],"isRequired":true,"uniqueKey":"status","typeLabel":"string"},"expires_on":{"type":"string","format":"date-time","description":"Session expiry timestamp","example":"2026-05-18T12:00:00.000Z","isRequired":true,"uniqueKey":"expires_on","typeLabel":"string\u003cdate-time>"},"order_id":{"type":"string","description":"Order reference","example":"ORD-123456","isRequired":true,"uniqueKey":"order_id","typeLabel":"string"},"amount":{"type":"integer","description":"Session amount in minor units","example":10000,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"type":"string","description":"Currency code (ISO 4217)","example":"SAR","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"customer":{"type":"object","description":"Customer details","properties":{"id":{"type":"string","description":"Customer ID","example":"cust_a1b2c3d4e5f6","uniqueKey":"customer.id","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Customer email","example":"john.doe@email.com","uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"first_name":{"type":"string","description":"Customer first name","example":"John","uniqueKey":"customer.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Customer last name","example":"Doe","uniqueKey":"customer.last_name","typeLabel":"string"},"phone_country_code":{"type":"string","description":"Phone country code","example":"+966","uniqueKey":"customer.phone_country_code","typeLabel":"string"},"phone_number":{"type":"string","description":"Phone number","example":"555123456","uniqueKey":"customer.phone_number","typeLabel":"string"}},"uniqueKey":"customer","typeLabel":"object"},"order":{"type":"object","description":"Order details","required":["reference"],"properties":{"reference":{"type":"string","description":"Order reference","example":"ORD-123456","isRequired":true,"uniqueKey":"order.reference","typeLabel":"string"},"items":{"type":"object","description":"Order line items","properties":{"products":{"type":"array","description":"Product line items","items":{"type":"object","required":["id","price","quantity"],"properties":{"id":{"type":"string","description":"Item ID","example":"prod_123","isRequired":true,"uniqueKey":"order.\\items.products.items.[INDEX].id","typeLabel":"string"},"price":{"type":"integer","minimum":0,"description":"Item price in minor units","example":5000,"isRequired":true,"uniqueKey":"order.\\items.products.items.[INDEX].price","typeLabel":"integer"},"quantity":{"type":"integer","minimum":1,"description":"Quantity","example":2,"isRequired":true,"uniqueKey":"order.\\items.products.items.[INDEX].quantity","typeLabel":"integer"},"name":{"type":"string","description":"Item name","example":"T-Shirt","uniqueKey":"order.\\items.products.items.[INDEX].name","typeLabel":"string"},"metadata":{"type":"object","description":"Item metadata","example":{"color":"Blue","size":"L"},"uniqueKey":"order.\\items.products.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"order.\\items.products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items.products","typeLabel":"object[]"},"vat":{"type":"object","description":"VAT details","properties":{"amount":{"type":"integer","description":"VAT amount in minor units","minimum":0,"example":750,"uniqueKey":"order.\\items.vat.amount","typeLabel":"integer"}},"uniqueKey":"order.\\items.vat","typeLabel":"object"},"shipping":{"type":"object","description":"Shipping details","properties":{"amount":{"type":"integer","description":"Shipping amount in minor units","minimum":0,"example":1000,"uniqueKey":"order.\\items.shipping.amount","typeLabel":"integer"}},"uniqueKey":"order.\\items.shipping","typeLabel":"object"}},"uniqueKey":"order.\\items","typeLabel":"object"},"shipping_address":{"type":"object","description":"Address information","properties":{"name":{"type":"string","description":"Contact name","example":"John Doe","uniqueKey":"order.shipping_address.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email","example":"john@example.com","uniqueKey":"order.shipping_address.email","typeLabel":"string\u003cemail>"},"street":{"type":"string","description":"Street address","example":"123 Main St","uniqueKey":"order.shipping_address.street","typeLabel":"string"},"city":{"type":"string","description":"City","example":"Riyadh","uniqueKey":"order.shipping_address.city","typeLabel":"string"},"state":{"type":"string","description":"State/region","example":"Riyadh Region","uniqueKey":"order.shipping_address.state","typeLabel":"string"},"zip":{"type":"string","description":"Zip/postal code","example":"12213","uniqueKey":"order.shipping_address.zip","typeLabel":"string"},"country":{"type":"string","description":"Country code (ISO 3166 alpha-2)","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","example":"SA","uniqueKey":"order.shipping_address.country","typeLabel":"string"}},"uniqueKey":"order.shipping_address","typeLabel":"object"},"billing_address":{"type":"object","description":"Address information","properties":{"name":{"type":"string","description":"Contact name","example":"John Doe","uniqueKey":"order.billing_address.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email","example":"john@example.com","uniqueKey":"order.billing_address.email","typeLabel":"string\u003cemail>"},"street":{"type":"string","description":"Street address","example":"123 Main St","uniqueKey":"order.billing_address.street","typeLabel":"string"},"city":{"type":"string","description":"City","example":"Riyadh","uniqueKey":"order.billing_address.city","typeLabel":"string"},"state":{"type":"string","description":"State/region","example":"Riyadh Region","uniqueKey":"order.billing_address.state","typeLabel":"string"},"zip":{"type":"string","description":"Zip/postal code","example":"12213","uniqueKey":"order.billing_address.zip","typeLabel":"string"},"country":{"type":"string","description":"Country code (ISO 3166 alpha-2)","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","example":"SA","uniqueKey":"order.billing_address.country","typeLabel":"string"}},"uniqueKey":"order.billing_address","typeLabel":"object"},"amount":{"type":"integer","description":"Order amount in minor units","minimum":100,"example":10000,"uniqueKey":"order.amount","typeLabel":"integer"},"currency":{"type":"string","description":"Currency code (ISO 4217)","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","example":"SAR","uniqueKey":"order.currency","typeLabel":"string"},"description":{"type":"string","description":"Order description","example":"Order description","uniqueKey":"order.description","typeLabel":"string"}},"uniqueKey":"order","typeLabel":"object"},"channel_id":{"type":"string","description":"Channel ID for the session","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"channel_id","typeLabel":"string"},"terminal_id":{"type":"string","format":"uuid","readOnly":true,"description":"Online terminal the session's payment is taken through. Present for business accounts only.","example":"0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11","uniqueKey":"terminal_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"550e8400-e29b-41d4-a716-446655440000","session_id":"550e8400-e29b-41d4-a716-446655440000","hosted_url":"https://checkout.lite.sa/ses_a1b2c3d4e5f6","client_secret":"cs_a1b2c3d4e5f6","status":"Pending","expires_on":"2026-05-18T12:00:00.000Z","order_id":"ORD-123456","amount":10000,"currency":"SAR","customer":{"id":"cust_a1b2c3d4e5f6","email":"john.doe@email.com","first_name":"John","last_name":"Doe","phone_country_code":"+966","phone_number":"555123456"},"order":{"reference":"ORD-123456","items":{"products":[{"id":"prod_123","price":5000,"quantity":2,"name":"T-Shirt","metadata":{"color":"Blue","size":"L"}}],"vat":{"amount":750},"shipping":{"amount":1000}},"shipping_address":{"name":"John Doe","email":"john@example.com","street":"123 Main St","city":"Riyadh","state":"Riyadh Region","zip":"12213","country":"SA"},"billing_address":{"name":"John Doe","email":"john@example.com","street":"123 Main St","city":"Riyadh","state":"Riyadh Region","zip":"12213","country":"SA"},"amount":10000,"currency":"SAR","description":"Order description"},"channel_id":"550e8400-e29b-41d4-a716-446655440000","terminal_id":"0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11"}}},"exampleType":"generated"}},"exampleType":"generated"},"d69917d7-5d0a-41cf-a476-8797ba1ac742":{"description":"The request was invalid or malformed.\n\nReturned when:\n- Request validation fails (missing required fields, invalid field formats, including a\n `terminal_id` that is not a UUID)\n- `terminal_id` names a terminal that is suspended or closed: `INVALID_REQUEST`,\n \"The terminal is not active.\"\n- `terminal_id` and `channel_id` are both sent: `INVALID_REQUEST`,\n \"Send either terminal_id or channel_id, not both.\"\n- `terminal_id` is sent by a merchant that is not a business account: `INVALID_REQUEST`,\n \"terminal_id is only supported for business accounts.\"\n- The operation is not allowed given the current resource state\n","content":{"application/json":{"schema":{"type":"object","description":"Error body returned by endpoints behind the external exception filter. Branch on\n`errors[].code`; `message` is readable text whose wording may change.\n","required":["errors","request_id"],"properties":{"errors":{"type":"array","description":"One item per problem. A validation failure returns one item per invalid field.","minItems":1,"items":{"type":"object","required":["category","code","message","retriable"],"properties":{"category":{"type":"string","description":"Broad class of the error","enum":["SETUP","VALIDATION","INSTRUMENT","ISSUER","FRAUD","WORKFLOW","CONNECTION","SYSTEM"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable error code to branch on","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the error","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"retriable":{"type":"boolean","description":"Whether retrying the same request, with the same `x-idempotency-key`, can succeed","isRequired":true,"uniqueKey":"errors.items.[INDEX].retriable","typeLabel":"boolean"},"field":{"type":"string","description":"The invalid request field. Present on validation errors only.","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Correlation ID of the request. Include it when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"category":"VALIDATION","code":"INVALID_REQUEST","message":"The terminal is not active.","retriable":false}],"request_id":"550e8400-e29b-41d4-a716-446655440000"},"examples":{"Example":{"title":"Example","value":{"errors":[{"category":"VALIDATION","code":"INVALID_REQUEST","message":"The terminal is not active.","retriable":false}],"request_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"examples"}},"exampleType":"examples"},"55f3665e-3d06-46b8-b27e-f8e17eb69fdb":{"description":"Authentication failed — missing or invalid token.\n\nReturned when:\n- The JWT bearer token is missing, expired, or has an invalid signature\n- The API key is missing or invalid\n- The authenticated session token is invalid\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","timestamp"],"properties":{"code":{"type":"string","description":"Error code identifying the type of error","example":"PAYMENT_DETAILS_MISMATCH","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description","example":"The request was invalid or malformed","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp when the error occurred","example":"2024-12-16T10:30:00.000Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","description":"Additional error details","uniqueKey":"error.details","typeLabel":"object"},"correlation_id":{"type":"string","format":"uuid","description":"Correlation ID for tracking the request","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"error.correlation_id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"PAYMENT_DETAILS_MISMATCH","message":"The request was invalid or malformed","timestamp":"2024-12-16T10:30:00.000Z","details":{},"correlation_id":"550e8400-e29b-41d4-a716-446655440000"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9bc08ec8-1447-4ae3-af8c-d745b6b73dbb":{"description":"Request blocked by security policy.\n\nReturned when:\n- A security threat is detected (SQL injection, XSS, NoSQL injection, LDAP injection, path traversal)\n- Header injection or suspicious headers are detected\n- The request payload exceeds the maximum allowed size\n- Geo-region validation fails (user country does not match client region)\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","timestamp"],"properties":{"code":{"type":"string","description":"Error code identifying the type of error","example":"PAYMENT_DETAILS_MISMATCH","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description","example":"The request was invalid or malformed","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp when the error occurred","example":"2024-12-16T10:30:00.000Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","description":"Additional error details","uniqueKey":"error.details","typeLabel":"object"},"correlation_id":{"type":"string","format":"uuid","description":"Correlation ID for tracking the request","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"error.correlation_id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"PAYMENT_DETAILS_MISMATCH","message":"The request was invalid or malformed","timestamp":"2024-12-16T10:30:00.000Z","details":{},"correlation_id":"550e8400-e29b-41d4-a716-446655440000"}}}},"exampleType":"generated"}},"exampleType":"generated"},"793c5224-1905-4d59-a605-3aa142e5bad2":{"description":"`terminal_id` does not name a terminal of this business account (`ENTITY_NOT_FOUND`).\nAn unknown id and another account's terminal return the same error.\n","content":{"application/json":{"schema":{"type":"object","description":"Error body returned by endpoints behind the external exception filter. Branch on\n`errors[].code`; `message` is readable text whose wording may change.\n","required":["errors","request_id"],"properties":{"errors":{"type":"array","description":"One item per problem. A validation failure returns one item per invalid field.","minItems":1,"items":{"type":"object","required":["category","code","message","retriable"],"properties":{"category":{"type":"string","description":"Broad class of the error","enum":["SETUP","VALIDATION","INSTRUMENT","ISSUER","FRAUD","WORKFLOW","CONNECTION","SYSTEM"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable error code to branch on","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the error","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"retriable":{"type":"boolean","description":"Whether retrying the same request, with the same `x-idempotency-key`, can succeed","isRequired":true,"uniqueKey":"errors.items.[INDEX].retriable","typeLabel":"boolean"},"field":{"type":"string","description":"The invalid request field. Present on validation errors only.","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Correlation ID of the request. Include it when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"category":"VALIDATION","code":"ENTITY_NOT_FOUND","message":"The terminal was not found.","retriable":false}],"request_id":"550e8400-e29b-41d4-a716-446655440000"},"examples":{"Example":{"title":"Example","value":{"errors":[{"category":"VALIDATION","code":"ENTITY_NOT_FOUND","message":"The terminal was not found.","retriable":false}],"request_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"examples"}},"exampleType":"examples"},"b1a17f36-74d2-4a86-a396-900dee8d57ba":{"description":"An unexpected error occurred on the server.\n\nReturned when an unhandled exception or infrastructure failure prevents the request from being processed. Retry the request with exponential backoff.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","timestamp"],"properties":{"code":{"type":"string","description":"Error code identifying the type of error","example":"PAYMENT_DETAILS_MISMATCH","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description","example":"The request was invalid or malformed","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp when the error occurred","example":"2024-12-16T10:30:00.000Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","description":"Additional error details","uniqueKey":"error.details","typeLabel":"object"},"correlation_id":{"type":"string","format":"uuid","description":"Correlation ID for tracking the request","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"error.correlation_id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"PAYMENT_DETAILS_MISMATCH","message":"The request was invalid or malformed","timestamp":"2024-12-16T10:30:00.000Z","details":{},"correlation_id":"550e8400-e29b-41d4-a716-446655440000"}}}},"exampleType":"generated"}},"exampleType":"generated"},"332fcd59-3887-474e-913c-34fe00f3dc19":{"description":"The terminal could not be confirmed (`PROVIDER_UNAVAILABLE`). This is temporary: retry with the\nsame `x-idempotency-key`.\n","content":{"application/json":{"schema":{"type":"object","description":"Error body returned by endpoints behind the external exception filter. Branch on\n`errors[].code`; `message` is readable text whose wording may change.\n","required":["errors","request_id"],"properties":{"errors":{"type":"array","description":"One item per problem. A validation failure returns one item per invalid field.","minItems":1,"items":{"type":"object","required":["category","code","message","retriable"],"properties":{"category":{"type":"string","description":"Broad class of the error","enum":["SETUP","VALIDATION","INSTRUMENT","ISSUER","FRAUD","WORKFLOW","CONNECTION","SYSTEM"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable error code to branch on","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the error","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"retriable":{"type":"boolean","description":"Whether retrying the same request, with the same `x-idempotency-key`, can succeed","isRequired":true,"uniqueKey":"errors.items.[INDEX].retriable","typeLabel":"boolean"},"field":{"type":"string","description":"The invalid request field. Present on validation errors only.","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Correlation ID of the request. Include it when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"category":"CONNECTION","code":"PROVIDER_UNAVAILABLE","message":"The terminal could not be confirmed. Retry the request.","retriable":true}],"request_id":"550e8400-e29b-41d4-a716-446655440000"},"examples":{"Example":{"title":"Example","value":{"errors":[{"category":"CONNECTION","code":"PROVIDER_UNAVAILABLE","message":"The terminal could not be confirmed. Retry the request.","retriable":true}],"request_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"855f167a-230a-48f4-a5d4-c5db35bd37fd":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for service-to-service or merchant authentication.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"58372e5d-e9ba-456c-b011-0b2ba37c00ab":{"url":"https://api.lite.sa","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for service-to-service or merchant authentication.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"API key for service-to-service or merchant authentication.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/payment-acceptance.json"},"subdomain":"lite-92e7ad3a","siteName":"lite Payments API Reference","title":"Create a checkout session - lite Payments API Reference","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T09:33:57.630Z","originalFileLocation":"api-reference/hosted-checkout/create-a-checkout-session.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new hosted checkout session and returns a payment link and client secret for use in the frontend SDK.\">\u003cmeta data-mint-head name=\"application-name\" content=\"lite Payments API Reference\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a checkout session - lite Payments API Reference\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new hosted checkout session and returns a payment link and client secret for use in the frontend SDK.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"lite Payments API Reference\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lite-92e7ad3a.mintlify.app/_mintlify/api/og/v2?division=Hosted+Checkout\u0026amp;title=Create+a+checkout+session\u0026amp;description=Creates+a+new+hosted+checkout+session+and+returns+a+payment+link+and+client%0Asecret+for+use+in+the+frontend+SDK.%0A\u0026amp;theme=7b869e5752aa04978885b3e8\u0026amp;signature=c3207936d3014083bb0fc2273063c36e727cbfa8dd5f023a39234641619f6fc7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a checkout session - lite Payments API Reference\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new hosted checkout session and returns a payment link and client secret for use in the frontend SDK.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lite-92e7ad3a.mintlify.app/_mintlify/api/og/v2?division=Hosted+Checkout\u0026amp;title=Create+a+checkout+session\u0026amp;description=Creates+a+new+hosted+checkout+session+and+returns+a+payment+link+and+client%0Asecret+for+use+in+the+frontend+SDK.%0A\u0026amp;theme=7b869e5752aa04978885b3e8\u0026amp;signature=c3207936d3014083bb0fc2273063c36e727cbfa8dd5f023a39234641619f6fc7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lite-92e7ad3a/0vj2oEL4xflrXeuz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"lite Payments API Reference\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6B4EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/hosted-checkout/create-a-checkout-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lite.sa/#organization\",\"name\":\"lite Payments API Reference\",\"url\":\"https://docs.lite.sa\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lite-92e7ad3a/uYpyqnuSvOdBocms/logo/lite-light.svg?fit=max\u0026auto=format\u0026n=uYpyqnuSvOdBocms\u0026q=85\u0026s=7d85c532514181dd38e2af8db58c4f3f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lite.sa#website\",\"name\":\"lite Payments API Reference\",\"url\":\"https://docs.lite.sa\",\"publisher\":{\"@id\":\"https://docs.lite.sa/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session#webpage\",\"url\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session\",\"name\":\"Create a checkout session\",\"description\":\"Creates a new hosted checkout session and returns a payment link and client secret for use in the frontend SDK.\",\"dateModified\":\"2026-10-22T09:33:57.630Z\",\"isPartOf\":{\"@id\":\"https://docs.lite.sa#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payment Acceptance\",\"item\":\"https://docs.lite.sa/api-reference/3ds-authentication/create-an-authentication-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a checkout session\",\"item\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session#apireference\",\"headline\":\"Create a checkout session\",\"name\":\"Create a checkout session\",\"description\":\"Creates a new hosted checkout session and returns a payment link and client secret for use in the frontend SDK.\",\"url\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session#webpage\"},\"dateModified\":\"2026-10-22T09:33:57.630Z\",\"publisher\":{\"@id\":\"https://docs.lite.sa/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lite.sa#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"lite Payments API Reference\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"lite Payments API Reference","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book","pages":[{"title":"Guides","href":"/guides/get-started"}]},{"tab":"API Reference","icon":"scroll","groups":[{"group":"Payment Acceptance","pages":[{"group":"3DS Authentication","pages":[{"title":"Create an authentication session","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /threeds/authenticate","href":"/api-reference/3ds-authentication/create-an-authentication-session"},{"title":"Get an authentication session","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /threeds/{authentication_id}","href":"/api-reference/3ds-authentication/get-an-authentication-session"},{"title":"Confirm challenge completion","description":"Confirms that the cardholder has completed the 3DS challenge. The authentication session must be in CHALLENGE_REQUIRED status.\n","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /threeds/{authentication_id}/confirm","href":"/api-reference/3ds-authentication/confirm-challenge-completion"}]},{"group":"Hosted Checkout","pages":[{"title":"Create a checkout session","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /checkout-sessions","href":"/api-reference/hosted-checkout/create-a-checkout-session"},{"title":"Get a checkout session","description":"Retrieves a checkout session with full details including available payment\nmethods, checkout configuration, and HATEOAS action links.\n","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /checkout-sessions/{session_id}","href":"/api-reference/hosted-checkout/get-a-checkout-session"},{"title":"Update a checkout session","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json patch /checkout-sessions/{session_id}","href":"/api-reference/hosted-checkout/update-a-checkout-session"},{"title":"Check session validity","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /checkout-sessions/{session_id}/validity","href":"/api-reference/hosted-checkout/check-session-validity"}]},{"group":"Payment Links","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payment-links","href":"/api-reference/payment-links/list-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /payment-links","href":"/api-reference/payment-links/create-a-payment-link"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payment-links/{link_id}","href":"/api-reference/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json patch /payment-links/{link_id}","href":"/api-reference/payment-links/update-a-payment-link"},{"title":"List consumption attempts for a payment link","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payment-links/{link_id}/consumptions","href":"/api-reference/payment-links/list-consumption-attempts-for-a-payment-link"}]},{"group":"Server-to-Server Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payments","href":"/api-reference/server-to-server-payments/list-payments"},{"title":"Create a new payment","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /payments","href":"/api-reference/server-to-server-payments/create-a-new-payment"},{"title":"Get payment by ID","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payments/{payment_id}","href":"/api-reference/server-to-server-payments/get-payment-by-id"},{"title":"Get payment by order ID","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payments/orders/{order_id}","href":"/api-reference/server-to-server-payments/get-payment-by-order-id"},{"title":"Capture an authorized payment","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /payments/{payment_id}/capture","href":"/api-reference/server-to-server-payments/capture-an-authorized-payment"},{"title":"Void an authorized payment","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /payments/{payment_id}/void","href":"/api-reference/server-to-server-payments/void-an-authorized-payment"},{"title":"Refund a captured payment","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /payments/{payment_id}/refund","href":"/api-reference/server-to-server-payments/refund-a-captured-payment"},{"title":"List payment reports","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payments/reports","href":"/api-reference/server-to-server-payments/list-payment-reports"},{"title":"Request a payment report","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json post /payments/reports","href":"/api-reference/server-to-server-payments/request-a-payment-report"},{"title":"Get a single payment report","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payments/reports/{report_id}","href":"/api-reference/server-to-server-payments/get-a-single-payment-report"},{"title":"Mint a download URL for a completed report","deprecated":null,"version":null,"openapi":"/openapi/payment-acceptance.json get /payments/reports/{report_id}/download","href":"/api-reference/server-to-server-payments/mint-a-download-url-for-a-completed-report"}]}]},{"group":"Tokenization","pages":[{"group":"Payment Instruments","pages":[{"title":"Lookup instruments","deprecated":null,"version":null,"openapi":"/openapi/payment-instruments.json get /instruments","href":"/api-reference/payment-instruments/lookup-instruments"},{"title":"Create a payment instrument","deprecated":null,"version":null,"openapi":"/openapi/payment-instruments.json post /instruments","href":"/api-reference/payment-instruments/create-a-payment-instrument"},{"title":"Get an instrument by ID","deprecated":null,"version":null,"openapi":"/openapi/payment-instruments.json get /instruments/{instrument_id}","href":"/api-reference/payment-instruments/get-an-instrument-by-id"}]}]},{"group":"Account Settlement","pages":[{"group":"Settlement Windows","pages":[{"title":"List settlement windows","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlement/settlement-windows","href":"/api-reference/settlement-windows/list-settlement-windows"},{"title":"Get settlement window by ID","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlement/settlement-windows/{id}","href":"/api-reference/settlement-windows/get-settlement-window-by-id"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlements/transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlements/transactions/{id}","href":"/api-reference/transactions/get-transaction-by-id"},{"title":"Get transaction by external reference ID","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlement/transactions/external-reference/{external_reference_id}","href":"/api-reference/transactions/get-transaction-by-external-reference-id"}]},{"group":"Settlement","pages":[{"title":"List acceptance accounts","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /accounts/acceptance-accounts","href":"/api-reference/settlement/list-acceptance-accounts"},{"title":"Get acceptance account by ID","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /accounts/acceptance-accounts/{id}","href":"/api-reference/settlement/get-acceptance-account-by-id"},{"title":"List settlement accounts","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlements/settlement-accounts","href":"/api-reference/settlement/list-settlement-accounts"},{"title":"Register a settlement account","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json post /settlements/settlement-accounts","href":"/api-reference/settlement/register-a-settlement-account"},{"title":"Get settlement account by ID","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlements/settlement-accounts/{id}","href":"/api-reference/settlement/get-settlement-account-by-id"},{"title":"Delete a settlement account","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json delete /settlements/settlement-accounts/{id}","href":"/api-reference/settlement/delete-a-settlement-account"},{"title":"List payouts","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlements/payouts","href":"/api-reference/settlement/list-payouts"},{"title":"Create a payout","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json post /settlements/payouts","href":"/api-reference/settlement/create-a-payout"},{"title":"Get payout by ID","deprecated":null,"version":null,"openapi":"/openapi/account-settlement.json get /settlements/payouts/{id}","href":"/api-reference/settlement/get-payout-by-id"},{"title":"Payout succeeded","version":null,"deprecated":null,"openapi":"/openapi/account-settlement.json webhook payout.succeeded","href":"/api-reference/settlement/payout-succeeded"},{"title":"Payout failed","version":null,"deprecated":null,"openapi":"/openapi/account-settlement.json webhook payout.failed","href":"/api-reference/settlement/payout-failed"},{"title":"Payout reversed","version":null,"deprecated":null,"openapi":"/openapi/account-settlement.json webhook payout.reversed","href":"/api-reference/settlement/payout-reversed"}]}]}]},{"tab":"Data Models","icon":"scroll","pages":[{"title":"Data Models","href":"/schemas/account-settlement/FeeSummary"}]}]},"title":"Create a checkout session - lite Payments API Reference","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-7TwLLapg.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}