Enrichments
Basis Theory offers several features that can be used to enrich the tokens that are tokenized. The following enrichments, when activated, can be found within the enrichments property of a Token.
| Attribute | Type | Token Types | Description |
|---|---|---|---|
bin_details | object | card , card_number | Object containing information related to the tokenized credit card |
Using Token Enrichments
When a specific Enrichment is activated for a Tenant, each is added as a token property and returned during every token operation and is available to be used within Detokenization Expressions.
BIN Details Enterprise
BIN details, or Bank Identification Number details, represent a fundamental aspect of credit card processing. Each credit card is associated with a unique BIN, which serves as a numerical identifier for the issuing bank or financial institution. These details hold crucial technical significance as they help validate transactions, prevent fraud, and optimize routing. Understanding the intricate mechanics of BIN details is vital for implementing secure and efficient credit card processing solutions.
Basis Theory offers two options for enriching card or card_number tokens with BIN details, depending on the level of detail you require:
| Level | Description |
|---|---|
| Standard | Basic information about the credit card's function and origin. |
| Enhanced | Includes Standard Data and also interchange, authentication, and other more advanced details. |
Standard Data
Properties
| Property | Type | Description |
|---|---|---|
| bank | object | |
| .name | string | Issuing bank name |
| .phone | string | Issuing bank phone |
| .url | string | Issuing bank website |
| .clean_name | string | Issuing bank name that has been reformatted for human readability |
| card_brand | string | Card brand |
| card_segment_type | string | ["", "Business", "Commercial", "Consumer", "Government"] |
| country | object | |
| .alpha2 | string | Issuing country ISO3166 alpha country code |
| .numeric | string | Issuing country ISO3166 numeric country code |
| .name | string | Issuing country name |
| prepaid | bool | Is prepaid BIN |
| product | object | |
| .code | string | The product code |
| .name | string | The product name |
| type | string | Card type ["Credit", "Debit"] |
JSON example
{
"bank": {
"name": "JPMORGAN CHASE BANK, N.A.",
"phone": "800-432-3117",
"url": "www.jpmorganchase.com",
"clean_name": "JPMORGAN CHASE BANK, N.A."
},
"card_brand": "VISA",
"card_segment_type": "CONSUMER",
"country": {
"alpha2": "US",
"numeric": "840",
"name": "United States of America"
},
"prepaid": false,
"product": {
"code": "D",
"name": "VISA TRADITIONAL"
},
"type": "CREDIT"
}
Enhanced Data
Properties
| Data Field | Variable Type | Description |
|---|---|---|
| account_updater | bool | Account Updater enabled |
| additional_card_brands | object | |
| .card_brand | string | Name of the additional brand |
| .card_brand_product | string | Card brand product |
| .card_brand_bank_name | string | Issuing bank |
| alm | bool | Participating in Account Level Management |
| authentication | array | Authentication requirements, e.g. [{"authentication_name": "EU PSD2 - SCA"}] |
| .authentication_name | string | The type of authentication required, e.g. EU PSD2 - SCA |
| bank | object | |
| .name | string | Issuing bank name |
| .phone | string | Issuing bank phone |
| .url | string | Issuing bank website |
| .clean_name | string | Issuing bank name that has been reformatted for human readability |
| bin_length | string | Length of BIN |
| card_brand | string | Card brand |
| card_segment_type | string | Indicator of consumer BIN or commercial BIN. Values include: Business, Commercial, Consumer, Government |
| combo_card | string | Card has combined card type capabilities |
| cost | array | Identifies associated costs by name and amount |
| .cap_advalorem_amount | string | Interchange percentage (decimal) assessed |
| .cap_type_name | string | Name of the regulated interchange cap |
| .cap_fixed_amount | string | If a fixed or regulated interchange amount applies, the amount will be shown here |
| domestic_only | bool | Domestic-only BIN |
| gambling_blocked | bool | Is not permitted to be used for online gambling |
| issuer_currency | string | 3-digit ISO-3166 Currency |
| level2 | bool | Level 2 interchange rate eligibility |
| level3 | bool | Level 3 interchange rate eligibility |
| pan_or_token | string | Indicates whether the BIN is a PAN or a Network Token. Values include: pan, token |
| product | object | |
| .code | string | The product code |
| .name | string | The product name |
| reloadable | bool | Is reloadable |
| type | string | Card type. Values include: Credit, Debit |
JSON example
{
"account_updater": true,
"additional_card_brands": [
{
"card_brand": "Visa",
"card_brand_product": "Platinum",
"card_brand_bank_name": "Example Bank"
}
],
"alm": "Managed",
"authentication": {
"authentication_required": true,
"authentication_name": "3ds"
},
"bank": {
"name": "JPMORGAN CHASE BANK, N.A.",
"phone": "800-432-3117",
"url": "www.jpmorganchase.com",
"clean_name": "JPMORGAN CHASE BANK, N.A."
},
"bin_length": "6",
"card_brand": "VISA",
"card_segment_type": "Consumer",
"combo_card": "Gold",
"cost": [
{
"cap_fixed_amount": 0,
"cap_advalorem_amount": 0.0115,
"cap_type_qualifier_text": "EU XB CNP MIF"
}
],
"domestic_only": true,
"gambling_blocked": true,
"issuer_currency": "USD",
"level2": false,
"level3": true,
"pan_or_token": "Token",
"product": {
"code": "F",
"name": "Visa Classic"
},
"reloadable": false,
"type": "Debit"
}
Product Code Reference
Visa
| Card Product Code | Card Product Name |
|---|---|
| A | Visa Traditional |
| B | Visa Traditional Rewards |
| C | Visa Signature |
| D | Visa Signature Preferred |
| F | Visa Classic |
| G | Visa Business |
| G1 | Visa Signature Business |
| G3 | Visa Business Enhanced |
| G4 | Visa Infinite Business |
| G5 | Visa Business Rewards |
| I | Visa Infinite |
| I1 | Visa Infinite Privilege |
| I2 | Visa UHNW |
| J3 | Visa Prepaid Healthcare |
| K | Visa Corporate |
| K1 | Visa Government Corporate T&E |
| L | Electron |
| N | Visa Platinum |
| N1 | Visa Rewards |
| N2 | Visa Select |
| O | Reserved |
| P | Visa Gold |
| Q | Private Label |
| Q2 | Private Label Basic |
| Q3 | Private Label Enhanced |
| Q4 | Private Label Standard |
| Q5 | Private Label Specialized |
| Q6 | Private Label Premium |
| R | Proprietary |
| S | Visa Purchasing |
| S1 | Visa Purchasing |
| S2 | Visa Government Purchasing |
| S3 | Visa Government Purchasing with Fleet |
| S4 | Visa Commercial Agriculture |
| S5 | Visa Commercial Transport |
| S6 | Visa Business Loan |
| Sl | Visa Purchasing with Fleet |
| U | Visa TravelMoney |
| V | Visa V Pay |
| X | Visa B2B |
Mastercard
| Card Product Code | Card Product Name |
|---|---|
| ACS | ACH for Consumer |
| BPC | Bill Pay Commercial |
| BPD | Mastercard World Business Debit |
| CIR | Cirrus Card |
| DBK | DIGITAL MASTERCARD BLACK |
| DCG | DIGITAL GOLD |
| DCS | DIGITAL STANDARD |
| DPL | DIGITAL PLATINUM |
| MAB | World Elite Mastercard for Business |
| MAC | Mastercard Corporate World Elite Card |
| Maestro | Branded Prepaid business programs issued in Europe |
| MAP | Mastercard Commercial Payment Account |
| MAQ | Mastercard Prepaid Commercial Payment Account |
| MBA | MasterCard B2B Product 2 |
| MBB | Mastercard Prepaid Consumer |
| MBC | MasterCard Prepaid Voucher |
| MBD | Debit MasterCard Professional Card |
| MBE | MasterCard Electronic BusinessCard Card |
| MBF | MasterCard Alimentacao (Food) |
| MBG | MasterCard B2B Product 3 |
| MBH | MasterCard B2B Product 4 |
| MBI | MasterCard B2B Product 5 |
| MBJ | MasterCard B2B Product 6 |
| MBK | MasterCard Black |
| MBM | MasterCard Refeicao (Meal) |
| MBP | MasterCard Corporate Prepaid |
| MBS | MasterCard B2B Product 1 |
| MBW | World MasterCard Black Edition |
| MCB | MasterCard BusinessCard Card |
| MCC | Mixed Product |
| MCC | MASTERCARD MIXED |
| MCE | MasterCard Electronic |
| MCF | MasterCard Corporate Fleet Card |
| MCG | Gold MasterCard |
| MCM | MasterCard Corporate Meeting Card |
| MCO | MasterCard Corporate Card |
| MCP | Mastercard Corporate Purchasing Card |
| MCS | Mastercard Standard |
| MCT | Titanium MasterCard |
| MCU | MasterCard Unembossed Card |
| MCW | World MasterCard Card |
| MDB | Debit MasterCard BusinessCard Card |
| MDG | Debit Gold MasterCard |
| MDH | World Debit MasterCard Embossed |
| MDJ | Debit MasterCard (enhanced) |
| MDO | Debit MasterCard Other Programs |
| MDP | Debit Platinum MasterCard |
| MDS | Debit MasterCard |
| MDS | Debit MasterCard |
| MDS | DEBIT STANDARD |
| MDT | Business Debit MasterCard |
| MDU | Debit MasterCard Unembossed |
| MDW | World Elite Debit MasterCard |
| MEB | MasterCard Executive BusinessCard Card |
| MEO | MasterCard Corporate Executive Card |
| MEP | Premium Debit MasterCard |
| MES | Mastercard Enterprise Solutions |
| MET | Titanium Debit MasterCard |
| MFR | MasterCard Commercial Reward Funding |
| MGF | MasterCard Government Commercial Card |
| MGP | Mastercard Prepaid Gold Payroll |
| MGS | Platinum Mastercard Prepaid General Spend |
| MHA | MasterCard Healthcare Prepaid Non |
| MHB | MasterCard HSA Substantiated |
| MHH | MasterCard HSA Non |
| MHP | HELOC Platinum MasterCard |
| MHS | HELOC Standard MasterCard |
| MIC | ISIC MasterCard Student Card |
| MIP | ISIC MasterCard Prepaid Student Card |
| MIS | ISIC Debit MasterCard Student Card |
| MIU | Debit MasterCard Unembossed |
| MLA | MasterCard Central Travel Solutions Air |
| MLB | MasterCard Brazil Prepaid Benefits |
| MLC | MasterCard Micro |
| MLD | MasterCard Distribution Card |
| MLE | MasterCard Pedagio Prepaid Card |
| MLF | MasterCard Agro |
| MLL | MasterCard Central Travel Solutions Land |
| MNF | MasterCard Public Sector Commercial Card |
| MNW | World MasterCard Card |
| MOW | World Maestro |
| MPA | Prepaid MasterCard Payroll Card |
| MPB | MasterCard Preferred BusinessCard Card |
| MPC | MasterCard Professional Card |
| MPD | Mastercard Flex Prepaid |
| MPF | Prepaid MasterCard Gift Card |
| MPG | Prepaid MasterCard General Spend Card |
| MPJ | Prepaid MC Debit Voucher Meal/Food Card |
| MPL | Platinum MasterCard |
| MPM | Prepaid MasterCard Consumer Incentive Card |
| MPN | Prepaid MasterCard Insurance Card |
| MPO | Prepaid MasterCard Other Card |
| MPP | MasterCard Prepaid Embossed |
| MPR | Prepaid MasterCard Travel Card |
| MPV | Prepaid MasterCard Government Card |
| MPW | Prepaid MasterCard Workplace B2B Solutions |
| MPX | Prepaid MasterCard Flex Benefit Card |
| MPY | Prepaid MasterCard Employee Incentive Card |
| MRC | Prepaid MasterCard Electronic Card |
| MRD | Platinum Debit Mastercard Prepaid General Spend |
| MRF | Standard Deferred |
| MRG | Prepaid MasterCard Card |
| MRH | MasterCard Prepaid Platinum Travel Card |
| MRJ | Prepaid MasterCard Voucher Meal/Food Card |
| MRK | Prepaid MC Public Sector Commercial Card |
| MRL | Mastercard Prepaid Business Preferred |
| MRO | MasterCard Rewards Only |
| MRW | Prepaid MasterCard BusinessCard Card |
| MSB | Maestro Small Business |
| MSI | Maestro Card |
| MSI | MAESTRO |
| MTP | MasterCard Platinum Prepaid Travel |
| MUP | Platinum Debit MasterCard Unembossed |
| MUS | Prepaid MasterCard Unembossed |
| MVA | Mastercard B2B VIP 1 |
| MVB | Mastercard B2B VIP 2 |
| MVC | Mastercard B2B VIP 3 |
| MVD | Mastercard B2B VIP 4 |
| MVE | Mastercard B2B VIP 5 |
| MVF | Mastercard B2B VIP 6 |
| MVG | Mastercard B2B VIP 7 |
| MVC | Mastercard B2B VIP 3 |
| MVD | Mastercard B2B VIP 4 |
| MVE | Mastercard B2B VIP 5 |
| MVF | Mastercard B2B VIP 6 |
| MVG | Mastercard B2B VIP 7 |
| MVH | Mastercard B2B VIP 8 |
| MVJ | Mastercard B2B VIP 10 |
| MVK | Mastercard B2B VIP 11 |
| MVL | Mastercard B2B VIP 12 |
| MVM | Mastercard B2B VIP 13 |
| MVN | Mastercard B2B VIP 14 |
| MWB | World MasterCard for Business |
| MWE | World Elite MasterCard Card |
| MWF | Mastercard Humanitarian Prepaid |
| MWO | MasterCard Corporate World Card |
| MWP | Mastercard World Prepaid |
| MXG | Digital Enablement Program |
| OLB | Maestro Small Business |
| OLC | Prepaid MasterCard Commercial Card |
| OLR | Prepaid MasterCard Consumer Card |
| OLS | Maestro |
| PVL | Private Label |
| PVT | Private Label Trade Program |
| SAP | MasterCard Salary Platinum |
| SAS | MasterCard Salary Standard |
| SUR | Prepaid MasterCard Unembossed |
| TCB | Mastercard BusinessCard Card |
| TCC | MasterCard Mixed Product |
| TCG | Gold MasterCard |
| TCO | Mastercard Corporate Card |
| TCS | MasterCard Standard |
| TCW | World Elite Mastercard |
| TIC | ISIC MasterCard Student Card |
| TIU | MasterCard Unembossed |
| TNW | World MasterCard |
| TPC | MasterCard Professional Card |
| TPL | Platinum MasterCard |
| TWB | World MasterCard Black Edition |
| WBE | World MasterCard Black Edition |
| WDR | World Debit MasterCard Rewards |
| WMR | World MasterCard Rewards |
| WPD | World Prepaid Debit |