com.stripe.android

Class PaymentSession

java.lang.Object

com.stripe.android.PaymentSession

public class PaymentSession
extends java.lang.Object

Represents a single start-to-finish payment operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PaymentSession.PaymentSessionListener Represents a listener for PaymentSession actions, used to update the host activity when necessary.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_PAYMENT_SESSION_ACTIVE
static java.lang.String	PAYMENT_SESSION_CONFIG
static java.lang.String	PAYMENT_SESSION_DATA_KEY
static java.lang.String	TOKEN_PAYMENT_SESSION

Constructor Summary

Constructors

Constructor and Description
PaymentSession(android.app.Activity hostActivity) Create a PaymentSession attached to the given host Activity.

Method Summary

Modifier and Type	Method and Description
void	completePayment(PaymentCompletionProvider provider) Complete a payment using the given provider.
PaymentSessionData	getPaymentSessionData()
boolean	handlePaymentData(int requestCode, int resultCode, android.content.Intent data) Method to handle Activity results from Stripe activities.
boolean	init(PaymentSession.PaymentSessionListener listener, PaymentSessionConfig paymentSessionConfig) Initialize the PaymentSession with a PaymentSession.PaymentSessionListener to be notified of data changes.
boolean	init(PaymentSession.PaymentSessionListener listener, PaymentSessionConfig paymentSessionConfig, android.os.Bundle savedInstanceState) Initialize the PaymentSession with a PaymentSession.PaymentSessionListener to be notified of data changes.
void	onDestroy() Should be called during the host Activity's onDestroy to detach listeners.
void	presentPaymentMethodSelection() Launch the PaymentMethodsActivity to allow the user to select a payment method, or to add a new one.
void	presentShippingFlow() Launch the PaymentFlowActivity to allow the user to fill in payment details.
void	savePaymentSessionInstanceState(android.os.Bundle outState) Save the data associated with this PaymentSession.
void	setCartTotal(long cartTotal) Set the cart total for this PaymentSession.
boolean	updateIsPaymentReadyToCharge(PaymentSessionConfig paymentSessionConfig, PaymentSessionData paymentSessionData) Function that looks at the PaymentSessionConfig and determines whether the data in the provided PaymentSessionData is ready to charge.

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_PAYMENT_SESSION

public static final java.lang.String TOKEN_PAYMENT_SESSION

See Also:

Constant Field Values

EXTRA_PAYMENT_SESSION_ACTIVE

public static final java.lang.String EXTRA_PAYMENT_SESSION_ACTIVE

See Also:

Constant Field Values

PAYMENT_SESSION_DATA_KEY

public static final java.lang.String PAYMENT_SESSION_DATA_KEY

See Also:

Constant Field Values

PAYMENT_SESSION_CONFIG

public static final java.lang.String PAYMENT_SESSION_CONFIG

See Also:

Constant Field Values

Constructor Detail

PaymentSession

public PaymentSession(android.app.Activity hostActivity)

Create a PaymentSession attached to the given host Activity.

Parameters:

hostActivity - an Activity from which to launch other Stripe Activities. This Activity will receive results in Activity.onActivityResult(int, int, Intent) that should be passed back to this session.

Method Detail

completePayment

public void completePayment(PaymentCompletionProvider provider)

Complete a payment using the given provider.

Parameters:

provider - a PaymentCompletionProvider that connects to a server and completes a charge on a background thread.

handlePaymentData

public boolean handlePaymentData(int requestCode,
                                 int resultCode,
                                 android.content.Intent data)

Method to handle Activity results from Stripe activities. Pass data here from your host Activity's Activity.onActivityResult(int, int, Intent) function.

Parameters:

requestCode - the request code used to open the resulting activity

resultCode - a result code representing the success of the intended action

data - an Intent with the resulting data from the Activity

Returns:

true if the activity result was handled by this function, otherwise false

updateIsPaymentReadyToCharge

public boolean updateIsPaymentReadyToCharge(PaymentSessionConfig paymentSessionConfig,
                                            PaymentSessionData paymentSessionData)

Function that looks at the PaymentSessionConfig and determines whether the data in the provided PaymentSessionData is ready to charge. Return with whether the data is ready to charge.

Parameters:

paymentSessionConfig - specifies what data is required.

paymentSessionData - holds the data that has been collected.

Returns:

whether the data in the provided PaymentSessionData is ready to charge.

init

public boolean init(PaymentSession.PaymentSessionListener listener,
                    PaymentSessionConfig paymentSessionConfig)

Initialize the PaymentSession with a PaymentSession.PaymentSessionListener to be notified of data changes.

Parameters:

listener - a PaymentSession.PaymentSessionListener that will receive notifications of changes in payment session status, including networking status

paymentSessionConfig - a PaymentSessionConfig used to decide which items are necessary in the PaymentSession.

Returns:

true if the PaymentSession is initialized, false if a state error occurs. Failure can only occur if there is no initialized CustomerSession.

init

public boolean init(PaymentSession.PaymentSessionListener listener,
                    PaymentSessionConfig paymentSessionConfig,
                    android.os.Bundle savedInstanceState)

Initialize the PaymentSession with a PaymentSession.PaymentSessionListener to be notified of data changes.

Parameters:

listener - a PaymentSession.PaymentSessionListener that will receive notifications of changes in payment session status, including networking status

paymentSessionConfig - a PaymentSessionConfig used to decide which items are necessary in the PaymentSession.

savedInstanceState - a Bundle containing the saved state of a PaymentSession that was stored in savePaymentSessionInstanceState(Bundle)

Returns:

true if the PaymentSession is initialized, false if a state error occurs. Failure can only occur if there is no initialized CustomerSession.

presentPaymentMethodSelection

public void presentPaymentMethodSelection()

Launch the PaymentMethodsActivity to allow the user to select a payment method, or to add a new one.

savePaymentSessionInstanceState

public void savePaymentSessionInstanceState(android.os.Bundle outState)

Save the data associated with this PaymentSession. This should be called in the host Activity Activity.onSaveInstanceState(Bundle) method.

Parameters:

outState - the host activity's outgoing Bundle

setCartTotal

public void setCartTotal(long cartTotal)

Set the cart total for this PaymentSession. This should not include shipping costs.

Parameters:

cartTotal - the current total price for all non-shipping and non-tax items in a customer's cart

presentShippingFlow

public void presentShippingFlow()

Launch the PaymentFlowActivity to allow the user to fill in payment details.

getPaymentSessionData

public PaymentSessionData getPaymentSessionData()

Returns:

the data associated with the instance of this class.

onDestroy

public void onDestroy()

Should be called during the host Activity's onDestroy to detach listeners.