Documentation
Documentation
Token
Close API Documentation
Token

A token allows to save payment information. It is practically a number (token reference) that represents this information and that the merchant can store. The token is initialized at the customer’s first payment and for the following ones an interaction is not necessary. A token is used for recurring payments. The set up of a token depends if the connector allows it. If the stored payment information is not valid anymore we ask the customer automatically.

States
  • Create
    The create state indicates that the Token is in creation.
  • Active
    The active state indicates that the Token is active and may be used.
  • Inactive
    The inactive state indicates that the Token is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Token is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Created On
    The date and time when the object was created.
  • Customer Email Address
    The customer's email address.
  • Customer ID
    The unique identifier of the customer in the external system.
  • Enabled For One-Click Payment
    Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
  • External ID
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • ID
    A unique identifier for the object.
  • Language
    The language that is linked to the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • 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.
  • State
    The object's current state.

    A token can have the following states:

    Active

    When the state is set to Active this token is going to be used during the transaction.

    Inactive

    When the state is set to Inactive this token is not going to be used. However, all the information is not deleted and you can reactivate the token at any moment.

    Deleting

    The token is in the process of deletion. This may take some time until the token is marked as Deleting before being marked as Deleted.

    Deleted

    The token is deleted. Since the token is linked with data which cannot be deleted immediately, we need to keep it until all the data can be removed.

  • Time Zone
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
  • Token Reference
    The reference used to identify the payment token (e.g. the customer's ID or email address).
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.