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 classSourceCreateParams.Builderstatic classSourceCreateParams.FlowState, county, province, or region.static classSourceCreateParams.Mandatestatic classSourceCreateParams.Ownerstatic classSourceCreateParams.ReceiverState, county, province, or region.static classSourceCreateParams.Redirectstatic classSourceCreateParams.SourceOrderThe URL you provide to redirect the customer back to you after they authenticated their payment.static classSourceCreateParams.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.Builderbuilder()java.lang.LonggetAmount()Amount associated with the source.java.lang.StringgetCurrency()Three-letter ISO code for the currency associated with the source.java.lang.StringgetCustomer()TheCustomerto 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.FlowgetFlow()The authenticationflowof the source to create.SourceCreateParams.MandategetMandate()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.StringgetOriginalSource()The source to share.SourceCreateParams.OwnergetOwner()Information about the owner of the payment instrument that may be used or required by particular source types.SourceCreateParams.ReceivergetReceiver()Optional parameters for the receiver flow.SourceCreateParams.RedirectgetRedirect()Parameters required for the redirect flow.SourceCreateParams.SourceOrdergetSourceOrder()Information about the items and shipping associated with the source.java.lang.StringgetStatementDescriptor()An arbitrary string to be displayed on your customer's statement.java.lang.StringgetToken()An optional token used to create the source.java.lang.StringgetType()Thetypeof the source to create.SourceCreateParams.UsagegetUsage()-
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_usesources. Not supported forreceivertype 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()
TheCustomerto 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@SerializedNamevalue. 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 authenticationflowof the source to create.flowis 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 (flowisreceiver).
-
getRedirect
public SourceCreateParams.Redirect getRedirect()
Parameters required for the redirect flow. Required if the source is authenticated by a redirect (flowisredirect).
-
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 isRunCluband the item you're charging for is a race ticket, you may want to specify astatement_descriptorofRunClub 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()
Thetypeof the source to create. Required unlesscustomerandoriginal_sourceare specified (see the Cloning card Sources guide)
-
getUsage
public SourceCreateParams.Usage getUsage()
-
-