BIN Data API Dictionary

This guide is a repository of information that you can access using Pagos BIN Data API and use to refine your payments strategy or get to know your customers better. In BIN Data API, there are two types of data fields for which you can receive responses: Standard and Enhanced.

Standard Data - Standard BIN data is included in every response for Pagos BIN Data API.
Enhanced Data - Enhanced BIN data is available in Pagos BIN Data API when setting the enhanced query parameter to "true".

Null/Empty Field Responses: The data provided in an individual field response depends on what data appears in the files Pagos receives from the card brands. If a field response is null, this means our network files don’t include any data for that field.Any bool fields marked as “Visa only” will return a true or false value for Visa BINs; for all non-Visa BINs, they’ll return a null value.

If you’re using BIN Data Batch, see the BIN Data Batch Dictionary.

Standard Data Fields

Data Field	Variable Type	Description	Example Response
`bank`	object	Issuing bank name and details	see nested values
`name`	string	Issuing bank name	”Bank of America National Association”
`phone`	string	Issuing bank phone	”180004321000”
`url`	string	Issuing bank website	”https://www.bankofamerica.com”
`bin_min`	string	Minimum PAN value for the BIN range	”4225090000000000000”
`bin_max`	string	Maximum PAN value for the BIN range	”4225099999999999999”
`card_brand`	string	The name of the card brand	”Mastercard”
`card_segment_type`	string	Indicator of consumer BIN or commercial BIN	”consumer”
`correlation_id`	string	A unique Pagos ID that maps a BIN range to a specific network file; used for troubleshooting	”eyJGaWxlSWQiOjE0NDUsIlZlcnNpb24iOjEwfQ==“
`country`	object	Issuing country details	see nested values
`alpha2`	string	2 letter country code representing the issuing country; Alpha 2 code meets the ISO3166 standards	”US”
`numeric`	string	Numeric country code representing the issuing country; the numeric country code meets ISO 3166 standards	”840”
`name`	string	Issuing country name	”United States”
`number`	object	Details about underlying PAN	see nested values
`length`	string	The length of the underlying PAN	”16”
`luhn`	bool	Indicator of the PAN passing Luhn validation	”true”
`prepaid`	bool	Indicator of a prepaid BIN	”true”
`product`	object	Details about the card product	see nested values
`product_id`	string	The product ID according to the card brand	”MWE”
`product_name`	string	The product name according to the card brand	”World Elite Mastercard card”
`type`	string	Indicator of the card type	”Debit”
`flagged_for_delete_remaining_wks`	string	Countdown in weeks until this BIN range is removed from the file; learn more	”4”

Enhanced Data Fields

Data Field	Description	Example Response
`clean_bank_name`	Pagos-harmonized bank name that has been formatted to proper case, removes unnecessary punctuation and misspellings, and spells out uncommon banking acronyms	”American Federal Credit Union”
`bank_url`	Issuing bank website	”https://www.bankofamerica.com”
`bank_phone`	Issuing bank phone number	”180004321000”
`regulated`	Indicator of the presence of an interchange regulation on a BIN	”true”
`regulated_name`	The name of the interchange regulation	”GOVERNMENT NON-EXEMPT INTERCHANGE FEE (WITH FRAUD)“
`reloadable`	Indicator of reloadable or non-reloadable prepaid	”false”
`pan_or_token`	Indicator if the BIN is a PAN or a Network Token. Note: Mastercard uses the same BIN ranges for both PANs and tokens, meaning all Mastercard BINs can be a PAN and will therefore always return pan in this field—even for those that are actually tokens. Refer to the issuer_supports_tokenization field to determine if the BIN supports tokens	”pan”
`account_updater`	(Visa-only field) Account Updater enabled	”true”
`alm`	(Visa-only field) Indicator of a BIN or Account Range participating in Account Level Management	”true”
`domestic_only`	(Visa-only field) Domestic-only BIN or Account Ranges	”true”
`gambling_blocked`	(Visa-only field) Indicator that this BIN is not permitted to be used for online gambling	”true”
`level2`	(Visa and Mastercard-only field) Indicator of Level 2 interchange rate eligibility	”true”
`level3`	(Visa and Mastercard-only field) Indicator of Level 3 interchange rate eligibility	”true”
`issuer_currency`	The currency that was issued to this BIN to transact in	”usd”
`combo_card`	Indicator for a card that has combined card type capabilities	”credit and prepaid”
`bin_length`	6 or 8 digit BIN	”6”
`authentication`	If additional customer authentication is required, this json array will indicate the authentication_name; this field is hardcoded based on issuer country law	”authentication_name”: “EU PSD2 - SCA”
`cost`	Identifies associated costs by name and amount, embedded as JSON in the column	see example below
`additional_card_brands`	If the card is associated with a secondary network (e.g. Star, pulse, nyce), this field contains that network’s details; note that secondary network’s typically provide less in their BIN data.	see example below
`issuer_supports_tokenization`	Set to true if the card brand data indicates the issuing bank supports network tokenization. Note: The field doesn’t indicate if the associated card actually is a PAN or token, just what it supports	”true”
`pagos_shared_bin`	Deprecated. This field has been replaced by `additional_card_brands`; for continuity, it remains in the returned BIN data, but will always be set to `"false"`	”false”
`billpay_enabled`	BIN has been enabled to make bill payments to service providers electronically, or over the internet	”false”
`ecom_enabled`	BIN has been enabled to make ecommerce purchases, or purchases over the internet	”true”
`virtual_card`	Set to true if the given BIN range supports virtual card creation. A null response indicates we do not know if there is support for virtual cards	“true”
`funding_source`	Indicates the funding source for a payment card, which is different from the type. Note: This field only displays the funding source for Visa and Mastercard; all other brands will show null.	“deferred debit”
`pagos_bin_length`	Indicates the length of the BIN as determined by Pagos using the bin_min and bin_max fields provided by the networks.	”8”
`multi_account_access_indicator`	Indicates if a Visa card allows for Flexible Credentials functionality. (Note: This field is only available for Visa cards. All other brands will show null.) The possible values for this field are: M - The card is multi-account managed, meaning the issuer manages which account is used and when S - The card is multi-account self-serve, meaning the cardholder manages which account is used and when N - The card is not a participant in multi-account functionality	”M”

{
  "card": {
    "number": {
      "length": 16
    },
    "bin_length": 6,
    "pagos_bin_length": 6,
    "bin_min": "5244780000000000000",
    "bin_max": "5244789999999999999",
    "pan_or_token": "pan",
    "virtual_card": null,
    "level2": false,
    "level3": false,
    "alm": null,
    "account_updater": null,
    "domestic_only": false,
    "gambling_blocked": null,
    "issuer_currency": null,
    "reloadable": false,
    "additional_card_brands": [
      {
        "card_brand": "NYCE",
        "bin_max": "4422669999999999999",
        "bin_min": "4422660000000000000",
        "card_brand_product": "NYCE Generic Product",
        "card_brand_bank_name": null,
        "ecom_enabled": true,
        "billpay_enabled": false
      }
    ],
    "card_brand": "MASTERCARD",
    "card_segment_type": "Consumer",
    "combo_card": null,
    "type": "Credit",
    "funding_source": "CREDIT",
    "prepaid": false,
    "product": {
      "product_id": "MCW",
      "product_name": "World Mastercard Card"
    },
    "bank": {
      "name": "Citadel Federal Credit Union",
      "phone": null,
      "url": null,
      "clean_name": "Citadel Federal Credit Union"
    },
    "country": {
      "alpha2": "US",
      "numeric": "840",
      "name": "UNITED STATES OF AMERICA"
    },
    "authentication": {
      "authentication_required": false,
      "authentication_name": null
    },
    "cost": {
      "interchange": {
        "regulated": false,
        "regulated_name": null,
        "domestic": null,
        "inter": null,
        "intra": null,
        "notes": null
      }
    },
    "networkfees": {},
    "correlation_id": "eyJGaWxlSWQiOjI0OTgxLCJWZXJzaW9uIjoxMjExfQ==",
    "issuer_supports_tokenization": true,
    "multi_account_access_indicator": null,
    "shared_bin": false,
    "flagged_for_delete_remaining_wks": null
  }
}

BIN Data FAQs

BIN Data APIs

BIN Data API Dictionary

Standard Data Fields

Enhanced Data Fields

​Standard Data Fields

​Enhanced Data Fields

Standard Data Fields

Enhanced Data Fields