Class PreferenceRequest
- java.lang.Object
-
- com.mercadopago.client.preference.PreferenceRequest
-
public class PreferenceRequest extends Object
Parameters to create/update a preference.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPreferenceRequest.PreferenceRequestBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PreferenceRequest.PreferenceRequestBuilderbuilder()StringgetAdditionalInfo()Additional info.StringgetAutoReturn()If specified, your buyers will be redirected back to your site immediately after completing the purchase.PreferenceBackUrlsRequestgetBackUrls()URLs to return to the sellers website.BooleangetBinaryMode()When set to true, the payment can only be approved or rejected.OffsetDateTimegetDateOfExpiration()Expiration date of cash payment.PreferenceDifferentialPricingRequestgetDifferentialPricing()Differential pricing configuration for this preference.OffsetDateTimegetExpirationDateFrom()Date since the preference will be active.OffsetDateTimegetExpirationDateTo()Date when the preference will be expired.BooleangetExpires()True if a preference expires, false if not.StringgetExternalReference()Reference you can synchronize with your payment system.List<PreferenceItemRequest>getItems()List of items to be paid.StringgetMarketplace()Origin of the payment.BigDecimalgetMarketplaceFee()Marketplace's fee charged by application owner.Map<String,Object>getMetadata()Data that can be attached to the preference to record additional attributes of the merchant.StringgetNotificationUrl()URL where you'd like to receive a payment notification.StringgetOperationType()Operation type.PreferencePayerRequestgetPayer()Payer information.PreferencePaymentMethodsRequestgetPaymentMethods()Set up payment methods.List<String>getProcessingModes()Configures which processing modes to use.StringgetPurpose()Purpose of the Preference.PreferenceShipmentsRequestgetShipments()Shipments information.StringgetStatementDescriptor()How will look the payment in the card bill.List<PreferenceTaxRequest>getTaxes()Taxes for preferences.List<PreferenceTrackRequest>getTracks()Tracks to be executed during the users interaction in the Checkout flow.
-
-
-
Method Detail
-
builder
public static PreferenceRequest.PreferenceRequestBuilder builder()
-
getAdditionalInfo
public String getAdditionalInfo()
Additional info.
-
getAutoReturn
public String getAutoReturn()
If specified, your buyers will be redirected back to your site immediately after completing the purchase.
-
getBackUrls
public PreferenceBackUrlsRequest getBackUrls()
URLs to return to the sellers website.
-
getBinaryMode
public Boolean getBinaryMode()
When set to true, the payment can only be approved or rejected. Otherwise in_process status is added.
-
getDateOfExpiration
public OffsetDateTime getDateOfExpiration()
Expiration date of cash payment.
-
getDifferentialPricing
public PreferenceDifferentialPricingRequest getDifferentialPricing()
Differential pricing configuration for this preference.
-
getExpirationDateFrom
public OffsetDateTime getExpirationDateFrom()
Date since the preference will be active.
-
getExpirationDateTo
public OffsetDateTime getExpirationDateTo()
Date when the preference will be expired.
-
getExpires
public Boolean getExpires()
True if a preference expires, false if not.
-
getExternalReference
public String getExternalReference()
Reference you can synchronize with your payment system.
-
getItems
public List<PreferenceItemRequest> getItems()
List of items to be paid.
-
getMarketplace
public String getMarketplace()
Origin of the payment. Default value: NONE.
-
getMarketplaceFee
public BigDecimal getMarketplaceFee()
Marketplace's fee charged by application owner.
-
getMetadata
public Map<String,Object> getMetadata()
Data that can be attached to the preference to record additional attributes of the merchant.
-
getNotificationUrl
public String getNotificationUrl()
URL where you'd like to receive a payment notification.
-
getOperationType
public String getOperationType()
Operation type.
-
getPayer
public PreferencePayerRequest getPayer()
Payer information.
-
getPaymentMethods
public PreferencePaymentMethodsRequest getPaymentMethods()
Set up payment methods.
-
getProcessingModes
public List<String> getProcessingModes()
Configures which processing modes to use.
-
getPurpose
public String getPurpose()
Purpose of the Preference.
-
getShipments
public PreferenceShipmentsRequest getShipments()
Shipments information.
-
getStatementDescriptor
public String getStatementDescriptor()
How will look the payment in the card bill.
-
getTaxes
public List<PreferenceTaxRequest> getTaxes()
Taxes for preferences.
-
getTracks
public List<PreferenceTrackRequest> getTracks()
Tracks to be executed during the users interaction in the Checkout flow.
-
-