Package com.stripe.param
Class TransferCreateParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.TransferCreateParams
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
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 TransferCreateParams.Builder
builder()
A positive integer in cents (or local equivalent) representing how much to transfer.Required. Three-letter ISO code for currency in lowercase.An arbitrary string attached to the object.Required. The ID of a connected Stripe account.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.You can use this parameter to transfer funds from a charge before they are added to your available balance.The source balance to use for this transfer.A string that identifies this transaction as part of a group.Methods inherited from class com.stripe.net.ApiRequestParams
paramsToMap, toMap
-
Method Details
-
builder
-
getAmount
A positive integer in cents (or local equivalent) representing how much to transfer. -
getCurrency
Required. Three-letter ISO code for currency in lowercase. Must be a supported currency. -
getDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
getDestination
Required. The ID of a connected Stripe account. See the Connect documentation for details. -
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
. -
getSourceTransaction
You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details. -
getSourceType
The source balance to use for this transfer. One ofbank_account
,card
, orfpx
. For most users, this will default tocard
. -
getTransferGroup
A string that identifies this transaction as part of a group. See the Connect documentation for details.
-