Examples: Requests to the BIN Lookup Service Using the REST API

These examples show various BIN lookup requests and successful responses.

Request Example: BIN Lookup Service with a Full Payment Card Number

{
  "paymentInformation": {
    "card": {
      "number": "4111111111111111"
    }
  }
}

Response 201 Example: Successful BIN Lookup Service with a Full Payment Card Number

{
  "id": "7187318127246929204951",
  "submitTimeUtc": "2024-06-18T05:30:12Z",
  "status": "COMPLETED",
  "paymentAccountInformation": {
    "card": {
      "type": "001",
      "brandName": "VISA",
      "maxLength": "16",
      "credentialType": "PAN"
    },
    "features": {
      "accountFundingSource": "DEBIT",
      "cardPlatform": "CONSUMER",
      "cardProduct": "Visa Classic"
    }
  },
  "issuerInformation": {
    "name": "CONOTOXIA SP. Z O.O",
    "country": "PL",
    "binLength": "6",
    "accountPrefix": "41111111"
  }
}

Request Example: BIN Lookup Service with a Health Card Number

{
  "paymentInformation": {
    "card": {
      "number": "4288900100000"
    }
  }
}

Response 201 Example: Successful BIN Lookup Service with a Health Card Number

{
  "id": "7187371922356613504951",
  "submitTimeUtc": "2024-06-18T06:59:52Z",
  "status": "COMPLETED",
  "paymentAccountInformation": {
    "card": {
      "type": "001",
      "brandName": "VISA",
      "maxLength": "16",
      "currency": "USD",
      "credentialType": "PAN"
    },
    "features": {
      "accountFundingSource": "CREDIT",
      "cardPlatform": "COMMERCIAL",
      "cardProduct": "Visa Purchasing",
      "healthCard": true
    }
  },
  "issuerInformation": {
    "name": "BANKUNITED, NATIONAL ASSOCIATION",
    "country": "US",
    "binLength": "6",
    "accountPrefix": "42889001"
  }
}

Request Example: BIN Lookup Service with a Network Token

{
  "paymentInformation": {
    "card": {
      "number": "4895370016313691"
    }
  }
}

Response 201 Example: Successful BIN Lookup Service with a Network Token

{
  "id": "6680880793396052804990",
  "submitTimeUtc": "2022-11-10T01:47:59Z",
  "status": "COMPLETED",
  "paymentAccountInformation": {
    "card": {
      "type": "001",
      "brandName": "VISA",
      "maxLength": "16",
      "credentialType": "TOKEN"
    },
    "features": {
      "accountFundingSource": "DEBIT",
      "cardPlatform": "CONSUMER",
      "cardProduct": "Visa Classic"
    }
  },
  "issuerInformation": {
    "name": "INTL HDQTRS-CENTER OWNED",
    "country": "US",
    "binLength": "6"
    "accountPrefix": "4111111"
  }
}

Request Example: BIN Lookup Service with a Six-Digit Payment Card Prefix

{
  "paymentInformation": {
    "card": {
      "number": "5033961"
    }
  }
}

Response 201 Example: Multiple Match BIN Lookup Service with a Six-Digit Payment Card Prefix

\\ This response occurs when multiple account ranges are found with the provided digits. If you receive this response, please provide extended BIN digits to narrow the result to a single range.
{
  "id": "6445408746306656603955",
  "submitTimeUtc": "2022-02-11T12:54:35Z",
  "status": "MULTIPLE"
}

Request Example: BIN Lookup Service with an Eight-Digit Payment Card Prefix

{
  "paymentInformation": {
    "card": {
      "number": "71111111"
    }
  }
}

Response 201 Example: BIN Lookup Service No Match

\\ This response occurs when a BIN record is not found with the provided digits.
{
  "id": "6445408746306656603955",
  "submitTimeUtc": "2022-02-11T12:54:35Z",
  "status": "NO MATCH"
}

Request Example: BIN Lookup Service with a TMS Customer ID Token

{
  "paymentInformation": {
    "customer": {
      "id": "D0ED44421CDA7A58E053AF598E0AD964"
    }
  }
}

Request Example: BIN Lookup Service with a TMS Payment Instrument Token

{
  "paymentInformation": {
    "paymentInstrument": {
      "id": "D0ED44421CD97A58E053AF598E0AD964"
    }
  }
}

Request Example: BIN Lookup Service with a TMS Instrument Identifier Token

{
  "paymentInformation": {
    "instrumentIdentifier": {
      "id": "801E10E1B4E2C86AE05341588E0A86EC"
    }
  }
}

Request Example: BIN Lookup Service with a TMS jti Transient Token

{
  "tokenInformation": {
    "jti": "1C26VZRFEIQMOO5H0504KH47I0AM2IZFC43V5L541HBLN9COI3L75F3194E196A1"
  }
}

Request Example: BIN Lookup Service with a Flex API JWT Transient Token

{
  "tokenInformation": {
    "transientTokenJwt": "eyJraWQ...xxxxx.yyyyy.zzzzz...xZqoGA"
  }
}