Documentation
Documentation
Charge
Close API Documentation
Charge
States
  • Pending
    The charge is created and the processing of the charge ongoing.
  • Failed
    The charge failed.
  • Successful
    The charge is authorized.
Properties
  • Created On
    The date and time when the object was created.
  • Failure Reason
    The reason for the failure of the charge.
  • 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.
  • Space View ID
    The ID of the space view this object is linked to.
  • State
    The object's current state.
  • Time Zone
    The time zone that this object is associated with.
  • Timeout On
    The date and time when the charge will expire.
  • Transaction
    The transaction that the charge belongs to.
  • Type
    The type specifying how the customer was charged.
  • User Failure Message
    The message that can be displayed to the customer explaining why the charge failed, in the customer's language.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.