Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings.
A session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.
The HTTP request information used to redirect the customer upon completion of the session.
Required for sessions that include an order and use redirect checkout, and for any session that tokenizes a customer — including standalone tokenization, where it is the destination the customer returns to after approving.
The HTTP request information used to redirect the customer in the case of a cancellation.
Required for sessions that include an order and use redirect checkout. Optional for standalone tokenization sessions, which have no order to cancel — supply it only if you want a separate destination for customers who decline.
The customer's shipping address.
Merchants enrolled in Sezzle's Long Term Lending program (as well as general integrations) must send a Customer object that includes, at a minimum, a complete and valid shipping_address object. Post office box (i.e., P. O. Box) addresses are not accepted for this purpose. For more details, please contact your account manager.
Tokenizing a customer allows you to authorize future transactions on their behalf. If omitted, will default to false.
To create an order and tokenize a customer in a single session, set customer.tokenize to true and provide an order object. The user will be prompted to accept tokenization during checkout.
To tokenize a customer without a purchase (standalone tokenization), set customer.tokenize to true and omit the order object. The response returns tokenize.approval_url to redirect the customer to. Standalone tokenization is enabled per merchant — contact your account manager.
Indicates whether the tokenization is part of a recurring subscription.
true - The token is associated with a subscription and will be reused for future charges.
false - The token is for a one-time use, such as Pre-order or Single Tokenization.
The name of the subscription plan associated with the recurring tokenization. This field provides context for the recurring charge agreement and can be shown in checkout
Use CAPTURE if payment should be captured immediately upon shopper authorization
Use AUTH if there is any post-authorization validation needed prior to capture, such as inventory validation or regulatory requirements, or if merchant policy is to charge the payment method at time of shipment
Submit a capture request via the API or your Merchant Dashboard before the authorization expires.
The authorization expiration window can be set from 30 minutes up to 7 days in your Merchant Dashboard Settings.
If not specified, the value will default to CAPTURE
The checkout or cart ID from the merchant, currently used for tracking only (must contain only alphanumeric characters, dashes (-), and underscores (_))
A Price object containing the total amount in cents of the order, which must be at least 100 which is $1.00. Please note your merchant configuration might have a higher minimum.
Object for any custom data you want to submit with the checkout. You are not limited to the key-value pairs shown in the example, and you may use any key-value pairs you like
The category path where the product is located. Use > only as the category delimiter, not as part of a product or category name. Example: Camping Gear & Supplies > Tents & Shelters.
Flag to indicate if you would like us to collect shipping information for this checkout from the customer. If omitted, defaults to false. Required for express checkout flow if express_checkout_type is single-step or multi-step.
The mode for the order checkout. Defaults to redirect if not provided. If iframe or popup is provided, then the cancel and complete URLs must include the origin of the parent window.
The date until which the shopper can access the checkout_url to complete the order, in ISO 8601 date/time format. If omitted, defaults to 30 minutes after creation. Values more than 7 days out are capped at 7 days.
Localizes the checkout. Accepted values are en-US (English, United States), en-CA (English, Canada) and fr-CA (French, Canada). Defaults to en-US if not provided.
single-step: only one shipping method exists, or only use default shipping method for Sezzle express checkout flow
multi-step: allow the user to select from merchant-supported shipping methods
no-shipping: purchase contains no shippable items and shopper does not have option to select, such as digital download or buy online pick up in store (BOPIS).
The relationship type indicating the purpose of this link (e.g., 'self' for the current resource, 'create' for creating a new resource, 'list' for listing resources)
Use CAPTURE if payment should be captured immediately upon shopper authorization
Use AUTH if there is any post-authorization validation needed prior to capture, such as inventory validation or regulatory requirements, or if merchant policy is to charge the payment method at time of shipment
Submit a capture request via the API or your Merchant Dashboard before the authorization expires.
The authorization expiration window can be set from 30 minutes up to 7 days in your Merchant Dashboard Settings.
If not specified, the value will default to CAPTURE
The relationship type indicating the purpose of this link (e.g., 'self' for the current resource, 'create' for creating a new resource, 'list' for listing resources)
This token represents the merchant request to tokenize a customer. This token can only be used one time. Once a user accepts/denies tokenization, this token and its approval URL will be obsolete.
The URL for the user to accept tokenization. This URL does not create an order and the customer is not charged; it is only used for tokenizing a customer.
Returned only for standalone tokenization — a session with customer.tokenize set to true and no order object — and only for merchants who have standalone tokenization enabled. It is omitted for sessions that include an order, where the customer authorizes tokenization during checkout instead.
The URL expires 30 minutes after the session is created, which is sooner than the expiration field above. Create the session at the moment the customer clicks to authorize.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Sezzle","colors":{"primary":"#8512e0","light":"#9e05f7","dark":"#382854"},"logo":{"light":"https://mintcdn.com/sezzle/01t5INarB6euKvP6/images/Sezzle_Logo_FullColor.svg?fit=max\u0026auto=format\u0026n=01t5INarB6euKvP6\u0026q=85\u0026s=5fc8a5aa9010b739b2874aa847929f68","dark":"https://mintcdn.com/sezzle/01t5INarB6euKvP6/images/Sezzle_Logo_FullColor_WhiteWM.svg?fit=max\u0026auto=format\u0026n=01t5INarB6euKvP6\u0026q=85\u0026s=29ba90f838043d564e396099c010812c","href":"https://docs.sezzle.com/docs/guides/sezzle/introduction"},"favicon":"https://mintcdn.com/sezzle/hKhvshWly4M3cXTJ/favicon.ico?fit=max\u0026auto=format\u0026n=hKhvshWly4M3cXTJ\u0026q=85\u0026s=11d74ec64895c6ac02eaafb1e22814c7","api":{"params":{"expanded":"all"}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://dashboard.sezzle.com/merchant/signup","label":"Sign Up"}],"primary":{"type":"button","label":"Log In","href":"https://dashboard.sezzle.com/merchant/login"}},"footer":{"socials":{"facebook":"https://www.facebook.com/sezzle","instagram":"https://www.instagram.com/sezzle","x":"https://twitter.com/sezzleinc","linkedin":"https://www.linkedin.com/company/sezzle"}},"styling":{"eyebrows":"section","codeblocks":"system","latex":true},"contextual":{"options":["copy","assistant","chatgpt","claude","view"],"display":"header"},"navigation":{"languages":[{"language":"en","href":"docs/guides/sezzle/introduction"},{"language":"fr","href":"fr/docs/guides/sezzle/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sezzle","hasAudioNarration":false,"actualSubdomain":"sezzle","customDomains":["docs.sezzle.com"],"gitSource":{"type":"github","owner":"sezzle","repo":"merchant-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae362f84d48ffa49b8b1813","collectionId":"076644d9-6528-4506-be23-e734f3a1c8b8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae362f84d48ffa49b8b1813"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae362f84d48ffa49b8b1813","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"en","tag":"API Docs","count":51},{"language":"fr","tag":"Documentation API","count":51},{"language":"en","tag":"API Reference","count":33},{"language":"fr","tag":"Référence API","count":33},{"language":"en","tag":"Core API","count":28},{"language":"fr","tag":"API Core","count":28},{"language":"en","tag":"Guides","count":22},{"language":"fr","tag":"Guides","count":21},{"language":"en","tag":"Platforms","count":19},{"language":"fr","tag":"Plateformes","count":19},{"language":"en","tag":"Orders","count":11},{"language":"en","tag":"v1 (deprecated)","count":11},{"language":"en","tag":"Other Platforms","count":11},{"language":"fr","tag":"Commandes","count":11},{"language":"fr","tag":"v1 (obsolète)","count":11},{"language":"fr","tag":"Autres Plateformes","count":11},{"language":"en","tag":"Webhooks","count":7},{"language":"en","tag":"Tokenization","count":7},{"language":"fr","tag":"Webhooks","count":7},{"language":"fr","tag":"Tokenisation","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"fr/docs/api/core/sessions/postv2session","slug":"/fr/docs/api/core/sessions/postv2session","pageMetadata":{"title":"Créer une session","id":"session-post","openapi":"post /v2/session","description":"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings.\nA session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\n","href":"/fr/docs/api/core/sessions/postv2session"},"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: \"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings.\\nA session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Créer une session","id":"session-post","openapi":"post /v2/session","description":"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings.\nA session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\n","href":"/fr/docs/api/core/sessions/postv2session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/sezzle/6c8e4f8d07136df6/widget-bundle.js","/_mintlify/custom/sezzle/cb5e9435d501a8cd/agent-tools.js"],"openApiReferenceData":{"operation":{"operationId":"HandleNewSession","description":"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings.\nA session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\n","summary":"Create a new session","tags":["Session"],"requestBody":"60231ff4-35b1-480c-8422-250fdba502d0","responses":{"201":"914008a0-19e1-40c6-9477-9c4ca55bacc2","400":"ac4eee90-65e7-4a20-b1aa-bcd627cd784f","401":"aaa0627d-2164-4138-ba5f-86fc435c0dfa","404":"ee5456b6-04f8-4b69-80a4-2fe2ec27b302","422":"0a8acd98-94ab-4406-b2c6-a82a8dff50ab"},"method":"post","type":"path","servers":["5b5596f5-c4d9-41c0-89f5-e86da59547cd","e3dace99-9f2f-4e98-85f7-7372b28712ce"],"security":["849dbee1-17b4-439f-a57a-a2d119b8e432"],"path":"/v2/session","baseUrlOptions":["https://sandbox.gateway.sezzle.com","https://gateway.sezzle.com"],"title":"Create a new session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["complete_url"],"properties":{"complete_url":{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The URL used when redirecting a customer upon order completion","isRequired":true,"uniqueKey":"complete_url.href","typeLabel":"string"},"method":{"type":"string","description":"The HTTP request method used when redirecting a customer. Currently only the GET method is supported. If omitted, will default to GET.","uniqueKey":"complete_url.method","typeLabel":"string"}},"description":"The HTTP request information used to redirect the customer upon completion of the session.\nRequired for sessions that include an order and use redirect checkout, and for any session that tokenizes a customer — including standalone tokenization, where it is the destination the customer returns to after approving.\n","isRequired":true,"uniqueKey":"complete_url","typeLabel":"object"},"cancel_url":{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The URL used when redirecting a customer upon order cancellation","isRequired":true,"uniqueKey":"cancel_url.href","typeLabel":"string"},"method":{"type":"string","description":"The HTTP request method used when redirecting a customer. Currently only the GET method is supported. If omitted, will default to GET.","uniqueKey":"cancel_url.method","typeLabel":"string"}},"description":"The HTTP request information used to redirect the customer in the case of a cancellation.\nRequired for sessions that include an order and use redirect checkout. Optional for standalone tokenization sessions, which have no order to cancel — supply it only if you want a separate destination for customers who decline.\n","uniqueKey":"cancel_url","typeLabel":"object"},"customer":{"type":"object","description":"Customer details for this session. To optimize checkout and boost conversion, it is recommended to include as much customer information as possible.","properties":{"first_name":{"type":"string","description":"The customer's first name","uniqueKey":"customer.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"The customer's last name","uniqueKey":"customer.last_name","typeLabel":"string"},"email":{"type":"string","description":"The customer's email address","uniqueKey":"customer.email","typeLabel":"string"},"phone":{"type":"string","description":"The customer's phone number","uniqueKey":"customer.phone","typeLabel":"string"},"billing_address":{"type":"object","description":"The customer's billing address","properties":{"name":{"type":"string","description":"The name on the address","uniqueKey":"customer.billing_address.name","typeLabel":"string"},"street":{"type":"string","description":"The street and number of the address","uniqueKey":"customer.billing_address.street","typeLabel":"string"},"street2":{"type":"string","description":"The apt or unit","uniqueKey":"customer.billing_address.street2","typeLabel":"string"},"city":{"type":"string","description":"The city","uniqueKey":"customer.billing_address.city","typeLabel":"string"},"state":{"type":"string","description":"The 2 character state code","uniqueKey":"customer.billing_address.state","typeLabel":"string"},"postal_code":{"type":"string","description":"The postal delivery code","uniqueKey":"customer.billing_address.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"The 2 character country code","uniqueKey":"customer.billing_address.country_code","typeLabel":"string"},"phone":{"type":"string","description":"The phone number at the delivery location","uniqueKey":"customer.billing_address.phone","typeLabel":"string"}},"uniqueKey":"customer.billing_address","typeLabel":"object"},"shipping_address":{"type":"object","description":"The customer's shipping address.\nMerchants enrolled in Sezzle's Long Term Lending program (as well as general integrations) must send a Customer object that includes, at a minimum, a complete and valid shipping_address object. Post office box (i.e., P. O. Box) addresses are not accepted for this purpose. For more details, please contact your account manager.\n","properties":{"name":{"type":"string","description":"The name on the address","uniqueKey":"customer.shipping_address.name","typeLabel":"string"},"street":{"type":"string","description":"The street and number of the address","uniqueKey":"customer.shipping_address.street","typeLabel":"string"},"street2":{"type":"string","description":"The apt or unit","uniqueKey":"customer.shipping_address.street2","typeLabel":"string"},"city":{"type":"string","description":"The city","uniqueKey":"customer.shipping_address.city","typeLabel":"string"},"state":{"type":"string","description":"The 2 character state code","uniqueKey":"customer.shipping_address.state","typeLabel":"string"},"postal_code":{"type":"string","description":"The postal delivery code","uniqueKey":"customer.shipping_address.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"The 2 character country code","uniqueKey":"customer.shipping_address.country_code","typeLabel":"string"},"phone":{"type":"string","description":"The phone number at the delivery location","uniqueKey":"customer.shipping_address.phone","typeLabel":"string"}},"uniqueKey":"customer.shipping_address","typeLabel":"object"},"dob":{"type":"string","format":"YYYY-MM-DD","description":"The customer's date of birth in YYYY-MM-DD format (parameter is input only)","uniqueKey":"customer.dob","typeLabel":"string\u003cYYYY-MM-DD>"},"tokenize":{"type":"boolean","description":"Tokenizing a customer allows you to authorize future transactions on their behalf. If omitted, will default to false.\nTo create an order and tokenize a customer in a single session, set customer.tokenize to true and provide an order object. The user will be prompted to accept tokenization during checkout.\nTo tokenize a customer without a purchase (standalone tokenization), set customer.tokenize to true and omit the order object. The response returns tokenize.approval_url to redirect the customer to. Standalone tokenization is enabled per merchant — contact your account manager.\n","uniqueKey":"customer.tokenize","typeLabel":"boolean"},"recurring":{"type":"boolean","description":"Indicates whether the tokenization is part of a recurring subscription. \n true - The token is associated with a subscription and will be reused for future charges.\n false - The token is for a one-time use, such as Pre-order or Single Tokenization.\n","uniqueKey":"customer.recurring","typeLabel":"boolean"},"recurring_metadata":{"type":"object","properties":{"name":{"type":"string","description":"The name of the subscription plan associated with the recurring tokenization. This field provides context for the recurring charge agreement and can be shown in checkout\n","uniqueKey":"customer.recurring_metadata.name","typeLabel":"string"}},"uniqueKey":"customer.recurring_metadata","typeLabel":"object"}},"uniqueKey":"customer","typeLabel":"object"},"order":{"type":"object","description":"Order ID, amount, and capture intent. Order details optional.\n","required":["intent","reference_id","description","order_amount"],"properties":{"intent":{"type":"string","description":"- Use CAPTURE if payment should be captured immediately upon shopper authorization\n- Use AUTH if there is any post-authorization validation needed prior to capture, such as inventory validation or regulatory requirements, or if merchant policy is to charge the payment method at time of shipment\n - Submit a capture request via the API or your Merchant Dashboard before the authorization expires.\n - The authorization expiration window can be set from 30 minutes up to 7 days in your Merchant Dashboard Settings. \n- If not specified, the value will default to CAPTURE\n","enum":["AUTH","CAPTURE"],"isRequired":true,"uniqueKey":"order.intent","typeLabel":"enum\u003cstring>"},"reference_id":{"type":"string","description":"The checkout or cart ID from the merchant, currently used for tracking only (must contain only alphanumeric characters, dashes (-), and underscores (_))","isRequired":true,"uniqueKey":"order.reference_id","typeLabel":"string"},"order_amount":{"type":"object","description":"A Price object containing the total amount in cents of the order, which must be at least 100 which is $1.00. Please note your merchant configuration might have a higher minimum.","required":["amount_in_cents","currency"],"properties":{"amount_in_cents":{"type":"integer","description":"The amount in cents","isRequired":true,"uniqueKey":"order.order_amount.amount_in_cents","typeLabel":"integer"},"currency":{"type":"string","description":"The 3 character currency code as defined by ISO 4217","isRequired":true,"uniqueKey":"order.order_amount.currency","typeLabel":"string"}},"isRequired":true,"uniqueKey":"order.order_amount","typeLabel":"object"},"description":{"type":"string","description":"Your description for this order","isRequired":true,"uniqueKey":"order.description","typeLabel":"string"},"metadata":{"type":"object","description":"Object for any custom data you want to submit with the checkout. You are not limited to the key-value pairs shown in the example, and you may use any key-value pairs you like","properties":{"any":{"type":"string","description":"Custom metadata field","uniqueKey":"order.metadata.any","typeLabel":"string"}},"uniqueKey":"order.metadata","typeLabel":"object"},"items":{"type":"array","description":"The items being purchased","items":{"type":"object","description":"Merchants who are in the Sports \u0026 Hobbies or Hunting \u0026 Fishing categories must define a category_path for each item in the order. Please talk with your account manager for further details.","properties":{"name":{"type":"string","description":"The name of the item","uniqueKey":"order.\\items.items.[INDEX].name","typeLabel":"string"},"sku":{"type":"string","description":"The sku identifier","uniqueKey":"order.\\items.items.[INDEX].sku","typeLabel":"string"},"quantity":{"type":"integer","description":"The quantity purchased","uniqueKey":"order.\\items.items.[INDEX].quantity","typeLabel":"integer"},"price":{"type":"object","description":"The price of the product before tax and discounts","required":["amount_in_cents","currency"],"properties":{"amount_in_cents":{"type":"integer","description":"The amount in cents","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].price.amount_in_cents","typeLabel":"integer"},"currency":{"type":"string","description":"The 3 character currency code as defined by ISO 4217","isRequired":true,"uniqueKey":"order.\\items.items.[INDEX].price.currency","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX].price","typeLabel":"object"},"category_path":{"type":"string","description":"The category path where the product is located. Use `>` only as the category delimiter, not as part of a product or category name. Example: Camping Gear \u0026 Supplies > Tents \u0026 Shelters.","uniqueKey":"order.\\items.items.[INDEX].category_path","typeLabel":"string"},"brand":{"type":"string","description":"The products brand name as customers would recognize. Examples: Nike, Kelty, Brooks, Carhartt, Columbia","uniqueKey":"order.\\items.items.[INDEX].brand","typeLabel":"string"},"image_url":{"type":"string","description":"The fully qualified URL that shows the image","uniqueKey":"order.\\items.items.[INDEX].image_url","typeLabel":"string"},"product_url":{"type":"string","description":"The fully qualified URL that links directly to the product being purchased","uniqueKey":"order.\\items.items.[INDEX].product_url","typeLabel":"string"},"global_trade_item_number":{"type":"string","description":"The products Global Trade Item Number (GTIN). Common types include UPC, ISBN, EAN. Exclude dashes and spaces.","uniqueKey":"order.\\items.items.[INDEX].global_trade_item_number","typeLabel":"string"},"manufacturer_part_number":{"type":"string","description":"The products Manufacturer Part Number (MPN) which together with brand can uniquely identify a product.","uniqueKey":"order.\\items.items.[INDEX].manufacturer_part_number","typeLabel":"string"}},"uniqueKey":"order.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.\\items","typeLabel":"object[]"},"requires_shipping_info":{"type":"boolean","description":"Flag to indicate if you would like us to collect shipping information for this checkout from the customer. If omitted, defaults to false. Required for express checkout flow if express_checkout_type is single-step or multi-step.","uniqueKey":"order.requires_shipping_info","typeLabel":"boolean"},"discounts":{"type":"array","description":"The discounts applied to this order. Must be included in total","items":{"type":"object","properties":{"name":{"type":"string","description":"The description of the discount","uniqueKey":"order.discounts.items.[INDEX].name","typeLabel":"string"},"amount":{"type":"object","description":"A price object","required":["amount_in_cents","currency"],"properties":{"amount_in_cents":{"type":"integer","description":"The amount in cents","isRequired":true,"uniqueKey":"order.discounts.items.[INDEX].amount.amount_in_cents","typeLabel":"integer"},"currency":{"type":"string","description":"The 3 character currency code as defined by ISO 4217","isRequired":true,"uniqueKey":"order.discounts.items.[INDEX].amount.currency","typeLabel":"string"}},"uniqueKey":"order.discounts.items.[INDEX].amount","typeLabel":"object"}},"uniqueKey":"order.discounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.discounts","typeLabel":"object[]"},"tax_amount":{"type":"object","description":"The taxes applied to this order. Must be included in the total","required":["amount_in_cents","currency"],"properties":{"amount_in_cents":{"type":"integer","description":"The amount in cents","isRequired":true,"uniqueKey":"order.tax_amount.amount_in_cents","typeLabel":"integer"},"currency":{"type":"string","description":"The 3 character currency code as defined by ISO 4217","isRequired":true,"uniqueKey":"order.tax_amount.currency","typeLabel":"string"}},"uniqueKey":"order.tax_amount","typeLabel":"object"},"shipping_amount":{"type":"object","description":"The shipping fees applied to this order. Must be included in the total","required":["amount_in_cents","currency"],"properties":{"amount_in_cents":{"type":"integer","description":"The amount in cents","isRequired":true,"uniqueKey":"order.shipping_amount.amount_in_cents","typeLabel":"integer"},"currency":{"type":"string","description":"The 3 character currency code as defined by ISO 4217","isRequired":true,"uniqueKey":"order.shipping_amount.currency","typeLabel":"string"}},"uniqueKey":"order.shipping_amount","typeLabel":"object"},"checkout_mode":{"type":"string","description":"The mode for the order checkout. Defaults to redirect if not provided. If iframe or popup is provided, then the cancel and complete URLs must include the origin of the parent window.","enum":["iframe","popup","redirect"],"uniqueKey":"order.checkout_mode","typeLabel":"enum\u003cstring>"},"send_checkout_url":{"type":"object","properties":{"to_sms_phone":{"type":"string","description":"The SMS phone number of the notification","uniqueKey":"order.send_checkout_url.to_sms_phone","typeLabel":"string"},"to_email":{"type":"string","description":"The email address of the notification","uniqueKey":"order.send_checkout_url.to_email","typeLabel":"string"},"language":{"type":"string","description":"The language of the notification. Acceptable values are en and fr-CA. Will default to English if not provided.","enum":["en","fr-CA"],"uniqueKey":"order.send_checkout_url.language","typeLabel":"enum\u003cstring>"}},"description":"A Notification object for sending checkout URL to the customer","uniqueKey":"order.send_checkout_url","typeLabel":"object"},"checkout_expiration":{"type":"string","format":"date-time","description":"The date until which the shopper can access the checkout_url to complete the order, in ISO 8601 date/time format. If omitted, defaults to 30 minutes after creation. Values more than 7 days out are capped at 7 days.","uniqueKey":"order.checkout_expiration","typeLabel":"string\u003cdate-time>"},"locale":{"type":"string","description":"Localizes the checkout. Accepted values are en-US (English, United States), en-CA (English, Canada) and fr-CA (French, Canada). Defaults to en-US if not provided.","enum":["en-US","en-CA","fr-CA"],"uniqueKey":"order.locale","typeLabel":"enum\u003cstring>"},"checkout_financing_options":{"type":"array","description":"The financing options of the checkout. Only one option can be included.","items":{"type":"string","description":"*currently not supported, defaults to 4-pay-biweekly*\n","enum":["4-pay-biweekly","4-pay-monthly","6-pay-monthly"],"uniqueKey":"order.checkout_financing_options.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"order.checkout_financing_options","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"order","typeLabel":"object"},"express_checkout_type":{"type":"string","description":"- single-step: only one shipping method exists, or only use default shipping method for Sezzle express checkout flow\n- multi-step: allow the user to select from merchant-supported shipping methods\n- no-shipping: purchase contains no shippable items and shopper does not have option to select, such as digital download or buy online pick up in store (BOPIS).\n","enum":["single-step","multi-step","no-shipping"],"uniqueKey":"express_checkout_type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"example":{"cancel_url":{"href":"https://example.com/cart","method":"GET"},"complete_url":{"href":"https://example.com/ord_12345/complete","method":"GET"},"customer":{"email":"john.doe@sezzle.com","first_name":"John","last_name":"Doe","phone":"5555045294","dob":"1990-02-25","billing_address":{"name":"John Doe","street":"123 W Lake St","street2":"Unit 104","city":"Minneapolis","state":"MN","postal_code":"55408","country_code":"US","phone_number":"5555045294"},"shipping_address":{"name":"John Doe","street":"123 W Lake St","street2":"Unit 104","city":"Minneapolis","state":"MN","postal_code":"55408","country_code":"US","phone_number":"5555045294"}},"order":{"intent":"CAPTURE","reference_id":"ord_12345","description":"sezzle-store - #12749253509255","items":[{"name":"widget","sku":"sku123456","quantity":1,"price":{"amount_in_cents":1000,"currency":"USD"}}],"discounts":[{"name":"20% off","amount":{"amount_in_cents":1000,"currency":"USD"}}],"metadata":{"location_id":"123","store_name":"Downtown Minneapolis","store_manager":"Jane Doe"},"shipping_amount":{"amount_in_cents":1000,"currency":"USD"},"tax_amount":{"amount_in_cents":1000,"currency":"USD"},"order_amount":{"amount_in_cents":10000,"currency":"USD"}}},"examples":{"Example":{"title":"Example","value":{"cancel_url":{"href":"https://example.com/cart","method":"GET"},"complete_url":{"href":"https://example.com/ord_12345/complete","method":"GET"},"customer":{"email":"john.doe@sezzle.com","first_name":"John","last_name":"Doe","phone":"5555045294","dob":"1990-02-25","billing_address":{"name":"John Doe","street":"123 W Lake St","street2":"Unit 104","city":"Minneapolis","state":"MN","postal_code":"55408","country_code":"US","phone_number":"5555045294"},"shipping_address":{"name":"John Doe","street":"123 W Lake St","street2":"Unit 104","city":"Minneapolis","state":"MN","postal_code":"55408","country_code":"US","phone_number":"5555045294"}},"order":{"intent":"CAPTURE","reference_id":"ord_12345","description":"sezzle-store - #12749253509255","items":[{"name":"widget","sku":"sku123456","quantity":1,"price":{"amount_in_cents":1000,"currency":"USD"}}],"discounts":[{"name":"20% off","amount":{"amount_in_cents":1000,"currency":"USD"}}],"metadata":{"location_id":"123","store_name":"Downtown Minneapolis","store_manager":"Jane Doe"},"shipping_amount":{"amount_in_cents":1000,"currency":"USD"},"tax_amount":{"amount_in_cents":1000,"currency":"USD"},"order_amount":{"amount_in_cents":10000,"currency":"USD"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"914008a0-19e1-40c6-9477-9c4ca55bacc2":{"description":"Successful Operation","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier for this response","uniqueKey":"uuid","typeLabel":"string"},"links":{"type":"array","description":"Available API links prefilled with UUID with accompanying method","items":{"type":"object","required":["href"],"properties":{"href":{"type":"string","description":"The fully qualified URL for the API endpoint","isRequired":true,"uniqueKey":"links.items.[INDEX].href","typeLabel":"string"},"rel":{"type":"string","description":"The relationship type indicating the purpose of this link (e.g., 'self' for the current resource, 'create' for creating a new resource, 'list' for listing resources)","enum":["self","capture","checkout","create","customer","list","order","preapprove","refund","release","session"],"uniqueKey":"links.items.[INDEX].rel","typeLabel":"enum\u003cstring>"},"method":{"type":"string","description":"The HTTP method to use when calling this API endpoint","enum":["GET","POST","PATCH","DELETE"],"uniqueKey":"links.items.[INDEX].method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"links.items.[INDEX]","typeLabel":"object"},"uniqueKey":"links","typeLabel":"object[]"},"order":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier for this order","uniqueKey":"order.uuid","typeLabel":"string"},"intent":{"type":"string","description":"- Use CAPTURE if payment should be captured immediately upon shopper authorization\n- Use AUTH if there is any post-authorization validation needed prior to capture, such as inventory validation or regulatory requirements, or if merchant policy is to charge the payment method at time of shipment\n - Submit a capture request via the API or your Merchant Dashboard before the authorization expires.\n - The authorization expiration window can be set from 30 minutes up to 7 days in your Merchant Dashboard Settings. \n- If not specified, the value will default to CAPTURE\n","enum":["AUTH","CAPTURE"],"uniqueKey":"order.intent","typeLabel":"enum\u003cstring>"},"checkout_url":{"type":"string","description":"The URL to which the shopper should be directed to complete their order with Sezzle","uniqueKey":"order.checkout_url","typeLabel":"string"},"links":{"type":"array","description":"Available API links prefilled with UUID with accompanying method","items":{"type":"object","required":["href"],"properties":{"href":{"type":"string","description":"The fully qualified URL for the API endpoint","isRequired":true,"uniqueKey":"order.links.items.[INDEX].href","typeLabel":"string"},"rel":{"type":"string","description":"The relationship type indicating the purpose of this link (e.g., 'self' for the current resource, 'create' for creating a new resource, 'list' for listing resources)","enum":["self","capture","checkout","create","customer","list","order","preapprove","refund","release","session"],"uniqueKey":"order.links.items.[INDEX].rel","typeLabel":"enum\u003cstring>"},"method":{"type":"string","description":"The HTTP method to use when calling this API endpoint","enum":["GET","POST","PATCH","DELETE"],"uniqueKey":"order.links.items.[INDEX].method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.links.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.links","typeLabel":"object[]"}},"description":"Order metadata required for checkout","uniqueKey":"order","typeLabel":"object"},"tokenize":{"type":"object","properties":{"token":{"type":"string","description":"This token represents the merchant request to tokenize a customer. This token can only be used one time. Once a user accepts/denies tokenization, this token and its approval URL will be obsolete.","uniqueKey":"tokenize.token","typeLabel":"string"},"expiration":{"type":"string","format":"date-time","description":"The expiration of the request token in ISO 8601 date/time format.","uniqueKey":"tokenize.expiration","typeLabel":"string\u003cdate-time>"},"approval_url":{"type":"string","description":"The URL for the user to accept tokenization. This URL does not create an order and the customer is not charged; it is only used for tokenizing a customer.\nReturned only for standalone tokenization — a session with customer.tokenize set to true and no order object — and only for merchants who have standalone tokenization enabled. It is omitted for sessions that include an order, where the customer authorizes tokenization during checkout instead.\nThe URL expires 30 minutes after the session is created, which is sooner than the expiration field above. Create the session at the moment the customer clicks to authorize.\n","uniqueKey":"tokenize.approval_url","typeLabel":"string"}},"description":"This is included in the response when starting a customer tokenization session.","uniqueKey":"tokenize","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"uuid":"fadbc642-05a4-4e38-9e74-80e325623af9","links":[{"href":"https://gateway.sezzle.com/v2/session/fadbc642-05a4-4e38-9e74-80e325623af9","method":"GET","rel":"self"}],"order":{"uuid":"12a34bc5-6de7-890f-g123-4hi1238jk902","checkout_url":"https://checkout.sezzle.com/?id=12a34bc5-6de7-890f-g123-4hi1238jk902","intent":"CAPTURE","links":[{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902","method":"GET","rel":"self"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902","method":"PATCH","rel":"self"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/release","method":"POST","rel":"release"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/capture","method":"POST","rel":"capture"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/refund","method":"POST","rel":"refund"}]}},"examples":{"Example":{"title":"Example","value":{"uuid":"fadbc642-05a4-4e38-9e74-80e325623af9","links":[{"href":"https://gateway.sezzle.com/v2/session/fadbc642-05a4-4e38-9e74-80e325623af9","method":"GET","rel":"self"}],"order":{"uuid":"12a34bc5-6de7-890f-g123-4hi1238jk902","checkout_url":"https://checkout.sezzle.com/?id=12a34bc5-6de7-890f-g123-4hi1238jk902","intent":"CAPTURE","links":[{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902","method":"GET","rel":"self"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902","method":"PATCH","rel":"self"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/release","method":"POST","rel":"release"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/capture","method":"POST","rel":"capture"},{"href":"https://gateway.sezzle.com/v2/order/12a34bc5-6de7-890f-g123-4hi1238jk902/refund","method":"POST","rel":"refund"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"ac4eee90-65e7-4a20-b1aa-bcd627cd784f":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The general error type","uniqueKey":"items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A more specific error message, if available","uniqueKey":"items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Where the error occurred","uniqueKey":"items.[INDEX].location","typeLabel":"string"},"debug_uuid":{"type":"string","description":"The unique identifier assigned to this error for troubleshooting","uniqueKey":"items.[INDEX].debug_uuid","typeLabel":"string"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"example":[{"code":"bad_request","message":"bad request"}],"examples":{"Example":{"title":"Example","value":[{"code":"bad_request","message":"bad request"}]}},"exampleType":"examples"}},"example":{"code":"bad request","message":"cannot unmarshal string into order.items.quantity","location":"order.items.quantity"},"exampleType":"examples"},"aaa0627d-2164-4138-ba5f-86fc435c0dfa":{"description":"Unauthorized. Returned for any failed bearer or basic auth, including expired bearer tokens.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The general error type","uniqueKey":"items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A more specific error message, if available","uniqueKey":"items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Where the error occurred","uniqueKey":"items.[INDEX].location","typeLabel":"string"},"debug_uuid":{"type":"string","description":"The unique identifier assigned to this error for troubleshooting","uniqueKey":"items.[INDEX].debug_uuid","typeLabel":"string"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"example":[{"code":"unauthorized","message":"authorization not accepted"}],"examples":{"Example":{"title":"Example","value":[{"code":"unauthorized","message":"authorization not accepted"}]}},"exampleType":"examples"}},"example":{"code":"unauthorized","message":"authorization not accepted"},"exampleType":"examples"},"ee5456b6-04f8-4b69-80a4-2fe2ec27b302":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The general error type","uniqueKey":"items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A more specific error message, if available","uniqueKey":"items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Where the error occurred","uniqueKey":"items.[INDEX].location","typeLabel":"string"},"debug_uuid":{"type":"string","description":"The unique identifier assigned to this error for troubleshooting","uniqueKey":"items.[INDEX].debug_uuid","typeLabel":"string"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"example":[{"code":"record_not_found","message":"not found"}],"examples":{"Example":{"title":"Example","value":[{"code":"record_not_found","message":"not found"}]}},"exampleType":"examples"}},"example":{"code":"record_not_found","message":"not found"},"exampleType":"examples"},"0a8acd98-94ab-4406-b2c6-a82a8dff50ab":{"description":"Unable to process the request entity","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The general error type","uniqueKey":"items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A more specific error message, if available","uniqueKey":"items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Where the error occurred","uniqueKey":"items.[INDEX].location","typeLabel":"string"},"debug_uuid":{"type":"string","description":"The unique identifier assigned to this error for troubleshooting","uniqueKey":"items.[INDEX].debug_uuid","typeLabel":"string"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"example":[{"code":"invalid","message":"Unprocessable entity"}],"examples":{"Example":{"title":"Example","value":[{"code":"invalid","message":"Unprocessable entity"}]}},"exampleType":"examples"}},"example":{"code":"invalid","message":"UnprocessableV2 entity"},"exampleType":"examples"}},"security":{"849dbee1-17b4-439f-a57a-a2d119b8e432":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header","description":"The authentication token generated from providing API Keys to Sezzle Gateway","scopes":[],"schemeName":"Bearer"}}},"servers":{"5b5596f5-c4d9-41c0-89f5-e86da59547cd":{"url":"https://sandbox.gateway.sezzle.com","description":"development server, usa, ca"},"e3dace99-9f2f-4e98-85f7-7372b28712ce":{"url":"https://gateway.sezzle.com","description":"production server, usa, ca"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","description":"The authentication token generated from providing API Keys to Sezzle Gateway","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Authorization","type":"string","description":"The authentication token generated from providing API Keys to Sezzle Gateway","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"sezzle","siteName":"Sezzle","title":"Créer une session - Sezzle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/docs/api/core/sessions/postv2session","matchLevel":1},"fr":{"href":"/fr/docs/api/core/sessions/postv2session","matchLevel":0}}},"lastModified":"2026-08-12T18:54:10.977Z","originalFileLocation":"fr/docs/api/core/sessions/postv2session.mdx","locale":"fr"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings. A session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sezzle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sezzle/awTX-WnCCeJfnpqG/_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/sezzle/awTX-WnCCeJfnpqG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sezzle/awTX-WnCCeJfnpqG/_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/sezzle/awTX-WnCCeJfnpqG/_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/sezzle/awTX-WnCCeJfnpqG/_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/sezzle/awTX-WnCCeJfnpqG/_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/sezzle/awTX-WnCCeJfnpqG/_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/sezzle/awTX-WnCCeJfnpqG/_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/sezzle/awTX-WnCCeJfnpqG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Créer une session - Sezzle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings. A session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sezzle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sezzle.mintlify.app/_mintlify/api/og/v2?division=Int%C3%A9gration+Directe\u0026amp;title=Cr%C3%A9er+une+session\u0026amp;description=Initiate+a+Sezzle+session+with+shopper+order+details%2C+redirect+links%2C+and+capture+and+tokenization+settings.%0AA+session+must+carry+an+order%2C+tokenize+a+customer%2C\u0026amp;theme=96f49580f47ce62ac4ab6238\u0026amp;signature=ae04a95a3c023350c4af268e46cee88ec2d6225cc66f1adb2404e312ec47fc56\">\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=\"Créer une session - Sezzle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings. A session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sezzle.mintlify.app/_mintlify/api/og/v2?division=Int%C3%A9gration+Directe\u0026amp;title=Cr%C3%A9er+une+session\u0026amp;description=Initiate+a+Sezzle+session+with+shopper+order+details%2C+redirect+links%2C+and+capture+and+tokenization+settings.%0AA+session+must+carry+an+order%2C+tokenize+a+customer%2C\u0026amp;theme=96f49580f47ce62ac4ab6238\u0026amp;signature=ae04a95a3c023350c4af268e46cee88ec2d6225cc66f1adb2404e312ec47fc56\">\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/sezzle/awTX-WnCCeJfnpqG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sezzle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8512e0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/fr/docs/api/core/sessions/postv2session.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.sezzle.com/docs/api/core/sessions/postv2session\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.sezzle.com/docs/api/core/sessions/postv2session\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sezzle.com/#organization\",\"name\":\"Sezzle\",\"url\":\"https://docs.sezzle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sezzle/01t5INarB6euKvP6/images/Sezzle_Logo_FullColor.svg?fit=max\u0026auto=format\u0026n=01t5INarB6euKvP6\u0026q=85\u0026s=5fc8a5aa9010b739b2874aa847929f68\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sezzle.com#website\",\"name\":\"Sezzle\",\"url\":\"https://docs.sezzle.com\",\"publisher\":{\"@id\":\"https://docs.sezzle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session#webpage\",\"url\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session\",\"name\":\"Créer une session\",\"description\":\"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings. A session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\",\"dateModified\":\"2026-08-12T18:54:10.977Z\",\"isPartOf\":{\"@id\":\"https://docs.sezzle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Référence API\",\"item\":\"https://docs.sezzle.com/fr/docs/api/intro\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Core\",\"item\":\"https://docs.sezzle.com/fr/docs/api/core/authentication/postauthentication\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Créer une session\",\"item\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session#apireference\",\"headline\":\"Créer une session\",\"name\":\"Créer une session\",\"description\":\"Initiate a Sezzle session with shopper order details, redirect links, and capture and tokenization settings. A session must carry an order, tokenize a customer, or both. Omit the order and set customer.tokenize to true for standalone tokenization, which returns tokenize.approval_url instead of an order.\",\"url\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sezzle.com/fr/docs/api/core/sessions/postv2session#webpage\"},\"dateModified\":\"2026-08-12T18:54:10.977Z\",\"publisher\":{\"@id\":\"https://docs.sezzle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sezzle.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sezzle\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sezzle","nav":{"global":null,"languages":[{"language":"en","pages":[{"title":"en","href":"/docs/api/core/sessions/postv2session"}]},{"language":"fr","anchors":[{"anchor":"Guides","icon":"book","pages":[{"title":"Guides","href":"/fr/docs/guides/sezzle/introduction"}]},{"anchor":"Documentation API","icon":"code","groups":[{"group":"Référence API","pages":[{"title":"Introduction","href":"/fr/docs/api/intro"},{"title":null,"href":"/fr/docs/api/environments"},{"title":null,"href":"/fr/docs/api/test-cards"},{"title":"Configuration de Postman","href":"/fr/docs/api/postman-setup"},{"title":"Erreurs","href":"/fr/docs/api/errors"},{"group":"API Core","pages":[{"group":"Authentification","pages":[{"title":"Obtenir un jeton d'authentification bearer","openapi":"post /v2/authentication","description":"Generate authentication token from your Sezzle merchant API keys for use in the header of all other API requests.","href":"/fr/docs/api/core/authentication/postauthentication"}]},{"group":"Sessions","pages":[{"group":"Intégration Directe","pages":[{"title":"Créer une session","openapi":"post /v2/session","href":"/fr/docs/api/core/sessions/postv2session"},{"title":"Obtenir le statut de la session","openapi":"get /v2/session/{session_uuid}","description":"Get session details.\nThe blocks returned mirror what the session was created with: an order session returns order, and a standalone tokenization session returns tokenize with its approval_url and no order block.\n","href":"/fr/docs/api/core/sessions/getv2session"}]},{"group":"Virtuelle","pages":[{"title":"Créer une session de carte","openapi":"post /v2/session/card","href":"/fr/docs/api/core/sessions/virtual/postv2sessioncard"},{"title":"Obtenir les données de carte par jeton","openapi":"get /v2/session/card/token/{token}","href":"/fr/docs/api/core/sessions/virtual/carddatabytoken"},{"title":"Mettre à jour une session de carte","openapi":"patch /v2/session/{session_id}/card","href":"/fr/docs/api/core/sessions/virtual/setorderid"}]}]},{"group":"Commandes","pages":[{"title":"Flux de paiement","href":"/fr/docs/api/core/orders/index"},{"title":"Obtenir les détails de la commande","openapi":"get /v2/order/{order_uuid}","href":"/fr/docs/api/core/orders/getv2order"},{"title":"Capturer un montant par commande","openapi":"post /v2/order/{order_uuid}/capture","href":"/fr/docs/api/core/orders/postv2capturebyorder"},{"title":"Mettre à jour la commande","openapi":"patch /v2/order/{order_uuid}","href":"/fr/docs/api/core/orders/patchv2checkout"},{"title":"Rembourser un montant par commande","openapi":"post /v2/order/{order_uuid}/refund","href":"/fr/docs/api/core/orders/postv2refundbyorder"},{"title":"Libérer un montant par commande","openapi":"post /v2/order/{order_uuid}/release","href":"/fr/docs/api/core/orders/postv2releasebyorder"},{"title":"Réautoriser le montant par commande","openapi":"post /v2/order/{order_uuid}/reauthorize","href":"/fr/docs/api/core/orders/postv2reauthorizebyorder"},{"title":"Montant du supplément par commande","openapi":"post /v2/order/{order_uuid}/upcharge","href":"/fr/docs/api/core/orders/postv2upchargebyorder"},{"title":"Mettre à jour le paiement par commande","openapi":"patch /v2/order/{order_uuid}/checkout","href":"/fr/docs/api/core/orders/patchv2updatecheckoutbyorder"},{"title":"Supprimer le paiement par commande","openapi":"delete /v2/order/{order_uuid}/checkout","href":"/fr/docs/api/core/orders/deletev2deletecheckoutbyorder"}]},{"group":"Webhooks","pages":[{"title":"Créer des webhooks","openapi":"post /v2/webhooks","href":"/fr/docs/api/core/webhooks/postv2webhooks"},{"title":"Lister les webhooks","openapi":"get /v2/webhooks","href":"/fr/docs/api/core/webhooks/getv2webhooks"},{"title":"Obtenir un webhook","openapi":"get /v2/webhooks/{webhooks_uuid}","href":"/fr/docs/api/core/webhooks/getv2webhook"},{"title":"Mettre à jour le webhook","openapi":"patch /v2/webhooks/{webhooks_uuid}","href":"/fr/docs/api/core/webhooks/patchv2webhooks"},{"title":"Déclencher un webhook de test","openapi":"post /v2/webhooks/test","href":"/fr/docs/api/core/webhooks/postv2webhooktest"},{"title":"Supprimer les webhooks","openapi":"delete /v2/webhooks/{webhooks_uuid}","href":"/fr/docs/api/core/webhooks/deletev2webhooks"},{"title":null,"href":"/fr/docs/api/core/webhooks/infov2webhooks"}]},{"group":"Rapports","pages":[{"group":"Commandes","pages":[{"title":null,"href":"/fr/docs/api/core/orderreports/getv2orderreports"}]},{"group":"Intérêts","pages":[{"title":"Obtenir l'activité du compte d'intérêts","openapi":"get /v2/interest/activity","href":"/fr/docs/api/core/interest/getv2activity"},{"title":"Obtenir le solde du compte d'intérêts","openapi":"get /v2/interest/balance","href":"/fr/docs/api/core/interest/getv2balance"}]},{"group":"Règlements","pages":[{"title":"Obtenir un récapitulatif","openapi":"get /v2/settlements/summaries","href":"/fr/docs/api/core/settlements/getv2summary"},{"title":"Obtenir les détails","openapi":"get /v2/settlements/details/{payout_uuid}","href":"/fr/docs/api/core/settlements/getv2summarydetail"}]}]}]}]},{"group":"Tokenisation","pages":[{"title":"Introduction","href":"/fr/docs/api/tokenization/intro"},{"group":"Clients","pages":[{"title":"Obtenir une liste de clients","openapi":"get /v2/customer","href":"/fr/docs/api/tokenization/customers/getv2customerlist"},{"title":"Obtenir un client","openapi":"get /v2/customer/{customer_uuid}","href":"/fr/docs/api/tokenization/customers/getv2customer"},{"title":"Préapprouver un montant par client","openapi":"post /v2/customer/{customer_uuid}/preapprove","href":"/fr/docs/api/tokenization/customers/preapprovev2token"},{"title":"Créer une commande par client","openapi":"post /v2/customer/{customer_uuid}/order","href":"/fr/docs/api/tokenization/customers/postv2customerorder"},{"title":"Supprimer un client","openapi":"delete /v2/customer/{customer_uuid}","href":"/fr/docs/api/tokenization/customers/deletev2token"}]},{"group":"Session","pages":[{"title":"Obtenir la tokenisation de session","openapi":"get /v2/token/{token}/session","href":"/fr/docs/api/tokenization/session/getv2sessiontoken"}]}]},{"group":"v1 (obsolète)","pages":[{"title":"Aperçu v1","href":"/fr/docs/api/v1/v1"},{"title":"Obtenir un jeton d'authentification","openapi":"post /v1/authentication","href":"/fr/docs/api/v1/obtain-authentication-token"},{"title":"Configurer votre configuration","openapi":"post /v1/configuration","href":"/fr/docs/api/v1/setting-your-configuration"},{"title":"Créer un paiement","openapi":"post /v1/checkouts","href":"/fr/docs/api/v1/create-a-checkout"},{"title":"Commandes","openapi":"get /v1/orders/{order_reference_id}","href":"/fr/docs/api/v1/orders"},{"title":"Finaliser un paiement","openapi":"post /v1/checkouts/{order_reference_id}/complete","href":"/fr/docs/api/v1/complete-a-checkout"},{"title":"Demande de remboursement","openapi":"post /v1/orders/{order_reference_id}/refund","href":"/fr/docs/api/v1/refund-request"},{"title":"Demande de solde du compte d'intérêts","openapi":"get /v1/interest/balance","href":"/fr/docs/api/v1/interest-account-reports/interest-account-balance-request"},{"title":"Demande d'activité de compte d'intérêts","openapi":"get /v1/interest/activity","href":"/fr/docs/api/v1/interest-account-reports/interest-account-activity-request"},{"title":"Demande de résumés de règlement","openapi":"get /v1/settlements/summaries","href":"/fr/docs/api/v1/settlement-reports/settlement-summaries-request"},{"title":"Demande de détails de règlement","openapi":"get /v1/settlements/details/{payout_uuid}","href":"/fr/docs/api/v1/settlement-reports/settlement-details-request"}]}]},{"anchor":"Plateformes","icon":"layer-group","pages":[{"title":"Plateformes","href":"/fr/docs/plugins/before-you-begin"}]}]}]},"title":"Créer une session - Sezzle","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}