PaymentMethodTokenizationParameters

AI-generated Key Takeaways

• PaymentMethodTokenizationParameters is used to pass parameters for tokenizing a credit card selected by the user.

• To configure gateway tokenization, set the tokenization type to PAYMENT_GATEWAY and add gateway-specific parameters using addParameter.

• Parameters are validated, and an invalid_parameters error is returned for missing or unexpected parameters.

• A Builder class is available to create PaymentMethodTokenizationParameters instances.

public final class PaymentMethodTokenizationParameters extends Object
implements Parcelable

Tokenization parameters that the integrator passes to tokenize the credit card that the user selects.

In order to configure gateway tokenization, set the tokenization type to WalletConstants.PAYMENT_METHOD_TOKENIZATION_TYPE_PAYMENT_GATEWAY and pass gateway specific parameters as key/value pairs by calling PaymentMethodTokenizationParameters.Builder.addParameter(String, String). When using gateway tokenization, the parameters must include a parameter with name "gateway" and value set to one of the supported gateways.

Note: parameters will be validated and error code WalletConstants.ERROR_CODE_INVALID_PARAMETERS will be returned if they happen to be invalid e.g. missing required parameter for a gateway or unexpected parameter is used.

An example of a tokenization configuration:

 PaymentMethodTokenizationParameters parameters = PaymentMethodTokenizationParameters.newBuilder()
     .setPaymentMethodTokenizationType(WalletConstants.PAYMENT_GATEWAY)
     .addParameter("gateway", "example")
     .addParameter("gatewayMerchantId", "exampleGatewayMerchantId")
     .build();

Nested Class Summary

class

PaymentMethodTokenizationParameters.Builder

Builder to create a PaymentMethodTokenizationParameters.

Inherited Constant Summary

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Field Summary

public static final Creator<PaymentMethodTokenizationParameters>

CREATOR

Public Method Summary

Bundle	getParameters() Payment method tokenization parameters.
int	getPaymentMethodTokenizationType() Payment method tokenization type.
static PaymentMethodTokenizationParameters.Builder	newBuilder()
void	writeToParcel(Parcel out, int flags)

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Fields

public static final Creator<PaymentMethodTokenizationParameters> CREATOR

Public Methods

public Bundle getParameters ()

Payment method tokenization parameters.

Returns

• payment method tokenization parameters

public int getPaymentMethodTokenizationType ()

Payment method tokenization type. See WalletConstants.PaymentMethodTokenizationType for a list of supported tokenization types.

Returns

• payment method tokenization type

public static PaymentMethodTokenizationParameters.Builder newBuilder ()

public void writeToParcel (Parcel out, int flags)