Lookup BIN data using 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

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.

paymentInstrumentobjectrequired

{
  "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, Visa Direct Account Funding Transaction eligibility and Visa (Direct) and Mastercard (Send) payout support.

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

panLengthinteger

Expected length of the Primary Account Number. A value of 0 indicates the PAN length is variable for this BIN range.

Example:16

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 Value	Description
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"

productIdstring

Scheme product identifier assigned by the card scheme. Can be used to determine card product tier and support interchange cost analysis. Values are scheme-defined and subject to change.

Example:"A"

productSubTypestring

Scheme product sub-type providing further classification within a product, for example agriculture or healthcare segments for Visa. Values are scheme-defined, subject to change, and not consistent across schemes.

Example:"HC"

flexibleCredentialobject

Visa Flexible Credential and Mastercard One Credential participation.

accountFundingTransactionsobject

Visa Direct Account Funding Transaction (AFT) eligibility for this BIN. AFTs are used to pull funds from a Visa card account to fund a push payment (OCT) to another account. Check these flags before initiating a Visa Direct pull payment to determine whether the transaction is permitted for this card.

payoutsobject

Supported payout capabilities for Visa and Mastercard. This object is omitted when payout information is not applicable to the scheme or when capability data is unavailable.

Response

{
  "type": "networkToken",
  "brand": [
    "visa"
  ],
  "bin": "491183",
  "binLength": 6,
  "panLength": 16,
  "fundingType": "debit",
  "issuerName": "Bank of America",
  "countryCode": "US",
  "currency": "USD",
  "dccAllowed": false,
  "anonymousPrepaid": "notPrepaidOrNonAnonymous",
  "category": "consumer",
  "productId": "A",
  "productSubType": "HC",
  "flexibleCredential": {
    "participating": false
  },
  "accountFundingTransactions": {
    "domestic": "supported",
    "crossBorder": "notSupported"
  }
}