Documentation
Documentation
Completion
Close API Documentation
Completion

A completion represents a try to move the transaction into the Completed state. There can only be one successful completion for a single transaction. However if a completion is not successful there can be more than one for a single transaction.

States
  • Created
    The create state indicates that the completion is in creation.
  • Pending
    The pending state indicates that the completion is being processed.
  • Failed
    The failed state indicates that the completion is failed.
  • Successful
    The successful state indicates that the completion succeeded.
  • Scheduled
    The scheduled state indicates that the completion is scheduled and that the processing have not been started yet.
Properties
  • Amount
    The total amount to be captured in this completion, including taxes.
  • Base Line Items
    The original line items from the transaction that serve as the baseline for this completion.
  • Created By
    The ID of the user the transaction completion was created by.
  • Created On
    The date and time when the object was created.
  • External ID
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • Failed On
    The date and time when the transaction completion failed.
  • Failure Reason
    The reason for the failure of the transaction completion.
  • ID
    A unique identifier for the object.
  • Invoice Merchant Reference
    The merchant's reference used to identify the invoice.
  • Labels
    The labels providing additional information about the object.
  • Language
    The language that is linked to the object.
  • Last Completion
    Whether this is the final completion for the transaction. After the last completion is successfully created, the transaction enters its final state, and no further completions can occur.
  • Line Item Version
    The specific version of the line items that are being used for this completion.
  • Line Items
    The line items captured in this transaction completion.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Linked Transaction
    The payment transaction this object is linked to.
  • Mode
    The mode of transaction completion, such as online or offline, determining how the completion process is executed.
  • Next Update On
    The date and time when the next update of the object's state is planned.
  • Payment Information
    Payment-specific details related to this transaction completion such as payment instructions or references needed for processing.
  • 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 completion was started.
  • Processor Reference
    The reference ID provided by the payment processor, used to trace the completion through the external payment system.
  • Remaining Line Items
    The line items yet to be captured in the transaction.
  • Space View ID
    The ID of the space view this object is linked to.
  • State
    The object's current state.
  • Statement Descriptor
    The statement descriptor that appears on a customer's bank statement, providing an explanation for charges or payments, helping customers identify the transaction.
  • Succeeded On
    The date and time when the transaction completion succeeded.
  • Tax Amount
    The portion of the captured amount that corresponds to taxes.
  • Time Zone
    The time zone that this object is associated with.
  • Timeout On
    The date and time when the object will expire.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.