Parrot Data Dictionary

The Parrot BIN list is a repository of information that you can use to refine your payments’ strategy and get to know your customers better. In both Parrot and Parrot Batch, there are two types of data fields: Standard and Enhanced.

Standard Data - Standard BIN data is included in every Parrot response for both Parrot and Parrot Batch.

Enhanced Data - For an additional cost, you can submit enhanced data BIN requests via Parrot and Parrot Batch v3.

📘

Table Key

The highest level of data per field is indicated in blue. If there are additional levels of data, the second level is denoted by * and the third level of data is denoted by .

Standard Data Fields

Data FieldVariable TypeDescriptionExample Response
bankobjectIssuing bank name and detailssee nested values
* namestringIssuing bank name"Bank of America National Association"
* phonestringIssuing bank phone"180004321000"
* urlstringIssuing bank website"https://www.bankofamerica.com"
card_brandstringThe name of the card brand"Mastercard"
card_segment_typestringIndicator of consumer BIN or
commercial BIN
"consumer"
countryobjectIssuing country detailssee nested values
* alpha2string2 letter country code representing the issuing country; Alpha 2 code meets the ISO3166 standards"US"
* numericstringNumeric country code representing the issuing country; the numeric country code meets ISO 3166 standards"840"
* namestringIssuing country name"United States"
numberobjectDetails about underlying PANsee nested values
* lengthstringThe length of the underlying PAN"16"
* luhnboolIndicator of the PAN passing Luhn validation"true"
prepaidboolIndicator of a prepaid BIN"true"
productobjectDetails about the card productsee nested values
* product_idstringThe product ID according to the card brand"MWE"
* product_namestringThe product name according to the card brand"World Elite Mastercard card"
typestringIndicator of the card type"Debit"

Here's an example of how Parrot returns standard data for the BIN 422509:

"card": {
        "number": {
            "length": 16
        },
        "bin_min": "4225090000000000000",
        "bin_max": "4225099999999999999",
        "card_brand": "VISA",
        "card_segment_type": "Consumer",
        "type": "Debit",
        "prepaid": false,
        "product": {
            "product_id": "F",
            "product_name": "Visa Classic"
        },
        "bank": {
            "name": "CREDIT UNION 1"
        },
        "country": {
            "alpha2": "US",
            "numeric": "840",
            "name": "UNITED STATES OF AMERICA"
        },
        "correlation_id": "eyJGaWxlSWQiOjE0NDUsIlZlcnNpb24iOjEwfQ=="
    }

Enhanced Data Fields

Data FieldVariable TypeDescriptionExample Response
account_updaterboolAccount Updater enabled"true"
additional_card_brandsobjectIf the BIN is a shared BIN, then the additional card brand details associated with this BIN will be shownsee nested values
* card_brandstringThe name of the additional card brand"Nyce"
*card_brand_productstringThe product name according to the additional card brand"Nyce International"
* card_brand_bank_namestringName of the issuing bank for the additional card brand"National Bank of Canada"
* ecom_enabledboolBIN has been enabled to make ecommerce purchases, or purchases over the internet"true"
* billpay_enabledboolBIN has been enabled to make bill payments to service providers electronically, or over the internet"false"
almstringIndicator of a BIN or Account Range participating in Account Level Management"true"
authenticationobjectDetails about customer authentication requirementssee nested values
* authentication_requiredboolDetails about customer authentication"true"
* authentication_namestringSet to true if additional customer authentication is required"EU PSD2 - SCA"
bin_lengthstring6 or 8 digit BIN"6"
clean_bank_namestringPagos-harmonized bank name that has been formatted to proper case, removes unnecessary punctuation and misspellings, and spells out uncommon banking acronyms

Note: this field is nested under the standard “bank” object
"American Federal Credit Union"
combo_cardstringIndicator for a card that has combined card type capabilities"credit and prepaid"
costobjectAssociated interchange regulations and estimated interchange costssee nested values
* interchangeobjectsee nested values
regulatedboolIndicator of the presence of an interchange regulation on a BIN"true"
regulated_namestringThe name of the interchange regulation"GOVERNMENT NON-EXEMPT
INTERCHANGE FEE (WITH FRAUD)"
* domesticobjectsee nested values
cap_region_shortnamestringAn abbreviated region name where the
interchange cap applies
“Dom”
cap_advalorem_amountstringThe interchange percentage assessed, shown in decimals for the capped interchange“0.002”
cap_type_namestringThe name of the regulated interchange cap“​​US Durbin Regulation Debit Visa”
cap_fixed_amountstringIf a fixed or regulated interchange amount applies
the amount will be shown here
“0.21”
cap_type_qualifier_currencystringThe currency of the qualified fixed_amount for the regulated or capped interchange“usd”
cap_type_qualifier_textstringThe description of the interchange cap or regulation“​​US Durbin Regulation Debit Visa”
cap_type_qualifier_lowerstringThe minimum merchant processing volume amount limit for the interchange cap"101mm"
cap_type_qualifier_upperstringThe maximum merchant processing volume amount limit for the interchange cap"500mm"
* internationalobjectsee nested values
cap_region_shortnamestringAn abbreviated region name where the
interchange cap applies
"Inter"
cap_advalorem_amountstringThe interchange percentage assessed, shown in decimals for the capped interchange"0.0115"
cap_type_namestringThe name of the regulated interchange cap"EU MIF"
cap_fixed_amountstringIf a fixed or regulated interchange amount applies
the amount will be shown here
"0"
cap_type_qualifier_currencystringThe currency of the qualified fixed_amount for the regulated or capped interchange"usd"
cap_type_qualifier_textstringThe description of the interchange cap or regulation"EU XB CNP MIF"
cap_type_qualifier_lowerstringThe minimum merchant processing volume amount limit for the interchange cap"101mm"
cap_type_qualifier_upperstringThe maximum merchant processing volume amount limit for the interchange cap"500mm"
domestic_onlyboolDomestic-only BIN or Account Ranges"true"
gambling_blockedboolIndicator that this BIN is not permitted to be used for online gambling"true"
issuer_currencystringThe currency that was issued to this BIN to transact in"usd"
level2boolIndicator of Level 2 interchange rate
eligibility
"true"
level3boolIndicator of Level 3 interchange rate
eligibility
"false
pan_or_tokenstringIndicator if the BIN is a PAN or a Network Token"pan"
reloadableboolIndicator of reloadable or
non-reloadable prepaid
"false"
shared_binboolSet to true if BIN is shared by multiple issuers"true

Here's an example of how Parrot returns enhanced data for the BIN 422509:

{
    "card": {
        "number": {
            "length": 16
        },
        "bin_length": 6,
        "bin_min": "4225090000000000000",
        "bin_max": "4225099999999999999",
        "pan_or_token": "pan",
        "level2": false,
        "level3": false,
        "alm": false,
        "account_updater": true,
        "domestic_only": false,
        "gambling_blocked": false,
        "issuer_currency": "USD",
        "reloadable": false,
        "additional_card_brands": [
            {
                "card_brand": "CULIANCE",
                "card_brand_product": "Culiance ATM CUHERE ATM reciprocal ID",
                "card_brand_bank_name": "MONEYPASS",
                "ecom_enabled": false,
                "billpay_enabled": false
            },
            {
                "card_brand": "STAR",
                "card_brand_product": null,
                "card_brand_bank_name": "",
                "ecom_enabled": true,
                "billpay_enabled": true
            }
        ],
        "card_brand": "VISA",
        "card_segment_type": "Consumer",
        "combo_card": null,
        "type": "Debit",
        "prepaid": false,
        "product": {
            "product_id": "F",
            "product_name": "Visa Classic"
        },
        "bank": {
            "name": "CREDIT UNION 1",
            "phone": null,
            "url": null,
            "clean_name": null
        },
        "country": {
            "alpha2": "US",
            "numeric": "840",
            "name": "UNITED STATES OF AMERICA"
        },
        "authentication": {
            "authentication_required": false,
            "authentication_name": null
        },
        "cost": {
            "interchange": {
                "regulated": false,
                "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE",
                "domestic": {
                    "cap_region_shortname": "DOM",
                    "cap_advalorem_amount": "0.05%",
                    "cap_type_name": "US DURBIN REGULATION DEBIT VISA",
                    "cap_fixed_amount": "21.00%",
                    "cap_type_qualifier_currency": "USD",
                    "cap_type_qualifier_text": "US DURBIN REGULATION DEBIT VISA",
                    "cap_type_qualifier_lower": null,
                    "cap_type_qualifier_upper": null
                },
                "inter": null,
                "intra": null,
                "notes": null
            }
        },
        "networkfees": {},
        "correlation_id": "eyJGaWxlSWQiOjExNTIsIlZlcnNpb24iOjl9",
        "shared_bin": false
    }
}
        "authentication": {
            "authentication_required": false,
            "authentication_name": null
        },
        "cost": {
            "interchange": {
                "regulated":,
                "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE",
                "domestic": {
                    "cap_region_shortname": "DOM",
                    "cap_advalorem_amount": "0.0005",
                    "cap_type_name": "US DURBIN REGULATION DEBIT VISA",
                    "cap_fixed_amount": "0.21",
                    "cap_type_qualifier_currency": "USD",
                    "cap_type_qualifier_text": "US DURBIN REGULATION DEBIT VISA",
                    "cap_type_qualifier_lower": "",
                    "cap_type_qualifier_upper": ""
                },
                "notes": ""
            }
        },
        "networkfees": {}
    }
}