Verifone · Schema

TokenDetails

TokenDetails from Verifone eCommerce API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name Type Description
reuse_token string The Verifone issued reuse token used to represent the previously stored cardholder data.
reuse_token_type string The type of Reuse Token. This indicates if the reuse token is an internal Verifone type or an external Third-Party type.
analytics_token string A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes.
token_expiry_date string When this Token will expire.
token_scope string The token scope under which this token was created.
token_status string The status of the Token.
created_at string The date when this token was first created.
updated_at string The last date token was updated.
variant string The variant of the card. eg. NEW_WORLD
type string The type of card application or account selection.
issuer_name string The issuer of this card. eg. HSBC, BARCLAYS.
issuer_country object
brand string The brand of this card. eg. VISA, MASTERCARD, AMEX.
expiry_year integer A 4 digit value as shown on card.
expiry_month integer A 2 digit value as shown on card. ISO8583 - DE 14
card_holder_name string The Card holder name as it appears on the card.
last_four string The last 4 digits of the card number.
bin string The Bank Identification Number (also called IIN - Issuer Identification Number) of this card.
currency_code string Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
View JSON Schema on GitHub

JSON Schema

ecommerce-api-tokendetails.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/ecommerce-api-tokendetails.json",
  "title": "TokenDetails",
  "description": "TokenDetails from Verifone eCommerce API",
  "type": "object",
  "properties": {
    "reuse_token": {
      "type": "string",
      "description": "The Verifone issued reuse token used to represent the previously stored cardholder data.",
      "minLength": 14,
      "maxLength": 255
    },
    "reuse_token_type": {
      "title": "Reuse Token Type",
      "description": "The type of Reuse Token. This indicates if the reuse token is an internal Verifone type or an external Third-Party type.",
      "type": "string",
      "enum": [
        "CHASE",
        "INTERNAL",
        "TAVE"
      ]
    },
    "analytics_token": {
      "type": "string",
      "description": "A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes."
    },
    "token_expiry_date": {
      "type": "string",
      "format": "date",
      "description": "When this Token will expire."
    },
    "token_scope": {
      "type": "string",
      "format": "uuid",
      "description": "The token scope under which this token was created."
    },
    "token_status": {
      "type": "string",
      "enum": [
        "DELETED",
        "ACTIVE",
        "SUSPENDED"
      ],
      "description": "The status of the Token."
    },
    "created_at": {
      "type": "string",
      "format": "date",
      "description": "The date when this token was first created."
    },
    "updated_at": {
      "type": "string",
      "format": "date",
      "description": "The last date token was updated."
    },
    "variant": {
      "type": "string",
      "description": "The variant of the card. eg. NEW_WORLD"
    },
    "type": {
      "type": "string",
      "enum": [
        "CREDIT",
        "DEBIT"
      ],
      "description": "The type of card application or account selection."
    },
    "issuer_name": {
      "type": "string",
      "description": "The issuer of this card. eg. HSBC, BARCLAYS."
    },
    "issuer_country": {
      "$ref": "#/components/schemas/issuerCountryEnum"
    },
    "brand": {
      "type": "string",
      "description": "The brand of this card. eg. VISA, MASTERCARD, AMEX."
    },
    "expiry_year": {
      "type": "integer",
      "description": "A 4 digit value as shown on card.",
      "maximum": 9999
    },
    "expiry_month": {
      "type": "integer",
      "description": "A 2 digit value as shown on card. ISO8583 - DE 14",
      "maximum": 12
    },
    "card_holder_name": {
      "type": "string",
      "description": "The Card holder name as it appears on the card.",
      "maxLength": 30
    },
    "last_four": {
      "type": "string",
      "description": "The last 4 digits of the card number.",
      "maxLength": 4
    },
    "bin": {
      "type": "string",
      "description": "The Bank Identification Number (also called IIN - Issuer Identification Number) of this card.",
      "minLength": 4,
      "maxLength": 11
    },
    "currency_code": {
      "type": "string",
      "title": "Currency Code",
      "description": "Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).",
      "enum": [
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BOV",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYR",
        "BZD",
        "CAD",
        "CDF",
        "CHE",
        "CHF",
        "CHW",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "COU",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LTL",
        "LVL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRO",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SLL",
        "SOS",
        "SRD",
        "SSP",
        "STD",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "USN",
        "USS",
        "UYI",
        "UYU",
        "UZS",
        "VEF",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XAG",
        "XAU",
        "XBA",
        "XBB",
        "XBC",
        "XBD",
        "XCD",
        "XDR",
        "XOF",
        "XPD",
        "XPF",
        "XPT",
        "XTS",
        "XXX",
        "YER",
        "ZAR",
        "ZMK",
        "ZMW",
        "BTC"
      ]
    }
  }
}