Documentation
Documentation
Charge Attempt
Close API Documentation
Charge Attempt
States
  • Processing
    The 'processing' state is set when the charge attempt is processing.
  • Failed
    The 'failed' state is set when the charge attempt is failed.
  • Successful
    The 'successful' state is set when the charge attempt is processed successful.
Properties
  • Charge
    The charge that the charge attempt belongs to.
  • Completion Behavior
    The behavior that controls when the transaction is completed.
  • Connector Configuration
    The payment connector configuration that was used for the charge attempt.
  • Created On
    The date and time when the object was created.
  • Customers Presence
    The customer's presence indicates whether and in what way the charge attempt's customer is present.
  • Environment
    The environment in which the charge attempt is executed.
  • Failed On
    The date and time when the charge attempt failed.
  • Failure Reason
    The reason for the failure of the charge attempt.
  • ID
    A unique identifier for the object.
  • Initializing Token Version
    Whether a new token version is being initialized.
  • Invocation
    The connector invocation that the charge attempt belongs to.
  • Labels
    The labels providing additional information about the object.
  • Language
    The language that is linked to the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Linked Transaction
    The payment transaction this object is linked to.
  • Next Update On
    The date and time when the next update of the object's state is planned.
  • 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.
  • Redirection Url
    The URL to redirect the customer to after payment processing.
  • Sales Channel
    The sales channel through which the charge attempt was made.
  • Space View ID
    The ID of the space view this object is linked to.
  • State
    The object's current state.
  • Succeeded On
    The date and time when the charge attempt succeeded.
  • Terminal
    The payment terminal through which the charge attempt was made.
  • Time Zone
    The time zone that this object is associated with.
  • Timeout On
    The date and time when the object will expire.
  • Token Version
    The token version used for the charge attempt.
  • User Failure Message
    The message that can be displayed to the customer explaining why the charge attempt failed, in the customer's language.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.
  • Wallet
    The type of wallet used to make the charge attempt.