com.stripe.android.model

Class SourceParams

java.lang.Object

com.stripe.android.model.SourceParams

public class SourceParams
extends java.lang.Object

Represents a grouping of parameters needed to create a Source object on the server.

Method Summary

Modifier and Type	Method and Description
static SourceParams	createAlipayReusableParams(java.lang.String currency, java.lang.String name, java.lang.String email, java.lang.String returnUrl) Create parameters necessary for creating a reusable Alipay source.
static SourceParams	createAlipaySingleUseParams(long amount, java.lang.String currency, java.lang.String name, java.lang.String email, java.lang.String returnUrl) Create parameters necessary for creating a single use Alipay source.
static SourceParams	createBancontactParams(long amount, java.lang.String name, java.lang.String returnUrl, java.lang.String statementDescriptor, java.lang.String preferredLanguage) Create parameters necessary for creating a Bancontact source.
static SourceParams	createCardParams(Card card) Create parameters necessary for creating a card source.
static SourceParams	createCustomParams() Create a custom SourceParams object.
static SourceParams	createEPSParams(long amount, java.lang.String name, java.lang.String returnUrl, java.lang.String statementDescriptor) Create parameters necessary for creating an EPS source.
static SourceParams	createGiropayParams(long amount, java.lang.String name, java.lang.String returnUrl, java.lang.String statementDescriptor) Create parameters necessary for creating a Giropay source
static SourceParams	createIdealParams(long amount, java.lang.String name, java.lang.String returnUrl, java.lang.String statementDescriptor, java.lang.String bank) Create parameters necessary for creating an iDEAL source.
static SourceParams	createMasterpassParams(java.lang.String transactionId, java.lang.String cartID) Create parameters needed to make a Masterpass source
static SourceParams	createMultibancoParams(long amount, java.lang.String returnUrl, java.lang.String email) Create parameters necessary to create a Multibanco source.
static SourceParams	createP24Params(long amount, java.lang.String currency, java.lang.String name, java.lang.String email, java.lang.String returnUrl) Create parameters necessary for creating a P24 source.
static java.util.Map<java.lang.String,java.lang.Object>	createRetrieveSourceParams(java.lang.String clientSecret) Create parameters needed to retrieve a source.
static SourceParams	createSepaDebitParams(java.lang.String name, java.lang.String iban, java.lang.String addressLine1, java.lang.String city, java.lang.String postalCode, java.lang.String country)
static SourceParams	createSepaDebitParams(java.lang.String name, java.lang.String iban, java.lang.String email, java.lang.String addressLine1, java.lang.String city, java.lang.String postalCode, java.lang.String country) Create parameters necessary to create a SEPA debit source
static SourceParams	createSofortParams(long amount, java.lang.String returnUrl, java.lang.String country, java.lang.String statementDescriptor) Create parameters necessary to create a SOFORT source.
static SourceParams	createSourceFromTokenParams(java.lang.String tokenId) Create parameters necessary for converting a token into a source
static SourceParams	createThreeDSecureParams(long amount, java.lang.String currency, java.lang.String returnUrl, java.lang.String cardID) Create parameters necessary to create a 3D Secure source.
static SourceParams	createVisaCheckoutParams(java.lang.String callId) Create parameters needed to make a Visa Checkout source.
java.lang.Long	getAmount()
java.util.Map<java.lang.String,java.lang.Object>	getApiParameterMap()
java.lang.String	getCurrency()
java.util.Map<java.lang.String,java.lang.String>	getMetaData()
java.util.Map<java.lang.String,java.lang.Object>	getOwner()
java.util.Map<java.lang.String,java.lang.Object>	getRedirect()
java.lang.String	getType()
java.lang.String	getTypeRaw()
java.lang.String	getUsage()
SourceParams	setAmount(long amount)
SourceParams	setApiParameterMap(java.util.Map<java.lang.String,java.lang.Object> apiParameterMap)
SourceParams	setCurrency(java.lang.String currency)
SourceParams	setExtraParams(java.util.Map<java.lang.String,java.lang.Object> extraParams) Sets extra params for this source object.
SourceParams	setMetaData(java.util.Map<java.lang.String,java.lang.String> metaData) Set custom metadata on the parameters.
SourceParams	setOwner(java.util.Map<java.lang.String,java.lang.Object> owner)
SourceParams	setRedirect(java.util.Map<java.lang.String,java.lang.Object> redirect) Sets a redirect property map for this source object.
SourceParams	setReturnUrl(java.lang.String returnUrl)
SourceParams	setToken(java.lang.String token) Sets a token ID on the parameters.
SourceParams	setType(java.lang.String type) Sets the Source.SourceType for this source.
SourceParams	setTypeRaw(java.lang.String typeRaw) Sets a custom type for the source, and sets the type for these parameters to be Source.UNKNOWN.
SourceParams	setUsage(java.lang.String usage) Sets a usage value on the parameters.
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

createP24Params

public static SourceParams createP24Params(long amount,
                                           java.lang.String currency,
                                           java.lang.String name,
                                           java.lang.String email,
                                           java.lang.String returnUrl)

Create parameters necessary for creating a P24 source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment).

currency - `eur` or `pln` (P24 payments must be in either Euros or Polish Zloty).

name - The name of the account holder (optional).

email - The email address of the account holder.

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

Returns:

a SourceParams that can be used to create a P24 source

See Also:

https://stripe.com/docs/sources/p24

createAlipayReusableParams

public static SourceParams createAlipayReusableParams(java.lang.String currency,
                                                      java.lang.String name,
                                                      java.lang.String email,
                                                      java.lang.String returnUrl)

Create parameters necessary for creating a reusable Alipay source.

Parameters:

currency - The currency of the payment. Must be the default currency for your country. Can be aud, cad, eur, gbp, hkd, jpy, nzd, sgd, or usd. Users in Denmark, Norway, Sweden, or Switzerland must use eur.

name - The name of the account holder (optional).

email - The email address of the account holder (optional).

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

Returns:

a SourceParams that can be used to create an Alipay reusable source

See Also:

https://stripe.com/docs/sources/alipay

createAlipaySingleUseParams

public static SourceParams createAlipaySingleUseParams(long amount,
                                                       java.lang.String currency,
                                                       java.lang.String name,
                                                       java.lang.String email,
                                                       java.lang.String returnUrl)

Create parameters necessary for creating a single use Alipay source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a $10.99 payment).

currency - The currency of the payment. Must be the default currency for your country. Can be aud, cad, eur, gbp, hkd, jpy, nzd, sgd, or usd. Users in Denmark, Norway, Sweden, or Switzerland must use eur.

name - The name of the account holder (optional).

email - The email address of the account holder (optional).

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

Returns:

a SourceParams that can be used to create an Alipay single-use source

See Also:

https://stripe.com/docs/sources/alipay

createBancontactParams

public static SourceParams createBancontactParams(long amount,
                                                  java.lang.String name,
                                                  java.lang.String returnUrl,
                                                  java.lang.String statementDescriptor,
                                                  java.lang.String preferredLanguage)

Create parameters necessary for creating a Bancontact source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment). The charge amount must be at least €1 or its equivalent in the given currency.

name - The full name of the account holder.

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

statementDescriptor - A custom statement descriptor for the payment (optional).

preferredLanguage - The preferred language of the Bancontact authorization page that the customer is redirected to. Supported values are: en, de, fr, or nl (optional).

Returns:

a SourceParams object that can be used to create a Bancontact source

See Also:

https://stripe.com/docs/sources/bancontact

createCustomParams

public static SourceParams createCustomParams()

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

Returns:

an empty SourceParams object.

createSourceFromTokenParams

public static SourceParams createSourceFromTokenParams(java.lang.String tokenId)

Create parameters necessary for converting a token into a source

Parameters:

tokenId - the id of the Token to be converted into a source.

Returns:

a SourceParams object that can be used to create a source.

createCardParams

public static SourceParams createCardParams(Card card)

Create parameters necessary for creating a card source.

Parameters:

card - A Card object containing the details necessary for the source.

Returns:

a SourceParams object that can be used to create a card source.

See Also:

https://stripe.com/docs/sources/cards

createEPSParams

public static SourceParams createEPSParams(long amount,
                                           java.lang.String name,
                                           java.lang.String returnUrl,
                                           java.lang.String statementDescriptor)

Create parameters necessary for creating an EPS source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment).

name - The full name of the account holder.

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

statementDescriptor - A custom statement descriptor for the payment (optional).

Returns:

a SourceParams object that can be used to create an EPS source

See Also:

https://stripe.com/docs/sources/eps

createGiropayParams

public static SourceParams createGiropayParams(long amount,
                                               java.lang.String name,
                                               java.lang.String returnUrl,
                                               java.lang.String statementDescriptor)

Create parameters necessary for creating a Giropay source

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment).

name - The full name of the account holder.

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

statementDescriptor - A custom statement descriptor for the payment (optional).

Returns:

a SourceParams object that can be used to create a Giropay source

See Also:

https://stripe.com/docs/sources/giropay

createIdealParams

public static SourceParams createIdealParams(long amount,
                                             java.lang.String name,
                                             java.lang.String returnUrl,
                                             java.lang.String statementDescriptor,
                                             java.lang.String bank)

Create parameters necessary for creating an iDEAL source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment).

name - The full name of the account holder (optional).

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

statementDescriptor - A custom statement descriptor for the payment (optional).

bank - The customer’s bank (optional).

Returns:

a SourceParams object that can be used to create an iDEAL source

See Also:

https://stripe.com/docs/sources/ideal

createMultibancoParams

public static SourceParams createMultibancoParams(long amount,
                                                  java.lang.String returnUrl,
                                                  java.lang.String email)

Create parameters necessary to create a Multibanco source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment).

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

email - The full email address of the customer.

Returns:

a SourceParams object that can be used to create a Multibanco source

See Also:

https://stripe.com/docs/sources/multibanco

createSepaDebitParams

public static SourceParams createSepaDebitParams(java.lang.String name,
                                                 java.lang.String iban,
                                                 java.lang.String addressLine1,
                                                 java.lang.String city,
                                                 java.lang.String postalCode,
                                                 java.lang.String country)

createSepaDebitParams

public static SourceParams createSepaDebitParams(java.lang.String name,
                                                 java.lang.String iban,
                                                 java.lang.String email,
                                                 java.lang.String addressLine1,
                                                 java.lang.String city,
                                                 java.lang.String postalCode,
                                                 java.lang.String country)

Create parameters necessary to create a SEPA debit source

Parameters:

name - The full name of the account holder.

iban - The IBAN number for the bank account that you wish to debit.

email - The full email address of the owner (optional).

addressLine1 - The first line of the owner's address (optional).

city - The city of the owner's address.

postalCode - The postal code of the owner's address.

country - The ISO-3166 2-letter country code of the owner's address.

Returns:

a SourceParams object that can be used to create a SEPA debit source

See Also:

https://stripe.com/docs/sources/sepa-debit

createSofortParams

public static SourceParams createSofortParams(long amount,
                                              java.lang.String returnUrl,
                                              java.lang.String country,
                                              java.lang.String statementDescriptor)

Create parameters necessary to create a SOFORT source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment).

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

country - The ISO-3166 2-letter country code of the customer’s bank.

statementDescriptor - A custom statement descriptor for the payment (optional).

Returns:

a SourceParams object that can be used to create a SOFORT source

See Also:

https://stripe.com/docs/sources/sofort

createThreeDSecureParams

public static SourceParams createThreeDSecureParams(long amount,
                                                    java.lang.String currency,
                                                    java.lang.String returnUrl,
                                                    java.lang.String cardID)

Create parameters necessary to create a 3D Secure source.

Parameters:

amount - A positive integer in the smallest currency unit representing the amount to charge the customer (e.g., 1099 for a €10.99 payment).

currency - The currency the payment is being created in (e.g., eur).

returnUrl - The URL the customer should be redirected to after the verification process.

cardID - The ID of the card source.

Returns:

a SourceParams object that can be used to create a 3D Secure source

See Also:

https://stripe.com/docs/sources/three-d-secure

createVisaCheckoutParams

public static SourceParams createVisaCheckoutParams(java.lang.String callId)

Create parameters needed to make a Visa Checkout source.

Parameters:

callId - The payment request ID (callId) from the Visa Checkout SDK.

Returns:

a SourceParams object that can be used to create a Visa Checkout Card Source.

See Also:

https://stripe.com/docs/visa-checkout, https://developer.visa.com/capabilities/visa_checkout/docs

createMasterpassParams

public static SourceParams createMasterpassParams(java.lang.String transactionId,
                                                  java.lang.String cartID)

Create parameters needed to make a Masterpass source

Parameters:

transactionId - The transaction ID from the Masterpass SDK.

cartID - A unique string that you generate to identify the purchase when creating a cart for checkout in the Masterpass SDK.

Returns:

a SourceParams object that can be used to create a Masterpass Card Source.

See Also:

https://stripe.com/docs/masterpass, https://developer.mastercard.com/product/masterpass, https://developer.mastercard.com/page/masterpass-merchant-mobile-checkout-sdk-for-android-v2

createRetrieveSourceParams

public static java.util.Map<java.lang.String,java.lang.Object> createRetrieveSourceParams(java.lang.String clientSecret)

Create parameters needed to retrieve a source.

Parameters:

clientSecret - the client secret for the source, needed because the Android SDK uses a public key

Returns:

a Map matching the parameter name to the client secret, ready to send to the server.

getAmount

public java.lang.Long getAmount()

Returns:

the amount of the transaction

getApiParameterMap

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

Returns:

a Map of the parameters specific to this type of source

getCurrency

public java.lang.String getCurrency()

Returns:

the currency code for the transaction

getOwner

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

Returns:

details about the source owner (map contents are specific to source type)

getRedirect

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

Returns:

redirect map for the source

getType

public java.lang.String getType()

Returns:

the Type of this source

getTypeRaw

public java.lang.String getTypeRaw()

Returns:

a custom type of this source, if one has been set

getUsage

public java.lang.String getUsage()

Returns:

the current usage of this source, if one has been set

getMetaData

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

Returns:

the custom metadata set on these params

setAmount

public SourceParams setAmount(long amount)

Parameters:

amount - currency amount for this source, in the lowest denomination.

Returns:

this, for chaining purposes

setApiParameterMap

public SourceParams setApiParameterMap(java.util.Map<java.lang.String,java.lang.Object> apiParameterMap)

Parameters:

apiParameterMap - a map of parameters specific for this type of source

Returns:

this, for chaining purposes

setCurrency

public SourceParams setCurrency(java.lang.String currency)

Parameters:

currency - currency code for this source (i.e. "EUR")

Returns:

this, for chaining purposes

setOwner

public SourceParams setOwner(java.util.Map<java.lang.String,java.lang.Object> owner)

Parameters:

owner - an SourceOwner object for this source

Returns:

this, for chaining purposes

setRedirect

public SourceParams setRedirect(java.util.Map<java.lang.String,java.lang.Object> redirect)

Sets a redirect property map for this source object. If you only want to set a return url, use setReturnUrl(String).

Parameters:

redirect - a set of redirect parameters

Returns:

this, for chaining purposes

setExtraParams

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

Sets extra params for this source object.

Parameters:

extraParams - a set of params

Returns:

this, for chaining purposes

setReturnUrl

public SourceParams setReturnUrl(java.lang.String returnUrl)

Parameters:

returnUrl - a redirect URL for this source.

Returns:

this, for chaining purposes

setType

public SourceParams setType(java.lang.String type)

Sets the Source.SourceType for this source. If you are creating a custom type, use setTypeRaw(String).

Parameters:

type - the Source.SourceType

Returns:

this, for chaining purposes

setTypeRaw

public SourceParams setTypeRaw(java.lang.String typeRaw)

Sets a custom type for the source, and sets the type for these parameters to be Source.UNKNOWN.

Parameters:

typeRaw - the name of the source type

Returns:

this, for chaining purposes

setMetaData

public SourceParams setMetaData(java.util.Map<java.lang.String,java.lang.String> metaData)

Set custom metadata on the parameters.

Parameters:

metaData -

Returns:

this, for chaining purposes

setToken

public SourceParams setToken(java.lang.String token)

Sets a token ID on the parameters.

Parameters:

token - a token ID

Returns:

this, for chaining purposes

setUsage

public SourceParams setUsage(java.lang.String usage)

Sets a usage value on the parameters. Used for Alipay, and should be either "single_use" or "reusable". Not setting this value defaults to "single_use".

Parameters:

usage - either "single_use" or "reusable"

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