Package com.stripe.param

Class RefundCreateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setAmount

      public RefundCreateParams.Builder setAmount(Long amount)

    • setCharge

      public RefundCreateParams.Builder setCharge(String charge)
      The identifier of the charge to refund.

    • setCurrency

      public RefundCreateParams.Builder setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setCustomer

      public RefundCreateParams.Builder setCustomer(String customer)
      Customer whose customer balance to refund from.

    • addExpand

      public RefundCreateParams.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 RefundCreateParams.expand for the field documentation.

    • addAllExpand

      public RefundCreateParams.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 RefundCreateParams.expand for the field documentation.

    • putExtraParam

      public RefundCreateParams.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 RefundCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public RefundCreateParams.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 RefundCreateParams.extraParams for the field documentation.

    • setInstructionsEmail

      public RefundCreateParams.Builder setInstructionsEmail(String instructionsEmail)
      For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.

    • putMetadata

      public RefundCreateParams.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 RefundCreateParams.metadata for the field documentation.

    • putAllMetadata

      public RefundCreateParams.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 RefundCreateParams.metadata for the field documentation.

    • setMetadata

      public RefundCreateParams.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 RefundCreateParams.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.

    • setOrigin

      public RefundCreateParams.Builder setOrigin(RefundCreateParams.Origin origin)
      Origin of the refund.

    • setPaymentIntent

      public RefundCreateParams.Builder setPaymentIntent(String paymentIntent)
      The identifier of the PaymentIntent to refund.

    • setReason

      public RefundCreateParams.Builder setReason(RefundCreateParams.Reason reason)
      String indicating the reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer. If you believe the charge to be fraudulent, specifying fraudulent as the reason will add the associated card and email to your block lists, and will also help us improve our fraud detection algorithms.

    • setRefundApplicationFee

      public RefundCreateParams.Builder setRefundApplicationFee(Boolean refundApplicationFee)
      Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.

    • setReverseTransfer

      public RefundCreateParams.Builder setReverseTransfer(Boolean reverseTransfer)
      Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

      A transfer can be reversed only by the application that created the charge.