Skip to content
Passed

Card BIN Data (1)

Retrieve detailed information about a card.

Header

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

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

You must use the Authorization header for any request you send to our Card BIN Data 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. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Worldpay

Languages
Servers
Try

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

Live

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

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.

entitystring[ 1 .. 64 ] characters^[A-Za-z0-9]*$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
cardNumberstring^\d{12,19}$required

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

Example: "4444333322221111"
application/json
{
  "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"airplus""allstar""amex""argencard""aurore""bc""cabal""carnet""cartesBancaires""cencosud"
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
application/json
{
  "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"
}