com.stripe.android.model

Class PaymentIntentParams

java.lang.Object

com.stripe.android.model.PaymentIntentParams

public class PaymentIntentParams
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static PaymentIntentParams	createConfirmPaymentIntentWithSourceDataParams(SourceParams sourceParams, java.lang.String clientSecret, java.lang.String returnUrl) Create the parameters necessary for confirming a PaymentIntent while attaching Source data
static PaymentIntentParams	createConfirmPaymentIntentWithSourceIdParams(java.lang.String sourceId, java.lang.String clientSecret, java.lang.String returnUrl) Create the parameters necessary for confirming a PaymentIntent while attaching a source that already exits.
static PaymentIntentParams	createCustomParams() Create a custom PaymentIntentParams.
static PaymentIntentParams	createRetrievePaymentIntentParams(java.lang.String clientSecret) Create the parameters necessary for retrieving the details of PaymentIntent
java.lang.String	getClientSecret()
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams()
java.lang.String	getReturnUrl()
java.lang.String	getSourceId()
SourceParams	getSourceParams()
PaymentIntentParams	setClientSecret(java.lang.String clientSecret) Sets the client secret that is used to authenticate actions on this PaymentIntent
PaymentIntentParams	setExtraParams(java.util.Map<java.lang.String,java.lang.Object> extraParams)
PaymentIntentParams	setReturnUrl(java.lang.String returnUrl)
PaymentIntentParams	setSourceId(java.lang.String sourceId) Sets a pre-existing source that will be attached to this PaymentIntent
PaymentIntentParams	setSourceParams(SourceParams sourceParams) Sets the source data that will be included with this PaymentIntent
java.util.Map<java.lang.String,java.lang.Object>	toParamMap() Create a string-keyed map representing this object that is ready to be sent over the network.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createCustomParams

public static PaymentIntentParams createCustomParams()

Create a custom PaymentIntentParams. Incorrect attributes may result in errors when connecting to Stripe's API.

Returns:

an empty Params object. Call the setter methods on this class to specific values on the params

createConfirmPaymentIntentWithSourceDataParams

public static PaymentIntentParams createConfirmPaymentIntentWithSourceDataParams(SourceParams sourceParams,
                                                                                 java.lang.String clientSecret,
                                                                                 java.lang.String returnUrl)

Create the parameters necessary for confirming a PaymentIntent while attaching Source data

Parameters:

sourceParams - params for the source that will be attached to this payment intent

clientSecret - client secret from the PaymentIntent that is to be confirmed

returnUrl - the URL the customer should be redirected to after the authorization process

Returns:

params that can be use to confirm a PaymentIntent

createConfirmPaymentIntentWithSourceIdParams

public static PaymentIntentParams createConfirmPaymentIntentWithSourceIdParams(java.lang.String sourceId,
                                                                               java.lang.String clientSecret,
                                                                               java.lang.String returnUrl)

Create the parameters necessary for confirming a PaymentIntent while attaching a source that already exits.

Parameters:

sourceId - the ID of the source that is being attached to the PaymentIntent being confirmed

clientSecret - client secret from the PaymentIntent being confirmed

returnUrl - the URL the customer should be redirected to after the authorization process

Returns:

params that can be use to confirm a PaymentIntent

createRetrievePaymentIntentParams

public static PaymentIntentParams createRetrievePaymentIntentParams(java.lang.String clientSecret)

Create the parameters necessary for retrieving the details of PaymentIntent

Parameters:

clientSecret - client secret from the PaymentIntent that is being retrieved

Returns:

params that can be used to retrieve a PaymentIntent

setSourceParams

public PaymentIntentParams setSourceParams(SourceParams sourceParams)

Sets the source data that will be included with this PaymentIntent

Parameters:

sourceParams - params for the source that will be attached to this payment intent. Only one of SourceParam and SourceId should be used at at time

Returns:

this, for chaining purposes

setSourceId

public PaymentIntentParams setSourceId(java.lang.String sourceId)

Sets a pre-existing source that will be attached to this PaymentIntent

Parameters:

sourceId - the ID of the source that is being attached to this PaymentIntent. Only one of SourceParam and SourceId should be used at at time

Returns:

this, for chaining purposes

setClientSecret

public PaymentIntentParams setClientSecret(java.lang.String clientSecret)

Sets the client secret that is used to authenticate actions on this PaymentIntent

Parameters:

clientSecret - client secret associated with this PaymentIntent

Returns:

this, for chaining purposes

setReturnUrl

public PaymentIntentParams setReturnUrl(java.lang.String returnUrl)

Parameters:

returnUrl - the URL the customer should be redirected to after the authorization process

Returns:

this, for chaining purposes

setExtraParams

public PaymentIntentParams setExtraParams(java.util.Map<java.lang.String,java.lang.Object> extraParams)

Parameters:

extraParams - params that will be included in the request. Incorrect params may result in errors when connecting to Stripe's API.

Returns:

this, for chaining purposes

toParamMap

public java.util.Map<java.lang.String,java.lang.Object> toParamMap()

Create a string-keyed map representing this object that is ready to be sent over the network.

Returns:

a String-keyed map

getClientSecret

public java.lang.String getClientSecret()

Returns:

client secret associated with the PaymentIntent, used to identify the PaymentIntent and authenticate actions.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Returns:

extraparams that will be included in the request

getSourceParams

public SourceParams getSourceParams()

Returns:

params for the source that will be attached to this payment intent

getSourceId

public java.lang.String getSourceId()

Returns:

the ID of the existing source that is being attached to this PaymentIntent.

getReturnUrl

public java.lang.String getReturnUrl()

Returns:

the URL the customer should be redirected to after the authorization process