Documentation
Documentation
Token Version
Close API Documentation
Token Version

Token versions represent the different updates of a token.

States
  • Uninitialized
    The token version is not initialized and hence it cannot be used.
  • Active
    The token version is active and can be used.
  • Obsolete
    The token version is obsolete. It cannot be used.
Properties
  • Activated On
    The date and time when the token version was activated.
  • Billing Address
    The billing address to be used for the transaction if no explicit billing address is provided during payment processing.
  • Created On
    The date and time when the object was created.
  • Environment
    The environment in which the token version was created.
  • Expires On
    The date and time when the token version is set to expire, after which it will be marked as obsolete.
  • ID
    A unique identifier for the object.
  • Icon Url
    The URL to the token's icon displayed to the customer.
  • Labels
    The labels providing additional information about the object.
  • Language
    The language that is linked to the object.
  • Last Retried On
    The date and time when the system last attempted a retry for this token version.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the token.
  • Obsoleted On
    The date and time when the token version was marked obsolete.
  • Payment Connector Configuration
    The payment connector configuration that initialized the token version.
  • Payment Information Hashes
    The hashed payment information that the token version represents.
  • Payment Method
    The payment method that initialized the token version.
  • Payment Method Brand
    The payment method brand that initialized the token version.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Processor Token
    The token name as specified by the processor.
  • Retry In
    Retry interval when the strategy advises retrying later.
  • Retry Strategy
    Retry advice derived from processor decline codes. If empty, no restriction applies and the system may retry when appropriate.
  • Shipping Address
    The shipping address to be used for the transaction if no explicit shipping address is provided during payment processing.
  • State
    The object's current state.
  • Token
    The token that the token version belongs to.
  • Type
    The type specifies the nature of the token and identifies the payment connector capable of processing it.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.