Package com.stripe.param

Class ChargeCreateParams

    • Method Detail

      • getAmount

        public java.lang.Long getAmount()
        Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

      • getApplicationFee

        public java.lang.Long getApplicationFee()

      • getApplicationFeeAmount

        public java.lang.Long getApplicationFeeAmount()
        A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

      • getCapture

        public java.lang.Boolean getCapture()
        Whether to immediately capture the charge. Defaults to true. When false, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the authorizing charges and settling later documentation.

      • getCustomer

        public java.lang.String getCustomer()
        The ID of an existing customer that will be charged in this request.

      • getDescription

        public java.lang.String getDescription()
        An arbitrary string which you can attach to a Charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.

      • 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.lang.Object 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.

      • getOnBehalfOf

        public java.lang.String getOnBehalfOf()
        The Stripe account ID for which these funds are intended. Automatically set if you use the destination parameter. For details, see Creating Separate Charges and Transfers.

      • getReceiptEmail

        public java.lang.String getReceiptEmail()
        The email address to which this charge's receipt will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a Customer, the email address specified here will override the customer's email address. If receipt_email is specified for a charge in live mode, a receipt will be sent regardless of your email settings.

      • getShipping

        public ChargeCreateParams.Shipping getShipping()
        Shipping information for the charge. Helps prevent fraud on charges for physical goods.

      • getStatementDescriptor

        public java.lang.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 java.lang.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.

      • getTransferGroup

        public java.lang.String getTransferGroup()
        A string that identifies this transaction as part of a group. For details, see Grouping transactions.