com.braintreepayments.api.models

Class PaymentMethodNonce

java.lang.Object

com.braintreepayments.api.models.PaymentMethodNonce

All Implemented Interfaces:

android.os.Parcelable

Direct Known Subclasses:

CardNonce, LocalPaymentResult, PayPalAccountNonce, VenmoAccountNonce, VisaCheckoutNonce

public abstract class PaymentMethodNonce
extends java.lang.Object
implements android.os.Parcelable

Base class representing a method of payment for a customer. PaymentMethodNonce represents the common interface of all payment method nonces, and can be handled by a server interchangeably.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DATA_KEY
protected boolean	mDefault
protected java.lang.String	mDescription
protected java.lang.String	mNonce
protected static java.lang.String	TOKEN_KEY

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	PaymentMethodNonce()
protected	PaymentMethodNonce(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
protected void	fromJson(org.json.JSONObject json)
java.lang.String	getDescription()
protected static org.json.JSONObject	getJsonObjectForType(java.lang.String apiResourceKey, org.json.JSONObject json)
java.lang.String	getNonce()
abstract java.lang.String	getTypeLabel()
boolean	isDefault()
static PaymentMethodNonce	parsePaymentMethodNonces(org.json.JSONObject json, java.lang.String type) Parses a PaymentMethodNonce from json.
static java.util.List<PaymentMethodNonce>	parsePaymentMethodNonces(java.lang.String jsonBody) Parses a response from the Braintree gateway for a list of payment method nonces.
static PaymentMethodNonce	parsePaymentMethodNonces(java.lang.String json, java.lang.String type) Parses a PaymentMethodNonce from json.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

DATA_KEY

protected static final java.lang.String DATA_KEY

See Also:

Constant Field Values

TOKEN_KEY

protected static final java.lang.String TOKEN_KEY

See Also:

Constant Field Values

mNonce

protected java.lang.String mNonce

mDescription

protected java.lang.String mDescription

mDefault

protected boolean mDefault

Constructor Detail

PaymentMethodNonce

public PaymentMethodNonce()

PaymentMethodNonce

protected PaymentMethodNonce(android.os.Parcel in)

Method Detail

getJsonObjectForType

protected static org.json.JSONObject getJsonObjectForType(java.lang.String apiResourceKey,
                                                          org.json.JSONObject json)
                                                   throws org.json.JSONException

Throws:

org.json.JSONException

fromJson

protected void fromJson(org.json.JSONObject json)
                 throws org.json.JSONException

Throws:

org.json.JSONException

getNonce

public java.lang.String getNonce()

Returns:

The nonce generated for this payment method by the Braintree gateway. The nonce will represent this PaymentMethod for the purposes of creating transactions and other monetary actions.

getDescription

public java.lang.String getDescription()

Returns:

The description of this PaymentMethod for displaying to a customer, e.g. 'Visa ending in...'

isDefault

public boolean isDefault()

Returns:

true if this payment method is the default for the current customer, false otherwise

getTypeLabel

public abstract java.lang.String getTypeLabel()

Returns:

The type of this PaymentMethod for displaying to a customer, e.g. 'Visa'. Can be used for displaying appropriate logos, etc.

parsePaymentMethodNonces

public static java.util.List<PaymentMethodNonce> parsePaymentMethodNonces(java.lang.String jsonBody)
                                                                   throws org.json.JSONException

Parses a response from the Braintree gateway for a list of payment method nonces.

Parameters:

jsonBody - Json-formatted String containing a list of PaymentMethodNonces

Returns:

List of PaymentMethodNonces contained in jsonBody

Throws:

org.json.JSONException

parsePaymentMethodNonces

public static PaymentMethodNonce parsePaymentMethodNonces(java.lang.String json,
                                                          java.lang.String type)
                                                   throws org.json.JSONException

Parses a PaymentMethodNonce from json.

Parameters:

json - String representation of a PaymentMethodNonce.

type - The String type of the PaymentMethodNonce.

Returns:

PaymentMethodNonce

Throws:

org.json.JSONException

parsePaymentMethodNonces

public static PaymentMethodNonce parsePaymentMethodNonces(org.json.JSONObject json,
                                                          java.lang.String type)
                                                   throws org.json.JSONException

Parses a PaymentMethodNonce from json.

Parameters:

json - JSONObject representation of a PaymentMethodNonce.

type - The String type of the PaymentMethodNonce.

Returns:

PaymentMethodNonce

Throws:

org.json.JSONException

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable