Preferences API
Attributes
AttributeTypeDescription
items
Array(Object)
Informações sobre o item.
id
String(256)
Indentificador do item.
title
String(256)
Título do item, é apresentado o fluxo de pagamento.
description
String(256)
Descrição do artigo.
picture_url
String(600)
URL da imagem do anúncio.
category_id
String(256)
Identificador da categoria do item.
quantity
Integer
Quantidade de itens.
currency_id
String(3)
Identificador de moeda em formato ISO_4217.
unit_price
Float
Preço unitário.
payer
Object
Informações sobre o comprador.
name
String(256)
Nome do comprador.
surname
String(256)
Apelido do comprador.
email
String(256)
Endereço de e-mail do comprador.
phone
Object
Telefone do comprador.
area_code
String(256)
Código de área.
number
String(256)
O Número.
identification
Object
Identificação pessoal.
type
String(256)
Tipo de identificação.
number
String(256)
O Número.
address
Object
Endereço do comprador.
zip_code
String(256)
Código postal.
street_name
String(256)
Nome da rua.
street_number
Integer
Número da rua.
date_created
Date(ISO_8601)
Data de registro.
payment_methods
Object
Métodos de pagamento a ser excluídos do fluxo de pagamento.
excluded_payment_methods
Array(Object)
Métodos de pagamento não são permitidos no fluxo de pagamento (à exceção de account_money).
id
String(256)
Identificador do método de pagamento.
excluded_payment_types
Array(Object)
Tipos de pagamento não são permitidos no fluxo de pagamento.
id
String(256)
Identificador de data_type do meio de pagamento.
default_payment_method_id
String(256)
Meio de pagamento preferido.
installments
Integer
Número Máximo de cotas.
default_installments
Integer
Preferência de cotas.
shipments
Object
Informações de envio.
mode
String
Modo de envio.
custom
Custom shipping.
me2
Mercado Envíos.
not_specified
Shipping mode not specified.
local_pickup
Boolean
Preferência de remoção de pacotes em agência(mode:me2 somente).
dimensions
String
Tamanho do pacote em cm x cm x cm, gr (mode:me2 somente)
default_shipping_method
Integer
Escolha um método de envio padrão no _checkout_(mode:me2 somente).
free_methods
Array(Object)
Oferecer um método de frete grátis (mode:me2 somente).
id
Integer
Identificador do método de envio.
cost
Float
Custo do transporte (mode:custom somente).
free_shipping
Boolean
Preferência de frete grátis para mode:custom.
receiver_address
Object
Endereço de envio.
zip_code
String(256)
Código postal.
street_name
String(256)
Rua.
city_name
String(256)
Cidade.
state_name
String(256)
Estado.
street_number
Integer
O Número.
floor
String(256)
Apartamento.
apartment
String(256)
Apartamento.
back_urls
Object
Url de retorno ao site do vendedor.
success
String(600)
URL de retorno ante o pagamento aprovado.
pending
String(600)
failure
String(600)
URL de retorno ante o pagamento cancelado.
notification_url
String(500)
URL para a qual você gostaria de receber notificações de pagamentos.
statement_descriptor
String
Como aparecerá o pagamento no extrato do cartão (ex: o MERCADOPAGO).
id
String(UUID)
Identificação de preferência.
init_point
String
URL de acesso ao checkout.
sandbox_init_point
String
URL de acesso ao sandbox checkout.
date_created
Date(ISO_8601)
Data de criação de sua preferência.
operation_type
String
data_type da operação.
regular_payment
Normal payment.
money_transfer
Money request.
additional_info
String(600)
Informações adicionais.
auto_return
String
No caso de estar especificado o comprador será redirecionado para o seu site imediatamente após a compra.
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)
Referência que pode sincronizar com seu sistema de pagamentos.
expires
Boolean
Preferência que determina se uma preferência expira.
date_of_expiration
Date(ISO_8601)
Data de expiração de meios de pagamento em dinheiro.
expiration_date_from
Date(ISO_8601)
Data a partir da qual a preferência estará ativa.
expiration_date_to
Date(ISO_8601)
Data em que a preferência expira.
collector_id
Integer
Sua identificação como um vendedor no Mercado Pago.
client_id
String
Id do dono do aplicativo que usa a API do Mercado Livre.
marketplace
String(256)
Origem do pagamento. Valor por defeito: NENHUM
marketplace_fee
Float
Comissão de Mercado cobrada pelo proprietário do aplicativo. Valor por defeito: 0 em moeda local
differential_pricing
Object
Configuração de preço diferencial para esta preferência.
id
Integer
Identificador de preço diferenciado.
binary_mode
Boolean
Quando definido como true, o pagamento só pode ter os status approved ou rejected. Caso contrário, o status in_process é adicionado.
taxes
Array(Object)
Definição de impostos diferenciados. Disponível apenas para o Mercado Livre Colombia.
type
String(3)
Identificador de imposto. Somente IVA e INC.
value
Float
Valor do imposto. É suportado no máximo duas casas decimais. Para itens isentos de imposto, zero deve ser relatado.
tracks
Array (Object)
Tracks que serão executados durante a interação do usuário no fluxo de Pagamento.
type
String
Tipo da track. Especifique a herramienta pertenecen los valores.
google_ad
Configure uma tag de acompanhamento de conversões do Google Ads no GTM. Valores necessários: conversion_id e conversion_label.
facebook_ad
Permite configurar um pixel do Facebook. Valores necessários: pixel_id.
values
Map
Valores de configuração de acordo com o tipo de track.