Documentation
Documentation
Refund
Close API Documentation
Refund

A refund is a credit issued to the customer, which can be initiated either by the merchant or by the customer as a 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
    The total monetary amount of the refund, representing the exact credit issued to the customer.
  • Base Line Items
    The original base line items from the transaction prior to the refund, serving as a reference for the refunded amounts.
  • Completion
    The transaction completion that the refund belongs to.
  • Created By
    The ID of the user the refund was created by.
  • Created On
    The date and time when the object was created.
  • Environment
    The environment used when rendering resources.
  • 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 refund failed.
  • Failure Reason
    The reason for the failure of the refund.
  • 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
    The line items included in the refund, representing the reductions.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Merchant Reference
    The merchant's reference used to identify the refund.
  • 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.
  • Processing On
    The date and time when the processing of the refund was started.
  • Processor Reference
    The reference ID provided by the payment processor, used to trace the refund through the external payment system.
  • Reduced Line Items
    The line items from the original transaction, adjusted to reflect any reductions applied during the refund process.
  • Reductions
    The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.
  • State
    The object's current state.
  • Succeeded On
    The date and time when the refund succeeded.
  • Taxes
    The tax breakdown applied to the refund amount, helping with tax calculations or reporting.
  • Time Zone
    The time zone that this object is associated with.
  • Timeout On
    The date and time when the object will expire.
  • Total Applied Fees
    The sum of fees applied to the refund transaction, such as processing or service charges.
  • Total Settled Amount
    The total amount settled for the refund, factoring in reductions, taxes, and any additional applied fees.
  • Transaction
    The transaction that the refund belongs to.
  • Type
    The type specifying the method and origin of the refund (e.g., initiated by the customer or merchant).
  • Updated Invoice
    An updated invoice reflecting adjustments made by the refund.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.
Staging 2.183.1