Class TransactionCreateReversalParams


public class TransactionCreateReversalParams extends ApiRequestParams
  • Method Details

    • builder

      public static TransactionCreateReversalParams.Builder builder()
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getFlatAmount

      public Long getFlatAmount()
      A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes.
    • getLineItems

      The line item amounts to reverse.
    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    • getMode

      Required. If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed.
    • getOriginalTransaction

      public String getOriginalTransaction()
      Required. The ID of the Transaction to partially or fully reverse.
    • getReference

      public String getReference()
      Required. A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports.
    • getShippingCost

      The shipping cost to reverse.