Checkout.com API logo

Card metadata

Get card metadata

Beta

Returns a single metadata record for the card specified by the Primary Account Number (PAN), Bank Identification Number (BIN), token, or instrument supplied.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
Request Body schema: application/json
object (CardMetadataRequestSource)

The source object

format
string
Default: "basic"

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.

Enum: "basic" "card_payouts"
reference
string

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

Responses
200

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

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

post/metadata/card
Request samples
application/json
{
  • "source": {
    },
  • "format": "basic"
}
Response samples
application/json
{
  • "bin": "45434720",
  • "scheme": "visa",
  • "local_schemes": [
    ],
  • "card_type": "CREDIT",
  • "card_category": "CONSUMER",
  • "currency": "MUR",
  • "issuer": "STATE BANK OF MAURITIUS",
  • "issuer_country": "MU",
  • "issuer_country_name": "Mauritius",
  • "is_combo_card": false,
  • "product_id": "F",
  • "product_type": "Visa Classic",
  • "subproduct_id": "VA",
  • "regulated_indicator": false,
  • "is_reloadable_prepaid": false,
  • "anonymous_prepaid_description": "Anonymous prepaid program and not AMLD5 compliant"
}
➔ Next to Network Tokens