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 and Card models.

Constructor Summary

Constructors

Constructor and Description
Stripe() A blank constructor to set the key later.
Stripe(java.lang.String publishableKey) Constructor with publishable key.

Method Summary

Modifier and Type	Method and Description
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	setDefaultPublishableKey(java.lang.String publishableKey) Set the default publishable key 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()

A blank constructor to set the key later.

Stripe

public Stripe(java.lang.String publishableKey)
       throws AuthenticationException

Constructor with publishable key.

Parameters:

publishableKey - the client's publishable key

Throws:

AuthenticationException - if the key is invalid

Method Detail

createToken

public void createToken(@NonNull
                        Card card,
                        @NonNull
                        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 defaultPublishableKey.

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(@NonNull
                        Card card,
                        @NonNull
                        java.lang.String publishableKey,
                        @NonNull
                        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(@NonNull
                        Card card,
                        @NonNull
                        java.util.concurrent.Executor executor,
                        @NonNull
                        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 createToken methods.

callback - a TokenCallback to receive the result of this operation

createToken

public void createToken(@NonNull
                        Card card,
                        @NonNull
                        java.lang.String publishableKey,
                        @Nullable
                        java.util.concurrent.Executor executor,
                        @NonNull
                        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

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

CardException - the card cannot be charged for some reason

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

setDefaultPublishableKey

public void setDefaultPublishableKey(@NonNull
                                     java.lang.String publishableKey)
                              throws AuthenticationException

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

Parameters:

publishableKey - the key to be set

Throws:

AuthenticationException - if the key is null, empty, or a secret key