Any additional information about the transaction that you would like to
store as key-value pairs. This data is passed to payment service
providers that support it.
Details about the payment method for card type only.
Show child attributes
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Gr4vy","colors":{"primary":"#0066CC","light":"#0099FF","dark":"#0066CC"},"logo":{"light":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99","dark":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/dark.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=7a09594217c27f95e0d127250c4cc958"},"favicon":"https://mintcdn.com/flexxbuy/39tfKGesfNHyX7HE/assets/favicon.png?fit=max\u0026auto=format\u0026n=39tfKGesfNHyX7HE\u0026q=85\u0026s=fc89afd637da9116e218f41f2c6b1105","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["csharp","go","java","php","python","javascript","curl"]},"mdx":{"auth":{"method":"bearer"},"server":["https://api.sandbox.flexxbuy.gr4vy.app","https://api.flexxbuy.gr4vy.app"]}},"navbar":{"links":[{"icon":"bell","href":"https://status.gr4vy.com","label":"Status"},{"icon":"github","href":"https://github.com/gr4vy","label":"GitHub"}],"primary":{"type":"button","label":"Gr4vy","href":"https://gr4vy.com/#form-contact"}},"footer":{"socials":{"website":"https://gr4vy.com","twitter":"https://twitter.com/Gr4vyInc","github":"https://github.com/gr4vy","linkedin":"https://www.linkedin.com/company/gr4vy-inc"},"links":[{"header":"About","items":[{"label":"Payment orchestration","href":"https://gr4vy.com/payment-orchestration"},{"label":"Gr4vy for merchants","href":"https://gr4vy.com/merchants"},{"label":"Gr4vy for platforms","href":"https://gr4vy.com/platforms"},{"label":"Increasing your revenue","href":"https://gr4vy.com/revenue"}]},{"header":"Developers","items":[{"label":"GitHub","href":"https://github.com/gr4vy"},{"label":"Latest news","href":"https://docs.gr4vy.com/updates"},{"label":"System status","href":"https://status.gr4vy.com"},{"label":"Customer support","href":"https://support.gr4vy.com"}]}]},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"G-9CX4E9QWKQ"}},"contextual":{"options":["chatgpt","claude","copy","view"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexxbuy","hasAudioNarration":false,"actualSubdomain":"flexxbuy","customDomains":["docs.byzly.com"],"gitSource":{"type":"github","owner":"gr4vy","repo":"flexxbuy-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf3ae99a12bdb039acf747","collectionId":"544c29bf-0e5f-4e25-a32b-f41314032e9f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf3ae99a12bdb039acf747"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf64bc3d6319f7be041995","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Build","count":195},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Connections","count":168},{"language":"default","tag":"Methods","count":141},{"language":"default","tag":"Features","count":95},{"language":"default","tag":"Integration guides","count":91},{"language":"default","tag":"Banking","count":46},{"language":"default","tag":"Dashboard","count":44},{"language":"default","tag":"Other","count":39},{"language":"default","tag":"Embed","count":38}]},"assistantConfig":{},"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":[{"filePath":"style.css","content":".payment-service-definition{background-color:#fff!important;border:1px solid #0a0e0d1a;border-radius:16px;padding:2em;vertical-align:middle}.payment-service-definition img{margin:0 1em 0 0;max-width:3em;display:inline-block}.payment-service-definition h2{margin:0;display:inline-block;position:relative;top:.1em}#sidebar-title{text-transform:uppercase}#sidebar-group .group{flex-direction:row-reverse}#footer .max-w-36{max-width:40rem}"}],"page":{"pagePath":"reference/checkout-sessions/get-checkout-session","slug":"/reference/checkout-sessions/get-checkout-session","pageMetadata":{"openapi":"openapi.speakeasy.json GET /checkout/sessions/{checkout_session_id}","title":null,"description":null,"href":"/reference/checkout-sessions/get-checkout-session"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`This endpoint requires the `,_jsx(_components.code,{children:`checkout-sessions.read`}),` scope.`]})}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":{"openapi":"openapi.speakeasy.json GET /checkout/sessions/{checkout_session_id}","title":null,"description":null,"href":"/reference/checkout-sessions/get-checkout-session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"get-checkout-session","summary":"Get checkout session","description":"Gets details about a current Checkout Session.","tags":["Checkout Sessions"],"responses":{"200":"8edb4acc-5280-4196-b0da-459318c5ab49","401":"aefe0603-6cd0-4181-ae71-ab8f82541317","404":"bd10f256-9e6e-4059-a85e-2ed3546b1d94"},"method":"get","type":"path","servers":["687beca7-453b-424d-a360-eaca1398b8d8","578272f1-d32a-4d53-8e16-3dc13be44c34"],"security":["6c6223af-e151-4dcc-8f35-88257b966832"],"path":"/checkout/sessions/{checkout_session_id}","baseUrlOptions":["https://api.sandbox.{id}.gr4vy.app","https://api.{id}.gr4vy.app"],"title":"Get checkout session","codeSamples":[],"requestExampleLanguages":["csharp","go","java","php","python","javascript","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9a92e776-5a4f-4cfc-b0be-0d3311044e9e":{"schema":{"type":"string","format":"uuid","example":"8724fd24-5489-4a5d-90fd-0604df7d3b83","isRequired":true,"description":"The unique ID for a Checkout Session.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"name":"checkout_session_id","in":"path","required":true,"description":"The unique ID for a Checkout Session."}},"responses":{"8edb4acc-5280-4196-b0da-459318c5ab49":{"description":"Returns details about a current Checkout Session.","content":{"application/json":{"schema":{"title":"Checkout Session","type":"object","description":"A short-lived checkout session.","x-tags":["Checkout"],"properties":{"type":{"type":"string","description":"`checkout-session`.","example":"checkout-session","enum":["checkout-session"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"The ID of the Checkout Session.","example":"8d3fe99b-1422-42e6-bbb3-932d95ae5f79","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"expires_at":{"type":"string","format":"date-time","description":"The date and time when the Checkout Session will expire.\nBy default this will be set to 1 hour from the date of creation.","example":"2022-01-01T00:00:00+00:00","uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"cart_items":{"oneOf":[{"type":"array","description":"An array of cart items that represents the line items of a transaction.","items":{"title":"Cart Item","type":"object","description":"A cart item that represents a single cart line item for a transaction.\nNote that some optional properties are required for certain payment\nservice providers. If no value is set for these properties, we will use\ntheir default value.\n\nIf the total due to be paid for the item is required by the payment service\nprovider, generally referred to as the \"total amount\", the formula below\nwill usually be used to calculate this amount:\n\n`(unit_amount * quantity) - discount_amount + tax_amount`\n\nIt's highly recommended that the total amount to pay for all items\nshould match the transaction's amount to reduce the risk of the\ntransaction being declined by the payment service provider.","required":["name","quantity","unit_amount"],"properties":{"name":{"type":"string","description":"The name of the cart item. The value you set for this property may\nbe truncated if the maximum length accepted by a payment service\nprovider is less than 255 characters.","example":"GoPro HERO9 Camcorder","maxLength":255,"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"integer","description":"The quantity of this item in the cart. This value cannot be negative\nor zero.","example":1,"minimum":1,"maximum":99999999,"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"unit_amount":{"type":"integer","description":"The amount for an individual item represented as a monetary amount\nin the smallest currency unit for the given currency, for example\n`1299` USD cents represents `$12.99`.\nThe amount sent through to the payment processor as unitary amount\nwill be calculated to include the discount and tax values sent\nas part of this cart item.","example":37999,"minimum":0,"maximum":99999999,"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_amount","typeLabel":"integer"},"discount_amount":{"oneOf":[{"type":"integer","description":"The amount discounted for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease note that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total discount amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `discount_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific discount.","example":0,"minimum":0,"maximum":99999999,"default":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount discounted for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease note that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total discount amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `discount_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific discount.","example":0,"minimum":0,"maximum":99999999,"default":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount","typeLabel":"integer | null"},"tax_amount":{"oneOf":[{"type":"integer","description":"The tax amount for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease not that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total tax amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `tax_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific tax amount.","example":0,"minimum":0,"maximum":99999999,"default":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The tax amount for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease not that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total tax amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `tax_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific tax amount.","example":0,"minimum":0,"maximum":99999999,"default":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount","typeLabel":"integer | null"},"external_identifier":{"oneOf":[{"type":"string","example":"item-789123","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","maxLength":200,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier.oneOf.0","typeLabel":"string"},{"type":"null","example":"item-789123","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","maxLength":200,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","example":"sku-789123","description":"The SKU for the item.","maxLength":200,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","example":"sku-789123","description":"The SKU for the item.","maxLength":200,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku","typeLabel":"string | null"},"product_url":{"oneOf":[{"type":"string","format":"url","example":"https://example.com/items/gopro","description":"The product URL for the item.","maxLength":2083,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","example":"https://example.com/items/gopro","description":"The product URL for the item.","maxLength":2083,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url","typeLabel":"string\u003curl> | null"},"image_url":{"oneOf":[{"type":"string","format":"url","example":"https://example.com/images/items/gopro.png","description":"The URL for the image of the item.","maxLength":2083,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","example":"https://example.com/images/items/gopro.png","description":"The URL for the image of the item.","maxLength":2083,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url","typeLabel":"string\u003curl> | null"},"categories":{"oneOf":[{"type":"array","description":"A list of strings containing product categories for the item.\nMax length per item: 50.","items":{"type":"string","maxLength":50,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":100,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"A list of strings containing product categories for the item.\nMax length per item: 50.","items":{"type":"string","maxLength":50},"maxItems":100,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories","typeLabel":"string[] | null"},"product_type":{"oneOf":[{"type":"string","description":"The product type of the cart item.","example":"physical","enum":["physical","discount","shipping_fee","sales_tax","digital","gift_card","store_credit","surcharge",null],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The product type of the cart item.","example":"physical","enum":["physical","discount","shipping_fee","sales_tax","digital","gift_card","store_credit","surcharge",null],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"seller_country":{"oneOf":[{"type":"string","description":"The country code of the seller of the item. For some connectors, if this country code\ndoes not match the `country` then the transaction will be marked to Visa as a foreign\nseller transaction to meet Marketplace reporting requirements.","example":"US","pattern":"^[A-Z]{2}$","uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code of the seller of the item. For some connectors, if this country code\ndoes not match the `country` then the transaction will be marked to Visa as a foreign\nseller transaction to meet Marketplace reporting requirements.","example":"US","pattern":"^[A-Z]{2}$","uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country","typeLabel":"string | null"}},"uniqueKey":"cart_items.oneOf.0.items.[INDEX]","typeLabel":"Cart Item · object"},"uniqueKey":"cart_items.oneOf.0","typeLabel":"Cart Item · object[]"},{"type":"null","description":"An array of cart items that represents the line items of a transaction.","items":{"title":"Cart Item","type":"object","description":"A cart item that represents a single cart line item for a transaction.\nNote that some optional properties are required for certain payment\nservice providers. If no value is set for these properties, we will use\ntheir default value.\n\nIf the total due to be paid for the item is required by the payment service\nprovider, generally referred to as the \"total amount\", the formula below\nwill usually be used to calculate this amount:\n\n`(unit_amount * quantity) - discount_amount + tax_amount`\n\nIt's highly recommended that the total amount to pay for all items\nshould match the transaction's amount to reduce the risk of the\ntransaction being declined by the payment service provider.","required":["name","quantity","unit_amount"],"properties":{"name":{"type":"string","description":"The name of the cart item. The value you set for this property may\nbe truncated if the maximum length accepted by a payment service\nprovider is less than 255 characters.","example":"GoPro HERO9 Camcorder","maxLength":255},"quantity":{"type":"integer","description":"The quantity of this item in the cart. This value cannot be negative\nor zero.","example":1,"minimum":1,"maximum":99999999},"unit_amount":{"type":"integer","description":"The amount for an individual item represented as a monetary amount\nin the smallest currency unit for the given currency, for example\n`1299` USD cents represents `$12.99`.\nThe amount sent through to the payment processor as unitary amount\nwill be calculated to include the discount and tax values sent\nas part of this cart item.","example":37999,"minimum":0,"maximum":99999999},"discount_amount":{"oneOf":[{"type":"integer","description":"The amount discounted for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease note that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total discount amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `discount_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific discount.","example":0,"minimum":0,"maximum":99999999,"default":0},{"type":"null","description":"The amount discounted for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease note that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total discount amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `discount_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific discount.","example":0,"minimum":0,"maximum":99999999,"default":0}]},"tax_amount":{"oneOf":[{"type":"integer","description":"The tax amount for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease not that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total tax amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `tax_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific tax amount.","example":0,"minimum":0,"maximum":99999999,"default":0},{"type":"null","description":"The tax amount for this item represented as a monetary amount\nin the smallest currency unit for the given currency, for example `1299`\nUSD cents represents `$12.99`.\n\nPlease not that this amount is for the total of the cart item and not\nfor an individual item. For example, if the quantity is 5, this value\nshould be the total tax amount for 5 of the cart item.\n\nYou might see unexpected failed transactions if the `tax_amount` can\nnot be equally divided by the `quantity` value. This is due to the fact\nthat some payment services require this amount to be specified per unit.\n\nIn this situation we recommend splitting this item into separate items,\neach with their own specific tax amount.","example":0,"minimum":0,"maximum":99999999,"default":0}]},"external_identifier":{"oneOf":[{"type":"string","example":"item-789123","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","maxLength":200},{"type":"null","example":"item-789123","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","maxLength":200}]},"sku":{"oneOf":[{"type":"string","example":"sku-789123","description":"The SKU for the item.","maxLength":200},{"type":"null","example":"sku-789123","description":"The SKU for the item.","maxLength":200}]},"product_url":{"oneOf":[{"type":"string","format":"url","example":"https://example.com/items/gopro","description":"The product URL for the item.","maxLength":2083},{"type":"null","format":"url","example":"https://example.com/items/gopro","description":"The product URL for the item.","maxLength":2083}]},"image_url":{"oneOf":[{"type":"string","format":"url","example":"https://example.com/images/items/gopro.png","description":"The URL for the image of the item.","maxLength":2083},{"type":"null","format":"url","example":"https://example.com/images/items/gopro.png","description":"The URL for the image of the item.","maxLength":2083}]},"categories":{"oneOf":[{"type":"array","description":"A list of strings containing product categories for the item.\nMax length per item: 50.","items":{"type":"string","maxLength":50},"maxItems":100},{"type":"null","description":"A list of strings containing product categories for the item.\nMax length per item: 50.","items":{"type":"string","maxLength":50},"maxItems":100}]},"product_type":{"oneOf":[{"type":"string","description":"The product type of the cart item.","example":"physical","enum":["physical","discount","shipping_fee","sales_tax","digital","gift_card","store_credit","surcharge",null]},{"type":"null","description":"The product type of the cart item.","example":"physical","enum":["physical","discount","shipping_fee","sales_tax","digital","gift_card","store_credit","surcharge",null]}]},"seller_country":{"oneOf":[{"type":"string","description":"The country code of the seller of the item. For some connectors, if this country code\ndoes not match the `country` then the transaction will be marked to Visa as a foreign\nseller transaction to meet Marketplace reporting requirements.","example":"US","pattern":"^[A-Z]{2}$"},{"type":"null","description":"The country code of the seller of the item. For some connectors, if this country code\ndoes not match the `country` then the transaction will be marked to Visa as a foreign\nseller transaction to meet Marketplace reporting requirements.","example":"US","pattern":"^[A-Z]{2}$"}]}}},"uniqueKey":"cart_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items","typeLabel":"Cart Item · object[] | null"},"metadata":{"oneOf":[{"description":"Any additional information about the transaction that you would like to\nstore as key-value pairs. This data is passed to payment service\nproviders that support it.","type":"object","maxProperties":20,"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"key":"value"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"description":"Any additional information about the transaction that you would like to\nstore as key-value pairs. This data is passed to payment service\nproviders that support it.","type":"null","maxProperties":20,"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"key":"value"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"airline":{"oneOf":[{"type":"object","title":"Airline Addendum","description":"Contains information about an airline travel, if applicable.","properties":{"passenger_name_record":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The Passenger Name Record (PNR) in the airline reservation system.","example":"JOHN L","uniqueKey":"airline.oneOf.0.passenger_name_record.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"The Passenger Name Record (PNR) in the airline reservation system.","example":"JOHN L","uniqueKey":"airline.oneOf.0.passenger_name_record.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passenger_name_record","typeLabel":"string | null"},"booking_code":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The unique identifier of the reservation in the global distribution system.","example":"X36Q9C","uniqueKey":"airline.oneOf.0.booking_code.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"The unique identifier of the reservation in the global distribution system.","example":"X36Q9C","uniqueKey":"airline.oneOf.0.booking_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.booking_code","typeLabel":"string | null"},"ticket_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The airline's unique ticket number.","example":"123-1234-151555","uniqueKey":"airline.oneOf.0.ticket_number.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"The airline's unique ticket number.","example":"123-1234-151555","uniqueKey":"airline.oneOf.0.ticket_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.ticket_number","typeLabel":"string | null"},"ticket_delivery_method":{"oneOf":[{"type":"string","enum":["electronic","other"],"default":"electronic","description":"The delivery method of the ticket.","example":"other","uniqueKey":"airline.oneOf.0.ticket_delivery_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["electronic","other"],"default":"electronic","description":"The delivery method of the ticket.","example":"other","uniqueKey":"airline.oneOf.0.ticket_delivery_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.ticket_delivery_method","typeLabel":"enum\u003cstring> | null"},"issued_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date that the ticket was last issued in the airline reservation\nsystem.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.issued_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date that the ticket was last issued in the airline reservation\nsystem.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.issued_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issued_at","typeLabel":"string\u003cdate-time> | null"},"issued_address":{"oneOf":[{"type":"string","minLength":1,"maxLength":255,"description":"The address of the place/agency that issued the ticket.","example":"123 Broadway, New York","uniqueKey":"airline.oneOf.0.issued_address.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":255,"description":"The address of the place/agency that issued the ticket.","example":"123 Broadway, New York","uniqueKey":"airline.oneOf.0.issued_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issued_address","typeLabel":"string | null"},"travel_agency_code":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The IATA travel agency code.","example":"12345","uniqueKey":"airline.oneOf.0.travel_agency_code.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"The IATA travel agency code.","example":"12345","uniqueKey":"airline.oneOf.0.travel_agency_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_code","typeLabel":"string | null"},"travel_agency_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":200,"description":"The name of the travel agency.","example":"Agency name","uniqueKey":"airline.oneOf.0.travel_agency_name.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":200,"description":"The name of the travel agency.","example":"Agency name","uniqueKey":"airline.oneOf.0.travel_agency_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_name","typeLabel":"string | null"},"travel_agency_invoice_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The reference number of the invoice that was issued by the\ntravel agency.","example":"EG15555155","uniqueKey":"airline.oneOf.0.travel_agency_invoice_number.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"The reference number of the invoice that was issued by the\ntravel agency.","example":"EG15555155","uniqueKey":"airline.oneOf.0.travel_agency_invoice_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_invoice_number","typeLabel":"string | null"},"travel_agency_plan_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":200,"description":"The name of the travel agency plan.","example":"B733","uniqueKey":"airline.oneOf.0.travel_agency_plan_name.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":200,"description":"The name of the travel agency plan.","example":"B733","uniqueKey":"airline.oneOf.0.travel_agency_plan_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_plan_name","typeLabel":"string | null"},"restricted_ticket":{"oneOf":[{"type":"boolean","description":"Indicates whether the ticket is restricted (refundable).","example":false,"uniqueKey":"airline.oneOf.0.restricted_ticket.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the ticket is restricted (refundable).","example":false,"uniqueKey":"airline.oneOf.0.restricted_ticket.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.restricted_ticket","typeLabel":"boolean | null"},"issuing_carrier_code":{"oneOf":[{"type":"string","minLength":2,"maxLength":3,"description":"For airline aggregators, two-character IATA code of the airline issuing\nthe ticket.","example":"A3","uniqueKey":"airline.oneOf.0.issuing_carrier_code.oneOf.0","typeLabel":"string"},{"type":"null","minLength":2,"maxLength":3,"description":"For airline aggregators, two-character IATA code of the airline issuing\nthe ticket.","example":"A3","uniqueKey":"airline.oneOf.0.issuing_carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_carrier_code","typeLabel":"string | null"},"issuing_carrier_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"The name of the airline issuing the ticket.","example":"Aegean Airlines","uniqueKey":"airline.oneOf.0.issuing_carrier_name.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":100,"description":"The name of the airline issuing the ticket.","example":"Aegean Airlines","uniqueKey":"airline.oneOf.0.issuing_carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_carrier_name","typeLabel":"string | null"},"issuing_iata_designator":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"2 character IATA code of the airline issuing the ticket.","example":"A3","uniqueKey":"airline.oneOf.0.issuing_iata_designator.oneOf.0","typeLabel":"string"},{"type":"null","minLength":2,"maxLength":2,"description":"2 character IATA code of the airline issuing the ticket.","example":"A3","uniqueKey":"airline.oneOf.0.issuing_iata_designator.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_iata_designator","typeLabel":"string | null"},"issuing_icao_code":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"3 character ICAO code of the airline issuing the ticket.","example":"AEE","uniqueKey":"airline.oneOf.0.issuing_icao_code.oneOf.0","typeLabel":"string"},{"type":"null","minLength":3,"maxLength":3,"description":"3 character ICAO code of the airline issuing the ticket.","example":"AEE","uniqueKey":"airline.oneOf.0.issuing_icao_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_icao_code","typeLabel":"string | null"},"reservation_system":{"oneOf":[{"type":"string","minLength":1,"maxLength":200,"description":"The name of the reservation system.","example":"Amadeus","uniqueKey":"airline.oneOf.0.reservation_system.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":200,"description":"The name of the reservation system.","example":"Amadeus","uniqueKey":"airline.oneOf.0.reservation_system.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.reservation_system","typeLabel":"string | null"},"is_cardholder_traveling":{"oneOf":[{"type":"boolean","description":"Indicates whether the cardholder is present in the flight.","example":false,"uniqueKey":"airline.oneOf.0.is_cardholder_traveling.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the cardholder is present in the flight.","example":false,"uniqueKey":"airline.oneOf.0.is_cardholder_traveling.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.is_cardholder_traveling","typeLabel":"boolean | null"},"passengers":{"oneOf":[{"description":"An array of the travelling passengers.","items":{"title":"Airline Addendum Passenger","type":"object","description":"Information of the travelling passenger.","properties":{"title":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"Title of the passenger.","example":"Mr.","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"Title of the passenger.","example":"Mr.","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":255,"description":"The first name(s) or given name of the passenger.","example":"John","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":255,"description":"The first name(s) or given name of the passenger.","example":"John","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":255,"description":"The last name, or family name, of the passenger.","example":"Lunn","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":255,"description":"The last name, or family name, of the passenger.","example":"Lunn","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name","typeLabel":"string | null"},"email_address":{"oneOf":[{"type":"string","minLength":1,"maxLength":320,"description":"The email address of the passenger.","example":"john@example.com","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":320,"description":"The email address of the passenger.","example":"john@example.com","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","pattern":"^\\+[1-9]\\d{1,14}$","minLength":1,"maxLength":50,"description":"The phone number of the passenger. This number is formatted according to the\n[E164 number standard](https://www.twilio.com/docs/glossary/what-e164).","example":"+1234567890","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^\\+[1-9]\\d{1,14}$","minLength":1,"maxLength":50,"description":"The phone number of the passenger. This number is formatted according to the\n[E164 number standard](https://www.twilio.com/docs/glossary/what-e164).","example":"+1234567890","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number","typeLabel":"string | null"},"passport_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The passenger's unique passport number.","example":"7700225","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"The passenger's unique passport number.","example":"7700225","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number","typeLabel":"string | null"},"ticket_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The ticket number for a flight.","example":"LH1236699999","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"The ticket number for a flight.","example":"LH1236699999","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number","typeLabel":"string | null"},"frequent_flyer_number":{"oneOf":[{"type":"string","minLength":5,"maxLength":50,"description":"The passenger's frequent flyer number.","example":"15885566","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number.oneOf.0","typeLabel":"string"},{"type":"null","minLength":5,"maxLength":50,"description":"The passenger's frequent flyer number.","example":"15885566","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number","typeLabel":"string | null"},"date_of_birth":{"oneOf":[{"type":"string","description":"The passenger's date of birth.","format":"date","example":"2013-07-16","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"The passenger's date of birth.","format":"date","example":"2013-07-16","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth","typeLabel":"string\u003cdate> | null"},"age_group":{"oneOf":[{"type":"string","enum":["adult","infant"],"example":"adult","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["adult","infant"],"example":"adult","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX]","typeLabel":"Airline Addendum Passenger · object"},"maxLength":20,"type":"array","uniqueKey":"airline.oneOf.0.passengers.oneOf.0","typeLabel":"Airline Addendum Passenger · object[]"},{"description":"An array of the travelling passengers.","items":{"title":"Airline Addendum Passenger","type":"object","description":"Information of the travelling passenger.","properties":{"title":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"Title of the passenger.","example":"Mr."},{"type":"null","minLength":1,"maxLength":50,"description":"Title of the passenger.","example":"Mr."}]},"first_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":255,"description":"The first name(s) or given name of the passenger.","example":"John"},{"type":"null","minLength":1,"maxLength":255,"description":"The first name(s) or given name of the passenger.","example":"John"}]},"last_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":255,"description":"The last name, or family name, of the passenger.","example":"Lunn"},{"type":"null","minLength":1,"maxLength":255,"description":"The last name, or family name, of the passenger.","example":"Lunn"}]},"email_address":{"oneOf":[{"type":"string","minLength":1,"maxLength":320,"description":"The email address of the passenger.","example":"john@example.com"},{"type":"null","minLength":1,"maxLength":320,"description":"The email address of the passenger.","example":"john@example.com"}]},"phone_number":{"oneOf":[{"type":"string","pattern":"^\\+[1-9]\\d{1,14}$","minLength":1,"maxLength":50,"description":"The phone number of the passenger. This number is formatted according to the\n[E164 number standard](https://www.twilio.com/docs/glossary/what-e164).","example":"+1234567890"},{"type":"null","pattern":"^\\+[1-9]\\d{1,14}$","minLength":1,"maxLength":50,"description":"The phone number of the passenger. This number is formatted according to the\n[E164 number standard](https://www.twilio.com/docs/glossary/what-e164).","example":"+1234567890"}]},"passport_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The passenger's unique passport number.","example":"7700225"},{"type":"null","minLength":1,"maxLength":50,"description":"The passenger's unique passport number.","example":"7700225"}]},"ticket_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"The ticket number for a flight.","example":"LH1236699999"},{"type":"null","minLength":1,"maxLength":50,"description":"The ticket number for a flight.","example":"LH1236699999"}]},"frequent_flyer_number":{"oneOf":[{"type":"string","minLength":5,"maxLength":50,"description":"The passenger's frequent flyer number.","example":"15885566"},{"type":"null","minLength":5,"maxLength":50,"description":"The passenger's frequent flyer number.","example":"15885566"}]},"date_of_birth":{"oneOf":[{"type":"string","description":"The passenger's date of birth.","format":"date","example":"2013-07-16"},{"type":"null","description":"The passenger's date of birth.","format":"date","example":"2013-07-16"}]},"age_group":{"oneOf":[{"type":"string","enum":["adult","infant"],"example":"adult"},{"type":"null","enum":["adult","infant"],"example":"adult"}]}}},"maxLength":20,"type":"null","uniqueKey":"airline.oneOf.0.passengers.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers","typeLabel":"Airline Addendum Passenger · object[] | null"},"legs":{"oneOf":[{"description":"An array of separate trip segments. Each leg contains detailed\nitinerary information.","items":{"title":"Airline Addendum Leg","type":"object","description":"Each of the separate trip segment, contains detailed itinerary information.","properties":{"carrier_code":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"2 character airline code as set by IATA.","example":"LY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code.oneOf.0","typeLabel":"string"},{"type":"null","minLength":2,"maxLength":2,"description":"2 character airline code as set by IATA.","example":"LY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code","typeLabel":"string | null"},"carrier_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"The name of the airline.","example":"El Al Israel Airlines","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":100,"description":"The name of the airline.","example":"El Al Israel Airlines","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name","typeLabel":"string | null"},"iata_designator":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"2 character IATA code of the airline.","example":"LY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator.oneOf.0","typeLabel":"string"},{"type":"null","minLength":2,"maxLength":2,"description":"2 character IATA code of the airline.","example":"LY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator","typeLabel":"string | null"},"icao_code":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"3 character ICAO code of the airline.","example":"ELY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code.oneOf.0","typeLabel":"string"},{"type":"null","minLength":3,"maxLength":3,"description":"3 character ICAO code of the airline.","example":"ELY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code","typeLabel":"string | null"},"flight_number":{"oneOf":[{"type":"string","minLength":3,"maxLength":6,"description":"Unique identifier of the flight number.","example":"BA98","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number.oneOf.0","typeLabel":"string"},{"type":"null","minLength":3,"maxLength":6,"description":"Unique identifier of the flight number.","example":"BA98","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number","typeLabel":"string | null"},"departure_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time of travel in local time at the departure airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time of travel in local time at the departure airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at","typeLabel":"string\u003cdate-time> | null"},"departure_country":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"Departure country code in ISO 3166 format.","example":"UK","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country.oneOf.0","typeLabel":"string"},{"type":"null","minLength":2,"maxLength":2,"description":"Departure country code in ISO 3166 format.","example":"UK","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country","typeLabel":"string | null"},"departure_city":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"Departure city name.","example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":100,"description":"Departure city name.","example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city","typeLabel":"string | null"},"departure_airport":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"Departure airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport.oneOf.0","typeLabel":"string"},{"type":"null","minLength":3,"maxLength":3,"description":"Departure airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport","typeLabel":"string | null"},"arrival_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time of travel in local time at the arrival airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time of travel in local time at the arrival airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at","typeLabel":"string\u003cdate-time> | null"},"arrival_country":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"Arrival country code in ISO 3166 format.","example":"UK","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country.oneOf.0","typeLabel":"string"},{"type":"null","minLength":2,"maxLength":2,"description":"Arrival country code in ISO 3166 format.","example":"UK","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country","typeLabel":"string | null"},"arrival_city":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"Arrival city name.","example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":100,"description":"Arrival city name.","example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city","typeLabel":"string | null"},"arrival_airport":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"Arrival airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport.oneOf.0","typeLabel":"string"},{"type":"null","minLength":3,"maxLength":3,"description":"Arrival airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport","typeLabel":"string | null"},"fare_basis_code":{"oneOf":[{"type":"string","minLength":1,"maxLength":8,"description":"The alphanumeric code for the \"booking class\" of a ticket.","example":"WH7LNR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":8,"description":"The alphanumeric code for the \"booking class\" of a ticket.","example":"WH7LNR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code","typeLabel":"string | null"},"flight_class":{"oneOf":[{"type":"string","minLength":1,"maxLength":5,"description":"Indicates service class (first class, business class, etc.).","example":"E","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":5,"description":"Indicates service class (first class, business class, etc.).","example":"E","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class","typeLabel":"string | null"},"stop_over":{"oneOf":[{"type":"boolean","description":"Indicates whether a stopover is allowed on this ticket.","example":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether a stopover is allowed on this ticket.","example":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over","typeLabel":"boolean | null"},"route_type":{"type":"string","description":"The route type of the flight.","enum":["round_trip","one_way"],"example":"round_trip","nullable":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].route_type","typeLabel":"enum\u003cstring>"},"coupon_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"Coupon number associated with the leg.","example":"15885566","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":50,"description":"Coupon number associated with the leg.","example":"15885566","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number","typeLabel":"string | null"},"fare_amount":{"oneOf":[{"type":"integer","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount","typeLabel":"integer | null"},"fee_amount":{"oneOf":[{"type":"integer","description":"Fee amount for current leg of the trip.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Fee amount for current leg of the trip.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount","typeLabel":"integer | null"},"tax_amount":{"oneOf":[{"type":"integer","description":"Amount of the taxes for current leg of the trip.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount of the taxes for current leg of the trip.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount","typeLabel":"integer | null"},"departure_tax_amount":{"oneOf":[{"type":"integer","description":"Departure tax amount charged by a country when a person is leaving the\ncountry.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Departure tax amount charged by a country when a person is leaving the\ncountry.","minimum":0,"maximum":99999999,"example":100,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount","typeLabel":"integer | null"},"seat_class":{"oneOf":[{"type":"string","minLength":1,"maxLength":5,"description":"Indicates seat class (first class, business class, etc.).","example":"F","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":5,"description":"Indicates seat class (first class, business class, etc.).","example":"F","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class","typeLabel":"string | null"}},"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX]","typeLabel":"Airline Addendum Leg · object"},"maxLength":20,"type":"array","uniqueKey":"airline.oneOf.0.legs.oneOf.0","typeLabel":"Airline Addendum Leg · object[]"},{"description":"An array of separate trip segments. Each leg contains detailed\nitinerary information.","items":{"title":"Airline Addendum Leg","type":"object","description":"Each of the separate trip segment, contains detailed itinerary information.","properties":{"carrier_code":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"2 character airline code as set by IATA.","example":"LY"},{"type":"null","minLength":2,"maxLength":2,"description":"2 character airline code as set by IATA.","example":"LY"}]},"carrier_name":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"The name of the airline.","example":"El Al Israel Airlines"},{"type":"null","minLength":1,"maxLength":100,"description":"The name of the airline.","example":"El Al Israel Airlines"}]},"iata_designator":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"2 character IATA code of the airline.","example":"LY"},{"type":"null","minLength":2,"maxLength":2,"description":"2 character IATA code of the airline.","example":"LY"}]},"icao_code":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"3 character ICAO code of the airline.","example":"ELY"},{"type":"null","minLength":3,"maxLength":3,"description":"3 character ICAO code of the airline.","example":"ELY"}]},"flight_number":{"oneOf":[{"type":"string","minLength":3,"maxLength":6,"description":"Unique identifier of the flight number.","example":"BA98"},{"type":"null","minLength":3,"maxLength":6,"description":"Unique identifier of the flight number.","example":"BA98"}]},"departure_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time of travel in local time at the departure airport.","example":"2013-07-16T19:23:00.000+00:00"},{"type":"null","format":"date-time","description":"The date and time of travel in local time at the departure airport.","example":"2013-07-16T19:23:00.000+00:00"}]},"departure_country":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"Departure country code in ISO 3166 format.","example":"UK"},{"type":"null","minLength":2,"maxLength":2,"description":"Departure country code in ISO 3166 format.","example":"UK"}]},"departure_city":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"Departure city name.","example":"London"},{"type":"null","minLength":1,"maxLength":100,"description":"Departure city name.","example":"London"}]},"departure_airport":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"Departure airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR"},{"type":"null","minLength":3,"maxLength":3,"description":"Departure airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR"}]},"arrival_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time of travel in local time at the arrival airport.","example":"2013-07-16T19:23:00.000+00:00"},{"type":"null","format":"date-time","description":"The date and time of travel in local time at the arrival airport.","example":"2013-07-16T19:23:00.000+00:00"}]},"arrival_country":{"oneOf":[{"type":"string","minLength":2,"maxLength":2,"description":"Arrival country code in ISO 3166 format.","example":"UK"},{"type":"null","minLength":2,"maxLength":2,"description":"Arrival country code in ISO 3166 format.","example":"UK"}]},"arrival_city":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"Arrival city name.","example":"London"},{"type":"null","minLength":1,"maxLength":100,"description":"Arrival city name.","example":"London"}]},"arrival_airport":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"Arrival airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR"},{"type":"null","minLength":3,"maxLength":3,"description":"Arrival airport code of leg. 3-letter ISO code according to IATA\nofficial directory.","example":"LHR"}]},"fare_basis_code":{"oneOf":[{"type":"string","minLength":1,"maxLength":8,"description":"The alphanumeric code for the \"booking class\" of a ticket.","example":"WH7LNR"},{"type":"null","minLength":1,"maxLength":8,"description":"The alphanumeric code for the \"booking class\" of a ticket.","example":"WH7LNR"}]},"flight_class":{"oneOf":[{"type":"string","minLength":1,"maxLength":5,"description":"Indicates service class (first class, business class, etc.).","example":"E"},{"type":"null","minLength":1,"maxLength":5,"description":"Indicates service class (first class, business class, etc.).","example":"E"}]},"stop_over":{"oneOf":[{"type":"boolean","description":"Indicates whether a stopover is allowed on this ticket.","example":false},{"type":"null","description":"Indicates whether a stopover is allowed on this ticket.","example":false}]},"route_type":{"type":"string","description":"The route type of the flight.","enum":["round_trip","one_way"],"example":"round_trip","nullable":false},"coupon_number":{"oneOf":[{"type":"string","minLength":1,"maxLength":50,"description":"Coupon number associated with the leg.","example":"15885566"},{"type":"null","minLength":1,"maxLength":50,"description":"Coupon number associated with the leg.","example":"15885566"}]},"fare_amount":{"oneOf":[{"type":"integer","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","minimum":0,"maximum":99999999,"example":100},{"type":"null","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","minimum":0,"maximum":99999999,"example":100}]},"fee_amount":{"oneOf":[{"type":"integer","description":"Fee amount for current leg of the trip.","minimum":0,"maximum":99999999,"example":100},{"type":"null","description":"Fee amount for current leg of the trip.","minimum":0,"maximum":99999999,"example":100}]},"tax_amount":{"oneOf":[{"type":"integer","description":"Amount of the taxes for current leg of the trip.","minimum":0,"maximum":99999999,"example":100},{"type":"null","description":"Amount of the taxes for current leg of the trip.","minimum":0,"maximum":99999999,"example":100}]},"departure_tax_amount":{"oneOf":[{"type":"integer","description":"Departure tax amount charged by a country when a person is leaving the\ncountry.","minimum":0,"maximum":99999999,"example":100},{"type":"null","description":"Departure tax amount charged by a country when a person is leaving the\ncountry.","minimum":0,"maximum":99999999,"example":100}]},"seat_class":{"oneOf":[{"type":"string","minLength":1,"maxLength":5,"description":"Indicates seat class (first class, business class, etc.).","example":"F"},{"type":"null","minLength":1,"maxLength":5,"description":"Indicates seat class (first class, business class, etc.).","example":"F"}]}}},"maxLength":20,"type":"null","uniqueKey":"airline.oneOf.0.legs.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs","typeLabel":"Airline Addendum Leg · object[] | null"}},"uniqueKey":"airline.oneOf.0","typeLabel":"Airline Addendum · object"},{"type":"null","uniqueKey":"airline.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline","typeLabel":"Airline Addendum · object | null"},"payment_method":{"oneOf":[{"description":"Details about the payment method for card type only.","type":"object","properties":{"type":{"type":"string","example":"payment_method","uniqueKey":"payment_method.oneOf.0.type","typeLabel":"string"},"id":{"oneOf":[{"type":"string","description":"Unique ID for the payment method.","uniqueKey":"payment_method.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique ID for the payment method.","uniqueKey":"payment_method.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.id","typeLabel":"string | null"},"method":{"type":"string","example":"card","description":"Payment method type.","enum":["card"],"uniqueKey":"payment_method.oneOf.0.method","typeLabel":"enum\u003cstring>"},"scheme":{"oneOf":[{"description":"The scheme/brand of the card.","type":"string","example":"visa","enum":["accel","amex","bancontact","carte-bancaire","cirrus","culiance","dankort","diners-club","discover","eftpos-australia","elo","hipercard","jcb","maestro","mastercard","mir","nyce","other","pulse","rupay","star","uatp","unionpay","visa",null],"uniqueKey":"payment_method.oneOf.0.scheme.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The scheme/brand of the card.","type":"null","example":"visa","enum":["accel","amex","bancontact","carte-bancaire","cirrus","culiance","dankort","diners-club","discover","eftpos-australia","elo","hipercard","jcb","maestro","mastercard","mir","nyce","other","pulse","rupay","star","uatp","unionpay","visa",null],"uniqueKey":"payment_method.oneOf.0.scheme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.scheme","typeLabel":"enum\u003cstring> | null"},"label":{"oneOf":[{"type":"string","example":"4242","description":"Last four digits of PAN.","uniqueKey":"payment_method.oneOf.0.label.oneOf.0","typeLabel":"string"},{"type":"null","example":"4242","description":"Last four digits of PAN.","uniqueKey":"payment_method.oneOf.0.label.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.label","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","properties":{"bin":{"oneOf":[{"type":"string","example":"411111","description":"First six digits of PAN.","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.bin.oneOf.0","typeLabel":"string"},{"type":"null","example":"411111","description":"First six digits of PAN.","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.bin.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.bin","typeLabel":"string | null"},"card_type":{"oneOf":[{"example":"credit","type":"string","enum":["credit","debit","prepaid"],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"example":"credit","type":"null","enum":["credit","debit","prepaid"],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_type","typeLabel":"enum\u003cstring> | null"},"card_country":{"oneOf":[{"type":"string","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2,"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_country.oneOf.0","typeLabel":"string"},{"type":"null","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2,"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_country","typeLabel":"string | null"},"card_issuer_name":{"oneOf":[{"type":"string","example":"Bank","description":"The name of the card issuer.","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_issuer_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Bank","description":"The name of the card issuer.","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_issuer_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_issuer_name","typeLabel":"string | null"}},"uniqueKey":"payment_method.oneOf.0.details.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"bin":{"oneOf":[{"type":"string","example":"411111","description":"First six digits of PAN."},{"type":"null","example":"411111","description":"First six digits of PAN."}]},"card_type":{"oneOf":[{"example":"credit","type":"string","enum":["credit","debit","prepaid"]},{"example":"credit","type":"null","enum":["credit","debit","prepaid"]}]},"card_country":{"oneOf":[{"type":"string","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2},{"type":"null","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2}]},"card_issuer_name":{"oneOf":[{"type":"string","example":"Bank","description":"The name of the card issuer."},{"type":"null","example":"Bank","description":"The name of the card issuer."}]}},"uniqueKey":"payment_method.oneOf.0.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details","typeLabel":"object | null"},"fingerprint":{"oneOf":[{"type":"string","description":"The unique hash derived from the payment method identifier (e.g. card number).","example":"20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17","uniqueKey":"payment_method.oneOf.0.fingerprint.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique hash derived from the payment method identifier (e.g. card number).","example":"20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17","uniqueKey":"payment_method.oneOf.0.fingerprint.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.fingerprint","typeLabel":"string | null"}},"uniqueKey":"payment_method.oneOf.0","typeLabel":"object"},{"description":"Details about the payment method for card type only.","type":"null","properties":{"type":{"type":"string","example":"payment_method"},"id":{"oneOf":[{"type":"string","description":"Unique ID for the payment method."},{"type":"null","description":"Unique ID for the payment method."}]},"method":{"type":"string","example":"card","description":"Payment method type.","enum":["card"]},"scheme":{"oneOf":[{"description":"The scheme/brand of the card.","type":"string","example":"visa","enum":["accel","amex","bancontact","carte-bancaire","cirrus","culiance","dankort","diners-club","discover","eftpos-australia","elo","hipercard","jcb","maestro","mastercard","mir","nyce","other","pulse","rupay","star","uatp","unionpay","visa",null]},{"description":"The scheme/brand of the card.","type":"null","example":"visa","enum":["accel","amex","bancontact","carte-bancaire","cirrus","culiance","dankort","diners-club","discover","eftpos-australia","elo","hipercard","jcb","maestro","mastercard","mir","nyce","other","pulse","rupay","star","uatp","unionpay","visa",null]}]},"label":{"oneOf":[{"type":"string","example":"4242","description":"Last four digits of PAN."},{"type":"null","example":"4242","description":"Last four digits of PAN."}]},"details":{"oneOf":[{"type":"object","properties":{"bin":{"oneOf":[{"type":"string","example":"411111","description":"First six digits of PAN."},{"type":"null","example":"411111","description":"First six digits of PAN."}]},"card_type":{"oneOf":[{"example":"credit","type":"string","enum":["credit","debit","prepaid"]},{"example":"credit","type":"null","enum":["credit","debit","prepaid"]}]},"card_country":{"oneOf":[{"type":"string","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2},{"type":"null","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2}]},"card_issuer_name":{"oneOf":[{"type":"string","example":"Bank","description":"The name of the card issuer."},{"type":"null","example":"Bank","description":"The name of the card issuer."}]}}},{"type":"null","properties":{"bin":{"oneOf":[{"type":"string","example":"411111","description":"First six digits of PAN."},{"type":"null","example":"411111","description":"First six digits of PAN."}]},"card_type":{"oneOf":[{"example":"credit","type":"string","enum":["credit","debit","prepaid"]},{"example":"credit","type":"null","enum":["credit","debit","prepaid"]}]},"card_country":{"oneOf":[{"type":"string","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2},{"type":"null","example":"US","description":"ISO 3166 two letter country code.","maxLength":2,"minLength":2}]},"card_issuer_name":{"oneOf":[{"type":"string","example":"Bank","description":"The name of the card issuer."},{"type":"null","example":"Bank","description":"The name of the card issuer."}]}}}]},"fingerprint":{"oneOf":[{"type":"string","description":"The unique hash derived from the payment method identifier (e.g. card number).","example":"20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17"},{"type":"null","description":"The unique hash derived from the payment method identifier (e.g. card number).","example":"20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17"}]}},"uniqueKey":"payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"Checkout Session · object"},"examples":{"Example":{"title":"Example","value":{"type":"checkout-session","id":"8d3fe99b-1422-42e6-bbb3-932d95ae5f79","expires_at":"2022-01-01T00:00:00+00:00","cart_items":[{"name":"GoPro HERO9 Camcorder","quantity":1,"unit_amount":37999,"discount_amount":0,"tax_amount":0,"external_identifier":"item-789123","sku":"sku-789123","product_url":"https://example.com/items/gopro","image_url":"https://example.com/images/items/gopro.png","categories":["\u003cstring>"],"product_type":"physical","seller_country":"US"}],"metadata":{"key":"value"},"airline":{"passenger_name_record":"JOHN L","booking_code":"X36Q9C","ticket_number":"123-1234-151555","ticket_delivery_method":"other","issued_at":"2013-07-16T19:23:00.000+00:00","issued_address":"123 Broadway, New York","travel_agency_code":"12345","travel_agency_name":"Agency name","travel_agency_invoice_number":"EG15555155","travel_agency_plan_name":"B733","restricted_ticket":false,"issuing_carrier_code":"A3","issuing_carrier_name":"Aegean Airlines","issuing_iata_designator":"A3","issuing_icao_code":"AEE","reservation_system":"Amadeus","is_cardholder_traveling":false,"passengers":[{"title":"Mr.","first_name":"John","last_name":"Lunn","email_address":"john@example.com","phone_number":"+1234567890","passport_number":"7700225","ticket_number":"LH1236699999","frequent_flyer_number":"15885566","date_of_birth":"2013-07-16","age_group":"adult"}],"legs":[{"carrier_code":"LY","carrier_name":"El Al Israel Airlines","iata_designator":"LY","icao_code":"ELY","flight_number":"BA98","departure_at":"2013-07-16T19:23:00.000+00:00","departure_country":"UK","departure_city":"London","departure_airport":"LHR","arrival_at":"2013-07-16T19:23:00.000+00:00","arrival_country":"UK","arrival_city":"London","arrival_airport":"LHR","fare_basis_code":"WH7LNR","flight_class":"E","stop_over":false,"route_type":"round_trip","coupon_number":"15885566","fare_amount":100,"fee_amount":100,"tax_amount":100,"departure_tax_amount":100,"seat_class":"F"}]},"payment_method":{"type":"payment_method","id":"\u003cstring>","method":"card","scheme":"visa","label":"4242","details":{"bin":"411111","card_type":"credit","card_country":"US","card_issuer_name":"Bank"},"fingerprint":"20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17"}}}},"exampleType":"generated"}},"exampleType":"generated"},"aefe0603-6cd0-4181-ae71-ab8f82541317":{"description":"Returns an error if no valid authentication was provided.","content":{"application/json":{"schema":{"title":"Unauthorized Error","type":"object","description":"Unauthorized Error (HTTP 401).","x-tags":["Errors"],"properties":{"type":{"type":"string","description":"`error`.","enum":["error"],"example":"error","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"`unauthorized`.","example":"unauthorized","enum":["unauthorized"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"status":{"type":"integer","description":"`401`.","example":401,"enum":[401],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","description":"No valid API authentication found.","example":"No valid API authentication found","enum":["No valid API authentication found"],"uniqueKey":"message","typeLabel":"enum\u003cstring>"},"details":{"type":"array","description":"A list of detail objects that further clarify the reason for the error.\nNot every error supports more detail.","example":[],"items":{"title":"Error details","description":"Additional detail about the part of a request body that caused an issue.","type":"object","x-tags":["Errors"],"properties":{"location":{"type":"string","example":"body","description":"The location where the error caused an issue.","enum":["query","body","path","header"],"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"type":{"type":"string","example":"value_error.missing","description":"A unique identifier for the type of error that occurred.","uniqueKey":"details.items.[INDEX].type","typeLabel":"string"},"pointer":{"type":"string","example":"/payment_method/number","description":"The exact item for which the validation did not succeed. This is a JSON\npointer for request bodies, while for query, path, and header parameters\nit is the name of the parameter.","uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","example":"field required","description":"A human readable message for this error detail.","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"Error details · object"},"uniqueKey":"details","typeLabel":"Error details · object[]"}},"uniqueKey":"","typeLabel":"Unauthorized Error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"unauthorized","status":401,"message":"No valid API authentication found","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"bd10f256-9e6e-4059-a85e-2ed3546b1d94":{"description":"Returns an error if the Checkout Session can not be found or has expired.","content":{"application/json":{"schema":{"title":"Not Found Error","type":"object","description":"Not Found Error (HTTP 404).","x-tags":["Errors"],"properties":{"type":{"type":"string","description":"`error`.","enum":["error"],"example":"error","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"The reason code for the error.","example":"not_found","enum":["not_found","pending_creation"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"status":{"type":"integer","description":"`404`.","example":404,"enum":[404],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","description":"The human readable reason for the error.","example":"The resource could not be found","uniqueKey":"message","typeLabel":"string"},"details":{"type":"array","description":"A list of detail objects that further clarify the reason for the error.\nNot every error supports more detail.","example":[],"items":{"title":"Error details","description":"Additional detail about the part of a request body that caused an issue.","type":"object","x-tags":["Errors"],"properties":{"location":{"type":"string","example":"body","description":"The location where the error caused an issue.","enum":["query","body","path","header"],"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"type":{"type":"string","example":"value_error.missing","description":"A unique identifier for the type of error that occurred.","uniqueKey":"details.items.[INDEX].type","typeLabel":"string"},"pointer":{"type":"string","example":"/payment_method/number","description":"The exact item for which the validation did not succeed. This is a JSON\npointer for request bodies, while for query, path, and header parameters\nit is the name of the parameter.","uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","example":"field required","description":"A human readable message for this error detail.","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"Error details · object"},"uniqueKey":"details","typeLabel":"Error details · object[]"}},"uniqueKey":"","typeLabel":"Not Found Error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"not_found","status":404,"message":"The resource could not be found","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6c6223af-e151-4dcc-8f35-88257b966832":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"687beca7-453b-424d-a360-eaca1398b8d8":{"url":"https://api.sandbox.{id}.gr4vy.app","x-speakeasy-server-id":"sandbox","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}},"578272f1-d32a-4d53-8e16-3dc13be44c34":{"url":"https://api.{id}.gr4vy.app","x-speakeasy-server-id":"production","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.v1.json"},"subdomain":"flexxbuy","siteName":"Gr4vy","title":"Get checkout session - Gr4vy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T13:44:50.897Z","originalFileLocation":"reference/checkout-sessions/get-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=\"application-name\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get checkout session - Gr4vy\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gr4vy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Checkout+Sessions\u0026amp;title=Get+checkout+session\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=5357060ea8c93665c095142686ae5b987594effa72bada61d9ea6b4678cc5c73\">\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=\"Get checkout session - Gr4vy\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Checkout+Sessions\u0026amp;title=Get+checkout+session\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=5357060ea8c93665c095142686ae5b987594effa72bada61d9ea6b4678cc5c73\">\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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066CC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/checkout-sessions/get-checkout-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.byzly.com/#organization\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.byzly.com#website\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session#webpage\",\"url\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session\",\"name\":\"Get checkout session\",\"dateModified\":\"2026-10-21T13:44:50.897Z\",\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Checkout Sessions\",\"item\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get checkout session\",\"item\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session#apireference\",\"headline\":\"Get checkout session\",\"name\":\"Get checkout session\",\"url\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/get-checkout-session#webpage\"},\"dateModified\":\"2026-10-21T13:44:50.897Z\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gr4vy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gr4vy","nav":{"global":null,"tabs":[{"tab":"Build","icon":"credit-card","groups":[{"group":"Get started","icon":"compass","pages":[{"sidebarTitle":"Overview","title":"Connect, build, and scale payments","mode":"wide","href":"/guides/get-started"},{"title":"Accept payments on the web","sidebarTitle":"Web payments","href":"/guides/payments/web"},{"title":"Accept payments on mobile","sidebarTitle":"Mobile payments","href":"/guides/payments/mobile"}]},{"group":"Integration guides","icon":"code","pages":[{"group":"Embed","pages":[{"group":"Web","pages":[{"title":"Embed","sidebarTitle":"Introduction","href":"/guides/payments/embed/quick-start/overview"},{"title":"Creating an API key for use with Embed","sidebarTitle":"API keys","href":"/guides/payments/embed/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/embed/quick-start/sdks"},{"title":"Adding Embed","sidebarTitle":"Embed checkout","href":"/guides/payments/embed/quick-start/embed"},{"title":"Inspecting transactions","sidebarTitle":"Transaction inspection","href":"/guides/payments/embed/quick-start/inspect"},{"title":"Going live","sidebarTitle":"Going live","href":"/guides/payments/embed/quick-start/live"},{"title":"Digital wallets in Embed","sidebarTitle":"Digital wallets","href":"/guides/payments/embed/digital-wallets"},{"title":"Embed events","sidebarTitle":"Events","href":"/guides/payments/embed/events"},{"title":"Embed localization","sidebarTitle":"Locales","href":"/guides/payments/embed/locale"},{"title":"Embed Theming","sidebarTitle":"Theming","href":"/guides/payments/embed/theming"},{"title":"Embed options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/embed/options"},{"title":"In-app browsers with Embed","sidebarTitle":"In-app browsers","href":"/guides/payments/embed/in-app-browsers"},{"title":"Common issues with Embed","sidebarTitle":"Common issues","href":"/guides/payments/embed/common-issues"}]},{"group":"Android","pages":[{"title":"Android SDK","sidebarTitle":"Introduction","href":"/guides/payments/android/quick-start/overview"},{"title":"Creating an API key for use with Android","sidebarTitle":"API keys","href":"/guides/payments/android/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/android/quick-start/sdks"},{"title":"Installing the Android SDK","sidebarTitle":"SDK installation","href":"/guides/payments/android/quick-start/android"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/android/quick-start/transact"},{"title":"Google Pay on Android","sidebarTitle":"Google Pay","href":"/guides/payments/android/google-pay"},{"title":"Android events","sidebarTitle":"Events","href":"/guides/payments/android/events"},{"title":"Android options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/android/options"}]},{"group":"iOS","pages":[{"title":"iOS SDK","sidebarTitle":"Introduction","href":"/guides/payments/ios/quick-start/overview"},{"title":"Creating an API key for use with iOS","sidebarTitle":"API keys","href":"/guides/payments/ios/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/ios/quick-start/sdks"},{"title":"Installing the iOS SDK","sidebarTitle":"SDK installation","href":"/guides/payments/ios/quick-start/ios"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/ios/quick-start/transact"},{"title":"Apple Pay on iOS","sidebarTitle":"Apple Pay","href":"/guides/payments/ios/apple-pay"},{"title":"iOS events","sidebarTitle":"Events","href":"/guides/payments/ios/events"},{"title":"iOS options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/ios/options"}]},{"group":"React Native","pages":[{"title":"React Native SDK","sidebarTitle":"Introduction","href":"/guides/payments/react-native/quick-start/overview"},{"title":"Creating an API key for use with React Native","sidebarTitle":"API keys","href":"/guides/payments/react-native/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/react-native/quick-start/sdks"},{"title":"Installing the React Native SDK","sidebarTitle":"SDK installation","href":"/guides/payments/react-native/quick-start/embed"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/react-native/quick-start/transact"},{"title":"Apple Pay on React Native","sidebarTitle":"Apple Pay","href":"/guides/payments/react-native/apple-pay"},{"title":"Google Pay on React Native","sidebarTitle":"Google Pay","href":"/guides/payments/react-native/google-pay"},{"title":"React Native events","sidebarTitle":"Events","href":"/guides/payments/react-native/events"},{"title":"React Native options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/react-native/options"}]}]},{"group":"Secure Fields","pages":[{"title":"Secure Fields","sidebarTitle":"Introduction","href":"/guides/payments/secure-fields/quick-start/overview"},{"title":"Creating an API key for use with Secure Fields","sidebarTitle":"API keys","href":"/guides/payments/secure-fields/quick-start/key"},{"title":"Creating checkout sessions","sidebarTitle":"Checkout sessions","href":"/guides/payments/secure-fields/quick-start/sdks"},{"title":"Adding secure fields","sidebarTitle":"Secure fields","href":"/guides/payments/secure-fields/quick-start/embed"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/secure-fields/quick-start/transact"},{"title":"Secure Fields and 3DS","sidebarTitle":"3DS","href":"/guides/payments/secure-fields/three-d-secure"},{"title":"Secure Fields with stored cards","sidebarTitle":"Stored cards","href":"/guides/payments/secure-fields/stored-cards"},{"title":"Secure Fields theming","sidebarTitle":"Theming","href":"/guides/payments/secure-fields/theming"},{"title":"Secure Fields events","sidebarTitle":"Events","href":"/guides/payments/secure-fields/events"},{"title":"Secure Fields UX options","sidebarTitle":"UX options","href":"/guides/payments/secure-fields/ux-options"}]},{"group":"Direct API","pages":[{"title":"Direct API","sidebarTitle":"Introduction","href":"/guides/payments/direct-api/quick-start/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/guides/payments/direct-api/quick-start/key"},{"title":"Listing payment options","sidebarTitle":"Payment options","href":"/guides/payments/direct-api/quick-start/payment-options"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/direct-api/quick-start/transaction"},{"title":"Handling redirects","sidebarTitle":"Redirects","href":"/guides/payments/direct-api/quick-start/handle-redirect"},{"title":"Getting transaction results","sidebarTitle":"Transaction results","href":"/guides/payments/direct-api/quick-start/status"},{"title":"PayPal via the API","sidebarTitle":"PayPal","href":"/guides/payments/direct-api/paypal"}]},{"group":"Native SDKs","pages":[{"title":"Native Mobile SDKs","sidebarTitle":"Overview","href":"/guides/payments/native/overview"},{"title":"Create an API key","sidebarTitle":"API keys","href":"/guides/payments/native/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/native/sdks"},{"title":"Vaulting card data","sidebarTitle":"Vaulting","href":"/guides/payments/native/vault"},{"title":"Adding 3DS authentication","sidebarTitle":"3DS","href":"/guides/payments/native/3ds"},{"sidebarTitle":"Get card details","title":"Card details","href":"/guides/payments/native/get-card-details"},{"sidebarTitle":"Payment options","title":"List payment options","href":"/guides/payments/native/list-payment-options"},{"sidebarTitle":"Buyer payment methods","title":"List buyer payment methods","href":"/guides/payments/native/list-buyer-payment-methods"},{"title":"SDK Response Reference","sidebarTitle":"Responses","href":"/guides/payments/native/responses"}]},{"group":"Agentic Development Kit","pages":[{"title":"Agentic Development Kit (ADK)","sidebarTitle":"Overview","href":"/guides/payments/adk/overview"},{"group":"ChatGPT","pages":[{"title":"ChatGPT ADK","sidebarTitle":"Introduction","href":"/guides/payments/chatgpt-app/overview"},{"title":"Architecture","sidebarTitle":"Architecture","href":"/guides/payments/chatgpt-app/architecture"},{"title":"Set up the project","sidebarTitle":"Setup","href":"/guides/payments/chatgpt-app/setup"},{"title":"Build the MCP server","sidebarTitle":"MCP server","href":"/guides/payments/chatgpt-app/mcp-server"},{"title":"Build the widgets","sidebarTitle":"Widgets","href":"/guides/payments/chatgpt-app/widgets"},{"title":"Integrate Gr4vy Embed","sidebarTitle":"Gr4vy Embed","href":"/guides/payments/chatgpt-app/gr4vy-embed"},{"title":"Deploy to ChatGPT","sidebarTitle":"Deployment","href":"/guides/payments/chatgpt-app/deployment"}]}]},{"group":"Vaulting","pages":[{"title":"Vaulting","sidebarTitle":"Overview","href":"/guides/features/vault-forwarding/overview"},{"title":"Tokenize a card","sidebarTitle":"Tokenize","href":"/guides/features/vault-forwarding/tokenize"},{"title":"Provision a PSP token","sidebarTitle":"PSP tokens","href":"/guides/features/vault-forwarding/psp-tokens"},{"title":"Vault Forward card data to API endpoint","sidebarTitle":"Forward to endpoint","href":"/guides/features/vault-forwarding/forward"}]},{"group":"E-commerce Plugins","pages":[{"group":"commercetools","pages":[{"title":"commercetools Integration","sidebarTitle":"Overview","href":"/guides/payments/commercetools/overview"},{"title":"commercetools Installation","sidebarTitle":"Installation","href":"/guides/payments/commercetools/installation"},{"title":"commercetools Configuration","sidebarTitle":"Configuration","href":"/guides/payments/commercetools/configuration"},{"title":"commercetools Administration","sidebarTitle":"Administration","href":"/guides/payments/commercetools/backend"},{"title":"commercetools Frontend","sidebarTitle":"Frontend","href":"/guides/payments/commercetools/frontend"}]},{"group":"Magento","pages":[{"title":"Magento Plugin","sidebarTitle":"Overview","href":"/guides/payments/magento/overview"},{"title":"Magento Installation","sidebarTitle":"Installation","href":"/guides/payments/magento/installation"},{"title":"Magento Configuration","sidebarTitle":"Configuration","href":"/guides/payments/magento/configuration"},{"title":"Magento Administration","sidebarTitle":"Administration","href":"/guides/payments/magento/backend"},{"title":"Magento Frontend","sidebarTitle":"Frontend","href":"/guides/payments/magento/frontend"}]},{"group":"Salesforce Commerce Cloud","pages":[{"title":"Salesforce Commerce Cloud Cartridge","sidebarTitle":"Overview","href":"/guides/payments/sfcc/overview"},{"title":"Salesforce Commerce Cloud Installation","sidebarTitle":"Installation","href":"/guides/payments/sfcc/installation"},{"title":"Salesforce Commerce Cloud Configuration","sidebarTitle":"Configuration","href":"/guides/payments/sfcc/configuration"},{"title":"Salesforce Commerce Cloud Administration","sidebarTitle":"Administration","href":"/guides/payments/sfcc/backend"},{"title":"Salesforce Commerce Cloud Frontend","sidebarTitle":"Frontend","href":"/guides/payments/sfcc/frontend"}]}]}]},{"group":"Best Practices","icon":"lightbulb","pages":[{"title":"Best practices","href":"/guides/best-practices/overview"},{"title":"Identifiers \u0026 reconciliation","sidebarTitle":"IDs \u0026 reconciliation","href":"/guides/ids"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"}]},{"group":"Resources","icon":"toolbox","pages":[{"title":"Command Line Interface (CLI)","sidebarTitle":"CLI","href":"/guides/tools/cli"},{"title":"Postman Collection","sidebarTitle":"Postman","href":"/guides/tools/postman"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"}]},{"group":"Features","icon":"sliders","pages":[{"group":"3-D Secure","pages":[{"title":"3-D Secure","sidebarTitle":"Overview","href":"/guides/features/3ds/overview"},{"title":"3-D Secure Setup","sidebarTitle":"Setup","href":"/guides/features/3ds/setup"},{"title":"Setup 3DS card schemes","sidebarTitle":"Schemes","href":"/guides/features/3ds/schemes"},{"title":"3-D Secure with multiple connections","sidebarTitle":"Multiple connections","href":"/guides/features/3ds/multiple-connections"},{"title":"3-D Secure in Embed","sidebarTitle":"Embed","href":"/guides/features/3ds/embed"},{"title":"Hosted 3-D Secure","sidebarTitle":"Hosted","href":"/guides/features/3ds/hosted"},{"title":"Native 3-D Secure","sidebarTitle":"Native","href":"/guides/features/3ds/native"},{"title":"Pass-through External 3-D Secure data","sidebarTitle":"External","href":"/guides/features/3ds/external"},{"title":"3DS authentication results","sidebarTitle":"Results","href":"/guides/features/3ds/statuses"},{"title":"3-D Secure testing","sidebarTitle":"Testing","href":"/guides/features/3ds/testing"},{"title":"3DS Scenarios","sidebarTitle":"Scenarios","href":"/guides/features/3ds/scenarios"}]},{"group":"Account updater","pages":[{"title":"Account Updater","sidebarTitle":"Overview","href":"/guides/features/account-updater/overview"},{"title":"Manual account updates","sidebarTitle":"Manual updates","href":"/guides/features/account-updater/integration"},{"title":"Scheduled account updates","sidebarTitle":"Scheduled updates","href":"/guides/features/account-updater/scheduler"},{"title":"Real time account updates","sidebarTitle":"Real time updates","href":"/guides/features/account-updater/real-time"}]},{"group":"AFTs","pages":[{"title":"Account funding transactions","sidebarTitle":"Overview","href":"/guides/features/account-funding-transactions/overview"}]},{"group":"Anti-fraud","pages":[{"title":"Anti-fraud","sidebarTitle":"Overview","href":"/guides/features/anti-fraud/overview"},{"title":"Anti-fraud setup","sidebarTitle":"Setup","href":"/guides/features/anti-fraud/setup"},{"title":"Silent mode","sidebarTitle":"Silent mode","href":"/guides/features/anti-fraud/silent-mode"},{"title":"Automatic anti-fraud device fingerprinting","sidebarTitle":"Fingerprints","href":"/guides/features/anti-fraud/fingerprint"},{"title":"Anti-fraud reviews","sidebarTitle":"Reviews","href":"/guides/features/anti-fraud/reviews"},{"title":"Anti-fraud simulator","sidebarTitle":"Simulator","href":"/guides/features/anti-fraud/simulator"}]},{"group":"Apple Pay","pages":[{"title":"Apple Pay","sidebarTitle":"Overview","href":"/guides/features/apple-pay/overview"},{"title":"Apple Pay on web with Embed","sidebarTitle":"Web with Embed","href":"/guides/features/apple-pay/web"},{"title":"Apple Pay on web without Embed","sidebarTitle":"Web without Embed","href":"/guides/features/apple-pay/web-without-sdk"},{"title":"Apple Pay on iOS with the SDK","sidebarTitle":"iOS with SDK","href":"/guides/features/apple-pay/ios"},{"title":"Apple Pay on iOS without the SDK","sidebarTitle":"iOS without SDK","href":"/guides/features/apple-pay/ios-without-sdk"},{"title":"Decrypted Apple Pay tokens","sidebarTitle":"Decrypted tokens","href":"/guides/features/apple-pay/decrypted-tokens"}]},{"group":"Click to Pay","pages":[{"title":"Click to Pay","sidebarTitle":"Overview","href":"/guides/features/click-to-pay/overview"},{"title":"Click to Pay Setup","sidebarTitle":"Setup","href":"/guides/features/click-to-pay/setup"},{"title":"Customer Authentication Module (CAM)","sidebarTitle":"Customer Authentication","href":"/guides/features/click-to-pay/cam"},{"title":"Token Authentication Service (TAS)","sidebarTitle":"Token Authentication","href":"/guides/features/click-to-pay/tas"}]},{"group":"Gift Cards","pages":[{"title":"Gift Cards","sidebarTitle":"Overview","href":"/guides/features/gift-cards/overview"},{"title":"Gift card simulator","sidebarTitle":"Simulator","href":"/guides/features/gift-cards/simulator"}]},{"group":"Google Pay","pages":[{"title":"Google Pay","sidebarTitle":"Overview","href":"/guides/features/google-pay/overview"},{"title":"Google Pay on web with Embed","sidebarTitle":"Web with Embed","href":"/guides/features/google-pay/web"},{"title":"Google Pay on web without Embed","sidebarTitle":"Web without Embed","href":"/guides/features/google-pay/web-without-sdk"},{"title":"Google Pay on Android with the SDK","sidebarTitle":"Android with SDK","href":"/guides/features/google-pay/mobile"},{"title":"Google Pay on Android without the SDK","sidebarTitle":"Android without SDK","href":"/guides/features/google-pay/mobile-without-sdk"},{"title":"Decrypted Google Pay tokens","sidebarTitle":"Decrypted tokens","href":"/guides/features/google-pay/decrypted-tokens"}]},{"group":"Guest checkout","pages":[{"title":"Guest checkout","sidebarTitle":"Overview","href":"/guides/features/guest-checkout/overview"},{"title":"Linking guests buyer details","sidebarTitle":"Buyer linking","href":"/guides/features/guest-checkout/linking"}]},{"group":"Import card data","pages":[{"title":"Vault token import","sidebarTitle":"Overview","href":"/guides/features/token-import/overview"},{"title":"Token import file creation","sidebarTitle":"Import file","mode":"wide","href":"/guides/features/token-import/token-import-file"},{"title":"Token import file upload","sidebarTitle":"Upload tokens","href":"/guides/features/token-import/token-file-transmission"},{"title":"Creating buyers \u0026 payment methods on import","sidebarTitle":"Buyers \u0026 payment methods","href":"/guides/features/token-import/buyer-payment-creation"}]},{"group":"Incremental authorization","pages":[{"title":"Incremental authorization","sidebarTitle":"Overview","href":"/guides/features/incremental-authorization/overview"}]},{"group":"Merchant accounts","pages":[{"title":"Merchant accounts","sidebarTitle":"Overview","href":"/guides/features/merchant-accounts/overview"},{"title":"Managing merchant accounts","sidebarTitle":"Accounts","href":"/guides/features/merchant-accounts/accounts"},{"title":"Users \u0026 merchant accounts","sidebarTitle":"Users","href":"/guides/features/merchant-accounts/users"},{"title":"API \u0026 merchant accounts","sidebarTitle":"API","href":"/guides/features/merchant-accounts/api"},{"title":"Embed \u0026 merchant accounts","sidebarTitle":"Embed","href":"/guides/features/merchant-accounts/embed"}]},{"group":"Multi captures","pages":[{"title":"Multi captures","sidebarTitle":"Overview","href":"/guides/features/multi-captures/overview"}]},{"group":"Network tokens","pages":[{"title":"Network tokens","sidebarTitle":"Overview","href":"/guides/features/network-tokens/overview"},{"title":"Network token implementation","sidebarTitle":"Implementation","href":"/guides/features/network-tokens/implementation"},{"title":"Network token lifecycle management","sidebarTitle":"Lifecycle","href":"/guides/features/network-tokens/lifecycle"},{"title":"Network Token Testing","sidebarTitle":"Testing","href":"/guides/features/network-tokens/testing"},{"title":"Network token pass through","sidebarTitle":"Pass through","href":"/guides/features/network-tokens/passthrough"}]},{"group":"Partial auth","pages":[{"title":"Partial authorization","sidebarTitle":"Overview","href":"/guides/features/partial-authentication/overview"}]},{"group":"Bank payments","pages":[{"title":"Bank payments","sidebarTitle":"Overview","href":"/guides/features/pay-by-bank/overview"}]},{"group":"Payment facilitators","pages":[{"title":"Payment facilitators","sidebarTitle":"Overview","href":"/guides/features/payment-facilitators/overview"}]},{"group":"Payment links","pages":[{"title":"Payment links","sidebarTitle":"Overview","href":"/guides/features/payment-links/overview"},{"title":"Sharing the payment link","sidebarTitle":"Sharing","href":"/guides/features/payment-links/sharing"},{"title":"Payment link expiration and statuses","sidebarTitle":"Expiration \u0026 Status","href":"/guides/features/payment-links/statuses"}]},{"group":"Payouts","pages":[{"title":"Payouts","sidebarTitle":"Introduction","href":"/guides/features/payouts/overview"}]},{"group":"Paze","pages":[{"title":"Paze","sidebarTitle":"Overview","href":"/guides/features/paze/overview"},{"title":"Set up Paze","sidebarTitle":"Set up","href":"/guides/features/paze/setup"},{"title":"Paze on web","sidebarTitle":"Web setup","href":"/guides/features/paze/web"},{"title":"Paze on mobile","sidebarTitle":"Mobile setup","href":"/guides/features/paze/mobile"}]},{"group":"PSP Tokenization","pages":[{"title":"PSP Tokenization","sidebarTitle":"Overview","href":"/guides/features/psp-tokenization/overview"}]},{"group":"Push payments","pages":[{"title":"Push payments","sidebarTitle":"Overview","href":"/guides/features/push-payments/overview"},{"title":"Push payments and Embed","sidebarTitle":"Embed","href":"/guides/features/push-payments/embed"}]},{"group":"Reauthorization","pages":[{"title":"Reauthorization","sidebarTitle":"Overview","href":"/guides/features/reauthorization/overview"}]},{"group":"Recurring payments","pages":[{"title":"Recurring payments","sidebarTitle":"Overview","href":"/guides/features/recurring-payments/overview"},{"title":"Common scenarios","href":"/guides/features/recurring-payments/scenarios"},{"title":"Recurring transactions with Embed","sidebarTitle":"In Embed","href":"/guides/features/recurring-payments/embed"},{"title":"Open-loop versus closed-loop","sidebarTitle":"Open or Closed-loop","href":"/guides/features/recurring-payments/open-loop"},{"title":"Recurring payments with network tokens","sidebarTitle":"Network tokens","href":"/guides/features/recurring-payments/network-tokens"},{"title":"Mastercard Transaction Link Identifier (TLID)","sidebarTitle":"Mastercard TLID","href":"/guides/features/recurring-payments/mastercard-tlid"}]},{"group":"Scheme Cards","pages":[{"title":"Card fingerprints","sidebarTitle":"Card fingerprints","href":"/guides/features/cards/fingerprints"},{"title":"Payment account references","sidebarTitle":"Payment account references","href":"/guides/features/cards/payment-account-reference"}]},{"group":"Shipment tracking","pages":[{"title":"Shipment tracking","sidebarTitle":"Overview","href":"/guides/features/shipment-tracking/overview"}]},{"group":"Simulators","pages":[{"title":"Transaction simulators","sidebarTitle":"Overview","href":"/guides/features/simulators/overview"},{"title":"Transaction simulator webhooks","sidebarTitle":"Webhooks","href":"/guides/features/simulators/webhooks"}]},{"group":"Vault Forwarding","pages":[{"title":"Enable a Vault Forward endpoint","sidebarTitle":"Enable endpoint","href":"/guides/features/vault-forwarding/enable"},{"title":"Vault Forward card data from a checkout session","sidebarTitle":"CVV \u0026 Secure Fields","href":"/guides/features/vault-forwarding/checkout-sessions"},{"title":"Forward 3DS authentication data via Vault Forward","sidebarTitle":"3DS forwarding","href":"/guides/features/vault-forwarding/3ds"},{"title":"Forward network tokens via Vault Forward","sidebarTitle":"Network tokens","href":"/guides/features/vault-forwarding/network-tokens"},{"group":"Advanced authentication","pages":[{"title":"Advanced authentication for Vault Forward","sidebarTitle":"Overview","href":"/guides/features/vault-forwarding/authentication"},{"title":"Advanced authentication for Visa","sidebarTitle":"Visa","href":"/guides/features/vault-forwarding/visa"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Introduction","href":"/guides/features/webhooks/overview"},{"title":"Webhook payload","sidebarTitle":"Payload","href":"/guides/features/webhooks/payload"},{"title":"Webhook events","sidebarTitle":"Events","mode":"wide","href":"/guides/features/webhooks/events"},{"title":"Technical webhook considerations","sidebarTitle":"Technical considerations","href":"/guides/features/webhooks/technical-considerations"},{"title":"Webhook signatures","sidebarTitle":"Signatures","href":"/guides/features/webhooks/signatures"}]}]},{"group":"Other","pages":[{"group":"Statuses","pages":[{"title":"Transaction statuses","sidebarTitle":"Transactions","href":"/guides/api/statuses/transactions"},{"title":"Payment method statuses","sidebarTitle":"Payment methods","href":"/guides/api/statuses/payment-methods"}]}]}]},{"tab":"Dashboard","icon":"circle-user","pages":[{"group":"Overview","icon":"compass","pages":[{"title":"Dashboard overview","sidebarTitle":"Overview","href":"/guides/dashboard/overview"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"API keys","sidebarTitle":"API keys","href":"/guides/dashboard/integrations/api-keys"}]},{"group":"Insights","icon":"eye","pages":[{"title":"Insights","sidebarTitle":"Overview","href":"/guides/dashboard/insights/homepage"},{"title":"Authentication Insights","sidebarTitle":"Authentications","mode":"wide","href":"/guides/dashboard/insights/authentications"},{"title":"Authorization Insights","sidebarTitle":"Authorizations","href":"/guides/dashboard/insights/authorizations"}]},{"group":"Monitoring \u0026 Alerting","icon":"chart-line","pages":[{"title":"Monitoring \u0026 Alerting","sidebarTitle":"Overview","href":"/guides/dashboard/monitoring-and-alerting/overview"},{"title":"Set Up a Monitor","sidebarTitle":"Setup","href":"/guides/dashboard/monitoring-and-alerting/setup"},{"title":"Alerts","sidebarTitle":"Alerts","href":"/guides/dashboard/monitoring-and-alerting/alerts"}]},{"group":"Flow","icon":"diagram-project","pages":[{"title":"Flow","sidebarTitle":"Overview","href":"/guides/dashboard/flow/overview"},{"title":"Checkout Flow","href":"/guides/dashboard/flow/checkout"},{"title":"Card Transactions Flow","href":"/guides/dashboard/flow/card-transactions"},{"title":"Other Transactions Flow","href":"/guides/dashboard/flow/other-transactions"}]},{"group":"Roles \u0026 Permissions","icon":"users","pages":[{"sidebarTitle":"Overview","title":"Roles \u0026 Permissions","href":"/guides/dashboard/roles-and-permissions/overview"},{"sidebarTitle":"Roles","title":"User roles","href":"/guides/dashboard/roles-and-permissions/roles"},{"sidebarTitle":"Additional permissions","title":"Additional user permissions","href":"/guides/dashboard/roles-and-permissions/additional-permissions"}]},{"group":"Reports","icon":"file-lines","pages":[{"title":"Reports","sidebarTitle":"Overview","href":"/guides/dashboard/reports/overview"},{"title":"Report specification","sidebarTitle":"Specification","href":"/guides/dashboard/reports/spec"},{"title":"Setup a report","sidebarTitle":"Setup","href":"/guides/dashboard/reports/how-to"},{"group":"Models","pages":[{"title":"Available report models","sidebarTitle":"Available models","href":"/guides/dashboard/reports/models"},{"title":"Receivable transactions","href":"/guides/dashboard/reports/models-accounts-receivables"},{"title":"Transactions","href":"/guides/dashboard/reports/models-transactions"},{"title":"Transactions retries","href":"/guides/dashboard/reports/models-transaction-retries"}]}]},{"group":"Settlement reports","icon":"money-bill-transfer","pages":[{"title":"Settlement reports","sidebarTitle":"Overview","href":"/guides/dashboard/reports/settlement/overview"},{"title":"Settlement report ingestion","sidebarTitle":"Ingestion","href":"/guides/dashboard/reports/settlement/ingestion"},{"title":"Settlement report scheduling","sidebarTitle":"Schedule \u0026 Retrieve","href":"/guides/dashboard/reports/settlement/scheduling"},{"title":"Settlement reconciliation","sidebarTitle":"Reconciliation","href":"/guides/dashboard/reports/settlement/reconciliation"},{"title":"Reconciling settlement records","sidebarTitle":"Settlement records","href":"/guides/dashboard/reports/settlement/settlement-records"},{"title":"Settlement report specification","sidebarTitle":"Specification","mode":"wide","href":"/guides/dashboard/reports/settlement/specification"},{"group":"Payment services","pages":[{"title":"Settlement report Adyen mapping","sidebarTitle":"Adyen","mode":"wide","href":"/guides/dashboard/reports/settlement/adyen"},{"title":"Settlement report BlueSnap mapping","sidebarTitle":"BlueSnap","mode":"wide","href":"/guides/dashboard/reports/settlement/bluesnap"},{"title":"Settlement report Braintree mapping","sidebarTitle":"Braintree","mode":"wide","href":"/guides/dashboard/reports/settlement/braintree"},{"title":"Settlement report Chase Orbital mapping","sidebarTitle":"Chase Orbital","mode":"wide","href":"/guides/dashboard/reports/settlement/chaseorbital"},{"title":"Settlement report Cybersource mapping","sidebarTitle":"Cybersource","mode":"wide","href":"/guides/dashboard/reports/settlement/cybersource"},{"title":"Settlement report dLocal mapping","sidebarTitle":"dLocal","mode":"wide","href":"/guides/dashboard/reports/settlement/dlocal"},{"title":"Settlement report Nuvei mapping","sidebarTitle":"Nuvei","mode":"wide","href":"/guides/dashboard/reports/settlement/nuvei"},{"title":"Settlement report PayPal mapping","sidebarTitle":"PayPal","mode":"wide","href":"/guides/dashboard/reports/settlement/paypal"},{"title":"Settlement report Stripe mapping","sidebarTitle":"Stripe","mode":"wide","href":"/guides/dashboard/reports/settlement/stripe"},{"title":"Settlement report Trustly (US) mapping","sidebarTitle":"Trustly (US)","mode":"wide","href":"/guides/dashboard/reports/settlement/trustly"}]}]},{"group":"SSO","icon":"shield","pages":[{"title":"Single Sign-On","sidebarTitle":"Overview","href":"/guides/dashboard/sso/overview"},{"title":"Single Sign-On with Okta","sidebarTitle":"Okta","href":"/guides/dashboard/sso/okta"},{"title":"Single Sign-On with Azure AD","sidebarTitle":"Azure AD","href":"/guides/dashboard/sso/azure"},{"title":"Single Sign-On with OneLogin","sidebarTitle":"OneLogin","href":"/guides/dashboard/sso/onelogin"},{"title":"Single Sign-On with Google Workspace","sidebarTitle":"Google Workspace","href":"/guides/dashboard/sso/google-workspace"},{"title":"Common SSO issues","sidebarTitle":"Common issues","href":"/guides/dashboard/sso/common-issues"}]}]},{"tab":"Connections","icon":{"style":"light","name":"circle-nodes"},"groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Connections","sidebarTitle":"Overview","mode":"wide","href":"/connections/payments/overview"},{"title":"Connection catalog","sidebarTitle":"Catalog","mode":"wide","href":"/connections/catalog"}]},{"group":"Aggregators","icon":"link","pages":[{"title":"Adyen","sidebarTitle":"Adyen","href":"/connections/payments/adyen"},{"title":"Braintree","sidebarTitle":"Braintree","href":"/connections/payments/braintree"},{"title":"Buckaroo","sidebarTitle":"Buckaroo","href":"/connections/payments/buckaroo"},{"title":"Chase","sidebarTitle":"Chase","href":"/connections/payments/chase"},{"title":"Checkout.com","sidebarTitle":"Checkout.com","href":"/connections/payments/checkout"},{"title":"Cybersource","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource"},{"title":"dLocal","sidebarTitle":"dLocal","href":"/connections/payments/dlocal"},{"title":"Fiserv","sidebarTitle":"Fiserv","href":"/connections/payments/fiserv"},{"title":"Nuvei","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei"},{"title":"PayPal","sidebarTitle":"PayPal","href":"/connections/payments/paypal"},{"title":"Stripe","sidebarTitle":"Stripe","href":"/connections/payments/stripe"},{"title":"Worldline","sidebarTitle":"Worldline","href":"/connections/payments/worldline"},{"title":"Worldpay","sidebarTitle":"Worldpay","href":"/connections/payments/worldpay"}]},{"group":"Methods","icon":"coins","tag":"400+","pages":[{"group":"Banking","pages":[{"group":"ACH Direct Debit","pages":[{"title":"Adyen - ACH Direct Debit","sidebarTitle":"Adyen","href":"/connections/payments/adyen-ach"},{"title":"BlueSnap - ACH Direct Debit","sidebarTitle":"BlueSnap","href":"/connections/payments/bluesnap-ach"}]},{"group":"Bank accounts","pages":[{"title":"Bank accounts","sidebarTitle":"Overview","href":"/connections/payments/bank"},{"title":"Adyen - Bank account (ACH, SEPA, BACS)","sidebarTitle":"Adyen","href":"/connections/payments/adyen-bank"},{"title":"Chase Orbital - Bank account (ACH)","sidebarTitle":"Chase Orbital","href":"/connections/payments/chaseorbital-bank"},{"title":"Nuvei - Bank account (ACH)","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-bank"},{"group":"Pay by Bank with Plaid","pages":[{"title":"Plaid","sidebarTitle":"Overview","href":"/connections/payments/plaid-bank"},{"title":"Plaid Integration","sidebarTitle":"Integration","href":"/connections/payments/plaid-bank-integration"},{"title":"Plaid Recurring Payments","sidebarTitle":"Recurring payments","href":"/connections/payments/plaid-bank-recurring"},{"title":"Plaid Signal setup","sidebarTitle":"Signal setup","href":"/connections/payments/plaid-bank-signal"}]}]},{"group":"BCP","pages":[{"title":"dLocal - BCP","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-bcp"}]},{"group":"BLIK","pages":[{"title":"Adyen - BLIK","sidebarTitle":"Adyen","href":"/connections/payments/adyen-blik"}]},{"group":"Bre-B","pages":[{"title":"dLocal - Bre-B","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-breb"}]},{"group":"Capitec","pages":[{"title":"dLocal - Capitec","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-capitec"}]},{"title":"GoCardless","sidebarTitle":"GoCardless","href":"/connections/payments/gocardless-gocardless"},{"group":"iDEAL | Wero","pages":[{"title":"Adyen - iDEAL | Wero","sidebarTitle":"Adyen","href":"/connections/payments/adyen-ideal"},{"title":"Buckaroo - iDEAL | Wero","sidebarTitle":"Buckaroo","href":"/connections/payments/buckaroo-ideal"},{"title":"Cybersource - iDEAL | Wero","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource-ideal"},{"title":"Nuvei - iDEAL | Wero","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-ideal"},{"title":"Worldline TravelHub - iDEAL | Wero","sidebarTitle":"Worldline TravelHub","href":"/connections/payments/travelhub-ideal"}]},{"group":"Interac","pages":[{"title":"Nuvei - Interac","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-interac"}]},{"group":"KCP","pages":[{"title":"Cybersource - KCP","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource-kcp"}]},{"group":"Khipu","pages":[{"title":"dLocal - Khipu","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-khipu"}]},{"group":"NetBanking","pages":[{"title":"dLocal - NetBanking","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-netbanking"}]},{"group":"NuPay","pages":[{"title":"dLocal - NuPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-nupay"}]},{"group":"Online Banking Czech Republic","pages":[{"title":"Adyen - Online Banking Czech Republic","sidebarTitle":"Adyen","href":"/connections/payments/adyen-onlinebankingcz"}]},{"group":"Pay by Bank (redirect)","pages":[{"title":"Adyen - Pay by Bank (redirect)","sidebarTitle":"Adyen","href":"/connections/payments/adyen-paybybank"}]},{"group":"PayID","pages":[{"title":"Azupay - PayID","sidebarTitle":"Azupay","href":"/connections/payments/azupay-payid"}]},{"group":"PayTo","pages":[{"title":"Azupay - PayTo","sidebarTitle":"Azupay","href":"/connections/payments/azupay-payto"}]},{"group":"Pix","pages":[{"title":"Adyen - Pix","sidebarTitle":"Adyen","href":"/connections/payments/adyen-pix"},{"title":"dLocal - Pix","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-pix"}]},{"group":"Przelewy24","pages":[{"title":"Nuvei - Przelewy24","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-p24"}]},{"group":"PSE","pages":[{"title":"dLocal - PSE","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-pse"},{"title":"Nuvei - PSE","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-pse"}]},{"group":"SEPA","pages":[{"title":"Adyen - SEPA","sidebarTitle":"Adyen","href":"/connections/payments/adyen-sepa"}]},{"group":"Sofort","pages":[{"title":"Adyen - Sofort","sidebarTitle":"Adyen","href":"/connections/payments/adyen-sofort"},{"title":"Worldline TravelHub - Sofort","sidebarTitle":"Worldline TravelHub","href":"/connections/payments/travelhub-sofort"}]},{"group":"SPEI","pages":[{"title":"Arcus - SPEI","sidebarTitle":"Arcus","href":"/connections/payments/arcusfi-spei"},{"title":"dLocal - SPEI","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-spei"},{"title":"Monato - SPEI","sidebarTitle":"Monato","href":"/connections/payments/monato-spei"},{"title":"Stripe - SPEI","sidebarTitle":"Stripe","href":"/connections/payments/stripe-spei"}]},{"group":"Stitch","pages":[{"title":"dLocal - Stitch","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-stitch"}]},{"title":"Trustly (Europe)","href":"/connections/payments/trustlyeurope-trustlyeurope"},{"title":"Trustly (United States)","href":"/connections/payments/trustly-trustly"},{"group":"UPI","pages":[{"title":"dLocal - UPI","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-upi"}]},{"group":"Webpay","pages":[{"title":"dLocal - Webpay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-webpay"}]}]},{"group":"BNPL","pages":[{"group":"Affirm","pages":[{"title":"Affirm","sidebarTitle":"Affirm","href":"/connections/payments/affirm-affirm"},{"title":"Stripe - Affirm","sidebarTitle":"Stripe","href":"/connections/payments/stripe-affirm"}]},{"title":"Afterpay","sidebarTitle":"Afterpay","href":"/connections/payments/afterpay-afterpay"},{"group":"Cash App Afterpay","pages":[{"title":"Adyen - Cash App Afterpay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-cashappafterpay"}]},{"group":"Klarna","pages":[{"title":"Klarna","sidebarTitle":"Klarna","href":"/connections/payments/klarna-klarna"},{"title":"Nuvei - Klarna","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-klarna"},{"title":"Stripe - Klarna","sidebarTitle":"Stripe","href":"/connections/payments/stripe-klarna"}]},{"title":"Latitude / Gem","sidebarTitle":"Latitude / Gem","href":"/connections/payments/latitude"},{"group":"PayPal Pay Later","pages":[{"title":"PayPal Pay Later","sidebarTitle":"PayPal","href":"/connections/payments/paypal-paypalpaylater"}]},{"title":"Sezzle","sidebarTitle":"Sezzle","href":"/connections/payments/sezzle-sezzle"},{"title":"Zip","sidebarTitle":"Zip","href":"/connections/payments/zippay-zippay"}]},{"group":"Cards","pages":[{"title":"ACI Worldwide - Card","sidebarTitle":"ACI Worldwide","href":"/connections/payments/aci-card"},{"title":"Adyen - Card","sidebarTitle":"Adyen","href":"/connections/payments/adyen-card"},{"title":"Airwallex - Card","sidebarTitle":"Airwallex","href":"/connections/payments/airwallex-card"},{"title":"Authorize.net - Card","sidebarTitle":"Authorize.net","href":"/connections/payments/authorizenet-card"},{"title":"BlueSnap - Card","sidebarTitle":"BlueSnap","href":"/connections/payments/bluesnap-card"},{"title":"Braintree - Card","sidebarTitle":"Braintree","href":"/connections/payments/braintree-card"},{"title":"Buckaroo - Card","sidebarTitle":"Buckaroo","href":"/connections/payments/buckaroo-card"},{"title":"CardPointe - Card","sidebarTitle":"CardPointe","href":"/connections/payments/cardpointe-card"},{"title":"Chase Orbital - Card","sidebarTitle":"Chase Orbital","href":"/connections/payments/chaseorbital-card"},{"title":"Checkout.com - Card","sidebarTitle":"Checkout.com","href":"/connections/payments/checkoutcom-card"},{"title":"Cybersource - Card","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource-card"},{"title":"dLocal - Card","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-card"},{"title":"Ecommpay - Card","sidebarTitle":"Ecommpay","href":"/connections/payments/ecommpay-card"},{"title":"Finix - Card","sidebarTitle":"Finix","href":"/connections/payments/finix-card"},{"title":"Fiserv IPG - Card","sidebarTitle":"Fiserv IPG","href":"/connections/payments/fiserv-card"},{"title":"Mastercard Gateway - Card","sidebarTitle":"Mastercard Gateway","href":"/connections/payments/mastercard-card"},{"title":"Merchant Warrior - Card","sidebarTitle":"Merchant Warrior","href":"/connections/payments/merchantwarrior-card"},{"title":"Moneris - Card","sidebarTitle":"Moneris","href":"/connections/payments/moneris-card"},{"title":"NMI - Card","sidebarTitle":"NMI","href":"/connections/payments/nmi-card"},{"title":"Nuvei - Card","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-card"},{"title":"PayPal - Card","sidebarTitle":"PayPal","href":"/connections/payments/paypal-card"},{"title":"Planet - Card","sidebarTitle":"Planet","href":"/connections/payments/planet-card"},{"title":"Repay - Card","sidebarTitle":"Repay","href":"/connections/payments/repay-card"},{"title":"Ryft - Card","sidebarTitle":"Ryft","href":"/connections/payments/ryft-card"},{"title":"Shift4 - Card","sidebarTitle":"Shift4","href":"/connections/payments/shift4-card"},{"title":"Stripe - Card","sidebarTitle":"Stripe","href":"/connections/payments/stripe-card"},{"title":"Trust Payments - Card","sidebarTitle":"Trust Payments","href":"/connections/payments/trustpayments-card"},{"title":"Unlimit - Card","sidebarTitle":"Unlimit","href":"/connections/payments/unlimit-card"},{"title":"USAePay - Card","sidebarTitle":"USAePay","href":"/connections/payments/usaepay-card"},{"title":"Windcave - Card","sidebarTitle":"Windcave","href":"/connections/payments/windcave-card"},{"title":"Worldline Connect - Card","sidebarTitle":"Worldline Connect","href":"/connections/payments/worldlineconnect-card"},{"title":"Worldline TravelHub - Card","sidebarTitle":"Worldline TravelHub","href":"/connections/payments/travelhub-card"},{"title":"Worldpay (VAP) - Card","sidebarTitle":"Worldpay (VAP)","href":"/connections/payments/worldpayvap-card"},{"title":"Worldpay (WPG) - Card","sidebarTitle":"Worldpay (WPG)","href":"/connections/payments/worldpaywpg-card"}]},{"group":"Cash vouchers","pages":[{"group":"Abitab","pages":[{"title":"dLocal - Abitab","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-abitab"}]},{"group":"Boleto","pages":[{"title":"dLocal - Boleto","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-boleto"}]},{"group":"Efecty","pages":[{"title":"dLocal - Efecty","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-efecty"}]},{"group":"Konbini","pages":[{"title":"Adyen - Konbini","sidebarTitle":"Adyen","href":"/connections/payments/adyen-konbini"}]},{"group":"Konbini (7-Eleven)","pages":[{"title":"Adyen - Konbini (7-Eleven)","sidebarTitle":"Adyen","href":"/connections/payments/adyen-seveneleven"}]},{"title":"Multipago","sidebarTitle":"Multipago","href":"/connections/payments/multipago-multipago"},{"group":"OXXO","pages":[{"title":"OXXO","href":"/connections/payments/oxxo-oxxo"},{"title":"dLocal - OXXO","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-oxxo"},{"title":"Stripe - OXXO","sidebarTitle":"Stripe","href":"/connections/payments/stripe-oxxo"}]},{"group":"Pago Efectivo","pages":[{"title":"dLocal - Pago Efectivo","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-pagoefectivo"}]},{"group":"Payvalida","pages":[{"title":"dLocal - Payvalida","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-payvalida"}]},{"group":"Rapipago","pages":[{"title":"dLocal - Rapipago","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-rapipago"}]},{"group":"Redpagos","pages":[{"title":"dLocal - Redpagos","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-redpagos"}]},{"group":"Servipag","pages":[{"title":"dLocal - Servipag","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-servipag"}]}]},{"group":"Crypto","pages":[{"title":"The Giving Block","href":"/connections/payments/givingblock-givingblock"}]},{"group":"Gift cards","pages":[{"title":"Qwikcilver (Gift Cards)","sidebarTitle":"Qwikcilver","href":"/connections/payments/qwikcilver-gift-card"},{"title":"Value Link (Gift Cards)","sidebarTitle":"Value Link","href":"/connections/payments/valuelink-gift-card"}]},{"group":"Wallets","pages":[{"group":"Alipay","pages":[{"title":"Adyen - Alipay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-alipay"},{"title":"dLocal - Alipay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-alipay"}]},{"group":"Boost","pages":[{"title":"dLocal - Boost","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-boost"}]},{"group":"Cash App Pay","pages":[{"title":"Adyen - Cash App Pay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-cashapp"}]},{"group":"DANA","pages":[{"title":"dLocal - DANA","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-dana"}]},{"group":"DuitNow","pages":[{"title":"Adyen - DuitNow","sidebarTitle":"Adyen","href":"/connections/payments/adyen-duitnow"}]},{"group":"GCash","pages":[{"title":"Adyen - GCash","sidebarTitle":"Adyen","href":"/connections/payments/adyen-gcash"},{"title":"dLocal - GCash","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-gcash"}]},{"group":"GrabPay","pages":[{"title":"dLocal - GrabPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-grabpay"}]},{"group":"Link","pages":[{"title":"Stripe - Onelink","sidebarTitle":"Stripe","href":"/connections/payments/stripe-onelink"}]},{"group":"LinkAja","pages":[{"title":"dLocal - LinkAja","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-linkaja"}]},{"group":"Maya","pages":[{"title":"dLocal - Maya","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-paymaya"}]},{"group":"Maybank QRPay","pages":[{"title":"dLocal - Maybank QRPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-maybankqrpay"}]},{"group":"Mercado Pago","pages":[{"title":"dLocal - Mercado Pago","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-mercadopago"}]},{"group":"Nequi","pages":[{"title":"dLocal - Nequi","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-nequi"}]},{"group":"OVO","pages":[{"title":"dLocal - OVO","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-ovo"}]},{"title":"PayPal","sidebarTitle":"PayPal","href":"/connections/payments/paypal-paypal"},{"group":"PayPay","pages":[{"title":"Adyen - PayPay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-paypay"}]},{"title":"Paysquad","sidebarTitle":"Paysquad","href":"/connections/payments/paysquad-paysquad"},{"group":"PicPay","pages":[{"title":"dLocal - PicPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-picpay"}]},{"group":"Rabbit LINE Pay","pages":[{"title":"dLocal - Rabbit LINE Pay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-rabbitlinepay"}]},{"group":"ShopeePay","pages":[{"title":"dLocal - ShopeePay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-shopeepay"}]},{"title":"Smartpay","sidebarTitle":"Smartpay","href":"/connections/payments/smartpay-smartpay"},{"group":"Swish","pages":[{"title":"Adyen - Swish","sidebarTitle":"Adyen","href":"/connections/payments/adyen-swish"}]},{"group":"Thai QR","pages":[{"title":"dLocal - Thai QR Payment","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-thaiqr"}]},{"group":"Touch 'n Go","pages":[{"title":"dLocal - Touch 'n Go","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-touchngo"}]},{"group":"TrueMoney","pages":[{"title":"dLocal - TrueMoney","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-truemoney"}]},{"group":"Venmo","pages":[{"title":"Braintree - Venmo","sidebarTitle":"Braintree","href":"/connections/payments/braintree-venmo"},{"title":"PayPal - Venmo","sidebarTitle":"PayPal","href":"/connections/payments/paypal-venmo"}]},{"group":"Vipps","pages":[{"title":"Adyen - Vipps","sidebarTitle":"Adyen","href":"/connections/payments/adyen-vipps"}]},{"group":"WeChat Pay","pages":[{"title":"dLocal - WeChat Pay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-wechat"}]},{"group":"Wero","pages":[{"title":"Nuvei - Wero","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-wero"}]},{"group":"Yape","pages":[{"title":"dLocal - Yape","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-yape"}]}]}]},{"group":"Digital wallets","icon":"wallet","pages":[{"title":"Apple Pay","sidebarTitle":"Apple Pay","href":"/connections/digital-wallets/apple-pay"},{"title":"Click to Pay","sidebarTitle":"Click to Pay","href":"/connections/digital-wallets/click-to-pay"},{"title":"Google Pay","sidebarTitle":"Google Pay","href":"/connections/digital-wallets/google-pay"},{"title":"Paze","sidebarTitle":"Paze","href":"/connections/digital-wallets/paze"}]},{"group":"Anti-fraud","icon":"shield","pages":[{"title":"Cybersource Decision Manager","sidebarTitle":"Cybersource","href":"/connections/anti-fraud/cybersource"},{"title":"Forter","sidebarTitle":"Forter","href":"/connections/anti-fraud/forter"},{"title":"Riskified","sidebarTitle":"Riskified","href":"/connections/anti-fraud/riskified"},{"title":"Sardine","sidebarTitle":"Sardine","href":"/connections/anti-fraud/sardine"},{"title":"Sift","sidebarTitle":"Sift","href":"/connections/anti-fraud/sift"}]},{"group":"Browse","icon":"magnifying-glass","pages":[{"title":"Connectors by country","href":"/connections/payments/by-country"},{"title":"Connectors by currency","href":"/connections/payments/by-currency"},{"title":"Card schemes","href":"/connections/payments/card-schemes"}]}]},{"tab":"Custom Connectors","icon":"plug","hidden":true,"pages":[{"title":"Custom Connectors","sidebarTitle":"Overview","href":"/guides/features/custom-connectors/overview"},{"group":"Integration","expanded":true,"pages":[{"title":"Configure the connector","sidebarTitle":"Step 1: Configure","href":"/guides/features/custom-connectors/integration/configure"},{"title":"Implement your adapter","sidebarTitle":"Step 2: Implement","href":"/guides/features/custom-connectors/integration/implement-adapter"},{"title":"Handle commands","sidebarTitle":"Step 3: Handle commands","href":"/guides/features/custom-connectors/integration/handle-commands"},{"title":"Return responses and operate","sidebarTitle":"Step 4: Operate","href":"/guides/features/custom-connectors/integration/return-and-operate"}]},{"group":"API reference","expanded":true,"pages":[{"sidebarTitle":"Verify credentials","title":"Verify credentials","openapi":"openapi.custom-connectors.json GET /verify-credentials","href":"/guides/features/custom-connectors/api/verify-credentials"},{"sidebarTitle":"Create transaction","title":"Create transaction","openapi":"openapi.custom-connectors.json POST /create-transaction","href":"/guides/features/custom-connectors/api/create-transaction"},{"sidebarTitle":"Approve transaction","title":"Approve transaction","openapi":"openapi.custom-connectors.json POST /approve-transaction","href":"/guides/features/custom-connectors/api/approve-transaction"},{"sidebarTitle":"Capture transaction","title":"Capture transaction","openapi":"openapi.custom-connectors.json POST /capture-transaction","href":"/guides/features/custom-connectors/api/capture-transaction"},{"sidebarTitle":"Create refund","title":"Create refund","openapi":"openapi.custom-connectors.json POST /create-refund","href":"/guides/features/custom-connectors/api/create-refund"},{"sidebarTitle":"Sync transaction","title":"Sync transaction","openapi":"openapi.custom-connectors.json POST /sync","href":"/guides/features/custom-connectors/api/sync-transaction"},{"sidebarTitle":"Webhook","title":"Webhook","openapi":"openapi.custom-connectors.json POST /webhook","href":"/guides/features/custom-connectors/api/webhook"}]},{"group":"Tokenization API reference","pages":[{"sidebarTitle":"Create token","title":"Create token","openapi":"openapi.custom-connectors.json POST /create-token","href":"/guides/features/custom-connectors/api/create-token"},{"sidebarTitle":"Approve token","title":"Approve token","openapi":"openapi.custom-connectors.json POST /approve-token","href":"/guides/features/custom-connectors/api/approve-token"},{"sidebarTitle":"Delete token","title":"Delete token","openapi":"openapi.custom-connectors.json POST /delete-token","href":"/guides/features/custom-connectors/api/delete-token"}]}]},{"tab":"Connector Requirements","icon":"clipboard-check","hidden":true,"pages":[{"title":"Connector requirements","sidebarTitle":"Overview","href":"/partners/connector-requirements/overview"},{"title":"Platform requirements","sidebarTitle":"Platform requirements","href":"/partners/connector-requirements/platform"},{"group":"Card connectors","expanded":true,"pages":[{"title":"Card connector requirements","sidebarTitle":"Cards overview","href":"/partners/connector-requirements/cards/overview"},{"title":"Card processing, routing, and failover","sidebarTitle":"Processing and failover","href":"/partners/connector-requirements/cards/processing"},{"title":"3-D Secure for card connectors","sidebarTitle":"3-D Secure","href":"/partners/connector-requirements/cards/three-d-secure"},{"title":"Digital wallets for card connectors","sidebarTitle":"Digital wallets","href":"/partners/connector-requirements/cards/wallets"},{"title":"Vault, network tokens, and recurring for cards","sidebarTitle":"Cards recurring","href":"/partners/connector-requirements/cards/recurring"},{"title":"Card summary checklist","sidebarTitle":"Cards checklist","href":"/partners/connector-requirements/cards/checklist"}]},{"group":"APM connectors","expanded":true,"pages":[{"title":"APM connector requirements","sidebarTitle":"APM overview","href":"/partners/connector-requirements/apm/overview"},{"title":"Redirect mode","sidebarTitle":"Redirect","href":"/partners/connector-requirements/apm/redirect"},{"title":"Direct mode","sidebarTitle":"Direct","href":"/partners/connector-requirements/apm/direct"},{"title":"Push payments","sidebarTitle":"Push","href":"/partners/connector-requirements/apm/push"},{"title":"Stored payment methods and recurring","sidebarTitle":"APM recurring","href":"/partners/connector-requirements/apm/recurring"},{"title":"APM summary checklist","sidebarTitle":"APM checklist","href":"/partners/connector-requirements/apm/checklist"}]},{"group":"Gift card connectors","expanded":true,"pages":[{"title":"Gift card connectors","sidebarTitle":"Overview","href":"/partners/connector-requirements/gift-cards/overview"},{"title":"Split tender and rollback","sidebarTitle":"Split tender","href":"/partners/connector-requirements/gift-cards/transactions"},{"title":"Operations and errors","sidebarTitle":"Operations and errors","href":"/partners/connector-requirements/gift-cards/operations"},{"title":"Stored cards, issuance, and activation","sidebarTitle":"Stored cards and issuance","href":"/partners/connector-requirements/gift-cards/lifecycle"},{"title":"Gift card summary checklist","sidebarTitle":"Gift cards checklist","href":"/partners/connector-requirements/gift-cards/checklist"}]},{"group":"Anti-fraud connectors","expanded":true,"pages":[{"title":"Anti-fraud connector requirements","sidebarTitle":"Anti-fraud overview","href":"/partners/connector-requirements/anti-fraud/overview"},{"title":"The anti-fraud decision","sidebarTitle":"Decisions","href":"/partners/connector-requirements/anti-fraud/decisions"},{"title":"Reviews and asynchronous outcomes","sidebarTitle":"Reviews","href":"/partners/connector-requirements/anti-fraud/reviews"},{"title":"Device fingerprinting","sidebarTitle":"Fingerprinting","href":"/partners/connector-requirements/anti-fraud/fingerprinting"},{"title":"Post-transaction feedback","sidebarTitle":"Feedback","href":"/partners/connector-requirements/anti-fraud/feedback"},{"title":"Anti-fraud summary checklist","sidebarTitle":"Anti-fraud checklist","href":"/partners/connector-requirements/anti-fraud/checklist"}]},{"title":"Glossary","sidebarTitle":"Glossary","href":"/partners/connector-requirements/glossary"}]},{"tab":"External Apps","icon":"puzzle-piece","hidden":true,"pages":[{"title":"External apps","sidebarTitle":"External apps","href":"/partners/external-apps"}]},{"tab":"API Reference","icon":{"style":"light","name":"square-terminal"},"groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Authentication","mode":"wide","href":"/guides/api/authentication"},{"title":"Managing API keys","sidebarTitle":"API keys","mode":"wide","href":"/guides/api/api-keys"},{"title":"API Compatibility","sidebarTitle":"Compatibility","href":"/guides/api/compatibility"},{"title":"Connectivity and TLS","sidebarTitle":"Connectivity","href":"/guides/api/connectivity"},{"sidebarTitle":"JWTs","title":"Authentication with JWTs","href":"/guides/api/jwts"},{"title":"Environments","href":"/guides/api/environments"},{"title":"Error handling","sidebarTitle":"Errors","mode":"wide","href":"/guides/api/errors"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"title":"IP address forwarding","href":"/guides/api/ip-address-forwarding"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"},{"title":"Pagination","href":"/guides/api/pagination"},{"sidebarTitle":"Prefer header","title":"Prefer header","href":"/guides/api/prefer-header"},{"title":"Rate limiting","href":"/guides/api/rate-limiting"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"},{"title":"Transaction error codes","sidebarTitle":"Error Codes","mode":"wide","href":"/guides/api/error-codes"}]},{"group":"Transactions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions","title":"List transactions","href":"/reference/transactions/list-transactions"},{"openapi":"openapi.speakeasy.json POST /transactions","title":"Create transaction","href":"/reference/transactions/new-transaction"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}","title":"Get transaction","href":"/reference/transactions/get-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/capture","title":"Capture transaction","href":"/reference/transactions/capture-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/void","title":"Void transaction","href":"/reference/transactions/void-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/authorization/increment","title":"Increment transaction authorization","href":"/reference/transactions/increment-transaction-authorization"},{"group":"Captures","pages":[{"sidebarTitle":"List captures","title":"List transaction captures","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures","href":"/reference/transactions/list-transaction-captures"},{"sidebarTitle":"Get capture","title":"Get capture","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures/{capture_id}","href":"/reference/transactions/get-transaction-capture"}]},{"group":"More actions","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/events","title":"List transaction events","href":"/reference/transactions/list-transaction-events"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/actions","title":"List transaction Flow rules","href":"/reference/transactions/list-transaction-actions"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/sync","title":"Sync transaction","href":"/reference/transactions/sync-transaction"},{"title":"Update a transaction","openapi":"openapi.speakeasy.json PUT /transactions/{transaction_id}","href":"/reference/transactions/update-transaction"},{"title":"Cancel a transaction","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/cancel","href":"/reference/transactions/cancel-transaction"},{"title":"Get or update transaction session","sidebarTitle":"Get session","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/session","href":"/reference/transactions/get-transaction-session"}]}]},{"group":"Buyers","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /buyers","title":"List all buyers","href":"/reference/buyers/list-buyers"},{"openapi":"openapi.speakeasy.json POST /buyers","title":"Add a buyer","href":"/reference/buyers/new-buyer"},{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}","title":"Get a buyer","href":"/reference/buyers/get-buyer"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}","title":"Update a buyer","href":"/reference/buyers/update-buyer"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}","title":"Delete a buyer","href":"/reference/buyers/delete-buyer"},{"group":"Shipping details","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}/shipping-details","title":"List a buyer's shipping details","href":"/reference/buyers/get-buyer-shipping-details"},{"openapi":"openapi.speakeasy.json POST /buyers/{buyer_id}/shipping-details","title":"Add buyer shipping details","href":"/reference/buyers/new-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Update a buyer's shipping details","href":"/reference/buyers/update-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Delete a buyer's shipping details","href":"/reference/buyers/delete-buyer-shipping-detail"}]}]},{"group":"Checkout Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /checkout/sessions","title":"Create checkout session","description":"Create a new checkout session.","href":"/reference/checkout-sessions/new-checkout-session"},{"openapi":"openapi.speakeasy.json GET /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/get-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}","title":null,"description":null,"href":"/reference/checkout-sessions/update-checkout-session"},{"openapi":"openapi.speakeasy.json DELETE /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/delete-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}/fields","sidebarTitle":"Update session fields","title":null,"href":"/reference/checkout-sessions/update-checkout-session-fields"}]},{"group":"Payment links","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payment-links","title":"List all payment links","href":"/reference/payment-links/list-payment-links"},{"openapi":"openapi.speakeasy.json POST /payment-links","title":"Add a payment link","href":"/reference/payment-links/new-payment-link"},{"openapi":"openapi.speakeasy.json GET /payment-links/{payment_link_id}","title":"Get payment link","href":"/reference/payment-links/get-payment-link"},{"openapi":"openapi.speakeasy.json POST /payment-links/{payment_link_id}/expire","title":"Expire a payment link","href":"/reference/payment-links/expire-payment-link"}]},{"group":"Payment options","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-options","title":"List payment options","href":"/reference/payment-options/list-payment-options"}]},{"group":"Payouts","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payouts","title":"List payouts created","href":"/reference/payouts/list-payouts"},{"openapi":"openapi.speakeasy.json POST /payouts","title":"Create a payout","href":"/reference/payouts/new-payout"},{"openapi":"openapi.speakeasy.json GET /payouts/{payout_id}","title":"Get a payout","href":"/reference/payouts/get-payout"}]},{"group":"Refunds","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refunds","title":"List transaction refunds","href":"/reference/transactions/list-transaction-refunds"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds","title":"Create transaction refund","href":"/reference/transactions/refund-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds/all","sidebarTitle":"Refund all instruments","title":"Create batch transaction refund","href":"/reference/transactions/refund-all"},{"sidebarTitle":"Get refund","title":"Get refund","openapi":"openapi.speakeasy.json GET /refunds/{refund_id}","href":"/reference/transactions/get-refund"}]},{"group":"Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-service-definitions/{payment_service_definition_id}/sessions","sidebarTitle":"Get session","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session"},{"openapi":"openapi.speakeasy.json POST /payment-services/{payment_service_id}/sessions","sidebarTitle":"Get session by ID","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session-by-id"}]},{"group":"Settlement records","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements","sidebarTitle":"List settlement records","title":"List transaction settlements","href":"/reference/settlements/list-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements/{settlement_id}","sidebarTitle":"Get settlement record","title":"Get transaction settlement","href":"/reference/settlements/get-settlement"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements","sidebarTitle":"List refund settlement records","title":"List transaction refund settlements","href":"/reference/settlements/list-refund-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements/{settlement_id}","sidebarTitle":"Get refund settlement record","title":"Get transaction refund settlement","href":"/reference/settlements/get-refund-settlement"}]},{"group":"Disputes","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargebacks","sidebarTitle":"List chargeback records","title":"List transaction chargebacks","href":"/reference/disputes/list-chargebacks"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargeback-reversals","sidebarTitle":"List chargeback reversal records","title":"List transaction chargeback reversals","href":"/reference/disputes/list-chargeback-reversals"}]},{"group":"Instruments","icon":"code","pages":[{"group":"Card schemes","pages":[{"openapi":"openapi.speakeasy.json GET /card-scheme-definitions","title":"List card scheme definitions","href":"/reference/card-schemes/list-card-scheme-definitions"}]},{"group":"Card details","pages":[{"openapi":"openapi.speakeasy.json GET /card-details","title":"Get card details","href":"/reference/card-details/get-card-details"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/apple/session","title":"Create a Apple Pay session","href":"/reference/digital-wallets/get-apple-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/google/session","title":"Create a Google Pay session","href":"/reference/digital-wallets/get-google-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/click-to-pay/session","title":"Create a Click to Pay session","href":"/reference/digital-wallets/get-click-to-pay-session"}]},{"group":"Gift cards","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/gift-cards","title":"List gift cards for a buyer","href":"/reference/gift-cards/list-buyer-gift-cards"},{"openapi":"openapi.speakeasy.json GET /gift-cards","title":"List gift cards","href":"/reference/gift-cards/list-gift-cards"},{"openapi":"openapi.speakeasy.json POST /gift-cards/balances","title":"Verify and get gift card balances","sidebarTitle":"Verify \u0026 get balance","href":"/reference/gift-cards/list-gift-card-balances"},{"openapi":"openapi.speakeasy.json POST /gift-cards","title":"Create gift card","href":"/reference/gift-cards/new-gift-card"},{"openapi":"openapi.speakeasy.json GET /gift-cards/{gift_card_id}","title":"Get gift card","href":"/reference/gift-cards/get-gift-card"},{"openapi":"openapi.speakeasy.json DELETE /gift-cards/{gift_card_id}","title":"Delete a gift card","href":"/reference/gift-cards/delete-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/issuances","title":"Issue a gift card","href":"/reference/gift-cards/issue-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/activations","title":"Activate a gift card","href":"/reference/gift-cards/activate-gift-card"}]},{"group":"Payment methods","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/payment-methods","title":"List payment methods for a buyer","href":"/reference/payment-methods/list-buyer-payment-methods"},{"openapi":"openapi.speakeasy.json GET /payment-methods","title":"List all payment methods","href":"/reference/payment-methods/list-payment-methods"},{"openapi":"openapi.speakeasy.json POST /payment-methods","title":"Create payment method","href":"/reference/payment-methods/new-payment-method"},{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}","title":"Get payment method","href":"/reference/payment-methods/get-payment-method"},{"openapi":"openapi.speakeasy.json PUT /payment-methods/{payment_method_id}","title":"Update payment method","href":"/reference/payment-methods/update-payment-method"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}","title":"Delete payment method","href":"/reference/payment-methods/delete-payment-method"}]},{"group":"Payment method definitions","pages":[{"openapi":"openapi.speakeasy.json GET /payment-method-definitions","title":"List payment method definitions","href":"/reference/payment-method-definitions/list-payment-method-definitions"}]}]},{"group":"Vault","icon":"code","pages":[{"group":"Account updater","pages":[{"openapi":"openapi.speakeasy.json POST /account-updater/jobs","sidebarTitle":"Create a job","title":"Create account updater job","href":"/reference/account-updater/new-account-updater-job"}]},{"group":"Network tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/network-tokens","title":"List network tokens","href":"/reference/network-tokens/list-network-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens","title":"Provision network token","href":"/reference/network-tokens/provision-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram","title":"Provision network token cryptogram","href":"/reference/network-tokens/get-network-token-cryptogram"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend","title":"Suspend network token","href":"/reference/network-tokens/suspend-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume","title":"Resume network token","href":"/reference/network-tokens/resume-network-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/network-tokens/{network_token_id}","title":"Delete network token","href":"/reference/network-tokens/delete-network-token"}]},{"group":"Payment service tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/payment-service-tokens","title":"List payment service tokens","href":"/reference/payment-service-tokens/list-payment-service-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/payment-service-tokens","title":"Create payment service token","href":"/reference/payment-service-tokens/provision-payment-service-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/payment-service-tokens/{payment_service_token_id}","title":"Delete payment service token","href":"/reference/payment-service-tokens/delete-payment-service-token"}]},{"group":"Vault Forward","pages":[{"openapi":"openapi.v1.json POST /vault-forward","title":"Forward PCI data","href":"/reference/vault-forwarding/make-vault-forward"}]},{"group":"Vault Forward endpoints","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs","sidebarTitle":"List endpoints","title":"List configured Vault Forward endpoints","href":"/reference/vault-forwarding/list-vault-forward-configs"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}","sidebarTitle":"Get endpoint","title":"Get configured Vault Forward endpoints","href":"/reference/vault-forwarding/get-vault-forward-config"}]},{"group":"Vault Forward authentication","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Get authentications","title":"List configured Vault Forward authentication methods","href":"/reference/vault-forwarding/list-vault-forward-authentications"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Get authentication","title":"Get Vault Forward authentication method","href":"/reference/vault-forwarding/get-vault-forward-authentication"},{"openapi":"openapi.v1.json POST /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Add authentication","title":"Adds new Vault Forward authentication method","href":"/reference/vault-forwarding/add-vault-forward-authentication"},{"openapi":"openapi.v1.json PUT /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Update authentication","title":"Update Vault Forward authentication method","href":"/reference/vault-forwarding/update-vault-forward-authentication"},{"openapi":"openapi.v1.json DELETE /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Remove authentication","title":"Remove a Vault Forward authentication method","href":"/reference/vault-forwarding/delete-vault-forward-authentication"}]}]},{"group":"PSPs \u0026 Gateways","icon":"code","pages":[{"group":"All services","pages":[{"openapi":"openapi.v1.json GET /connections","title":"List connections","href":"/reference/connections/list-connections"},{"openapi":"openapi.speakeasy.json GET /connection-definitions","title":null,"href":"/reference/connections/list-connection-definitions"}]},{"group":"Payment services","pages":[{"openapi":"openapi.speakeasy.json GET /payment-service-definitions/{payment_service_definition_id}","sidebarTitle":"Get service definition","title":"Get a payment service definition","href":"/reference/payment-service-definitions/get-payment-service-definition"},{"openapi":"openapi.speakeasy.json GET /payment-services","title":"List payment services","href":"/reference/payment-services/list-payment-services"},{"openapi":"openapi.speakeasy.json POST /payment-services","title":"Configure a payment service","href":"/reference/payment-services/new-payment-service"},{"openapi":"openapi.speakeasy.json GET /payment-services/{payment_service_id}","title":"Get payment service","href":"/reference/payment-services/get-payment-service"},{"openapi":"openapi.speakeasy.json PUT /payment-services/{payment_service_id}","title":"Update a configured payment service","href":"/reference/payment-services/update-payment-service"},{"openapi":"openapi.speakeasy.json DELETE /payment-services/{payment_service_id}","title":"Delete a configured payment service","href":"/reference/payment-services/delete-payment-service"},{"openapi":"openapi.speakeasy.json POST /payment-services/verify","sidebarTitle":"Verify credentials","title":"Verify payment service credentials","href":"/reference/payment-services/verify-payment-service"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json GET /digital-wallets","title":"List digital wallets","href":"/reference/digital-wallets/list-digital-wallets"},{"openapi":"openapi.speakeasy.json GET /digital-wallets/{digital_wallet_id}","title":"Get digital wallet","href":"/reference/digital-wallets/get-digital-wallet"},{"openapi":"openapi.speakeasy.json POST /digital-wallets","title":"Register digital wallet","href":"/reference/digital-wallets/register-digital-wallet"},{"openapi":"openapi.speakeasy.json PUT /digital-wallets/{digital_wallet_id}","title":"Update digital wallet","href":"/reference/digital-wallets/update-digital-wallet"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}","title":"Delete digital wallet","href":"/reference/digital-wallets/deregister-digital-wallet"},{"group":"Domain registration","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/{digital_wallet_id}/domains","title":"Register a digital wallet domain","href":"/reference/digital-wallets/new-digital-wallet-domain"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}/domains","title":"Remove a digital wallet domain","href":"/reference/digital-wallets/delete-digital-wallet-domain"}]},{"group":"Mobile Certificates (Apple Pay)","pages":[{"openapi":"openapi.v1.json GET /apple-pay-certificates","sidebarTitle":"List certificates","title":"List Apple Pay certificates","href":"/reference/digital-wallets/list-apple-pay-certificates"},{"openapi":"openapi.v1.json POST /apple-pay-certificates","sidebarTitle":"Create certificate","title":"New Apple Pay certificate","href":"/reference/digital-wallets/create-apple-pay-certificate"},{"openapi":"openapi.v1.json PUT /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Update certificate","title":"Update Apple Pay certificate","href":"/reference/digital-wallets/update-apple-pay-certificate"},{"openapi":"openapi.v1.json DELETE /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Delete certificate","title":"Remove Apple Pay certificate","href":"/reference/digital-wallets/delete-apple-pay-certificate"}]}]},{"group":"Anti-fraud services","pages":[{"openapi":"openapi.v1.json GET /anti-fraud-service-definitions/{anti_fraud_service_definition_id}","sidebarTitle":"Get service definition","title":"Get anti fraud service definition","href":"/reference/anti-fraud-services/get-anti-fraud-service-definition"},{"openapi":"openapi.v1.json POST /anti-fraud-services","title":"New anti-fraud service","href":"/reference/anti-fraud-services/new-anti-fraud-service"},{"openapi":"openapi.v1.json GET /anti-fraud-services/{anti_fraud_service_id}","title":"Get anti-fraud service","href":"/reference/anti-fraud-services/get-anti-fraud-service"},{"openapi":"openapi.v1.json PUT /anti-fraud-services/{anti_fraud_service_id}","title":"Update anti-fraud service","href":"/reference/anti-fraud-services/update-anti-fraud-service"},{"openapi":"openapi.v1.json DELETE /anti-fraud-services/{anti_fraud_service_id}","title":"Delete anti-fraud service","href":"/reference/anti-fraud-services/delete-anti-fraud-service"}]},{"group":"Gift-card services","pages":[{"openapi":"openapi.v1.json GET /gift-card-service-definitions/{gift_card_service_definition_id}","sidebarTitle":"Get service definition","title":"Get gift card service definition","href":"/reference/gift-card-services/get-gift-card-service-definition"},{"openapi":"openapi.v1.json POST /gift-card-services","title":"New gift card service","href":"/reference/gift-card-services/new-gift-card-service"},{"openapi":"openapi.v1.json GET /gift-card-services/{gift_card_service_id}","title":"Get gift card service","href":"/reference/gift-card-services/get-gift-card-service"},{"openapi":"openapi.v1.json PUT /gift-card-services/{gift_card_service_id}","title":"Update gift card service","href":"/reference/gift-card-services/update-gift-card-service"},{"openapi":"openapi.v1.json DELETE /gift-card-services/{gift_card_service_id}","title":"Delete gift card service","href":"/reference/gift-card-services/delete-gift-card-service"}]}]},{"group":"Errors","icon":"code","pages":[{"title":"Client-side errors (4XX)","sidebarTitle":"Client errors","href":"/reference/errors/client-errors"},{"title":"Server-side errors (5XX)","sidebarTitle":"Server errors","href":"/reference/errors/server-errors"},{"openapi":"openapi.v1.json GET /api-logs","title":"List 4XX errors","href":"/reference/logs/list-api-error-logs"}]},{"group":"Other","icon":"code","pages":[{"group":"API keys","pages":[{"openapi":"openapi.speakeasy.json GET /api-key-pairs","sidebarTitle":"List API keys","title":"List all API key pairs","href":"/reference/api-key-pairs/list-api-key-pairs"},{"openapi":"openapi.speakeasy.json POST /api-key-pairs","sidebarTitle":"Create API key","title":"Create an API key pair","href":"/reference/api-key-pairs/new-api-key-pair"},{"openapi":"openapi.speakeasy.json GET /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Get API key","title":"Get an API key pair","href":"/reference/api-key-pairs/get-api-key-pair"},{"openapi":"openapi.speakeasy.json PUT /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Update API key","title":"Update an API key pair","href":"/reference/api-key-pairs/update-api-key-pair"},{"openapi":"openapi.speakeasy.json DELETE /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Delete API key","title":"Delete an API key pair","href":"/reference/api-key-pairs/delete-api-key-pair"}]},{"group":"3DS Configuration","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"List 3DS configuration","sidebarTitle":"List 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/list-three-ds-configurations"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"Add 3DS configuration","sidebarTitle":"Add 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/new-three-ds-configuration"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Update 3DS configuration","sidebarTitle":"Update 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/update-three-ds-configuration"},{"openapi":"openapi.speakeasy.json DELETE /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Delete 3DS configuration","sidebarTitle":"Delete 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/delete-three-ds-configuration"}]},{"group":"3DS Scenarios","pages":[{"openapi":"openapi.speakeasy.json GET /three-ds-scenarios","title":"List 3DS scenario","href":"/reference/three-ds-scenarios/list-three-ds-scenarios"},{"openapi":"openapi.speakeasy.json POST /three-ds-scenarios","title":"Create a 3DS scenario","href":"/reference/three-ds-scenarios/new-three-ds-scenario"},{"openapi":"openapi.speakeasy.json PUT /three-ds-scenarios/{three_ds_scenario_id}","title":"Update a 3DS scenario","href":"/reference/three-ds-scenarios/update-three-ds-scenario"},{"openapi":"openapi.speakeasy.json DELETE /three-ds-scenarios/{three_ds_scenario_id}","title":"Delete a 3DS scenario","href":"/reference/three-ds-scenarios/delete-three-ds-scenario"}]},{"group":"Flow","pages":[{"openapi":"openapi.v1.json GET /flows/{flow}","title":"List flow rules","href":"/reference/flow/list-rules"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Get rule","href":"/reference/flow/get-rule"},{"openapi":"openapi.v1.json POST /flows/{flow}/actions/{action}/rules","title":"Create flow rule","href":"/reference/flow/new-rule"},{"openapi":"openapi.v1.json PUT /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Update flow rule","href":"/reference/flow/update-rule"},{"openapi":"openapi.v1.json DELETE /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Delete flow rule","href":"/reference/flow/delete-rule"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/outcomes","title":"List flow outcomes","href":"/reference/flow/list-outcomes"}]},{"group":"Merchant accounts","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts","title":"List all merchant accounts","href":"/reference/merchant-accounts/list-merchant-accounts"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts","title":"Create a merchant account","href":"/reference/merchant-accounts/new-merchant-account"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}","title":"Update a merchant account","href":"/reference/merchant-accounts/update-merchant-account"}]},{"group":"Reports","pages":[{"openapi":"openapi.speakeasy.json GET /reports","title":"List configured reports","href":"/reference/reports/list-reports"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}","title":"Get a report","href":"/reference/reports/get-report"},{"openapi":"openapi.speakeasy.json POST /reports","title":"Add a report","href":"/reference/reports/new-report"},{"openapi":"openapi.speakeasy.json PUT /reports/{report_id}","title":"Update a report","href":"/reference/reports/update-report"}]},{"group":"Report executions","pages":[{"openapi":"openapi.speakeasy.json GET /report-executions","title":"List executed reports","href":"/reference/reports/list-all-report-executions"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}/executions","title":"List executions for report","href":"/reference/reports/list-executions-for-report"},{"openapi":"openapi.speakeasy.json GET /report-executions/{report_execution_id}","title":"Get executed report","href":"/reference/reports/get-report-execution"},{"openapi":"openapi.speakeasy.json POST /reports/{report_id}/executions/{report_execution_id}/url","title":"Create URL for executed report","href":"/reference/reports/generate-download-url"}]},{"group":"Roles","pages":[{"openapi":"openapi.speakeasy.json GET /roles","sidebarTitle":"List roles","title":"List all roles","href":"/reference/roles/list-roles"}]},{"group":"Users","pages":[{"openapi":"openapi.speakeasy.json GET /audit-logs","title":"List audit log entries","href":"/reference/audit-logs/list-audit-logs"}]},{"group":"Webhook subscriptions","pages":[{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions","sidebarTitle":"List subscriptions","title":"List webhook subscriptions","href":"/reference/webhook-subscriptions/list-webhook-subscriptions"},{"openapi":"openapi.speakeasy.json POST /webhook-subscriptions","sidebarTitle":"New subscription","title":"Create webhook subscription","href":"/reference/webhook-subscriptions/new-webhook-subscription"},{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions/{subscription_id}","sidebarTitle":"Get subscription","title":"Get webhook subscription","href":"/reference/webhook-subscriptions/get-webhook-subscription"},{"openapi":"openapi.speakeasy.json PUT /webhook-subscriptions/{subscription_id}","sidebarTitle":"Update subscription","title":"Update webhook subscription","href":"/reference/webhook-subscriptions/update-webhook-subscription"},{"openapi":"openapi.speakeasy.json DELETE /webhook-subscriptions/{subscription_id}","sidebarTitle":"Delete subscription","title":"Delete webhook subscription","href":"/reference/webhook-subscriptions/delete-webhook-subscription"}]}]}]},{"tab":"Updates","icon":"bullhorn","groups":[{"group":"Updates","icon":"bell","pages":[{"title":"The Changelog","sidebarTitle":"Latest","href":"/updates"},{"title":null,"href":"/updates/2025"}]},{"group":"SDKs","icon":"toolbox","pages":[{"title":"C#","url":"https://github.com/gr4vy/gr4vy-csharp/releases","href":"/updates/csharp"},{"title":"Go","url":"https://github.com/gr4vy/gr4vy-go/releases","href":"/updates/go"},{"title":"Java","url":"https://github.com/gr4vy/gr4vy-java/releases","href":"/updates/java"},{"title":"PHP","url":"https://github.com/gr4vy/gr4vy-php/releases","href":"/updates/php"},{"title":"Python","url":"https://github.com/gr4vy/gr4vy-python/releases","href":"/updates/python"},{"title":"TypeScript","url":"https://github.com/gr4vy/gr4vy-typescript/releases","href":"/updates/typescript"},{"title":"Swift","url":"https://github.com/gr4vy/gr4vy-swift/releases","href":"/updates/swift"},{"title":"Kotlin","url":"https://github.com/gr4vy/gr4vy-kotlin/releases","href":"/updates/kotlin"},{"title":"iOS","url":"https://github.com/gr4vy/gr4vy-ios/releases","href":"/updates/ios"},{"title":"Android","url":"https://github.com/gr4vy/gr4vy-android/releases","href":"/updates/android"}]}]}]},"title":"Get checkout session - Gr4vy","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"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","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.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"]}