action neutrinoapi_binlookup {
  label: "BIN Lookup"
  description: "Perform a BIN (Bank Identification Number) or IIN (Issuer Identification Number) lookup"
  provider: neutrinoapi
  method: GET
  path: "/bin-lookup"
  encoding: json
  input: {
    type: "object"
    properties: {
      "bin-number": {
        type: "string"
      }
      "customer-ip": {
        type: "string"
      }
    }
    required: ["bin-number"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["bin-number", "card-brand", "card-category", "card-type", "country", "country-code", "country-code3", "currency-code", "ip-blocklisted", "ip-blocklists", "ip-city", "ip-country", "ip-country-code", "ip-country-code3", "ip-matches-bin", "ip-region", "is-commercial", "is-prepaid", "issuer", "issuer-phone", "issuer-website", "valid"]
    properties: {
      "bin-number": {
        type: "string"
        description: "The BIN or IIN number"
      }
      "card-brand": {
        type: "string"
        description: "The card brand (e.g. Visa or Mastercard)"
      }
      "card-category": {
        type: "string"
        description: "The card category. There are many different card categories the most common card categories are: CLASSIC, BUSINESS, CORPORATE, PLATINUM, PREPAID"
      }
      "card-type": {
        type: "string"
        description: "The card type, will always be one of: DEBIT, CREDIT, CHARGE CARD"
      }
      country: {
        type: "string"
        description: "The full country name of the issuer"
      }
      "country-code": {
        type: "string"
        description: "The ISO 2-letter country code of the issuer"
      }
      "country-code3": {
        type: "string"
        description: "The ISO 3-letter country code of the issuer"
      }
      "currency-code": {
        type: "string"
        description: "ISO 4217 currency code associated with the country of the issuer"
      }
      "ip-blocklisted": {
        type: "boolean"
        description: "True if the customers IP is listed on one of our blocklists, see the <a href=\"http://www.neutrinoapi.com/api/ip-blocklist/\">IP Blocklist API</a>"
      }
      "ip-blocklists": {
        type: "array"
        description: "An array of strings indicating which blocklists this IP is listed on"
        items: {
          type: "string"
        }
      }
      "ip-city": {
        type: "string"
        description: "The city of the customers IP (if detectable)"
      }
      "ip-country": {
        type: "string"
        description: "The country of the customers IP"
      }
      "ip-country-code": {
        type: "string"
        description: "The ISO 2-letter country code of the customers IP"
      }
      "ip-country-code3": {
        type: "string"
        description: "The ISO 3-letter country code of the customers IP"
      }
      "ip-matches-bin": {
        type: "boolean"
        description: "True if the customers IP country matches the BIN country"
      }
      "ip-region": {
        type: "string"
        description: "The region of the customers IP (if detectable)"
      }
      "is-commercial": {
        type: "boolean"
        description: "Is this a commercial/business use card"
      }
      "is-prepaid": {
        type: "boolean"
        description: "Is this a prepaid or prepaid reloadable card"
      }
      issuer: {
        type: "string"
        description: "The card issuer"
      }
      "issuer-phone": {
        type: "string"
        description: "The card issuers phone number"
      }
      "issuer-website": {
        type: "string"
        description: "The card issuers website"
      }
      valid: {
        type: "boolean"
        description: "Is this a valid BIN or IIN number"
      }
    }
  }
}