{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["code-walkthrough","step"]},"redocly_category":"Documentation","type":"markdown"},"seo":{"title":"Tokenize payment card information","description":"Add the FramePay JavaScript library to a checkout form and use it to tokenize payment card information.","siteUrl":"https://www.rebilly.com","image":"/assets/rebillysocial.94fb32fc280c9e84b963c440ec462771d25f4e6fdaaa6c59de41e8135113b46b.db81178d.png","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"keywords":"Developer docs, FramePay"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeWalkthrough","attributes":{"__idx":1,"preview":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is an interactive example of a basic checkout form that uses the FramePay library to tokenize payment cards."," ","Complete the payment flow using this test card number: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["4111 1111 1111 1111"]},"."," ","Use any future expiration date and any 3 digits for the CVC number."," ","For more test cards, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/tutorials/test-payment-cards"},"children":["Test cards, IBANs, and ACH details"]},"."]},{"$$mdtype":"Tag","name":"iframe","attributes":{"border":"0","frameBorder":"0","scrolling":"no","style":{"height":"400px","width":"100%"},"src":"/examples/framepay/set-up-payment-card-method.html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To view ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["console.log"]}," messages, ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/examples/framepay/set-up-payment-card-method.html","target":"_blank"},"children":["open the example in a new window"]},"."]}],"filters":{},"filesets":[{"files":[{"path":"docs/dev-docs/_code-samples/setup-payment-card-method/example.html","content":["",""," ",{"start":3,"condition":{"steps":["include-framepay-stylesheet"]},"children":[" "]},{"start":6,"condition":{"steps":["include-framepay-script"]},"children":[" "]}," "," "," ",{"start":12,"condition":{"steps":["create-checkout-form"]},"children":["
"," "," ","",{"start":17,"condition":{"steps":["include-html-mounting-points"]},"children":["
"]},"
"]}," ","",""],"metadata":{"steps":["include-framepay-stylesheet","include-framepay-script","create-checkout-form","include-html-mounting-points"]},"basename":"example.html","language":"html"}],"downloadAssociatedFiles":[]},{"files":[{"path":"docs/dev-docs/_code-samples/setup-payment-card-method/client.js","content":[{"start":0,"condition":{"steps":["initialize"]},"children":["Framepay.initialize({",{"start":2,"condition":{"steps":["rebilly-data"]},"children":[" publishableKey: \"pk_sandbox_123\","," organizationId: \"org-123\","," websiteId: \"website-123\","]},{"start":7,"condition":{"steps":["transaction-data"]},"children":[" transactionData: {"," currency: \"USD\","," amount: 10,"," },"]},"});"]},{"start":15,"condition":{"steps":["mount-card-field"]},"children":["Framepay.on(\"ready\", function () {"," const card = Framepay.card.mount(\"#mounting-point\");","});"]},{"start":20,"condition":{"steps":["create-payment-token"]},"children":["try {"," const form = document.getElementById(\"payment-form\");"," const paymentToken = await Framepay.createToken(form);"," console.log(paymentToken);","} catch (error) {"," console.log(\"❌ Create token error:\", error);","}"]},""],"metadata":{"steps":["initialize","rebilly-data","transaction-data","mount-card-field","create-payment-token"]},"basename":"client.js","language":"javascript"}],"downloadAssociatedFiles":[]}],"steps":[{"id":"include-framepay-stylesheet","heading":"Include the FramePay stylesheet"},{"id":"include-framepay-script","heading":"Include the FramePay script"},{"id":"create-checkout-form","heading":"Create your checkout form"},{"id":"include-html-mounting-points","heading":"Include the HTML mounting points"},{"id":"initialize","heading":"Initialize"},{"id":"rebilly-data","heading":"Rebilly data"},{"id":"transaction-data","heading":"Transaction data"},{"id":"mount-card-field","heading":"Mount the card field"},{"id":"create-payment-token","heading":"Create a payment token"}],"inputs":{},"toggles":{}},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"tokenize-payment-card-information","__idx":0},"children":["Tokenize payment card information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide describes how to add the FramePay JavaScript library to a checkout form and use it to tokenize payment card information."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To complete this guide, you must have: an organization ID, a website ID, and a publishable API key."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must also have a payment gateway configured in your Rebilly account."," ","For sandbox testing, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TestProcessor"]}," gateway is pre-configured."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you already have your IDs and API key, continue to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#step-1-initial-setup"},"children":["Step 1: Initial setup"]},"."," ","If you do not, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/dev-docs/set-up-environment"},"children":["Set up your environment"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-initial-setup","__idx":1},"children":["Step 1: Initial setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set up the FramePay library and provide the HTML."]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"include-framepay-stylesheet","heading":"Include the FramePay stylesheet"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the default styles for the FramePay library elements on the page."]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"include-framepay-script","heading":"Include the FramePay script"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Expose the FramePay library in the global JS scope as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Framepay"]},"."]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"create-checkout-form","heading":"Create your checkout form"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a checkout form on your page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Define the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-rebilly"]}," attributes on your input fields."," ","This instructs the FramePay library to automatically gather data from your checkout form."]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"include-html-mounting-points","heading":"Include the HTML mounting points"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add an empty HTML element with a unique ID to your form."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["FramePay renders the card input field inside this container."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-configure-framepay-library","__idx":2},"children":["Step 2: Configure FramePay library"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This step describes the basic setup for mounting."]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"initialize","heading":"Initialize"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a configuration object and initialize the FramePay library with it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/dev-docs/framepay-configuration-reference/"},"children":["FramePay configuration reference"]},"."]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"rebilly-data","heading":"Rebilly data"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provide your publishable API key, organization ID, and website ID to connect with the Rebilly API."," ","For more information, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/dev-docs/framepay-configuration-reference/"},"children":["FramePay configuration reference"]},"."]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"transaction-data","heading":"Transaction data"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provide the transaction data."," ","A transaction for a payment card requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," values."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-get-the-payment-token","__idx":3},"children":["Step 3: Get the payment token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Mount the FramePay library on your page and listen for a payment token."]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"mount-card-field","heading":"Mount the card field"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After initialization, mount the card field in the container element."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/dev-docs/events/#ready"},"children":["Framepay.on('ready', ...)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/dev-docs/framepay-global-reference/#framepaycardmount"},"children":["Framepay.card.mount(...)"]}]}]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"create-payment-token","heading":"Create a payment token"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you mount your card element, your customer can complete the form."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To send the form data to the FramePay library, call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Framepay.createToken()"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the form data is valid, you receive a successful result with a new payment token."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the form data is invalid, you receive an error explaining why."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, see: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/dev-docs/framepay-global-reference/#framepaycreatetoken"},"children":["Framepay.createToken(form)"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":4},"children":["Related topics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/dev-docs/framepay-configuration-reference/"},"children":["FramePay configuration reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/settings/payment-gateway/"},"children":["Payment gateways"]}]}]}]}]},"headings":[{"value":"Tokenize payment card information","id":"tokenize-payment-card-information","depth":1},{"value":"Step 1: Initial setup","id":"step-1-initial-setup","depth":2},{"value":"Step 2: Configure FramePay library","id":"step-2-configure-framepay-library","depth":2},{"value":"Step 3: Get the payment token","id":"step-3-get-the-payment-token","depth":2},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"markdown":{"toc":{"hide":true}},"seo":{"title":"Tokenize payment card information","description":"Add the FramePay JavaScript library to a checkout form and use it to tokenize payment card information.","lang":"en-US","keywords":"Developer docs, FramePay"},"redirects":{"/docs/content/dev-docs/tutorial/setup-payment-card-method/":{},"/docs/content/concepts-and-features/tutorial/setup-payment-card-method/":{},"/docs/concepts-and-features/tutorial/setup-payment-card-method/":{}},"excludeFromSearch":true,"footer":{"hide":true}},"lastModified":"2026-03-24T10:16:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/dev-docs/setup-payment-card-method","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}