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 transferred.
Properties
  • Accept Header
    The 'Accept' header of the customer's web browser.
  • Accept Language Header
    The 'Accept Language' header of the customer's web browser.
  • Allowed Payment Method Brands
    The payment method brands that can be used to authorize the transaction.
  • Allowed Payment Method Configurations
    The payment method configurations that can be used to authorize the transaction.
  • Authorization Amount
    The sum of all line item prices including taxes in the transaction's currency.
  • Authorization Environment
    The environment in which the transaction was authorized.
  • Authorization Timeout On
    The date and time when the transaction must be authorized, otherwise it will canceled.
  • Authorized On
    The date and time when the transaction was authorized.
  • Auto Confirmation Enabled
    Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.
  • Billing Address
    The address associated with the payment method for invoicing and transaction processing purposes.
  • Charge Retry Enabled
    Whether the customer can make further payment attempts if the first one has failed. Default is true.
  • Completed Amount
    The total amount that was completed, in the transaction's currency.
  • Completed On
    The date and time when the transaction was completed.
  • Completion Behavior
    The behavior that controls when the transaction is completed.
  • Completion Timeout On
    The date and time when the transaction is completed automatically.
  • Confirmed By
    The ID of the user the transaction was confirmed by.
  • Confirmed On
    The date and time when the transaction was created.
  • Created By
    The ID of the user the transaction was created by.
  • Created On
    The date and time when the object was created.
  • Currency
    The three-letter code (ISO 4217 format) of the transaction's currency.
  • Customer Email Address
    The customer's email address.
  • Customer ID
    The unique identifier of the customer in the external system.
  • Customers Presence
    The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.
  • Delivery Decision Made On
    This date and time when the decision was made as to whether the order should be shipped.
  • Device Session Identifier
    Allows to link the transaction to the data collected from the customer's device.
  • Emails Disabled
    Whether email sending is deactivated for the transaction. Default is false.
  • End Of Life
    The date and time when the transaction reaches its end of live. No further actions can be carried out at this time.
  • Environment
    The environment used when rendering resources.
  • Environment Selection Strategy
    The strategy for determining whether the transaction is to be processed in the test or production environment.
  • Failed On
    The date and time when the transaction failed.
  • Failed Url
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
  • Failure Reason
    The reason for the failure of the transaction.
  • Group
    The group that the transaction belongs to.
  • ID
    A unique identifier for the object.
  • Internet Protocol (IP) Address
    The IP address of the customer's device.
  • Internet Protocol Address Country
    The country determined from the IP address of the customer's device.
  • Invoice Merchant Reference
    The merchant's reference used to identify the invoice.
  • Java Enabled
    Whether Java is enabled on the customer's web browser.
  • Language
    The language that is linked to the object.
  • Line Items
    The line items purchased by the customer.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Merchant Reference
    The merchant's reference used to identify the transaction.
  • Meta Data
    Allow to store additional information about the object.
  • Parent
    The parent transaction which was (partially) replaced by this transaction.
  • Payment Connector Configuration
    The payment connector configuration that was used to authorize the transaction.
  • 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
    The date and time when the processing of the transaction was started.
  • Refunded Amount
    The total amount that was refunded, in the transaction's currency.
  • Sales Channel
    The sales channel through which the transaction was placed.
  • Screen Color Depth
    The screen color depth of the customer's web browser.
  • Screen Height
    The screen height of the customer's web browser.
  • Screen Width
    The screen width of the customer's web browser.
  • Shipping Address
    The address to where the order will be shipped.
  • Shipping Method
    The name of the shipping method used to ship the products.
  • Space View ID
    The ID of the space view this object is linked to.
  • State
    The object's current state.
  • Success Url
    The URL to redirect the customer back to after they successfully authenticated their payment.
  • Terminal
    The payment terminal through which the payment was processed.
  • Time Zone
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
  • Token
    The payment token that should be used to charge the customer.
  • Tokenization Mode
    The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.
  • Total Applied Fees
    The total of all fees charged, in the transaction's currency.
  • Total Settled Amount
    The total amount that was settled, in the transaction's currency.
  • User Agent Header
    The 'User Agent' header of the customer's web browser.
  • User Failure Message
    The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.
  • User Interface Type
    The type of user interface the customer used to provide the payment information.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.
  • Window Height
    The window height of the customer's web browser.
  • Window Width
    The window width of the customer's web browser.
  • Years To Keep
    The number of years the transaction is kept after its authorization.