com.stripe.android

Class Stripe

java.lang.Object

com.stripe.android.Stripe

public class Stripe
extends java.lang.Object

Class that handles Token creation from charges, Card, and accounts.

Constructor Summary

Constructors

Constructor and Description
Stripe(android.content.Context context) A constructor with only context, to set the key later.
Stripe(android.content.Context context, java.lang.String publishableKey) Constructor with publishable key.

Method Summary

Modifier and Type	Method and Description
PaymentIntent	confirmPaymentIntentSynchronous(PaymentIntentParams paymentIntentParams, java.lang.String publishableKey) Blocking method to confirm a PaymentIntent object.
Token	createAccountTokenSynchronous(AccountParams accountParams) Blocking method to create a Token for a Connect Account.
Token	createAccountTokenSynchronous(AccountParams accountParams, java.lang.String publishableKey) Blocking method to create a Token for a Connect Account.
void	createBankAccountToken(BankAccount bankAccount, java.lang.String publishableKey, java.util.concurrent.Executor executor, TokenCallback callback) Call to create a Token for a BankAccount with the publishable key and Executor specified.
void	createBankAccountToken(BankAccount bankAccount, TokenCallback callback) The simplest way to create a BankAccount token.
Token	createBankAccountTokenSynchronous(BankAccount bankAccount) Blocking method to create a Token for a BankAccount.
Token	createBankAccountTokenSynchronous(BankAccount bankAccount, java.lang.String publishableKey) Blocking method to create a Token using a BankAccount.
void	createPiiToken(java.lang.String personalId, java.lang.String publishableKey, java.util.concurrent.Executor executor, TokenCallback callback) Call to create a Token for PII with the publishable key and Executor specified.
void	createPiiToken(java.lang.String personalId, TokenCallback callback) The simplest way to create a PII token.
Token	createPiiTokenSynchronous(java.lang.String personalId) Blocking method to create a Token for PII.
Token	createPiiTokenSynchronous(java.lang.String personalId, java.lang.String publishableKey) Blocking method to create a Token for PII.
void	createSource(SourceParams sourceParams, SourceCallback callback) Create a Source using an AsyncTask on the default Executor with a publishable api key that has already been set on this Stripe instance.
void	createSource(SourceParams sourceParams, SourceCallback callback, java.lang.String publishableKey, java.util.concurrent.Executor executor) Create a Source using an AsyncTask.
Source	createSourceSynchronous(SourceParams params) Blocking method to create a Source object using this object's key.
Source	createSourceSynchronous(SourceParams params, java.lang.String publishableKey) Blocking method to create a Source object.
void	createToken(Card card, java.util.concurrent.Executor executor, TokenCallback callback) Call to create a Token on a specific Executor.
void	createToken(Card card, java.lang.String publishableKey, java.util.concurrent.Executor executor, TokenCallback callback) Call to create a Token with the publishable key and Executor specified.
void	createToken(Card card, java.lang.String publishableKey, TokenCallback callback) Call to create a Token with a specific public key.
void	createToken(Card card, TokenCallback callback) The simplest way to create a token, using a Card and TokenCallback.
Token	createTokenSynchronous(Card card) Blocking method to create a Token.
Token	createTokenSynchronous(Card card, java.lang.String publishableKey) Blocking method to create a Token.
void	logEventSynchronous(java.util.List<java.lang.String> productUsageTokens, StripePaymentSource paymentSource)
PaymentIntent	retrievePaymentIntentSynchronous(PaymentIntentParams paymentIntentParams, java.lang.String publishableKey) Blocking method to retrieve a PaymentIntent object.
Source	retrieveSourceSynchronous(java.lang.String sourceId, java.lang.String clientSecret) Retrieve an existing Source from the Stripe API.
Source	retrieveSourceSynchronous(java.lang.String sourceId, java.lang.String clientSecret, java.lang.String publishableKey) Retrieve an existing Source from the Stripe API.
void	setDefaultPublishableKey(java.lang.String publishableKey) Set the default publishable key to use with this Stripe instance.
void	setStripeAccount(java.lang.String stripeAccount) Set the Stripe Connect account to use with this Stripe instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Stripe

public Stripe(android.content.Context context)

A constructor with only context, to set the key later.

Parameters:

context - Context for resolving resources

Stripe

public Stripe(android.content.Context context,
              java.lang.String publishableKey)

Constructor with publishable key.

Parameters:

context - Context for resolving resources

publishableKey - the client's publishable key

Method Detail

createBankAccountToken

public void createBankAccountToken(BankAccount bankAccount,
                                   TokenCallback callback)

The simplest way to create a BankAccount token. This runs on the default Executor and with the currently set mDefaultPublishableKey.

Parameters:

bankAccount - the BankAccount used to create this token

callback - a TokenCallback to receive either the token or an error

createBankAccountToken

public void createBankAccountToken(BankAccount bankAccount,
                                   java.lang.String publishableKey,
                                   java.util.concurrent.Executor executor,
                                   TokenCallback callback)

Call to create a Token for a BankAccount with the publishable key and Executor specified.

Parameters:

bankAccount - the BankAccount for which to create a Token

publishableKey - the publishable key to use

executor - an Executor to run this operation on. If null, this is run on a default non-ui executor

callback - a TokenCallback to receive the result or error message

createPiiToken

public void createPiiToken(java.lang.String personalId,
                           TokenCallback callback)

The simplest way to create a PII token. This runs on the default Executor and with the currently set mDefaultPublishableKey.

Parameters:

personalId - the personal id used to create this token

callback - a TokenCallback to receive either the token or an error

createPiiToken

public void createPiiToken(java.lang.String personalId,
                           java.lang.String publishableKey,
                           java.util.concurrent.Executor executor,
                           TokenCallback callback)

Call to create a Token for PII with the publishable key and Executor specified.

Parameters:

personalId - the personal id used to create this token

publishableKey - the publishable key to use

executor - an Executor to run this operation on. If null, this is run on a default non-ui executor

callback - a TokenCallback to receive the result or error message

createBankAccountTokenSynchronous

public Token createBankAccountTokenSynchronous(BankAccount bankAccount)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Blocking method to create a Token for a BankAccount. Do not call this on the UI thread or your app will crash. This method uses the default publishable key for this Stripe instance.

Parameters:

bankAccount - the Card to use for this token

Returns:

a Token that can be used for this BankAccount

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

CardException - should not be thrown with this type of token, but is theoretically possible given the underlying methods called

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers

createBankAccountTokenSynchronous

public Token createBankAccountTokenSynchronous(BankAccount bankAccount,
                                               java.lang.String publishableKey)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Blocking method to create a Token using a BankAccount. Do not call this on the UI thread or your app will crash.

Parameters:

bankAccount - the BankAccount to use for this token

publishableKey - the publishable key to use with this request

Returns:

a Token that can be used for this BankAccount

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

CardException - should not be thrown with this type of token, but is theoretically possible given the underlying methods called

APIException - any other type of problem

createSource

public void createSource(SourceParams sourceParams,
                         SourceCallback callback)

Create a Source using an AsyncTask on the default Executor with a publishable api key that has already been set on this Stripe instance.

Parameters:

sourceParams - the SourceParams to be used

callback - a SourceCallback to receive a result or an error message

createSource

public void createSource(SourceParams sourceParams,
                         SourceCallback callback,
                         java.lang.String publishableKey,
                         java.util.concurrent.Executor executor)

Create a Source using an AsyncTask.

Parameters:

sourceParams - the SourceParams to be used

callback - a SourceCallback to receive a result or an error message

publishableKey - the publishable api key to be used

executor - an Executor on which to execute the task, or null for default

createToken

public void createToken(Card card,
                        TokenCallback callback)

The simplest way to create a token, using a Card and TokenCallback. This runs on the default Executor and with the currently set mDefaultPublishableKey.

Parameters:

card - the Card used to create this payment token

callback - a TokenCallback to receive either the token or an error

createToken

public void createToken(Card card,
                        java.lang.String publishableKey,
                        TokenCallback callback)

Call to create a Token with a specific public key.

Parameters:

card - the Card used for this transaction

publishableKey - the public key used for this transaction

callback - a TokenCallback to receive the result of this operation

createToken

public void createToken(Card card,
                        java.util.concurrent.Executor executor,
                        TokenCallback callback)

Call to create a Token on a specific Executor.

Parameters:

card - the Card to use for this token creation

executor - An Executor on which to run this operation. If you don't wish to specify an executor, use one of the other createTokenFromParams methods.

callback - a TokenCallback to receive the result of this operation

createToken

public void createToken(Card card,
                        java.lang.String publishableKey,
                        java.util.concurrent.Executor executor,
                        TokenCallback callback)

Call to create a Token with the publishable key and Executor specified.

Parameters:

card - the Card used for this token

publishableKey - the publishable key to use

executor - an Executor to run this operation on. If null, this is run on a default non-ui executor

callback - a TokenCallback to receive the result or error message

createSourceSynchronous

public Source createSourceSynchronous(SourceParams params)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Blocking method to create a Source object using this object's key. Do not call this on the UI thread or your app will crash.

Parameters:

params - a set of SourceParams with which to create the source

Returns:

a Source, or null if a problem occurred

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

CardException - the card cannot be charged for some reason

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers

createSourceSynchronous

public Source createSourceSynchronous(SourceParams params,
                                      java.lang.String publishableKey)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      APIException

Blocking method to create a Source object. Do not call this on the UI thread or your app will crash.

Parameters:

params - a set of SourceParams with which to create the source

publishableKey - a publishable API key to use

Returns:

a Source, or null if a problem occurred

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers

retrievePaymentIntentSynchronous

public PaymentIntent retrievePaymentIntentSynchronous(PaymentIntentParams paymentIntentParams,
                                                      java.lang.String publishableKey)
                                               throws AuthenticationException,
                                                      InvalidRequestException,
                                                      APIConnectionException,
                                                      APIException

Blocking method to retrieve a PaymentIntent object. Do not call this on the UI thread or your app will crash.

Parameters:

paymentIntentParams - a set of params with which to retrieve the Payment Intent

publishableKey - a publishable API key to use

Returns:

a PaymentIntent or null if a problem occurred

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

confirmPaymentIntentSynchronous

public PaymentIntent confirmPaymentIntentSynchronous(PaymentIntentParams paymentIntentParams,
                                                     java.lang.String publishableKey)
                                              throws AuthenticationException,
                                                     InvalidRequestException,
                                                     APIConnectionException,
                                                     APIException

Blocking method to confirm a PaymentIntent object. Do not call this on the UI thread or your app will crash.

Parameters:

paymentIntentParams - a set of params with which to confirm the Payment Intent

publishableKey - a publishable API key to use

Returns:

a PaymentIntent or null if a problem occurred

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

createTokenSynchronous

public Token createTokenSynchronous(Card card)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Blocking method to create a Token. Do not call this on the UI thread or your app will crash. This method uses the default publishable key for this Stripe instance.

Parameters:

card - the Card to use for this token

Returns:

a Token that can be used for this card

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

CardException - the card cannot be charged for some reason

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers

createTokenSynchronous

public Token createTokenSynchronous(Card card,
                                    java.lang.String publishableKey)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Blocking method to create a Token. Do not call this on the UI thread or your app will crash.

Parameters:

card - the Card to use for this token

publishableKey - the publishable key to use with this request

Returns:

a Token that can be used for this card

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers)

CardException

createPiiTokenSynchronous

public Token createPiiTokenSynchronous(java.lang.String personalId)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

Blocking method to create a Token for PII. Do not call this on the UI thread or your app will crash. The method uses the currently set mDefaultPublishableKey.

Parameters:

personalId - the personal ID to use for this token

Returns:

a Token that can be used for this card

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers)

CardException

createPiiTokenSynchronous

public Token createPiiTokenSynchronous(java.lang.String personalId,
                                       java.lang.String publishableKey)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

Blocking method to create a Token for PII. Do not call this on the UI thread or your app will crash.

Parameters:

personalId - the personal ID to use for this token

publishableKey - the publishable key to use with this request

Returns:

a Token that can be used for this card

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers)

CardException

createAccountTokenSynchronous

public Token createAccountTokenSynchronous(AccountParams accountParams)
                                    throws AuthenticationException,
                                           InvalidRequestException,
                                           APIConnectionException,
                                           APIException

Blocking method to create a Token for a Connect Account. Do not call this on the UI thread or your app will crash. The method uses the currently set mDefaultPublishableKey.

Parameters:

accountParams - params to use for this token.

Returns:

a Token that can be used for this account.

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers)

createAccountTokenSynchronous

public Token createAccountTokenSynchronous(AccountParams accountParams,
                                           java.lang.String publishableKey)
                                    throws AuthenticationException,
                                           InvalidRequestException,
                                           APIConnectionException,
                                           APIException

Blocking method to create a Token for a Connect Account. Do not call this on the UI thread.

Parameters:

accountParams - params to use for this token.

publishableKey - the publishable key to use with this request. If null is passed in as the publishable key, we will use the default publishable key.

Returns:

a Token that can be used for this account.

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers)

logEventSynchronous

public void logEventSynchronous(java.util.List<java.lang.String> productUsageTokens,
                                StripePaymentSource paymentSource)

retrieveSourceSynchronous

public Source retrieveSourceSynchronous(java.lang.String sourceId,
                                        java.lang.String clientSecret)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Retrieve an existing Source from the Stripe API. Note that this is a synchronous method, and cannot be called on the main thread. Doing so will cause your app to crash. This method uses the default publishable key for this Stripe instance.

Parameters:

sourceId - the Source.mId field of the desired Source object

clientSecret - the Source.mClientSecret field of the desired Source object

Returns:

a Source if one could be found based on the input params, or null if no such Source could be found.

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers)

CardException

retrieveSourceSynchronous

public Source retrieveSourceSynchronous(java.lang.String sourceId,
                                        java.lang.String clientSecret,
                                        java.lang.String publishableKey)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Retrieve an existing Source from the Stripe API. Note that this is a synchronous method, and cannot be called on the main thread. Doing so will cause your app to crash.

Parameters:

sourceId - the Source.mId field of the desired Source object

clientSecret - the Source.mClientSecret field of the desired Source object

publishableKey - a publishable API key to use

Returns:

a Source if one could be found based on the input params, or null if no such Source could be found.

Throws:

AuthenticationException - failure to properly authenticate yourself (check your key)

InvalidRequestException - your request has invalid parameters

APIConnectionException - failure to connect to Stripe's API

APIException - any other type of problem (for instance, a temporary issue with Stripe's servers)

CardException

setDefaultPublishableKey

public void setDefaultPublishableKey(java.lang.String publishableKey)

Set the default publishable key to use with this Stripe instance.

Parameters:

publishableKey - the key to be set

setStripeAccount

public void setStripeAccount(java.lang.String stripeAccount)

Set the Stripe Connect account to use with this Stripe instance.

Parameters:

stripeAccount - the account ID to be set

See Also:

Authentication via the stripe account header