Verifone · Schema

CardResponse

CardResponse from Verifone eCommerce API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name Type Description
reuse_token string The identifier used to represent the Cardholder data.
analytics_token string A token that cannot be reversed to Card Holder data. This is included in a Payment for auditing and tracking purposes.
bin string The Bank Identification Number (also called IIN - Issuer Identification Number) of this card.
expiry_month integer A 2 digit value as shown on card. ISO8583 - DE 14
expiry_year integer A 4 digit value as shown on card.
last_four string The last 4 digits of the card number.
card_holder_name string The Card holder name as it appears on the card.
bin_details object
updated_at string The last date token was updated.
created_at string The last date token was created.
token_expiry_date string When this Token will expire.
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.
token_scope string The token scope under which this token was created.
token_status string The status of the Token.
currency object
issuer_country object
scheme_token object
View JSON Schema on GitHub

JSON Schema

ecommerce-api-cardresponse.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-cardresponse.json",
  "title": "CardResponse",
  "description": "CardResponse from Verifone eCommerce API",
  "type": "object",
  "properties": {
    "reuse_token": {
      "type": "string",
      "description": "The identifier used to represent the Cardholder data."
    },
    "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."
    },
    "bin": {
      "type": "string",
      "minLength": 4,
      "maxLength": 11,
      "description": "The Bank Identification Number (also called IIN - Issuer Identification Number) of this card."
    },
    "expiry_month": {
      "type": "integer",
      "maximum": 12,
      "description": "A 2 digit value as shown on card. ISO8583 - DE 14"
    },
    "expiry_year": {
      "type": "integer",
      "maximum": 9999,
      "description": "A 4 digit value as shown on card."
    },
    "last_four": {
      "type": "string",
      "maxLength": 4,
      "description": "The last 4 digits of the card number."
    },
    "card_holder_name": {
      "type": "string",
      "maxLength": 30,
      "description": "The Card holder name as it appears on the card."
    },
    "bin_details": {
      "$ref": "#/components/schemas/BinDetails"
    },
    "updated_at": {
      "type": "string",
      "description": "The last date token was updated.",
      "format": "date"
    },
    "created_at": {
      "type": "string",
      "description": "The last date token was created.",
      "format": "date"
    },
    "token_expiry_date": {
      "type": "string",
      "description": "When this Token will expire.",
      "format": "date"
    },
    "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"
      ]
    },
    "token_scope": {
      "type": "string",
      "description": "The token scope under which this token was created.",
      "format": "uuid"
    },
    "token_status": {
      "type": "string",
      "description": "The status of the Token.",
      "title": "Token Status Type",
      "enum": [
        "DELETED",
        "ACTIVE",
        "SUSPENDED"
      ]
    },
    "currency": {
      "$ref": "#/components/schemas/CurrencyCodeEnum"
    },
    "issuer_country": {
      "$ref": "#/components/schemas/issuerCountryEnum"
    },
    "scheme_token": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SchemeToken"
        }
      ]
    }
  }
}