Package com.stripe.param
Class SourceCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.SourceCreateParams
-
public class SourceCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SourceCreateParams.Builder
static class
SourceCreateParams.Flow
State, county, province, or region.static class
SourceCreateParams.Mandate
static class
SourceCreateParams.Owner
static class
SourceCreateParams.Receiver
State, county, province, or region.static class
SourceCreateParams.Redirect
static class
SourceCreateParams.SourceOrder
The URL you provide to redirect the customer back to you after they authenticated their payment.static class
SourceCreateParams.Usage
-
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 SourceCreateParams.Builder
builder()
java.lang.Long
getAmount()
Amount associated with the source.java.lang.String
getCurrency()
Three-letter ISO code for the currency associated with the source.java.lang.String
getCustomer()
TheCustomer
to whom the original source is attached to.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.SourceCreateParams.Flow
getFlow()
The authenticationflow
of the source to create.SourceCreateParams.Mandate
getMandate()
Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
java.lang.String
getOriginalSource()
The source to share.SourceCreateParams.Owner
getOwner()
Information about the owner of the payment instrument that may be used or required by particular source types.SourceCreateParams.Receiver
getReceiver()
Optional parameters for the receiver flow.SourceCreateParams.Redirect
getRedirect()
Parameters required for the redirect flow.SourceCreateParams.SourceOrder
getSourceOrder()
Information about the items and shipping associated with the source.java.lang.String
getStatementDescriptor()
An arbitrary string to be displayed on your customer's statement.java.lang.String
getToken()
An optional token used to create the source.java.lang.String
getType()
Thetype
of the source to create.SourceCreateParams.Usage
getUsage()
-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static SourceCreateParams.Builder builder()
-
getAmount
public java.lang.Long getAmount()
Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required forsingle_use
sources. Not supported forreceiver
type sources, where charge amount may not be specified until funds land.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready.
-
getCustomer
public java.lang.String getCustomer()
TheCustomer
to whom the original source is attached to. Must be set when the original source is not aSource
(e.g.,Card
).
-
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.
-
getFlow
public SourceCreateParams.Flow getFlow()
The authenticationflow
of the source to create.flow
is one ofredirect
,receiver
,code_verification
,none
. It is generally inferred unless a type supports multiple flows.
-
getMandate
public SourceCreateParams.Mandate getMandate()
Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
-
getOriginalSource
public java.lang.String getOriginalSource()
The source to share.
-
getOwner
public SourceCreateParams.Owner getOwner()
Information about the owner of the payment instrument that may be used or required by particular source types.
-
getReceiver
public SourceCreateParams.Receiver getReceiver()
Optional parameters for the receiver flow. Can be set only if the source is a receiver (flow
isreceiver
).
-
getRedirect
public SourceCreateParams.Redirect getRedirect()
Parameters required for the redirect flow. Required if the source is authenticated by a redirect (flow
isredirect
).
-
getSourceOrder
public SourceCreateParams.SourceOrder getSourceOrder()
Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
-
getStatementDescriptor
public java.lang.String getStatementDescriptor()
An arbitrary string to be displayed on your customer's statement. As an example, if your website isRunClub
and the item you're charging for is a race ticket, you may want to specify astatement_descriptor
ofRunClub 5K race ticket.
While many payment types will display this information, some may not display it at all.
-
getToken
public java.lang.String getToken()
An optional token used to create the source. When passed, token properties will override source parameters.
-
getType
public java.lang.String getType()
Thetype
of the source to create. Required unlesscustomer
andoriginal_source
are specified (see the Cloning card Sources guide)
-
getUsage
public SourceCreateParams.Usage getUsage()
-
-