Package com.stripe.param

Class TransferReversalCreateParams.Builder

java.lang.Object
com.stripe.param.TransferReversalCreateParams.Builder
Enclosing class:
TransferReversalCreateParams
public static class TransferReversalCreateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public TransferReversalCreateParams build()
      Finalize and obtain parameter instance from this builder.

    • setAmount

      public TransferReversalCreateParams.Builder setAmount(Long amount)
      A positive integer in cents (or local equivalent) 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.

    • setDescription

      public TransferReversalCreateParams.Builder setDescription(String description)
      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.

    • addExpand

      public TransferReversalCreateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransferReversalCreateParams.expand for the field documentation.

    • addAllExpand

      public TransferReversalCreateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransferReversalCreateParams.expand for the field documentation.

    • putExtraParam

      public TransferReversalCreateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferReversalCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public TransferReversalCreateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferReversalCreateParams.extraParams for the field documentation.

    • putMetadata

      public TransferReversalCreateParams.Builder putMetadata(String key, String value)
      Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferReversalCreateParams.metadata for the field documentation.

    • putAllMetadata

      public TransferReversalCreateParams.Builder putAllMetadata(Map<String,String> map)
      Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferReversalCreateParams.metadata for the field documentation.

    • setMetadata

      public TransferReversalCreateParams.Builder setMetadata(EmptyParam metadata)
      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.

    • setMetadata

      public TransferReversalCreateParams.Builder setMetadata(Map<String,String> metadata)
      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.

    • setRefundApplicationFee

      public TransferReversalCreateParams.Builder setRefundApplicationFee(Boolean refundApplicationFee)
      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.