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 Parrot, 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 Parrot response for both Parrot and Parrot Batch.
- Enhanced Data - For an additional cost, you can submit enhanced data BIN requests via Parrot.
Null/Empty Field Responses
The data provided in an individual field response depends on what data appears in the files Parrot 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
orfalse
value for Visa BINs; for all non-Visa BINs, they'll return anull
value.
If you're using Parrot Batch, see the Parrot Batch Data Dictionary.
Standard Data Fields
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—
.
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 | The minimum value of the primary card brand's BIN range in which this BIN value falls | "4225090000000000000" |
bin_max | string | The maximum value of the primary card brand's BIN range in which this BIN value falls | "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" |
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
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—
.
Data Field | Variable Type | Description | Example Response |
---|---|---|---|
account_updater | bool | (Visa-only field) Account Updater enabled | "true" |
additional_card_brands | object | If the BIN is a shared BIN, then the additional card brand details associated with this BIN will be shown | see nested values |
* bin_min | string | The minimum value of the additional card brand's BIN range in which this BIN value falls | "3715999999999999999" |
* bin_max | string | The maximum value of the additional card brand's BIN range in which this BIN value falls | "3715000000000000000" |
* card_brand | string | The name of the additional card brand | "Nyce" |
*card_brand_product | string | The product name according to the additional card brand | "Nyce International" |
* card_brand_bank_name | string | Name of the issuing bank for the additional card brand | "National Bank of Canada" |
* ecom_enabled | bool | BIN has been enabled to make ecommerce purchases, or purchases over the internet | "true" |
* billpay_enabled | bool | BIN has been enabled to make bill payments to service providers electronically, or over the internet | "false" |
alm | string | (Visa-only field) Indicator of a BIN or Account Range participating in Account Level Management | "true" |
authentication | object | Details about customer authentication requirements hardcoded based on issuer country law | see nested values |
* authentication_required | bool | Set to true if additional customer authentication is required | "true" |
* authentication_name | string | The SCA name | "EU PSD2 - SCA" |
bin_length | string | 6 or 8 digit BIN Note: Not every network provides this field; if a network file doesn't include this attribute, the response will be 6 | "6" |
clean_bank_name | string | Pagos-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_card | string | Indicator for a card that has combined card type capabilities | "credit and prepaid" |
cost | object | Associated interchange regulations and estimated interchange costs | see nested values |
* interchange | object | see nested values | |
— regulated | bool | Indicator of the presence of an interchange regulation on a BIN | "true" |
— regulated_name | string | The name of the interchange regulation | "GOVERNMENT NON-EXEMPT INTERCHANGE FEE (WITH FRAUD)" |
* domestic | object | see nested values | |
— cap_region_shortname | string | An abbreviated region name where the interchange cap applies | “Dom” |
— cap_advalorem_amount | string | The interchange percentage assessed, shown in decimals for the capped interchange | “0.002” |
— cap_type_name | string | The name of the regulated interchange cap | “US Durbin Regulation Debit Visa” |
— cap_fixed_amount | string | If a fixed or regulated interchange amount applies the amount will be shown here | “0.21” |
— cap_type_qualifier_currency | string | The currency of the qualified fixed_amount for the regulated or capped interchange | “usd” |
— cap_type_qualifier_text | string | The description of the interchange cap or regulation | “US Durbin Regulation Debit Visa” |
— cap_type_qualifier_lower | string | The minimum merchant processing volume amount limit for the interchange cap | "0" |
— cap_type_qualifier_upper | string | The maximum merchant processing volume amount limit for the interchange cap | "999999999999" |
* international | object | see nested values | |
— cap_region_shortname | string | An abbreviated region name where the interchange cap applies | "Inter" |
— cap_advalorem_amount | string | The interchange percentage assessed, shown in decimals for the capped interchange | "0.0115" |
— cap_type_name | string | The name of the regulated interchange cap | "EU MIF" |
— cap_fixed_amount | string | If a fixed or regulated interchange amount applies the amount will be shown here | "0" |
—cap_type_qualifier_currency | string | The currency of the qualified fixed_amount for the regulated or capped interchange | "usd" |
— cap_type_qualifier_text | string | The description of the interchange cap or regulation | "EU XB CNP MIF" |
— cap_type_qualifier_lower | string | The minimum merchant processing volume amount limit for the interchange cap | "0" |
— cap_type_qualifier_upper | string | The maximum merchant processing volume amount limit for the interchange cap | "999999999999" |
domestic_only | bool | (Visa-only field) Domestic-only BIN or Account Ranges | "true" |
gambling_blocked | bool | (Visa-only field) Indicator that this BIN is not permitted to be used for online gambling | "true" |
issuer_currency | string | The currency that was issued to this BIN to transact in | "usd" |
issuer_supports_tokenization | bool | Set to true if the card brand data indicates the issuing bank supports network tokenization. | "true" |
level2 | bool | (Visa and Mastercard-only field) Indicator of Level 2 interchange rate eligibility | "true" |
level3 | bool | (Visa and Mastercard-only field) Indicator of Level 3 interchange rate eligibility | "false" |
pan_or_token | string | Indicator if the BIN is a PAN or a Network Token. | "pan" "token" |
reloadable | bool | Indicator of reloadable or non-reloadable prepaid | "false" |
shared_bin | bool | Set to true if BIN is shared by multiple issuers; more BIN digits may be required in order to get the most accurate BIN details | "true" |
virtual_card | bool | 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 | string | 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 | string | 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 | string | Indicates if a Visa card allows for Flexible Credentials functionality. The possible values for this field are:M - The card is multi-account managed, meaning the issuer manages which account is used and whenS - The card is multi-account self-serve, meaning the cardholder manages which account is used and whenN - The card is not a participant in multi-account functionalityNote: This field is only available for Visa cards. All other brands will show null . | "M" |
Here's an example of how Parrot returns enhanced data for the BIN 422509
:
{
"card": {
"number": {
"length": 16
},
"bin_length": 6,
"bin_min": "3715620000000000000",
"bin_max": "3715629999999999999",
"pan_or_token": "pan",
"level2": false,
"level3": false,
"alm": false,
"account_updater": false,
"domestic_only": false,
"gambling_blocked": false,
"issuer_currency": null,
"reloadable": true,
"additional_card_brands": [
{
"card_brand": "NYCE",
"bin_max": "3715999999999999999",
"bin_min": "3715000000000000000",
"card_brand_product": "NYCE Generic Product",
"card_brand_bank_name": null,
"ecom_enabled": false,
"billpay_enabled": false
}
],
"card_brand": "AMEX",
"card_segment_type": null,
"combo_card": null,
"type": "Credit",
"prepaid": false,
"product": {
"product_id": "AX_CONS",
"product_name": "CONSUMER"
},
"bank": {
"name": "",
"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": null,
"domestic": null,
"inter": null,
"intra": null,
"notes": null
}
},
"networkfees": {},
"correlation_id": "eyJGaWxlSWQiOjY1MzcsIlZlcnNpb24iOjM2fQ==",
"issuer_supports_tokenization": null,
"shared_bin": false
}
}