← Back to schema index

BinLookupResponse

Response from `GET /v1/public/bin-lookup/{bin}`. A single resource with the issuing SPEI bank resolved against the local `bin_directory` catalog (pure read, no external lookup). An unknown BIN returns `404`, not this body.

Properties

Field Type Description
type * string JSON:API resource type.
id * string The 6-8 digit BIN that matched in the catalog.
attributes * object Issuing bank and card metadata associated with the BIN.
bin * string The matched BIN (same value as `id`; 6-8 digits).
bank_name * string Canonical Banxico name of the issuing bank.
banxico_code * string 5-digit Banxico SPEI code of the issuing bank, or `null` when the issuer is not SPEI-routable (e.g. Amex, vouchers).
card_brand string Card network (VISA, MASTERCARD, …), or `null` if unknown.
card_type string Card type (CREDIT, DEBIT, PREPAID, …), or `null` if unknown.
card_level string Card level/tier (GOLD, PLATINUM, …), or `null` if unknown.
country_iso * string Issuing country as ISO-3166 alpha-2.

Variants

allOf

Used in operations

  • GET /v1/public/bin-lookup/{bin}