Skip to content
APIs/Card BIN Data/Card Lookup

Card BIN Data (2)

Lookup card metadata from a Primary Account Number (PAN), Network Token Number, or Worldpay token href.

Returns: card brand(s), BIN and BIN length, PAN length, funding type, issuer name, issuer country (ISO alpha-2), default currency (ISO alpha-3), DCC eligibility, anonymous prepaid / AMLD5 compliance status, card category (consumer or commercial), product ID, product subtype, flexible credential participation including the Visa deployment model and account funding transactions support for domestic and cross-border.

Set your headers

  Authorization: {your_credentials}
  Content-Type: application/json
  WP-Api-Version: 2

Replace {your_credentials} with your base64-encoded Basic Auth username:password given to you by your Implementation Manager.

We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT.

We use the WP-Api-Version header to identify which version of our API you are using. You must use this header for any request you send to our Card BIN API.

DNS whitelisting
Whitelist the following URLs:
* https://try.access.worldpay.com/
* https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Test (Try) - use for integration and QA
https://try.access.worldpay.com
Live - use for production traffic
https://access.worldpay.com

Card Lookup

Lookup card metadata by PAN, Network Token Number, or Worldpay token.

Operations

Lookup BIN data for a card number or Worldpay token

Request

Returns card metadata for the supplied payment instrument. This is a read-only lookup with no side effects - safe to retry on network errors.

Security
basicAuth
Headers
WP-Api-Versioninteger[ 2 .. 2 ]required

API major version number. Must be 2.

Example: 2
Bodyapplication/jsonrequired

Provide a paymentInstrument with type card (PAN or Network Token Number, 12-19 digits) or type token (Worldpay token href). The merchant.entity field identifies your routing entity; use the value assigned during on-boarding.

merchantobjectrequired

Identifies the merchant entity for request routing. The entity value is assigned during on-boarding.

entitystring[ 1 .. 64 ] characters^(?! )[ \-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`\/+]...required

Merchant routing entity name assigned during on-boarding. Supports alphanumeric characters and the following special characters: space (not leading or trailing), hyphen, underscore, and common punctuation.

Example: "default"
paymentInstrumentobjectrequired

Use the card variant when you have a raw PAN or Network Token Number. Use the token variant when you have a Worldpay token href.

typestringrequired

Discriminator value identifying this as a card number lookup.

Value"card"
Discriminator
numberstring[ 12 .. 19 ] characters^\d+$required

Primary Account Number (PAN) or Network Token Number. Must be 12–19 digits. Do not include spaces or dashes.

Example: "4444333322221111"
application/json
{
  "merchant": {
    "entity": "default"
  },
  "paymentInstrument": {
    "type": "card",
    "number": "4444333322221111"
  }
}

Responses

BIN lookup succeeded. Response contains card metadata including brand, BIN and BIN length, PAN length, funding type, issuer details, DCC eligibility, AMLD5 status, card category, scheme product ID and sub-type, flexible credential participation, and Visa Direct Account Funding Transaction eligibility.

Headers
WP-CorrelationIdstring

Unique request/response correlation ID. Include in support tickets when reporting issues.

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

Full API version (major.minor.patch) used to process the request.

Example: "2.0.20260327"
Bodyapplication/json
typestring

Indicates whether the card belongs to a tokenized issuer range.

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

Card brand(s). Co-branded cards return multiple values.

This list may grow as new schemes are added. Treat unrecognised values as valid strings and handle them gracefully rather than failing.

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

Bank Identification Number extracted from the card. Capped at 8 digits to protect PCI-sensitive data where the BIN length exceeds 8 digits. Use binLength to determine the full BIN length for this card.

Example: "444422"
binLengthinteger

Number of digits in the BIN (typically 6 or 8).

Example: 6
fundingTypestring

Funding source of the card. Use to select the correct interchange category, apply surcharging rules, or restrict card acceptance by type.

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

Name of the card-issuing bank or financial institution.

Example: "Bank of America"
countryCodestring

ISO 3166-1 alpha-2 country code of the card issuer. Use for cross-border fee logic or geographic restrictions.

Example: "US"
currencystring

ISO 4217 alpha-3 default currency of the card. Use together with dccAllowed to determine whether to offer Dynamic Currency Conversion.

Example: "USD"
dccAllowedboolean

true if Dynamic Currency Conversion may be offered to the cardholder for this card. Always check this flag before presenting a DCC offer.

Example: true
anonymousPrepaidstring

AMLD5 anonymous prepaid status.

Enum ValueDescription
notPrepaidOrNonAnonymous

No AMLD5 concern.

anonymousCompliant

Anonymous prepaid but AMLD5-compliant.

anonymousNonCompliant

Anonymous prepaid and non-compliant; block if your compliance policy requires it.

unknown

Status could not be determined.

Example: "notPrepaidOrNonAnonymous"
categorystring

Whether the card is a commercial (business) or consumer card.

Enum"commercial""consumer"
Example: "consumer"
Response
application/json
{
  "type": "networkToken",
  "brand": [
    "visa"
  ],
  "bin": "491183",
  "binLength": 6,
  "fundingType": "debit",
  "issuerName": "Bank of America",
  "countryCode": "US",
  "currency": "USD",
  "dccAllowed": false,
  "anonymousPrepaid": "notPrepaidOrNonAnonymous",
  "category": "consumer"
}