The Token object Preview

Attributes

• idstring

  Unique identifier for the object.

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• cardstringExpandable

  Card associated with this token.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• device_fingerprintnullable string

  The hashed ID derived from the device ID from the card network associated with the token.

• last4nullable string

  The last four digits of the token.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• networkenum

  The token service provider / card network associated with the token.

  Possible enum values

  mastercard MasterCard token service provider.

  visa Visa token service provider.

• network_datanullable objectPreview featureExpandable

  Additional details obtained from the network about the token, primarily related to the token creation process. For security reasons, this is only available to view in the first 24 hours after token creation, based on the created value, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a token” endpoint and “Update a token status” endpoint.

  Hide child attributes

  • network_data.devicenullable object

    Data about the device at the instance of provisioning this token.

    Hide child attributes

    • network_data.device.device_fingerprintnullable string

      An obfuscated ID derived from the device ID.

    • network_data.device.ip_addressnullable string

      The IP address of the device at provisioning time.

    • network_data.device.locationnullable string

      The geographic latitude/longitude coordinates of the device at provisioning time. The format is [±]decimal/[±]decimal.

    • network_data.device.namenullable string

      The name of the device used for tokenization.

    • network_data.device.phone_numbernullable string

      The phone number of the device used for tokenization.

    • network_data.device.typenullable enum

      The type of device used for tokenization.

      Possible enum values

      other Device is some other form factor, such as tablet or laptop.

      phone Device is a mobile phone or phone form factor.

      watch Device is a watch or watch form factor.

  • network_data.mastercardnullable object

    If this is a mastercard network token, this hash contains tokenization data specific to this card network.

    Hide child attributes

    • network_data.mastercard.card_reference_idnullable string

      A unique reference ID from MasterCard to represent the card account number.

    • network_data.mastercard.token_reference_idstring

      The network-unique identifier for the token.

    • network_data.mastercard.token_requestor_idstring

      The ID of the entity requesting tokenization, specific to MasterCard.

    • network_data.mastercard.token_requestor_namenullable string

      The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.

  • network_data.typeenum

    The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.

    Possible enum values

    mastercard MasterCard token service provider.

    visa Visa token service provider.

  • network_data.visanullable object

    If this is a visa network token, this hash contains tokenization data specific to this card network.

    Hide child attributes

    • network_data.visa.card_reference_idstring

      A unique reference ID from Visa to represent the card account number.

    • network_data.visa.token_reference_idstring

      The network-unique identifier for the token.

    • network_data.visa.token_requestor_idstring

      The ID of the entity requesting tokenization, specific to Visa.

    • network_data.visa.token_risk_scorenullable string

      Degree of risk associated with the token between 01 and 99, with higher number indicating higher risk. A 00 value indicates the token was not scored by Visa.

  • network_data.wallet_providernullable object

    The digital wallet used for provisioning this token.

    Hide child attributes

    • network_data.wallet_provider.account_idnullable string

      The wallet provider-given account ID of the digital wallet the token belongs to.

    • network_data.wallet_provider.account_trust_scorenullable integer

      An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.

    • network_data.wallet_provider.card_number_sourcenullable enum

      The method used for tokenizing a card.

      Possible enum values

      app The card was provisioned from a mobile application.

      manual The card details were manually provided to the wallet provider. This includes manual card number entry by the cardholder, card number detection via OCR, and tapping a physical contactless card on a mobile device.

      on_file The card data stored on file was used for provisioning.

      other The token was provisioned by another method.

    • network_data.wallet_provider.cardholder_addressnullable object

      The address of the cardholder tokenizing the card.

      Hide child attributes

      • network_data.wallet_provider.cardholder_address.line1string

        The street address of the cardholder tokenizing the card.

      • network_data.wallet_provider.cardholder_address.postal_codestring

        The postal code of the cardholder tokenizing the card.

    • network_data.wallet_provider.cardholder_namenullable string

      The name of the cardholder tokenizing the card.

    • network_data.wallet_provider.device_trust_scorenullable integer

      An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.

    • network_data.wallet_provider.hashed_account_email_addressnullable string

      The hashed email address of the cardholder’s account with the wallet provider.

    • network_data.wallet_provider.reason_codesnullable array of enums

      The reasons for suggested tokenization given by the card network.

      Possible enum values

      account_card_too_new Cardholders’ wallet account/card pair is newer than date threshold.

      account_recently_changed Changes made to account data within the date threshold.

      account_too_new Cardholders’ wallet account is too new relative to provisioning request.

      account_too_new_since_launch Cardholders’ wallet account is too new relative to launch.

      additional_device The digitization is for an additional device for the same Account PAN and consumer account. There must be a currently active (not suspended) Token that was previously digitized and activated on an existing device for the same Account PAN and consumer account.

      data_expired Issuer encrypted payment instrument data has expired.

      defer_id_v_decision Issuer preferred to defer ID&V decision to token creation time.

      device_recently_lost Device was put in lost mode.

      good_activity_history There has been financial activity linked to the account for at least and within a period of not less than six months; no suspicious activity is linked to the account within a period of at least one year.

      has_suspended_tokens Suspended cards in the secure element.

      Show 18 more

    • network_data.wallet_provider.suggested_decisionnullable enum

      The recommendation on responding to the tokenization request.

      Possible enum values

      approve The card network suggests approving the provisioning request.

      decline The card network suggests declining the provisioning request.

      require_auth The card network suggests performing additional identity verification in order to approve tokenization.

    • network_data.wallet_provider.suggested_decision_versionnullable string

      The version of the standard for mapping reason codes followed by the wallet provider.

• network_updated_attimestamp

  Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.

• statusenum

  The usage state of the token.

  Possible enum values

  active Token is provisioned and usable for payments.

  deleted Terminal state. Token can no longer be used.

  requested Token has been requested to be provisioned, but has not completed the activation process.

  suspended Token temporarily cannot be used for payments.

• wallet_providernullable enum

  The digital wallet for this token, if one was used.

  Possible enum values

  apple_pay Apple Pay.

  google_pay Google Pay.

  samsung_pay Samsung Pay.