Preferences API

Attributes

AttributeTypeDescription
items Array(Object) Items information.
id String(256) Item ID.
title String(256) Item title. It will be displayed in the payment process.
description String(256) Item description.
picture_url String(600) Item image URL.
category_id String(256) Item category ID.
quantity Integer Item quantity.
currency_id String(3) Currency ID. ISO_4217 code.
unit_price Float Unit price.
payer Object Buyer Information.
name String(256) Buyer name.
surname String(256) Buyer last name.
email String(256) Buyer e-mail address.
phone Object Buyer phone.
area_code String(256) Area code.
number String(256) Number.
identification Object Personal identification.
type String(256) Identification Type.
number String(256) Number.
address Object Buyer address.
zip_code String(256) Zip code.
street_name String(256) Street name.
street_number Integer Street number.
date_created Date(ISO_8601) Registration date.
payment_methods Object Set up payment methods to be excluded from the payment process.
excluded_payment_methods Array(Object) Payment methods not allowed in payment process (except account_money).
id String(256) Payment method ID.
excluded_payment_types Array(Object) Payment types not allowed in payment process.
id String(256) Payment method data_type ID.
default_payment_method_id String(256) Payment method to be preferred on the payments methods list.
installments Integer Maximum number of credit card installments to be accepted.
default_installments Integer Prefered number of credit card installments.
shipments Object Shipments information.
mode String Shipment mode.
custom Custom shipping.
me2 Mercado Envíos.
not_specified Shipping mode not specified.
local_pickup Boolean The payer have the option to pick up the shipment in your store (mode:me2 only).
dimensions String Dimensions of the shipment in cm x cm x cm, gr (mode:me2 only)
default_shipping_method Integer Select default shipping method in checkout (mode:me2 only).
free_methods Array(Object) Offer a shipping method as free shipping (mode:me2 only).
id Integer Shipping method ID.
cost Float Shipment cost (mode:custom only).
free_shipping Boolean Free shipping for mode:custom.
receiver_address Object Shipping address.
zip_code String(256) Zip code.
street_name String(256) Street name.
street_number Integer Street number.
floor String(256) Floor.
apartment String(256) Apartment.
back_urls Object URLs to return to the sellers website.
success String(600) Approved payment URL.
pending String(600) Pending payment URL.
failure String(600) Canceled payment URL.
notification_url String(500) URL where you'd like to receive a payment notification.
id String(UUID) Preference ID.
init_point String Checkout access URL.
sandbox_init_point String Sandbox checkout access URL.
date_created Date(ISO_8601) Preference's creation date.
operation_type String Operation data_type.
regular_payment Normal payment.
money_transfer Money request.
additional_info String(600) Additional information.
auto_return String If specified, your buyers will be redirected back to your site immediately after completing the purchase.
approved The redirection takes place only for approved payments.
all The redirection takes place only for approved payments, forward compatibility only if we change the default behavior
external_reference String(256) Reference you can synchronize with your payment system.
expires Boolean Boolean value that determines if a preference expire.
expiration_date_from Date(ISO_8601) Date since the preference will be active.
expiration_date_to Date(ISO_8601) Date when the preference will be expired.
collector_id Integer Your Mercado Pago seller ID.
client_id String Application owner ID that use Mercado Libre API.
marketplace String(256) Origin of the payment. Default value: NONE
marketplace_fee Float Marketplace's fee charged by application owner. Default value: 0 in local currency
differential_pricing Object Differential pricing configuration for this preference.
id Integer Differential pricing ID.
binary_mode Boolean When set to true, the payment can only be approved or rejected. Otherwise in_process status is added.
taxes Array(Object) Differentiated taxes definition. Only available for Mercado Libre Colombia.
type String(3) Tax identifier. Only IVA and INC
value Float Tax amount. A maximum of two decimal places is supported. For tax exempt items, zero must be reported.

La búsqueda no arrojó ningún resultado.

Verifica la la ortografía de los términos de búsqueda o prueba con otras palabras clave.