{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["gated","admonition"]},"type":"markdown"},"seo":{"title":"Checkout","meta":[{"name":"robots","content":"noindex, nofollow"},{"name":"pingdom","content":"sh3MDv8mJpWhCWSTdGtN"}]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"checkout","__idx":0},"children":["Checkout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shift4 Checkout is a hosted payment form that handles the entire payment flow for you. It collects card details, validates input, handles 3D Secure authentication, and creates the charge."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":1},"children":["How it works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To open Checkout, first create a Checkout Session on your backend and pass its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientSecret"]}," to the frontend. Then use our Checkout library, available at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://dev.shift4.com/checkout.js"]},", to render the Checkout app in the browser."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have your Checkout Session, there are two ways to integrate with Checkout on the frontend:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Simple integration"]}," provides a button that opens Checkout and, after successful payment, submits your payment form with Checkout results added as hidden input fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom integration"]}," allows you to open Checkout from JavaScript and handle the Checkout results in the JavaScript callback function."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both are shown in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/checkout/using-checkout-session"},"children":["Using Checkout"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please check our guidelines for CSP ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/csp-integration"},"children":["here"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-models","__idx":2},"children":["Integration models"]},{"$$mdtype":"Tag","name":"GatedContent","attributes":{"features":"!checkout_request"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Checkout is initialized with a Checkout Session: your server creates a session with your secret key and passes the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientSecret"]}," to the client."]}]},{"$$mdtype":"Tag","name":"GatedContent","attributes":{"features":"checkout_request"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are two ways to initialize Checkout:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Model"},"children":["Model"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"How it works"},"children":["How it works"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Checkout Session"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your server creates a session with your secret key and passes the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientSecret"]}," to the client."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Checkout Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deprecated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your server signs a JSON payload with your secret key offline and passes the signed string to the client."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Checkout Request is created offline, without communicating with Shift4 servers — there is no endpoint to call. You build a JSON object and sign it with your secret key using HMAC-SHA256. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/checkout/checkout-request"},"children":["Checkout Request"]}," for the full reference."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Checkout Requests are deprecated and will be removed in a future release. All new integrations should use Checkout Sessions."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"checkout-sessions","__idx":3},"children":["Checkout Sessions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Checkout Session is a server-created configuration that defines what the customer is paying for and how the Checkout form behaves. Sessions must be created using a secret API key, which allows Shift4 to enforce rate limiting and prevent abuse scenarios such as automated card testing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once created, a session is immutable. If changes are required, create a new session."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/shift4-gateway/checkout/createcheckoutsession"},"children":["Create a checkout session"]}," endpoint in the API Reference."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration-parameters","__idx":4},"children":["Configuration parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These parameters can be added to your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<script>"]}," tag to configure and customize Checkout."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required","__idx":5},"children":["Required"]},{"$$mdtype":"Tag","name":"GatedContent","attributes":{"features":"!checkout_request"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your public key (either live or test)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-client-secret"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The client secret found in the Checkout Session created by your backend service."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"GatedContent","attributes":{"features":"checkout_request"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your public key (either live or test)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-client-secret"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The client secret found in the Checkout Session created by your backend service. Required when initializing Checkout with a Checkout Session."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-checkout-request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The signed Checkout Request produced by your server, as described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/checkout/checkout-request"},"children":["Checkout Request"]},". Required when initializing Checkout with a Checkout Request instead of a Checkout Session — provide one or the other, not both."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"optional","__idx":6},"children":["Optional"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The relative (or absolute) URL to image of your brand or product. Recommended image size is 70×70 pixels. Recommended image types are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".png"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".jpeg"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".gif"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of your company or website."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The description of the product that is being sold."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-payment-button"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The text that will appear on the payment button in Checkout. If the text contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{amount}}"]},", it will be replaced by a charge amount. Otherwise, the charge amount will be appended at the end."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If provided, it will be used to the pre-fill email field in Checkout."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-checkout-button"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The text that will appear on the button that will be added on your website."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-class"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value of the HTML ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["class"]}," attribute that will be set on the payment button on your website."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-locale"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The language that will be used in Checkout, provided as a two-letter code from ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#supported-languages"},"children":["Supported languages"]},". If not provided, Checkout will be displayed in the user's preferred language (defined in the browser)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-shipping-address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", Checkout will collect the customer's shipping address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-billing-address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", Checkout will collect the customer's billing address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-payment-button-background-color"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets color of a payment button."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-typography"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets fonts used in Checkout form."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-show-payment-amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," amount on the payment button is hidden. Default setting is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"GatedContent","attributes":{"features":"!checkout_request"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-locale"]}," and the Checkout Session ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locale"]}," field are the same setting and accept the same two-letter codes."]}]},{"$$mdtype":"Tag","name":"GatedContent","attributes":{"features":"checkout_request"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-locale"]},", the Checkout Request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locale"]}," field, and the Checkout Session ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locale"]}," field are the same setting and accept the same two-letter codes."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"result-parameters","__idx":7},"children":["Result parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These parameters are added to your payment ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<form>"]}," tag after a successful payment."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4Email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The email address that was provided by the user in Checkout."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4CustomerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the customer object that was used by Checkout. It can be either a customer provided when Checkout was initialized, or a new customer created by Checkout."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4ChargeId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the charge object that was created by Checkout."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4SubscriptionId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the subscription object that was created by Checkout. Only present if Checkout was configured to create a recurring subscription."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"billing-and-shipping-details","__idx":8},"children":["Billing and shipping details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These parameters are added alongside the ones above. Billing parameters are only populated when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-billing-address"]}," is set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", and shipping parameters only when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-shipping-address"]}," is set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4BillingName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name provided in the billing details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4BillingAddressLine1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First line of the billing address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4BillingAddressZip"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal code of the billing address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4BillingAddressCity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["City of the billing address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4BillingAddressCountry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country of the billing address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4BillingVat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The VAT number provided in the billing details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4ShippingName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name provided in the shipping details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4ShippingAddressLine1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First line of the shipping address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4ShippingAddressZip"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal code of the shipping address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4ShippingAddressCity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["City of the shipping address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shift4ShippingAddressCountry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country of the shipping address."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-languages","__idx":9},"children":["Supported languages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following languages are supported by Checkout:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Language"},"children":["Language"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["be"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Belarusian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bg"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bulgarian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Czech"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["da"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Danish"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["de"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["German"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["el"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Greek"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["English"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["es"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Spanish"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["et"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Estonian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fi"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Finnish"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fr"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["French"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hr"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Croatian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hu"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hungarian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["it"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Italian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iw"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hebrew"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lithuanian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lv"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Latvian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dutch"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["no"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Norwegian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Polish"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Portuguese"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ro"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Romanian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ru"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Russian"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sk"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Slovak"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Slovenian"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the requested code is not on this list, Checkout falls back to English."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":10},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/checkout/using-checkout-session"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Using Checkout"]}]}," -- create a Checkout Session and render Checkout in the browser."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/checkout/customization"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Checkout customization"]}]}," -- customize Checkout appearance and behavior in your Account Settings."]}]},{"$$mdtype":"Tag","name":"GatedContent","attributes":{"features":"checkout_request"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/checkout/checkout-request"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Checkout Request"]}]}," -- the deprecated signed-payload integration model."]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/shift4-gateway/charges/createcharge"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Charges"]}]}," -- understand the charge object created behind the scenes."]}]}]},"headings":[{"value":"Checkout","id":"checkout","depth":1},{"value":"How it works","id":"how-it-works","depth":2},{"value":"Integration models","id":"integration-models","depth":2},{"value":"Checkout Sessions","id":"checkout-sessions","depth":3},{"value":"Configuration parameters","id":"configuration-parameters","depth":2},{"value":"Required","id":"required","depth":3},{"value":"Optional","id":"optional","depth":3},{"value":"Result parameters","id":"result-parameters","depth":2},{"value":"Billing and shipping details","id":"billing-and-shipping-details","depth":3},{"value":"Supported languages","id":"supported-languages","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Checkout","description":"Accept payments with Shift4 Checkout, a hosted payment form that handles card collection, 3D Secure authentication, and charge creation.","seo":{"title":"Checkout"}},"lastModified":"2026-08-19T07:05:18.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/checkout","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}