Class ChargeCaptureParams


public class ChargeCaptureParams extends ApiRequestParams
  • Method Details

    • builder

      public static ChargeCaptureParams.Builder builder()
    • getAmount

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

      public Long getApplicationFee()
      An application fee to add on to this charge.
    • getApplicationFeeAmount

      public Long getApplicationFeeAmount()
      An application fee amount to add on to this charge, which must be less than or equal to the original amount.
    • 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.
    • getReceiptEmail

      public String getReceiptEmail()
      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.
    • getStatementDescriptor

      public String getStatementDescriptor()
      For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
    • getStatementDescriptorSuffix

      public String getStatementDescriptorSuffix()
      Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
    • getTransferData

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

      public String getTransferGroup()
      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.