> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://ixopay.ferndocs.com/modules/token-ex/data-dictionary/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://ixopay.ferndocs.com/_mcp/server. # Data Dictionary This page defines every field returned by IXOPAY's BIN Lookup API response. Key fields include card brand, funding source, issuer information, country codes, BIN range boundaries, and tokenization-support indicators. Use this reference to understand what data is available for fraud prevention, routing optimization, and payment processing decisions. @@CALLOUT\_OPEN|note|@@ This is mapped to how it appears in the API response. The actual BIN File fields are not in camelCase but rather appear with underscorings eg. `bin_min` | Field | Type | Description | | ------------------------------------------------------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `binMin` | `string` | The minimum account number for this BIN's assigned account number range. | | *Example:* `"5584750000000000"` | | | | `binMax` | `string` | The maximum account number for this BIN's assigned account number range. | | *Example:* `"5584759999999999"` | | | | `binLength` | `number` | The length of the BIN (typically 6 or 8). | | *Example:* `6` | | | | `cleanBankName` | `string` | Normalized bank name formatted to proper case. | | *Example:* `"Nexi Payments Spa"` | | | | `productName` | `string` | The name of the card product. | | *Example:* `"MasterCard Preferred BusinessCard Card"` | | | | `cardBrand` | `string` | The primary card network. | | *Example:* `"MASTERCARD"` | | | | `countryAlpha2` | `string` | Two letter country code (ISO 3166 Alpha 2). | | *Example:* `"IT"` | | | | `countryName` | `string` | Country in which the issuing bank resides. | | *Example:* `"ITALY"` | | | | `countryNumeric` | `string` | Numeric country code (ISO 3166 standards). | | *Example:* `"380"` | | | | `type` | `string` | Type of Payment Card (e.g., Debit, Credit). | | *Example:* `"Credit"` | | | | `bankName` | `string` | Name of Issuing Bank. | | *Example:* `"NEXI PAYMENTS SPA"` | | | | `bankUrl` | `string` | URL of issuing bank website. | | *Example:* `"https://www.bankofamerica.com"` | | | | `bankPhone` | `string` | Phone number of issuing bank. | | *Example:* `"180004321000"` | | | | `productCode` | `string` | The card product ID according to the card brand. | | *Example:* `"MPB"` | | | | `prepaid` | optional`boolean?` | Prepaid card type indicator. | | *Example:* `false` | | | | `regulated` | `boolean` | Indicator of interchange regulation presence. | | *Example:* `false` | | | | `regulatedName` | `string` | The name of the interchange regulation. | | *Example:* `"GOVERNMENT NON-EXEMPT REGULATED INTERCHANGE FEE"` | | | | `reloadable` | optional`boolean?` | (Visa-only field) Indicator of reloadable or non-reloadable status. | | *Example:* `true` | | | | `panOrToken` | `string` | Indicates if account number is a network token or PAN. | | *Example:* `"pan"` | | | | `accountUpdater` | `boolean` | Indicator for Account Updater enablement. | | *Example:* `false` | | | | `alm` | `boolean` | Indicator of Account Level Management participation. | | *Example:* `false` | | | | `domesticOnly` | `boolean` | If the BIN can only be used in the country of issue. | | *Example:* `false` | | | | `gamblingBlocked` | `boolean` | Indicator if BIN is restricted from online gambling. | | *Example:* `false` | | | | `level2` | `boolean` | Indicator of Level 2 interchange rate eligibility. | | *Example:* `false` | | | | `level3` | `boolean` | Indicator of Level 3 interchange rate eligibility. | | *Example:* `false` | | | | `issuerCurrency` | `string` | The currency assigned to this BIN. | | *Example:* `"USD"` | | | | `cardSegmentType` | `string` | Indicates if the card is consumer or commercial. | | *Example:* `"Commercial"` | | | | `comboCard` | `string` | Indicator for combined card type capabilities. | | *Example:* `"Credit and Debit"` | | | | `cardBrandIsAdditional` | `boolean` | False if primary network; True if secondary. Primary networks are Visa, Mastercard, Discover, Amex, JCB or Unionpay. Secondary networks typically provide less in their BIN data. | | *Example:* `false` | | | | `correlationId` | `string` | ID mapping a BIN range to a network file. | | *Example:* `"eyJGaWxlS..."` | | | | `sharedBin` | `boolean` | Set to true if BIN is shared by multiple issuers. | | *Example:* `false` | | | | `issuerSupportsTokenization` | `boolean` | If the bank supports network tokenization. | | *Example:* `true` | | | | `billpayEnabled` | `boolean` | BIN enabled for electronic bill payments. | | *Example:* `true` | | | | `ecomEnabled` | `boolean` | BIN enabled for ecommerce purchases. | | *Example:* `true` | | | | `cost` | `array` | Identifies associated costs by name and amount. See cost fields below. | | *Example:* `{'[{"capFixedAmount": 0, ...}]'}` | | | | `authentication` | `array` | JSON array identifying required authentication. | | *Example:* `{'[{"scaName": "EU PSD2 - SCA"}]'}` | | | | `additionalCardBrands` | `array`\[`BinData`] | List of any secondary card networks which fall into the same range as the primary card network. Indicated by `cardBrandIsAdditional`. | | *Example:* `[]` | | | | `fundingSource` | `string` | Funding source (CREDIT, DEBIT, PREPAID). Only for Visa and Mastercard. | | *Example:* `"CREDIT"` | | | | `cardNumberLength` | `string` | The length of the full card number. | | *Example:* `"16"` | | | | `virtualCard` | `boolean` | Supports virtual card creation. | | *Example:* `true` | | | | `calculatedBinLength` | `string` | The length of a BIN as calculated by the provider. | | *Example:* `"8"` | | | | `multiAccountAccessIndicator` | `string` | Visa-only indicator for account management. | | *Example:* `"M"` | | | ## Cost Fields | Field | Type | Description | | ---------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `capRegionShortName` | `string` | An abbreviated region name where the interchange cap applies. Possible values are `"Dom"` and `"Inter"` for domestic and international, respectively. | | *Example:* `"Dom"` | | | | `capAdvaloremAmount` | optional`number?` | The interchange percentage assessed, shown in decimals for the capped interchange. | | *Example:* `0.002` | | | | `capTypeName` | `string` | The name of the regulated interchange cap. | | *Example:* `"US Durbin Regulation Debit Visa"` | | | | `capFixedAmount` | optional`number?` | If a fixed or regulated interchange amount applies, the amount will be shown here. | | *Example:* `0.21` | | | | `capTypeQualifierCurrency` | `string` | The currency of the qualified fixed amount for the regulated or capped interchange. | | *Example:* `"usd"` | | | | `capTypeQualifierText` | `string` | The description of the interchange cap or regulation. | | *Example:* `"US Durbin Regulation Debit Visa"` | | | | `capTypeQualifierLower` | `string` | The minimum merchant processing volume amount limit for the interchange cap. | | *Example:* `"101mm"` | | | | `capTypeQualifierUpper` | `string` | The maximum merchant processing volume amount limit for the interchange cap. | | *Example:* `"500mm"` | | |