← 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
`data`	`object`	Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
`type`*	`string`	API resource type (`bin_lookup` by default).
`id`*	`string`	The 6-8 digit BIN that matched in the lookup.
`attributes`*	`object`	Attributes of the BIN and the associated bank.
`bin`*	`string`	The 6-8 digit BIN that matched in the lookup (same value as `id`).
`bank_name`*	`string`	Official name of the banking institution.
`banxico_code`*	`string \| null`	5-digit code of the banking institution in the SPEI system, or `null` when the bank is not a SPEI participant (e.g. Amex).
`card_brand`	`string \| null`	Card network (VISA, MASTERCARD, …), or `null` if unknown.
`card_type`	`string \| null`	Card type (CREDIT, DEBIT, PREPAID, …), or `null` if unknown.
`card_level`	`string \| null`	Card level (GOLD, PLATINUM, …), or `null` if unknown.
`country_iso`*	`string`	Issuing country code (in ISO-3166 alpha-2).
`meta`	`object`	Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
`version`	`string`	API version that processed the request.
`api_version`	`string`	API route prefix version (e.g. `v1`).
`request_id`	`string`	Unique request identifier (hex).
`datetime`	`object`	Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec.
`timezone`*	`string`	Always `UTC` — the canonical timezone for every datetime field in the body.
`format`*	`string`	Always `ISO 8601` — explicit `Z` suffix on every datetime.
`links`	`object`	Pagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

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