Documentation
Documentation
Installment Payment
Close API Documentation
Installment Payment

An installment payment represents a payment paid in multiple slices.

States
  • Create
    The create state is set during the creation of the installment payment.
  • Confirmed
    The installment payment is confirmed. The authorization of the initial transaction is going on.
  • Rejected
    The installment payment has been rejected by the buyer, by the processor or by the merchant.
  • Authorized
    The installment payment has been authorized by the buyer.
  • Completed
    The installment has been completed.
  • Running
    The initial installment payment was successfully carried out and the subsequent charges will be carried out as scheduled.
  • Done
    The installment payment has been fully done. All payments have been paid.
  • Defaulted
    The initial transaction has been paid and the goods have been delivered, however the buyer has defaulted one or more payments.
Properties
  • Created On
    The date and time when the object was created.
  • ID
    A unique identifier for the object.
  • Initial Transaction
  • Line Items
  • Linked Space ID
    The ID of the space this object belongs to.
  • Plan 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.
  • State
    The object's current state.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.