Documentation
Documentation
    • English (United States)
Refund
Close API Documentation
Refund

The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).

A refund triggers a process by which money is transfered back to the customer from the merchant account.

To create a refund you need to complete a transaction first.

States
  • Created
    The create state indicates that the refund is in creation.
  • Scheduled
    The scheduled state indicates that the refund is scheduled and that the processing have not been started yet.
  • Manual Check
    The manual check state indicates that the refund is not for certain processed by the processor. The state of the refund has to be checked.
  • Failed
    The failed state indicates that the refund has failed.
  • Successful
    The successful state indicates that the refund succeed.
  • Pending
    The pending state indicates that the refund is pending.
Properties
  • Amount
  • Base Line Items
  • Completion
  • Created By
  • Created On
    The date and time when the object was created.
  • Environment
  • External ID
    The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
  • Failed On
  • Failure Reason
  • ID
    A unique identifier for the object.
  • Labels
    The labels providing additional information about the object.
  • Language
    The language that is linked to the object.
  • Line Items
  • Linked Space ID
    The ID of the space this object belongs to.
  • Merchant Reference
  • Next Update On
  • 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
  • Processor Reference
  • Reduced Line Items
  • Reductions
  • State
    The object's current state.
  • Succeeded On
  • Taxes
  • Time Zone
  • Timeout On
  • Total Applied Fees
    The total applied fees is the sum of all fees that have been applied so far.
  • Total Settled Amount
    The total settled amount is the total amount which has been settled so far.
  • Transaction
  • Type
  • Updated Invoice
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.