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 created on date indicates the date on which the entity was stored into the database.
  • Customer Email Address
    The customer email address is the email address of the customer.
  • Customer ID
    The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
  • Enabled For One-Click Payment
    When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
  • External ID
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Language
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • 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 time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
  • Token Reference
    Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.