PatchTokenResponse

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/ecommerce-api-patchtokenresponse.json",
  "title": "PatchTokenResponse",
  "description": "PatchTokenResponse from Verifone eCommerce API",
  "type": "object",
  "properties": {
    "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."
    },
    "card_holder_email": {
      "type": "string",
      "title": "Email Address",
      "minLength": 3,
      "maxLength": 254,
      "format": "email",
      "description": "A valid internationalized email address, as defined by RFC 5322, RFC 6530, and other RFCs. Due to RFC 5321, an email address can be up to 254 characters long even though up to 64 characters are allowed before and 255 characters are allowed after the @ sign. This pattern verifies only that the string contains an unquoted @ sign. See https://tools.ietf.org/html/rfc5322#section-3.4.1."
    },
    "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"
    },
    "token_status": {
      "type": "string",
      "description": "The status of the Token.",
      "title": "Token Status Type",
      "enum": [
        "DELETED",
        "ACTIVE",
        "SUSPENDED"
      ]
    },
    "bin_details": {
      "$ref": "#/components/schemas/BinDetails"
    },
    "currency": {
      "$ref": "#/components/schemas/CurrencyCodeEnum"
    },
    "issuer_country": {
      "$ref": "#/components/schemas/issuerCountryEnum"
    },
    "scheme_token": {
      "title": "Scheme Token Response",
      "description": "This object is returned only if scheme_tokens were created already or scheme_token_action indicated creation (ACTIVATE) of new or suspension (SUSPEND) or deletion () of existing scheme tokens. Scheme token details are provided only if the token requestor is the Merchant, otherwise just the scheme_token_status is returned.",
      "type": "object",
      "properties": {
        "network_token": {
          "description": "Card scheme token. Will be received only if a valid Token Requestor ID is stored on your account.",
          "type": "string",
          "minLength": 12,
          "maxLength": 16
        },
        "status": {
          "description": "The status of the cardholder data token.",
          "type": "string",
          "enum": [
            "DELETED",
            "ACTIVE",
            "SUSPENDED"
          ]
        },
        "expiry_month": {
          "description": "Network tokens' expiry date's month. A 2 digit value. ISO8583 - DE 14",
          "type": "integer",
          "maximum": 12
        },
        "expiry_year": {
          "description": "Network tokens' expiry date's year. A 4 digit value.",
          "type": "integer",
          "maximum": 9999
        },
        "payment_account_reference": {
          "description": "Payment Account Reference",
          "type": "string",
          "maxLength": 29
        }
      }
    }
  }
}