{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-cashier/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Opening the Cashier","siteUrl":"https://docs.omno.com"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"opening-the-cashier","__idx":0},"children":["Opening the Cashier"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open a session with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cashier.open(...)"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["token"]}," from the create-session response is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},"."]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["sessionId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Session ID from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v3/public/cashier/session"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cashier token from the same create-session response. Authorizes opening this session; the SDK attaches it to the Cashier URL. Treat it as opaque."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of an element to mount the Cashier into. Omit for a modal."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Land directly on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEPOSIT"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WITHDRAW"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'single'"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single-column layout for a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/cashier/single-payment"},"children":["Single Payment"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import { PaymentAction } from \"@omno-payment/checkout-js\";\n\n// Modal (default)\ncashier.open({ sessionId, token });\n\n// Inside your own container\ncashier.open({ sessionId, token, containerId: \"cashier-slot\" });\n\n// Land directly on deposit or withdrawal\ncashier.open({ sessionId, token, paymentAction: PaymentAction.WITHDRAW });\n\n// Single-column layout (Single Payment)\ncashier.open({ sessionId, token, layout: \"single\" });\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ℹ️ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["token"]}," is required (≥ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@omno-payment/checkout-js"]}," 1.0.29). Opening without it is rejected."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"build-it-","__idx":1},"children":["Build it →"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/cashier/sdk/methods"},"children":["Methods"]}," · ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/cashier/sdk/events"},"children":["Events"]}," · ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/cashier/single-payment"},"children":["Single Payment"]}]}]}]},"headings":[{"value":"Opening the Cashier","id":"opening-the-cashier","depth":1},{"value":"Build it →","id":"build-it-","depth":2}],"frontmatter":{"title":"Opening the Cashier","description":"The open() parameters for the Omno Web SDK — sessionId and the required token, plus containerId, paymentAction and layout.","seo":{"title":"Opening the Cashier"}},"lastModified":"2026-11-06T11:46:00.425Z","pagePropGetterError":{"message":"","name":""}},"slug":"/cashier/sdk/open","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}