com.mercadopago.android.px.preferences

Class CheckoutPreference.Builder

java.lang.Object

com.mercadopago.android.px.preferences.CheckoutPreference.Builder

Enclosing class:

CheckoutPreference

public static class CheckoutPreference.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder(Site site, OpenPayer payer, java.util.List<Item> items) Deprecated.
Builder(Site site, java.lang.String payerEmail, java.util.List<Item> items) Builder for custom CheckoutPreference construction.

Method Summary

Modifier and Type	Method and Description
CheckoutPreference.Builder	addExcludedPaymentMethod(java.lang.String paymentMethodId) Add exclusion payment method id If you exclude it, it's not going appear as a payment method available on checkout
CheckoutPreference.Builder	addExcludedPaymentMethods(java.util.Collection<java.lang.String> paymentMethodIds) Add exclusion list by payment method id If you exclude it, it's not going appear as a payment method available on checkout
CheckoutPreference.Builder	addExcludedPaymentType(java.lang.String paymentTypeId) Add exclusion by payment type If you exclude it, it's not going appear as a payment method available on checkout
CheckoutPreference.Builder	addExcludedPaymentTypes(java.util.Collection<java.lang.String> paymentTypeIds) Add exclusion list by payment type If you exclude it, it's not going appear as a payment method available on checkout
CheckoutPreference	build() It creates the checkout preference.
CheckoutPreference.Builder	setActiveFrom(java.util.Date date) Date that indicates from when the preference is active.
CheckoutPreference.Builder	setBinaryMode(boolean isBinaryMode) If enableBinaryMode is called, processed payment can only be APPROVED or REJECTED.
CheckoutPreference.Builder	setConceptAmount(java.math.BigDecimal conceptAmount) internal usage
CheckoutPreference.Builder	setConceptId(java.lang.String conceptId) internal usage
CheckoutPreference.Builder	setDefaultInstallments(java.lang.Integer defaultInstallments) When default installments is not null then this value will be forced as installment selected if it matches with one provided by the Installments service.
CheckoutPreference.Builder	setDifferentialPricing(DifferentialPricing differentialPricing) Differential pricing configuration for this preference.
CheckoutPreference.Builder	setExpirationDate(java.util.Date date) Date that indicates when this preference expires.
CheckoutPreference.Builder	setMarketplaceFee(java.math.BigDecimal marketplaceFee) internal usage
CheckoutPreference.Builder	setMaxInstallments(java.lang.Integer maxInstallments) This value limits the amount of installments to be shown by the user.
CheckoutPreference.Builder	setOperationType(java.lang.String operationType) internal usage
CheckoutPreference.Builder	setShippingCost(java.math.BigDecimal shippingCost) internal usage

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               Site site,
               @NonNull
               java.lang.String payerEmail,
               @NonNull
               java.util.List<Item> items)

Builder for custom CheckoutPreference construction. It should be only used if you are processing the payment with a Payment processor. Otherwise you should use the ID constructor.

Parameters:

site - preference site Sites.getById(String)

payerEmail - payer email

items - items to pay

Builder

@Deprecated
public Builder(@NonNull
                           Site site,
                           @NonNull
                           OpenPayer payer,
                           @NonNull
                           java.util.List<Item> items)

Deprecated.

Builder for custom CheckoutPreference construction. It should be only used if you are processing the payment with a Payment processor. Otherwise you should use the ID constructor.

Parameters:

site - preference site Sites.getById(String)

payer - payer

items - items to pay

Method Detail

addExcludedPaymentMethod

public CheckoutPreference.Builder addExcludedPaymentMethod(@NonNull
                                                           java.lang.String paymentMethodId)

Add exclusion payment method id If you exclude it, it's not going appear as a payment method available on checkout

Parameters:

paymentMethodId - exclusion id

Returns:

builder

See Also:

PaymentMethods

addExcludedPaymentMethods

public CheckoutPreference.Builder addExcludedPaymentMethods(@NonNull
                                                            java.util.Collection<java.lang.String> paymentMethodIds)

Add exclusion list by payment method id If you exclude it, it's not going appear as a payment method available on checkout

Parameters:

paymentMethodIds - exclusion list

Returns:

builder

See Also:

PaymentMethods

addExcludedPaymentType

public CheckoutPreference.Builder addExcludedPaymentType(@NonNull
                                                         java.lang.String paymentTypeId)

Add exclusion by payment type If you exclude it, it's not going appear as a payment method available on checkout

Parameters:

paymentTypeId - exclusion type

Returns:

builder

See Also:

PaymentTypes

addExcludedPaymentTypes

public CheckoutPreference.Builder addExcludedPaymentTypes(@NonNull
                                                          java.util.Collection<java.lang.String> paymentTypeIds)

Add exclusion list by payment type If you exclude it, it's not going appear as a payment method available on checkout

Parameters:

paymentTypeIds - exclusion list

Returns:

builder

See Also:

PaymentTypes

setBinaryMode

public CheckoutPreference.Builder setBinaryMode(boolean isBinaryMode)

If enableBinaryMode is called, processed payment can only be APPROVED or REJECTED. Default value is false.

Non compatible with PaymentProcessor.

Non compatible with off payments methods

Returns:

builder to keep operating

setMaxInstallments

public CheckoutPreference.Builder setMaxInstallments(@Nullable
                                                     java.lang.Integer maxInstallments)

This value limits the amount of installments to be shown by the user.

Parameters:

maxInstallments - max installments to be shown

Returns:

builder

setDefaultInstallments

public CheckoutPreference.Builder setDefaultInstallments(@Nullable
                                                         java.lang.Integer defaultInstallments)

When default installments is not null then this value will be forced as installment selected if it matches with one provided by the Installments service.

Parameters:

defaultInstallments - number of the value to be forced

Returns:

builder

setExpirationDate

public CheckoutPreference.Builder setExpirationDate(@Nullable
                                                    java.util.Date date)

Date that indicates when this preference expires. If the preference is expired, then the checkout will show an error.

Parameters:

date - creation date.

Returns:

builder

setActiveFrom

public CheckoutPreference.Builder setActiveFrom(@Nullable
                                                java.util.Date date)

Date that indicates from when the preference is active. If the preference is related with a date in the future then an error screen will be shown.

Parameters:

date - creation date.

Returns:

builder

setDifferentialPricing

public CheckoutPreference.Builder setDifferentialPricing(@Nullable
                                                         DifferentialPricing differentialPricing)

Differential pricing configuration for this preference. This object is related with the way the installments are asked.

Parameters:

differentialPricing - differential pricing object

Returns:

builder

setMarketplaceFee

public CheckoutPreference.Builder setMarketplaceFee(java.math.BigDecimal marketplaceFee)

internal usage

Parameters:

marketplaceFee - amount fee

Returns:

builder

setShippingCost

public CheckoutPreference.Builder setShippingCost(java.math.BigDecimal shippingCost)

internal usage

Parameters:

shippingCost - amount fee

Returns:

builder

setOperationType

public CheckoutPreference.Builder setOperationType(java.lang.String operationType)

internal usage

Parameters:

operationType - this operation can be ...

Returns:

builder

setConceptAmount

public CheckoutPreference.Builder setConceptAmount(java.math.BigDecimal conceptAmount)

internal usage

Parameters:

conceptAmount - amount

Returns:

builder

setConceptId

public CheckoutPreference.Builder setConceptId(java.lang.String conceptId)

internal usage

Parameters:

conceptId - identifier

Returns:

builder

build

public CheckoutPreference build()

It creates the checkout preference.

Returns:

CheckoutPreference