Package com.stripe.param
Class ChargeCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.ChargeCreateParams
-
public class ChargeCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChargeCreateParams.Builder
static class
ChargeCreateParams.Destination
static class
ChargeCreateParams.Shipping
Add all map key/value pairs to `extraParams` map.static class
ChargeCreateParams.TransferData
State, county, province, or region.-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ChargeCreateParams.Builder
builder()
java.lang.Long
getAmount()
Amount intended to be collected by this payment.java.lang.Long
getApplicationFee()
java.lang.Long
getApplicationFeeAmount()
A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account.java.lang.Boolean
getCapture()
Whether to immediately capture the charge.java.lang.String
getCurrency()
Three-letter ISO currency code, in lowercase.java.lang.String
getCustomer()
The ID of an existing customer that will be charged in this request.java.lang.String
getDescription()
An arbitrary string which you can attach to aCharge
object.ChargeCreateParams.Destination
getDestination()
java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getOnBehalfOf()
The Stripe account ID for which these funds are intended.java.lang.String
getReceiptEmail()
The email address to which this charge's receipt will be sent.ChargeCreateParams.Shipping
getShipping()
Shipping information for the charge.java.lang.String
getSource()
A payment source to be charged.java.lang.String
getStatementDescriptor()
For card charges, usestatement_descriptor_suffix
instead.java.lang.String
getStatementDescriptorSuffix()
Provides information about the charge that customers see on their statements.ChargeCreateParams.TransferData
getTransferData()
An optional dictionary including the account to automatically transfer to as part of a destination charge.java.lang.String
getTransferGroup()
A string that identifies this transaction as part of a group.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static ChargeCreateParams.Builder builder()
-
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 theStripe-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 totrue
. Whenfalse
, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire in seven days. For more information, see the authorizing charges and settling later documentation.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
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 aCharge
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 thedescription
of the charge(s) that they are describing.
-
getDestination
public ChargeCreateParams.Destination getDestination()
-
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 tometadata
.
-
getOnBehalfOf
public java.lang.String getOnBehalfOf()
The Stripe account ID for which these funds are intended. Automatically set if you use thedestination
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. Ifreceipt_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.
-
getSource
public java.lang.String getSource()
A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the associated customer.
-
getStatementDescriptor
public java.lang.String getStatementDescriptor()
For card charges, usestatement_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.
-
getTransferData
public ChargeCreateParams.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 java.lang.String getTransferGroup()
A string that identifies this transaction as part of a group. For details, see Grouping transactions.
-
-