Metadata Inquiries

Request card metadata based on PAN, PCI tokens, or network tokens.

Metadata inquiries are an add-on feature and may be subject to extra charges.

Overview

Metadata inquiries allow you to retrieve information about the card and the issuing bank. It is useful for various validation and routing scenarios.

Supported Sources

You can request metadata from:

Source	Description
`pan`	Direct card number lookup (it does not even require a token to be present)
`pci_token`	Metadata lookup using existing PCI tokens
`network_token`	Metadata lookup using network tokens

A lookup by pan requires SAQ-D+ compliance; otherwise it returns a 403. A lookup by network_token returns the metadata of the card the token was provisioned for, so bin is the BIN of the card, not of the token. If the Metadata Inquiries add-on is not enabled on your instance (see Plans & Access), the endpoint returns a 403.

Returned Data

Create inquiry returns the following fields:

Field	Description
`bin`	The bank identification number of the card.
`schemes`	The card brands, for example `visa` or `mastercard`. A co-branded card returns more than one.
`type`	The funding type: `credit`, `debit`, `prepaid`, `charge`, `deferred`, or `unknown`.
`segment`	`consumer` or `commercial`.
`currency_code`	The currency of the card, as a three-letter ISO 4217 code.
`issuer_name`	The name of the issuing bank.
`issuer_country_code`	The country of the issuer, as a two-letter ISO 3166-1 alpha-2 code.

bin and schemes are always returned. The other fields depend on the data available for the card.

{
  "bin": "411111",
  "schemes": ["visa"],
  "type": "credit",
  "segment": "consumer",
  "currency_code": "EUR",
  "issuer_name": "Starfish Bank",
  "issuer_country_code": "DE"
}

Use Cases

Card Display: Show more details about the card in user interfaces
Validation: Verify card details before processing
Routing: Determine payment routing based on card metadata
Analytics: Gather insights about card usage patterns

Getting Started

Features

Management

Migrations

Overview

Supported Sources

Returned Data

Use Cases

​Overview

​Supported Sources

​Returned Data

​Use Cases

Overview

Supported Sources

Returned Data

Use Cases