Payments
Insights

BIN Lookup

Performs a BIN lookup for the provided card number and retrieves associated information such as the card brand, country, issuer, and more.

post/payments/bin-lookups

Request

Request body

numberstring required

The card number for which the BIN lookup is being requested. It can be a plaintext Card number (FPAN) / Network Token number (DPAN), an encrypted Card number / Network Token number or simply just a BIN (6-10 first digits of a Card Number) for range lookup.

externalCustomerReferencestring

An optional reference of your choice, such as a correlation ID, that is attached to the request. The reference will be visible in your logs. Must be between 1 and 255 characters.

Example request

{
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

Returns BIN details for the provided card number.

idstring required

The unique identifier for the BIN lookup

brand'visa' | 'mastercard' | 'american-express' | 'discover' | 'diners-club' | 'jcb' | 'unionpay'

The card brand associated with the payment card.

funding'debit' | 'credit' | 'prepaid' | 'deferred-debit' | 'charge'

The card funding type specifies the method by which transactions are financed.

segment'consumer' | 'commercial' | 'business' | 'government' | 'payouts' | 'all'

The card segment indicates the primary market or usage category of the card.

countrystring iso-3166-1-alpha-2

The country associated with the card.

currencystring

The currency associated with the card (ISO 4217)

issuerstring

The name of the issuer bank

type'null' | 'card' | 'network-token' nullable

Type of card range identified during the lookup

productNamestring

The name of the product associated with the card

matchPrecisionnumber

Indicates how many leading digits of the submitted BIN are confirmed by the matched data. A higher value means a more specific match. When multiple matches are found, the value represents the least precise BIN range the submitted BIN could belong to.

createdAtinteger required

Unix timestamp of when the BIN lookup was created

Example response

{
  "id": "bin_lookup_1234567890",
  "brand": "visa",
  "funding": "credit",
  "segment": "consumer",
  "country": "gb",
  "currency": "gbp",
  "issuer": "Gringotts Wizarding Bank and Trust Company",
  "productName": "Visa Debit",
  "fastFunds": {
    "domestic": true,
    "crossBorder": false
  },
  "type": "card",
  "createdAt": 169297262323
}

Changes

No recorded changes to this operation across all 1 revision of this API.