Package com.stripe.param

Class ChargeCaptureParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setAmount

      public ChargeCaptureParams.Builder setAmount(Long amount)
      The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.

    • setApplicationFee

      public ChargeCaptureParams.Builder setApplicationFee(Long applicationFee)
      An application fee to add on to this charge.

    • setApplicationFeeAmount

      public ChargeCaptureParams.Builder setApplicationFeeAmount(Long applicationFeeAmount)
      An application fee amount to add on to this charge, which must be less than or equal to the original amount.

    • addExpand

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

    • addAllExpand

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

    • putExtraParam

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

    • putAllExtraParam

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

    • setReceiptEmail

      public ChargeCaptureParams.Builder setReceiptEmail(String receiptEmail)
      The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.

    • setStatementDescriptor

      public ChargeCaptureParams.Builder setStatementDescriptor(String statementDescriptor)
      For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

      For a card charge, this value is ignored unless you don't specify a statement_descriptor_suffix, in which case this value is used as the suffix.

    • setStatementDescriptorSuffix

      public ChargeCaptureParams.Builder setStatementDescriptorSuffix(String statementDescriptorSuffix)
      Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.

    • setTransferData

      public ChargeCaptureParams.Builder setTransferData(ChargeCaptureParams.TransferData transferData)
      An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

    • setTransferGroup

      public ChargeCaptureParams.Builder setTransferGroup(String transferGroup)
      A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.