CHcheckout
Card metadata

Get card metadata

<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p> Returns a single metadata record for the card specified by the Primary Account Number (PAN), Bank Identification Number (BIN), token, or instrument supplied.

post/metadata/card

Request

Request body

format'basic' | 'card_payouts'

The format to provide the output in.

A basic response will only include standard metadata, while a card_payouts formatted response will also include fields specific to card payouts.

referencestring

A reference you can later use to identify this Payment Context. For example, an order number.

Example request

{
  "source": {
    "type": "card",
    "number": "4543474002249996"
  },
  "format": "basic",
  "reference": "ORD-5023-4E89"
}

Response

Metadata for the card number, BIN, token, or instrument ID provided

binstring required

The issuer's Bank Identification Number (BIN). Supports 6, 8, or 11 digit BINs.

schemestring required

The global card scheme. For example, "american_express", "cartes_bancaires", "diners_club_international", "discover", "eftpos", "jcb", "mastercard", or "visa".

scheme_local'cartes_bancaires' | 'mada' | 'omannet'

Replaced by local_schemes. The local card scheme, if the card is co-branded.

local_schemesstring[]

The local card scheme or schemes, if the card is co-branded.

card_type'CREDIT' | 'DEBIT' | 'PREPAID' | 'CHARGE' | 'DEFERRED DEBIT' | 'NETWORK TOKEN'

The card type

card_category'CONSUMER' | 'COMMERCIAL'

The card category

currencystring

The card billing currency, as a three-letter ISO-4217 <a href="https://www.checkout.com/docs/developer-resources/testing/codes/currency-codes" target="blank">currency code</a>.

issuerstring

The card issuer

issuer_countrystring

The card issuer's country, as an ISO-2 code

issuer_country_namestring

The card issuer's country

is_combo_cardboolean

Indicates whether the card is a combo credit and debit card. Applicable to Visa and Mastercard.

product_idstring

The card issuer or scheme's product identifier

product_typestring

The card issuer or scheme's product type

subproduct_idstring

The card issuer or scheme's sub-product identifier

regulated_indicatorboolean

Specifies whether the card is assigned to an interchange regulated BIN range

regulated_type'base_regulated' | 'fraud_protected_regulated'

The type of the interchange regulated card BIN range

is_reloadable_prepaidboolean

Indicates whether the prepaid bank identification number (BIN) is reloadable.

anonymous_prepaid_description'Anonymous prepaid program and not AMLD5 compliant' | 'Anonymous prepaid program and AMLD5 compliant' | 'Not prepaid or non-anonymous prepaid program/default'

The description of the prepaid BIN, specifying if it's an anonymous prepaid card.

Example response

{
  "bin": "45434720",
  "scheme": "visa",
  "scheme_local": "cartes_bancaires",
  "local_schemes": [
    "cartes_bancaires",
    "upi"
  ],
  "card_type": "CREDIT",
  "card_category": "CONSUMER",
  "currency": "MUR",
  "issuer": "STATE BANK OF MAURITIUS",
  "issuer_country": "MU",
  "issuer_country_name": "Mauritius",
  "is_combo_card": true,
  "product_id": "CLASSIC",
  "product_type": "F",
  "subproduct_id": "VA",
  "regulated_indicator": true,
  "regulated_type": "base_regulated",
  "is_reloadable_prepaid": true,
  "anonymous_prepaid_description": "Anonymous prepaid program and not AMLD5 compliant",
  "card_payouts": {
    "domestic_non_money_transfer": "not_supported",
    "cross_border_non_money_transfer": "standard",
    "domestic_gambling": "fast_funds",
    "cross_border_gambling": "unknown",
    "domestic_money_transfer": "not_supported",
    "cross_border_money_transfer": "not_supported"
  },
  "scheme_metadata": {
    "accel": [
      {
        "network_id": "aam",
        "network_description": "Accel Money Transfer Advantage",
        "bill_pay_indicator": true,
        "ecommerce_indicator": true,
        "interchange_fee_indicator": "00",
        "money_transfer_indicator": true
      }
    ],
    "pulse": [
      {
        "network_id": "aam",
        "network_description": "Accel Money Transfer Advantage",
        "bill_pay_indicator": true,
        "ecommerce_indicator": true,
        "interchange_fee_indicator": "00",
        "money_transfer_indicator": true
      }
    ],
    "nyce": [
      {
        "network_id": "aam",
        "network_description": "Accel Money Transfer Advantage",
        "bill_pay_indicator": true,
        "ecommerce_indicator": true,
        "interchange_fee_indicator": "00",
        "money_transfer_indicator": true
      }
    ],
    "shazam": [
      {
        "network_id": "aam",
        "network_description": "Accel Money Transfer Advantage",
        "bill_pay_indicator": true,
        "ecommerce_indicator": true,
        "interchange_fee_indicator": "00",
        "money_transfer_indicator": true
      }
    ],
    "star": [
      {
        "network_id": "aam",
        "network_description": "Accel Money Transfer Advantage",
        "bill_pay_indicator": true,
        "ecommerce_indicator": true,
        "interchange_fee_indicator": "00",
        "money_transfer_indicator": true
      }
    ]
  },
  "account_funding_transaction": {
    "aft_indicator": {
      "pull_funds": {
        "cross_border": true,
        "domestic": true
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.