Documentation
Documentation
Transaction
Close API Documentation
Transaction

A transaction can go through the following states:

Pending

The transaction is initialized. Most of the information on the transaction can be changed. The transaction’s next state is Confirmed.

Confirmed

The transaction is confirmed by the web shop or by the merchant. Once a transaction is Confirmed no changes can be made on it. The transaction’s next state is Processing.

Processing

The transaction switches to Processing when we start with the collecting of the payment information and start with the processing. A transaction can remain a long time in the Processing state (e.g. when used with charge flows). In case the processing of the transaction is successful the transaction switches into Authorized. If the processing is not successful the transaction switches into Failed.

Failed

The transaction could not be Authorized. Typically either the customer cancelled the transaction or the customer was unable or not willing to authorize the payment. Details why the transaction Failed can be found in the failure reason on the transaction. This is a final state.

Authorized

The customer has Authorized the payment. Authorized means the customer has accepted the payment and the amount could be reserved. However the transfer of the amount to the merchant account is not be initiated. In this state the merchant can change the line items of the transaction. The transaction’s next state is Completed.

Completed

The payment has been initiated. The transfer of the money to the merchant account has been done or is initiated. As such the amount cannot be changed anymore. It is not recommend to initiate the delivery when this state is reached. The decision if the delivery of the goods should occur depends on the payment method on the settings done by the merchant. The transaction’s next states are Fulfill or Decline.

Fulfill

The transaction is ready to be delivered by the merchant. All the risk checks are executed and indicate that the transaction is safe to be delivered. This is a final state.

Decline

The transaction should not be delivered. It is recommended to decline the delivery because either the money will never arrive on the merchant account or the chances are high that the customer is not willing to pay the payment. This is a final state.

States
  • Create
    The create state is set during the creation of the transaction.
  • Pending
    The transaction is created but it is not confirmed by the merchant system.
  • Confirmed
    The transaction is created and confirmed however the processing has not yet started.
  • Processing
    The transaction is processing.
  • Failed
    The transaction authorization failed.
  • Authorized
    The transaction is authorized.
  • Completed
    The transaction is completed.
  • Fulfill
    The transaction is ready to be delivered.
  • Decline
    The goods or services should not be delivered.
  • Voided
    The authorization is voided and hence no money is transfered.
Properties
  • Accept Header
  • Accept Language Header
    The accept language contains the header which indicates the language preferences of the buyer.
  • Allowed Payment Method Brands
  • Allowed Payment Method Configurations
  • Authorization Amount
  • Authorization Environment
    The environment in which this transaction was successfully authorized.
  • Authorization Timeout On
    This is the time on which the transaction will be timed out when it is not at least authorized. The timeout time may change over time.
  • Authorized On
  • Auto Confirmation Enabled
    When auto confirmation is enabled the transaction can be confirmed by the user and does not require an explicit confirmation through the web service API.
  • Billing Address
  • Charge Retry Enabled
    When the charging of the customer fails we can retry the charging. This implies that we redirect the user back to the payment page which allows the customer to retry. By default we will retry.
  • Completed Amount
    The completed amount is the total amount which has been captured so far.
  • Completed On
  • Completion Behavior
    The completion behavior controls when the transaction is completed.
  • Completion Timeout On
  • Confirmed By
  • Confirmed On
  • Created By
  • Created On
    The date and time when the object was created.
  • Currency
  • Customer Email Address
    The customer email address is the email address of the customer. If no email address is provided on the shipping or billing address this address is used.
  • Customer Id
  • Customers Presence
    The customer's presence indicates what kind of authentication method was finally used during authorization of the transaction. If no value is provided, 'Virtually Present' is used by default.
  • Delivery Decision Made On
    This date indicates when the decision has been made if a transaction should be delivered or not.
  • Device Session Identifier
    The device session identifier links the transaction with the session identifier provided in the URL of the device data JavaScript. This allows to link the transaction with the collected device data of the buyer.
  • Emails Disabled
    Flag indicating whether email sending is disabled for this particular transaction. Defaults to false.
  • End of Life
    The transaction's end of life indicates the date from which on no operation can be carried out anymore.
  • Environment
  • Environment Selection Strategy
    The environment selection strategy determines how the environment (test or production) for processing the transaction is selected.
  • Failed On
  • Failed Url
    The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
  • Failure Reason
    The failure reason describes why the transaction failed. This is only provided when the transaction is marked as failed.
  • Group
  • ID
    A unique identifier for the object.
  • Internet Protocol (IP) Address
    The Internet Protocol (IP) address identifies the device of the buyer.
  • Internet Protocol Address Country
  • Invoice Merchant Reference
  • Java Enabled
  • Language
    The language that is linked to the object.
  • Line Items
  • Linked Space ID
    The ID of the space this object belongs to.
  • Merchant Reference
  • Meta Data
    Meta data allow to store additional data along the object.
  • Parent
  • Payment Connector Configuration
  • 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.
  • Processing On
  • Refunded Amount
    The refunded amount is the total amount which has been refunded so far.
  • Sales Channel
    The sales channel through which the transaction was placed.
  • Screen Color Depth
  • Screen Height
  • Screen Width
  • Shipping Address
  • Shipping Method
  • Space View Id
  • State
    The object's current state.
  • Success Url
    The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
  • Terminal
    The terminal on which the payment was processed.
  • 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
  • Tokenization Mode
    The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.
  • Total Applied Fees
    The total applied fees is the sum of all fees that have been applied so far.
  • Total Settled Amount
    The total settled amount is the total amount which has been settled so far.
  • User Agent Header
    The user agent header provides the exact string which contains the user agent of the buyer.
  • User Failure Message
    The failure message describes for an end user why the transaction is failed in the language of the user. This is only provided when the transaction is marked as failed.
  • User Interface Type
    The user interface type defines through which user interface the transaction has been processed resp. created.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.
  • Window Height
  • Window Width
  • Years to Keep
    The number of years the transaction will be stored after it has been authorized.