{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-js/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["code-walkthrough","step"]},"type":"markdown"},"seo":{"title":"Options | Finix.js Reference","description":"API reference for all Finix.PaymentForm options — configure payment methods, fields, validation, appearance, and more.","siteUrl":"https://docs.finix.com/","llmstxt":{"hide":false,"sections":[{"title":"Getting Started","includeFiles":["guides/getting-started/**/*.md"],"excludeFiles":[]},{"title":"Online Payments","includeFiles":["guides/online-payments/**/*.md"],"excludeFiles":["guides/online-payments/payment-features/fsa-hsa-non-healthcare-mcc.md"]},{"title":"In-Person Payments","includeFiles":["guides/in-person-payments/**/*.md"],"excludeFiles":[]},{"title":"Subscriptions","includeFiles":["guides/subscriptions/**/*.md"],"excludeFiles":[]},{"title":"After the Payment","includeFiles":["guides/subscriptions/after-the-payment/**/*.md"],"excludeFiles":[]},{"title":"Managing Operations","includeFiles":["guides/managing-operations/**/*.md"],"excludeFiles":[]},{"title":"Platform Payments","includeFiles":["guides/platform-payments/**/*.md"],"excludeFiles":[]},{"title":"Payouts","includeFiles":["guides/payouts/**/*.md"],"excludeFiles":[]},{"title":"Developers","includeFiles":["additional-resources/developers/**/*.md"],"excludeFiles":[]},{"title":"Plugins","includeFiles":["additional-resources/plugins/**/*.md"],"excludeFiles":[]},{"title":"Industry Considerations","includeFiles":["guides/industry-considerations/**/*.md"],"excludeFiles":[]},{"title":"Regional Considerations","includeFiles":["guides/regional-considerations/**/*.md"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeWalkthrough","attributes":{"__idx":1,"filters":{},"filesets":[{"files":[{"path":"js/_filesets/options.js","content":[{"start":0,"condition":{"steps":["payment-methods"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  paymentMethods: [\"card\", \"bank\"], // Accept both (default)","  // paymentMethods: [\"card\"],      // Cards only","  // paymentMethods: [\"bank\"],      // Bank accounts only","});"]},"",{"start":8,"condition":{"steps":["show-address"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  showAddress: true,  // Show billing address fields (default: false)","});"]},"",{"start":14,"condition":{"steps":["show-labels-placeholders"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  showLabels: true,       // Show field labels (default: true)","  showPlaceholders: true, // Show placeholder text (default: true)","});"]},"",{"start":21,"condition":{"steps":["hide-fields"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  hideFields: [\"security_code\", \"card_holder_name\"],","  // Note: \"number\" and \"expiration_date\" cannot be hidden","});"]},"",{"start":28,"condition":{"steps":["required-fields"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  requiredFields: [","    \"name\",              // Alias for card_holder_name / account_holder_name","    \"address_line1\",","    \"address_city\",","    \"address_region\",","    \"address_postal_code\",","    \"address_country\",","  ],","});"]},"",{"start":41,"condition":{"steps":["custom-labels"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  labels: {","    card_holder_name: \"Full Name\",","    number: \"Card Number\",","    expiration_date: \"Expiry\",","    security_code: \"CVV\",","  },","});"]},"",{"start":52,"condition":{"steps":["custom-placeholders"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  placeholders: {","    card_holder_name: \"Jane Smith\",","    number: \"•••• •••• •••• ••••\",","    security_code: \"•••\",","  },","});"]},"",{"start":62,"condition":{"steps":["error-messages"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  errorMessages: {","    number: \"Please enter a valid card number.\",","    expiration_date: \"Please enter a valid expiration date.\",","    security_code: \"Please enter your 3-digit CVV.\",","  },","});"]},"",{"start":72,"condition":{"steps":["default-values"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  defaultValues: {","    // PCI-sensitive fields cannot be pre-filled:","    // number, expiration_date, security_code, account_number, bank_code","    card_holder_name: \"Jane Smith\",","    address_line1: \"123 Main St\",","    address_city: \"San Francisco\",","    address_region: \"CA\",","    address_postal_code: \"94105\",","    address_country: \"USA\",","  },","});"]},"",{"start":87,"condition":{"steps":["submit-label"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  onSubmit: function (error, response) { /* ... */ },","  submitLabel: \"Pay Now\", // Custom label for the auto-rendered submit button","});"]},"",{"start":94,"condition":{"steps":["validation"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  requireSecurityCode: true,         // Require CVV/CVC (default: true)","  confirmAccountNumber: true,        // Show double-entry for bank account number (default: true)","  hidePotentialIssueMessages: false, // Hide warnings for unusual-but-valid cards (default: false)","  hideErrorMessages: false,          // Hide all validation error messages (default: false)","});"]},"",{"start":103,"condition":{"steps":["appearance"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  // Available themes: finix, amethyst, sapphire, topaz, ruby, emerald, midnight, elevated","  theme: \"sapphire\",","  enableDarkMode: true, // Respect prefers-color-scheme media query (default: false)","});"]},"",{"start":111,"condition":{"steps":["plaid-link-settings"]},"children":["Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  paymentMethods: [\"bank\"],","  plaidLinkSettings: {","    displayName: \"My Store\",  // Name shown at top of Plaid modal","    language: \"en\",           // Language for the Plaid experience (default: \"en\")","    countries: [\"USA\", \"CAN\"],// ISO-3 country codes (default: [\"USA\", \"CAN\"])","  },","});"]},""],"metadata":{"steps":["payment-methods","show-address","show-labels-placeholders","hide-fields","required-fields","custom-labels","custom-placeholders","error-messages","default-values","submit-label","validation","appearance","plaid-link-settings"]},"basename":"options.js","language":"javascript"}],"downloadAssociatedFiles":[]}],"steps":[{"id":"payment-methods","heading":"paymentMethods"},{"id":"show-address","heading":"showAddress"},{"id":"show-labels-placeholders","heading":"showLabels / showPlaceholders"},{"id":"hide-fields","heading":"hideFields"},{"id":"required-fields","heading":"requiredFields"},{"id":"custom-labels","heading":"labels"},{"id":"custom-placeholders","heading":"placeholders"},{"id":"error-messages","heading":"errorMessages"},{"id":"default-values","heading":"defaultValues"},{"id":"submit-label","heading":"submitLabel"},{"id":"validation","heading":"Validation options"},{"id":"appearance","heading":"theme / enableDarkMode"},{"id":"plaid-link-settings","heading":"plaidLinkSettings"}],"inputs":{},"toggles":{}},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"options","__idx":0},"children":["Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The optional fourth argument to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/js/payment-form"},"children":["Finix.PaymentForm()"]},". All properties are optional."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payment-methods","__idx":1},"children":["Payment Methods"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"payment-methods","heading":"paymentMethods"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls which payment types the form accepts."]},{"$$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":"Value"},"children":["Value"]},{"$$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":["[\"card\", \"bank\"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept both card and bank accounts (default)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"card\"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept only credit or debit cards"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"bank\"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept only bank accounts (USA and Canada)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string[]"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"card\", \"bank\"]"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"field-display","__idx":2},"children":["Field Display"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"show-address","heading":"showAddress"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show billing address fields below the payment fields."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To find the list of address field IDs, go to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/js/field-ids"},"children":["Field IDs"]}," page and look for the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Address Fields"]}," section."]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"show-labels-placeholders","heading":"showLabels / showPlaceholders"},"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":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$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":["showLabels"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show labels above each input"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showPlaceholders"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show placeholder text inside inputs"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"hide-fields","heading":"hideFields"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of field IDs to hide from the form. The fields ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiration_date"]}," cannot be hidden."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string[]"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For valid field ID values, visit the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/js/field-ids"},"children":["Field IDs"]}," page."]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"required-fields","heading":"requiredFields"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of field IDs to mark as required beyond the form defaults."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string[]"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card_holder_name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_holder_name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_line1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_line2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_city"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_region"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_postal_code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_country"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"custom-text","__idx":3},"children":["Custom Text"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"custom-labels","heading":"labels"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Override the default label text for any field, keyed by field ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Record<string, string>"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{}"]}]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"custom-placeholders","heading":"placeholders"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Override the default placeholder text for any field, keyed by field ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Record<string, string>"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{}"]}]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"error-messages","heading":"errorMessages"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Override the default validation error messages for any field, keyed by field ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Record<string, string>"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{}"]}]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"default-values","heading":"defaultValues"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pre-fill field values on form load, keyed by field ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Record<string, string>"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following PCI-sensitive fields ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["cannot"]}," be pre-filled: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiration_date"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["security_code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_number"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bank_code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["institution_number"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transit_number"]}]}]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"submit-label","heading":"submitLabel"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom text for the auto-rendered submit button. Only applies when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onSubmit"]}," is provided."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["undefined"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validation","__idx":4},"children":["Validation"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"validation","heading":"Validation options"},"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":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$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":["requireSecurityCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Require CVV/CVC for card payments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confirmAccountNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show double-entry confirmation for bank account number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hidePotentialIssueMessages"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hide warning messages for non-standard but valid card numbers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hideErrorMessages"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hide all inline validation error messages"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"appearance","__idx":5},"children":["Appearance"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"appearance","heading":"theme / enableDarkMode"},"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":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$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":["theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"finix\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Built-in visual theme"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enableDarkMode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Apply dark styles when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prefers-color-scheme: dark"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Available themes: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["finix"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amethyst"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sapphire"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["topaz"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ruby"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emerald"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["midnight"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elevated"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For custom CSS overrides, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/js/styles-and-fonts"},"children":["Styles & Fonts"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"plaid","__idx":6},"children":["Plaid"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"plaid-link-settings","heading":"plaidLinkSettings"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure the Plaid Link experience for bank account connections. Only applies when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentMethods"]}," includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"bank\""]},"."]},{"$$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":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$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":["displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Application name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name shown at the top of the Plaid modal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"en\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language for the Plaid Link experience"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countries"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"USA\", \"CAN\"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO-3 country codes for which banks appear"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a user completes the Plaid flow, finix.js submits a third-party token request using the Plaid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["public_token"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_id"]},"."]}]}]}]},"headings":[{"value":"Options","id":"options","depth":1},{"value":"Payment Methods","id":"payment-methods","depth":2},{"value":"Field Display","id":"field-display","depth":2},{"value":"Custom Text","id":"custom-text","depth":2},{"value":"Validation","id":"validation","depth":2},{"value":"Appearance","id":"appearance","depth":2},{"value":"Plaid","id":"plaid","depth":2}],"frontmatter":{"seo":{"title":"Options | Finix.js Reference","description":"API reference for all Finix.PaymentForm options — configure payment methods, fields, validation, appearance, and more."},"markdown":{"toc":{"hide":true}},"footer":{"hide":true}},"lastModified":"2026-05-29T22:52:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/js/options","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}