BIN lookup service API

BIN lookup service API (1.0.0)

This is an API reference for the BIN lookup service.

Download OpenAPI description

bin-lookup.json

bin-lookup.yaml

Servers

Production environment

https://api-services.pxp.io/api/v1/

Sandbox environment

https://api-services.test.pxp.io/api/v1/

BIN lookup

Request

Perform a BIN (Bank Identification Number) lookup using a card's PAN (Primary Account Number). This will return high-level data about the card, such as the issuer, card type, and funding source. For more details, use the extended endpoint.

Bodyapplication/jsonrequired

primaryAccountNumberstringrequired

The unique number assigned to a payment card, such as a credit or debit card. This number typically contains 16 digits, structured in a specific format to indicate the card network, issuing bank, and account number.

Example: "4111111111111111"

curl -i -X POST \
  https://api-services.pxp.io/api/v1/bin-recognition/bin-range-lookup \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryAccountNumber": "4111111111111111"
  }'

Responses

Success

Bodyapplication/json

fromBininteger(int64)

The starting number of the BIN range. This information helps businesses identify the first number in a series of card numbers issued by a single card issuer, aiding in card validation and fraud detection.

Example: 41110000

toBininteger(int64)

The ending number of the BIN range. This detail is crucial for determining the scope of card numbers associated with a specific card issuer, enabling accurate card verification.

Example: 41112099

issuerNamestring

The name of the financial institution that issued the card. This information is essential for transaction authentication and understanding the issuer's reputation and reliability.

issuerCountryCodestring= 3 characters

The country code of the card issuer, in ISO 3166-1 alpha-3 format. This is important for you to manage cross-border transactions, comply with regional regulations, and understand the geographical distribution of their customer base.

Example: "840"

issuerMemberIdstring

A unique identifier for the card issuer member. This aids in distinguishing between different entities within the same financial network for advanced transaction processing.

Example: "BofA-V1234567"

cardSchemestring^[A-Z]

The card network (e.g., Visa, MasterCard). This is essential for processing transactions according to the specific card scheme's guidelines and for compatibility with payment gateways.

Example: "Visa"

fundingSourcestring

The type of funding for the card (e.g., credit, debit). This can help you tailor payment options and understand the customer's spending behaviour.

Enum"Credit""Debit""Prepaid"

Example: "Credit"

ownerTypestring

The type of owner. Identifies if the card is owned by an consumer or a commercial entity. This is useful for personalisation of services and risk management in transaction processing.

Enum"Consumer""Commercial"

currencyCodestring= 3 characters

The currency associated with the card, in ISO 4217 format.

Example: "EUR"

binLengthnumber

The length of the BIN number. This information is vital for validating the format of the card number and ensuring compliance with industry standards.

Example: 8

gamingCreditSupportedboolean or null

Whether the card supports gaming credits. This is particularly relevant for businesses in the gaming industry for payment option compatibility.

productNamestring

The name of the product.

Example: "Debit Plus"

productTargetstring

The target market or region for the product.

Example: "USA"

isAnonymousProductboolean or null

Whether the product is anonymous.

Example: true

rangeTypestring

The type of range associated with the product.

Example: "none"

Response

application/json

{
  "fromBin": 441690000000000000,
  "toBin": 441691000000000000,
  "cardScheme": "Visa",
  "issuerName": "UCBF",
  "issuerCountryCode": "USD",
  "issuerMemberId": "Test Bank",
  "cardType": "Visa",
  "fundingSource": "Credit",
  "ownerType": "Individual",
  "currencyCode": "USD",
  "binLength": 8,
  "gamingCreditSupported": true,
  "productName": "Debit Plus",
  "productTarget": "USA",
  "isAnonymousProduct": true,
  "rangeType": "none"
}

BIN lookup (extended)

Request

Perform an extended BIN (Bank Identification Number) lookup using a card's PAN (Primary Account Number). This will return detailed information about the card, including the issuer, card type, and funding source. For high-level data, use the standard endpoint.

Bodyapplication/jsonrequired

primaryAccountNumberstringrequired

Example: "4111111111111111"

curl -i -X POST \
  https://api-services.pxp.io/api/v1/bin-recognition/bin-range-lookup/extended \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryAccountNumber": "4111111111111111"
  }'

Responses

Success

Bodyapplication/json

fromBininteger(int64)

Example: 41110000

toBininteger(int64)

The ending number of the BIN range. This detail is crucial for determining the scope of card numbers associated with a specific card issuer, enabling accurate card verification.

Example: 41112099

issuerNamestring

The name of the financial institution that issued the card. This information is essential for transaction authentication and understanding the issuer's reputation and reliability.

issuerCountryCodestring= 3 characters

Example: "840"

issuerMemberIdstring

A unique identifier for the card issuer member. This aids in distinguishing between different entities within the same financial network for advanced transaction processing.

Example: "BofA-V1234567"

cardSchemestring^[A-Z]

The card network (e.g., Visa, MasterCard). This is essential for processing transactions according to the specific card scheme's guidelines and for compatibility with payment gateways.

Example: "Visa"

fundingSourcestring

The type of funding for the card (e.g., credit, debit). This can help you tailor payment options and understand the customer's spending behaviour.

Enum"Credit""Debit""Prepaid"

Example: "Credit"

ownerTypestring

The type of owner. Identifies if the card is owned by an consumer or a commercial entity. This is useful for personalisation of services and risk management in transaction processing.

Enum"Consumer""Commercial"

currencyCodestring= 3 characters

The currency associated with the card, in ISO 4217 format.

Example: "EUR"

binLengthnumber

The length of the BIN number. This information is vital for validating the format of the card number and ensuring compliance with industry standards.

Example: 8

gamingCreditSupportedboolean or null

Whether the card supports gaming credits. This is particularly relevant for businesses in the gaming industry for payment option compatibility.

productNamestring

The name of the product.

Example: "Debit Plus"

productTargetstring

The target market or region for the product.

Example: "USA"

isAnonymousProductboolean or null

Whether the product is anonymous.

Example: true

rangeTypestring

The type of range associated with the product.

Example: "none"

extendedDataobject

Additional details about the Bank Identification Number (BIN).

Response

application/json

{
  "fromBin": 441690000000000000,
  "toBin": 441691000000000000,
  "cardScheme": "Visa",
  "issuerName": "UCBF",
  "issuerCountryCode": "USD",
  "issuerMemberId": "Test Bank",
  "cardType": "Visa",
  "fundingSource": "Credit",
  "ownerType": "Individual",
  "currencyCode": "USD",
  "binLength": 8,
  "gamingCreditSupported": true,
  "productName": "Debit Plus",
  "productTarget": "USA",
  "isAnonymousProduct": true,
  "rangeType": "none",
  "extendedData": {
    "issuerBin": 441690,
    "issuerName": "Bank of America",
    "binLength": 6,
    "minPanLength": 15,
    "maxPanLength": 15,
    "cashbackEligibility": "N",
    "tokenIndicator": "N",
    "productRegulationValue": "NA",
    "lastUpdate": "2007-01-29",
    "cpsOption": "N",
    "productType": "Commercial",
    "productTypeId": "Commercial",
    "countryCodeNumeric": "840"
  }
}

BIN lookup service API (1.0.0)

BIN lookup

Request

Responses

Was this helpful?

BIN lookup (extended)

Request

Responses

Was this helpful?