Package com.stripe.param
Class PayoutCreateParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.PayoutCreateParams
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static enum
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
Modifier and TypeMethodDescriptionstatic PayoutCreateParams.Builder
builder()
A positive integer in cents representing how much to payout.Three-letter ISO currency code, in lowercase.An arbitrary string attached to the object.The ID of a bank account or a card to send the payout to.Specifies which fields in the response should be expanded.Map of extra parameters for custom features not available in this client library.Set of key-value pairs that you can attach to an object.The method used to send this payout, which can bestandard
orinstant
.The balance type of your Stripe balance to draw this payout from.A string to be displayed on the recipient's bank or card statement.Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
Method Details
-
builder
-
getAmount
A positive integer in cents representing how much to payout. -
getCurrency
Three-letter ISO currency code, in lowercase. Must be a supported currency. -
getDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
getDestination
The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. -
getExpand
Specifies which fields in the response should be expanded. -
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
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
. -
getMethod
The method used to send this payout, which can bestandard
orinstant
.instant
is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.) -
getSourceType
The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One ofbank_account
,card
, orfpx
. -
getStatementDescriptor
A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use astatement_descriptor
longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.
-