{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-js/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["code-walkthrough","admonition","step"]},"type":"markdown"},"seo":{"title":"Field IDs | Finix.js Reference","description":"API reference for Finix.js field IDs — identifiers for card, bank account, and address fields used in options and callbacks.","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/field-ids.js","content":[{"start":0,"condition":{"steps":["card-fields"]},"children":["// Card field IDs for use with hideFields, requiredFields, labels,","// placeholders, errorMessages, and defaultValues options.","//","// Field ID          | Can Hide | Can Pre-fill","// ------------------|----------|-------------","// card_holder_name  | Yes      | Yes","// number            | No       | No (PCI)","// expiration_date   | No       | No (PCI)","// security_code     | Yes      | No (PCI)","","Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  paymentMethods: [\"card\"],","  labels: { number: \"Card Number\", security_code: \"CVV\" },","  hideFields: [\"card_holder_name\"],","});"]},"",{"start":18,"condition":{"steps":["bank-fields"]},"children":["// Bank field IDs","//","// Field ID              | Can Pre-fill","// ----------------------|-------------","// account_holder_name   | Yes","// account_number        | No (PCI)","// bank_code             | No (PCI)","// account_type          | No","","Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  paymentMethods: [\"bank\"],","  labels: { account_holder_name: \"Account Holder\" },","  defaultValues: { account_holder_name: \"Jane Smith\" },","});"]},"",{"start":35,"condition":{"steps":["address-fields"]},"children":["// Address field IDs — only shown when showAddress: true","","Finix.PaymentForm(\"payment-form\", \"sandbox\", \"APgPDQrLD52TYvqazjHJJchM\", {","  showAddress: true,","  defaultValues: {","    address_line1: \"123 Main St\",","    address_city: \"San Francisco\",","    address_region: \"CA\",","    address_postal_code: \"94105\",","    address_country: \"USA\",","  },","});"]},""],"metadata":{"steps":["card-fields","bank-fields","address-fields"]},"basename":"field-ids.js","language":"javascript"}],"downloadAssociatedFiles":[]}],"steps":[{"id":"card-fields","heading":"Card field IDs"},{"id":"bank-fields","heading":"Bank field IDs"},{"id":"address-fields","heading":"Address field IDs"}],"inputs":{},"toggles":{}},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"field-ids","__idx":0},"children":["Field IDs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["String identifiers used to configure individual fields in the payment form. Accepted by these ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/js/options"},"children":["options"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hideFields"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requiredFields"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["labels"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["placeholders"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorMessages"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultValues"]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Field ID restrictions"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hideFields"]}," cannot hide ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiration_date"]}," — these are required by card networks. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultValues"]}," cannot pre-fill ",{"$$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"]}," due to PCI compliance."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"card-fields","__idx":1},"children":["Card Fields"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"card-fields","heading":"Card field IDs"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card_holder_name"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," — required, cannot be hidden or pre-filled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiration_date"]}," — required, cannot be hidden or pre-filled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["security_code"]}," — cannot be pre-filled; make optional with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requireSecurityCode: false"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"bank-fields","__idx":2},"children":["Bank Fields"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"bank-fields","heading":"Bank field IDs"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_holder_name"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_number"]}," — cannot be pre-filled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bank_code"]}," — cannot be pre-filled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_type"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"address-fields","__idx":3},"children":["Address Fields"]},{"$$mdtype":"Tag","name":"CodeStep","attributes":{"id":"address-fields","heading":"Address field IDs"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only displayed when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showAddress: true"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_line1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_line2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_city"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_region"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_postal_code"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address_country"]}]}]}]}]}]},"headings":[{"value":"Field IDs","id":"field-ids","depth":1},{"value":"Card Fields","id":"card-fields","depth":2},{"value":"Bank Fields","id":"bank-fields","depth":2},{"value":"Address Fields","id":"address-fields","depth":2}],"frontmatter":{"seo":{"title":"Field IDs | Finix.js Reference","description":"API reference for Finix.js field IDs — identifiers for card, bank account, and address fields used in options and callbacks."},"markdown":{"toc":{"hide":true}},"footer":{"hide":true}},"lastModified":"2026-04-07T17:00:18.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/js/field-ids","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}