Card BIN Data (20230808)

Download OpenAPI specification:Download

License: Worldpay

The Card BIN Data API provides detailed information about a card.

Servers

Try

https://try.access.worldpay.com/api/

Live

https://access.worldpay.com/api/

Get BIN data

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

SecurityHTTP: BasicAuth
Request
header Parameters
WP-Api-Version
required
string

The API version

Enum: "2023-06-01" "2023-11-15"
Example: 2023-06-01
Request Body schema: application/json

Lookup details

One of:

Lookup details

required
object (merchant)

An object that contains information about the merchant and API level configuration.

cardNumber
required
string^\d{12,19}$

The Primary Account Number (PAN).
Supports full card numbers and network tokens.

Example: 4444333322221111
post
/cardBin/panLookup
Request samples
application/json
{ "merchant": { "entity": "MindPalaceLtd" }, "cardNumber": "4444333322221111" }
Responses

200

Request Successful

Response Headers
WP-CorrelationId
string

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

Example: "4c195ce9-3dbd-4bc8-9c94-3d3393842323"
Response Schema: application/json
type
string

The type of account number provided

Enum: "pan" "networkToken"
Example: "pan"
brand
Array of strings

Brand of the card

Items Enum: "airplus" "allstar" "amex" "argencard" "aurore" "bc" "cabal" "carnet" "cartesBancaires" "cencosud" "unionPay" "coopeplus" "credimas" "dankort" "diners" "discover" "mastercard" "eftpos" "elo" "hana" "hipercard" "hyundai" "italcred" "jcb" "keyfuels" "kookmin" "lotte" "maestro" "naranja" "nativa" "nevada" "nexo" "nonghyup" "overdrive" "samsung" "sears" "shinhan" "sorocred" "supercharge" "tarjeta" "troy" "uatp" "visa"
Example: "visa"
bin
string

Bank Identification Number

Example: 444422
binLength
integer

Length of the BIN

Example: 6
fundingType
string

Funding source of the card

Enum: "credit" "debit" "prepaid" "chargeCard" "deferredDebit"
Example: "credit"
issuerName
string

Card issuer name

Example: "Bank of America"
countryCode
string

Card issuer country, ISO alpha-2 or unknown

Example: "US"
currency
string

Currency of the card, ISO alpha-3

Example: "USD"
dccAllowed
boolean

Is Dynamic Currency Converstion (DCC) permitted

Example: true
anonymousPrepaid
string

Anonymous prepaid program and AMLD5 compliance

Enum: "anonymousNonCompliant" "anonymousCompliant" "notPrepaidOrNonAnonomous" "unknown"
Example: "notPrepaidOrNonAnonomous"
category
string

Card category

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

400

Bad Request

401

Client is not authorized due to missing or invalid Authorization header.

404

Not Found

415

Invalid content-type HTTP header

500

An error occurred processing the request on our side.

Response samples
application/json
{ "type": "pan", "brand": [ "visa" ], "bin": "444433", "binLength": 6, "fundingType": "debit", "issuerName": "Bank of America", "countryCode": "US", "currency": "USD", "dccAllowed": true, "anonymousPrepaid": "notPrepaidOrNonAnonomous", "category": "consumer" }