--- title: "Get card metadata" method: POST path: "/metadata/card" tags: ["Card metadata"] --- # Get card metadata `POST /metadata/card` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/metadata/card` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `vault:card-metadata` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Beta

Returns a single metadata record for the card specified by the Primary Account Number (PAN), Bank Identification Number (BIN), token, or instrument supplied. ## Request body - CardMetadataRequest - `source` union: The source object - CardMetadataRequestSourceCard: An existing payment source - `type` string, required: The source type - `number` string, required: The Primary Account Number (PAN) - CardMetadataRequestSourceBin: An existing payment source - `type` string, required: The source type - `bin` string, required: The issuer's Bank Identification Number (BIN) - CardMetadataRequestSourceToken: An existing payment source - `type` string, required: The source type - `token` string, required: The Checkout.com unique token that was generated when the card's details were tokenized - CardMetadataRequestSourceInstrument: An existing payment source - `type` string, required: The source type - `id` string, required: The unique ID for the payment instrument that was created using the card's details - `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. - `reference` string: A reference you can later use to identify this Payment Context. For example, an order number. ## Response `200` Metadata for the card number, BIN, token, or instrument ID provided - CardMetadataResponse: Card Metadata - `bin` string, required: The issuer's Bank Identification Number (BIN). Supports 6, 8, or 11 digit BINs. - `scheme` string, 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_schemes` string[]: 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 - `currency` string: The card billing currency, as a three-letter ISO-4217 currency code. - `issuer` string: The card issuer - `issuer_country` string: The card issuer's country, as an ISO-2 code - `issuer_country_name` string: The card issuer's country - `is_combo_card` boolean: Indicates whether the card is a combo credit and debit card. Applicable to Visa and Mastercard. - `product_id` string: The card issuer or scheme's product identifier - `product_type` string: The card issuer or scheme's product type - `subproduct_id` string: The card issuer or scheme's sub-product identifier - `regulated_indicator` boolean: 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_prepaid` boolean: 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. - `card_payouts` object: A card payouts block exists in the response if the format in the request is "card_payouts". - `domestic_non_money_transfer` 'not_supported' | 'standard' | 'fast_funds' | 'unknown': Describes whether the card is eligible for domestic non-money transfer transactions - `cross_border_non_money_transfer` 'not_supported' | 'standard' | 'fast_funds' | 'unknown': Describes whether the card is eligible for cross-border non-money transfer transactions - `domestic_gambling` 'not_supported' | 'standard' | 'fast_funds' | 'unknown': Describes whether the card is eligible for domestic gambling transactions - `cross_border_gambling` 'not_supported' | 'standard' | 'fast_funds' | 'unknown': Describes whether the card is eligible for cross-border gambling transactions - `domestic_money_transfer` 'not_supported' | 'standard' | 'fast_funds' | 'unknown': Describes whether the card is eligible for domestic money transfer transactions - `cross_border_money_transfer` 'not_supported' | 'standard' | 'fast_funds' | 'unknown': Describes whether the card is eligible for cross-border money transfer transactions - `scheme_metadata` object: Provides additional information about the scheme or local scheme's capabilities. It is sent if the card is issued in the US and can be used in a PINless debit network.
`scheme_metadata` is returned when you provide: - The full card number or - 11 digit bin - `accel` PinlessDebitSchemeMetadata[] - `network_id` string: The PINless debit network identifier - `network_description` string: The PINless debit network name - `bill_pay_indicator` boolean: Describes whether the card is eligible for bill payment transactions - `ecommerce_indicator` boolean: Describes whether the card is eligible for e-commerce transactions - `interchange_fee_indicator` string: The type of interchange fee used for transactions - `money_transfer_indicator` boolean: Describes whether the card is eligible for money transfer transactions - `token_indicator` boolean: True indicates that the card PAN is a DPAN, false indicates that it is a FPAN - `pulse` PinlessDebitSchemeMetadata[] - `network_id` string: The PINless debit network identifier - `network_description` string: The PINless debit network name - `bill_pay_indicator` boolean: Describes whether the card is eligible for bill payment transactions - `ecommerce_indicator` boolean: Describes whether the card is eligible for e-commerce transactions - `interchange_fee_indicator` string: The type of interchange fee used for transactions - `money_transfer_indicator` boolean: Describes whether the card is eligible for money transfer transactions - `token_indicator` boolean: True indicates that the card PAN is a DPAN, false indicates that it is a FPAN - `nyce` PinlessDebitSchemeMetadata[] - `network_id` string: The PINless debit network identifier - `network_description` string: The PINless debit network name - `bill_pay_indicator` boolean: Describes whether the card is eligible for bill payment transactions - `ecommerce_indicator` boolean: Describes whether the card is eligible for e-commerce transactions - `interchange_fee_indicator` string: The type of interchange fee used for transactions - `money_transfer_indicator` boolean: Describes whether the card is eligible for money transfer transactions - `token_indicator` boolean: True indicates that the card PAN is a DPAN, false indicates that it is a FPAN - `shazam` PinlessDebitSchemeMetadata[] - `network_id` string: The PINless debit network identifier - `network_description` string: The PINless debit network name - `bill_pay_indicator` boolean: Describes whether the card is eligible for bill payment transactions - `ecommerce_indicator` boolean: Describes whether the card is eligible for e-commerce transactions - `interchange_fee_indicator` string: The type of interchange fee used for transactions - `money_transfer_indicator` boolean: Describes whether the card is eligible for money transfer transactions - `token_indicator` boolean: True indicates that the card PAN is a DPAN, false indicates that it is a FPAN - `star` PinlessDebitSchemeMetadata[] - `network_id` string: The PINless debit network identifier - `network_description` string: The PINless debit network name - `bill_pay_indicator` boolean: Describes whether the card is eligible for bill payment transactions - `ecommerce_indicator` boolean: Describes whether the card is eligible for e-commerce transactions - `interchange_fee_indicator` string: The type of interchange fee used for transactions - `money_transfer_indicator` boolean: Describes whether the card is eligible for money transfer transactions - `token_indicator` boolean: True indicates that the card PAN is a DPAN, false indicates that it is a FPAN - `account_funding_transaction` AccountFundingTransaction: Account Funding Transaction - `aft_indicator` object: Describes whether the card is eligible for Account Funding Transactions - `pull_funds` PullFunds: Describes whether the card is eligible to take funds from different accounts to fund other non-merchant accounts - `cross_border` boolean: Describes whether the card is eligible for Account Funding Transactions between accounts in different countries - `domestic` boolean: Describes whether the card is eligible for Account Funding Transactions between accounts in the same country ## Other responses - `401`: Unauthorized - `404`: Card Metadata not found - `415`: Unsupported Media Type - `422`: Invalid data was sent - `500`: Internal Server Error - `502`: Bad Gateway - `504`: Gateway Timeout --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)