Package com.stripe.param

Class TransferReversalCollectionCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.TransferReversalCollectionCreateParams
public class TransferReversalCollectionCreateParams
extends ApiRequestParams

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  TransferReversalCollectionCreateParams.Builder  

    Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

    ApiRequestParams.EnumParam

  • Field Summary

    Fields inherited from class com.stripe.net.ApiRequestParams

    EXTRA_PARAMS_KEY

  • Method Summary

    Modifier and Type Method Description
    static TransferReversalCollectionCreateParams.Builder builder()  
    java.lang.Long getAmount()
    A positive integer in %s representing how much of this transfer to reverse.
    java.lang.String getDescription()
    An arbitrary string which you can attach to a reversal object.
    java.util.List<java.lang.String> getExpand()
    Specifies which fields in the response should be expanded.
    java.util.Map<java.lang.String,​java.lang.Object> getExtraParams()
    Map of extra parameters for custom features not available in this client library.
    java.util.Map<java.lang.String,​java.lang.String> getMetadata()
    Set of key-value pairs that you can attach to an object.
    java.lang.Boolean getRefundApplicationFee()
    Boolean indicating whether the application fee should be refunded when reversing this transfer.

    Methods inherited from class com.stripe.net.ApiRequestParams

    toMap

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • builder

      public static TransferReversalCollectionCreateParams.Builder builder()

    • getAmount

      public java.lang.Long getAmount()
      A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.

    • getDescription

      public java.lang.String getDescription()
      An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value.

    • getExpand

      public java.util.List<java.lang.String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public java.util.Map<java.lang.String,​java.lang.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.

    • getMetadata

      public java.util.Map<java.lang.String,​java.lang.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`.

    • getRefundApplicationFee

      public java.lang.Boolean getRefundApplicationFee()
      Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.