Skip to content
APIs/Card BIN Data/
Get BIN data

Get BIN data

Request

Returns card BIN data for the card number or Worldpay token supplied.

Security
BasicAuth
Headers
WP-Api-Versioninteger, >= 1required

The API version.

Example:1
Bodyapplication/jsonrequired

Lookup details.

One of:

Lookup details.

merchantobjectrequired

An object that contains information about the merchant.

cardNumberstring^\d{12,19}$required

Primary Account Number (PAN) and Network Token Number are accepted.

Example:"4444333322221111"
{
  "merchant": {
    "entity": "default"
  },
  "cardNumber": "4444333322221111"
}

Responses

Request Successful

Headers
WP-CorrelationIdstring

Generated identifier for the request and response. When contacting support please include this.

Example:"4c195ce9-3dbd-4bc8-9c94-3d3393842323"
WP-Api-Versionstring

The complete API Version is returned in the WP-Api-Version HPP Header. It contains the Major, Minor and Patch details of API Version.

Example:"1.1.20240411"
Bodyapplication/json
typestring

The type of account number provided.

Enum:"pan""networkToken"
Example:"pan"
brandArray of strings

Brand of the card. For co-branded cards multiple brands are returned.

Items Enum:"accel""affn""airplus""allstar""amex""argencard""ath""aurore""bc""cabal"
Example:
[
  "visa"
]
binstring

Bank Identification Number.

Example:"444422"
binLengthinteger

Length of the BIN.

Example:6
fundingTypestring

Funding source of the card.

Enum:"credit""debit""prepaid""chargeCard""deferredDebit""unknown"
Example:"credit"
issuerNamestring

Card issuer name.

Example:"Bank of America"
countryCodestring

Card issuer country in ISO alpha-2 format or unknown.

Example:"US"
currencystring

Currency of the card in ISO alpha-3 format.

Example:"USD"
dccAllowedboolean

Sets whether Dynamic Currency Conversion (DCC) is permitted.

Example:true
anonymousPrepaidstring

Anonymous prepaid program and AMLD5 compliance.

Enum:"anonymousNonCompliant""anonymousCompliant""notPrepaidOrNonAnonymous""unknown"
Example:"notPrepaidOrNonAnonymous"
categorystring

The card category.

Enum:"commercial""consumer"
Example:"consumer"
multipleAccountAccessstring

Participation in Visa multiple-account access. Managed cardholder choices are stored with Visa and self-serve with the issuer.

Enum:"managed""selfServe""notParticipating""notSupported"
Example:"managed"
Response
{
  "type": "pan",
  "brand": [
    "visa"
  ],
  "bin": "444433",
  "binLength": 6,
  "fundingType": "debit",
  "issuerName": "Bank of America",
  "countryCode": "US",
  "currency": "USD",
  "dccAllowed": true,
  "anonymousPrepaid": "notPrepaidOrNonAnonymous",
  "category": "consumer",
  "multipleAccountAccess": "managed"
}