← Back to schema index

BinResource

A BIN resolution result from the local `bin_directory` catalog, in JSON:API shape. `id` and `attributes.bin` are equal: the 6-8 digit BIN that actually matched (never the full number the caller sent).

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringAPI resource type (`bin_lookup` by default).
id*stringThe 6-8 digit BIN that matched in the lookup.
attributes*objectAttributes of the BIN and the associated bank.
bin*stringThe 6-8 digit BIN that matched in the lookup (same value as `id`).
bank_name*stringOfficial name of the banking institution.
banxico_code*string | null5-digit code of the banking institution in the SPEI system, or `null` when the bank is not a SPEI participant (e.g. Amex).
card_brandstring | nullCard network (VISA, MASTERCARD, …), or `null` if unknown.
card_typestring | nullCard type (CREDIT, DEBIT, PREPAID, …), or `null` if unknown.
card_levelstring | nullCard level (GOLD, PLATINUM, …), or `null` if unknown.
country_iso*stringIssuing country code (in ISO-3166 alpha-2).

Used in operations

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

Referenced by schemas