/checkout/preferences

BASE URI https://api.mercadopago.com/checkout/preferences

HTTP Request

curl

 curl -X POST \
  'https://api.mercadopago.com/checkout/preferences?access_token=ACCESS_TOKEN_ENV' \
  -H 'content-type:application/json' \
  -d '{
        "items": [
            {
            "title": "Dummy Item",
            "description": "Multicolor Item",
            "quantity": 1,
            "currency_id": "[FAKER][CURRENCY][ACRONYM]",
            "unit_price": 10.0
            }
        ]
    }'






     

Request Params

ParameterTypeDescription
items Array(Object) Información sobre el ítem.
id String(256) Indentificador del ítem.
title String(256) Título del ítem, se mostrará en el flujo de pago.
description String(256) Descripción del item.
picture_url String(600) URL de imagen del ítem.
category_id String(256) Identificador de la categoría del ítem.
quantity Integer Cantidad de ítems.
currency_id String(3) Identificador de moneda en formato ISO_4217.
unit_price Float Precio unitario.
payer Object Información sobre el comprador.
name String(256) Nombre del comprador.
surname String(256) Apellido del comprador.
email String(256) Dirección de e-mail del comprador.
phone Object Teléfono del comprador.
area_code String(256) Código de área.
number String(256) Número.
identification Object Identificación personal.
type String(256) Tipo de identificación.
number String(256) Número.
address Object Dirección del comprador.
zip_code String(256) Código postal.
street_name String(256) Nombre de la calle.
street_number Integer Número de la calle.
date_created Date(ISO_8601) Fecha de registración.
payment_methods Object Métodos de pago a ser excluídos del flujo de pago.
excluded_payment_methods Array(Object) Métodos de pago no permitidos en el flujo de pago (a excepción de account_money).
id String(256) Identificador del método de pago.
excluded_payment_types Array(Object) Tipos de pago no permitidos en el flujo de pago.
id String(256) Identificador de data_type del medio de pago.
default_payment_method_id String(256) Medio de pago preferido.
installments Integer Máximo número de cuotas.
default_installments Integer Preferencia de cuotas.
shipments Object Información de envío.
mode String Modo de envío.
custom Envío personalizado.
me2 Mercado Envíos.
not_specified Modo de envío no especificado.
local_pickup Boolean Preferencia de retiro de paquetes en sucursal(mode:me2 solamente).
dimensions String Tamaño del paquete en cm x cm x cm, gr (mode:me2 solamente)
default_shipping_method Integer Elegir un método de envío predeterminado en el _checkout_(mode:me2 solamente).
free_methods Array(Object) Ofrecer un método de envío gratuito (mode:me2 solamente).
id Integer Identificador de método de envío.
cost Float Costo del envío (mode:custom solamente).
free_shipping Boolean Preferencia de envío gratuito para mode:custom.
receiver_address Object Dirección de envío.
zip_code String(256) Código postal.
street_name String(256) Calle.
city_name String(256) Ciudad.
state_name String(256) Estado.
street_number Integer Número.
floor String(256) Piso.
apartment String(256) Departamento.
back_urls Object URLs de retorno al sitio del vendedor.
success String(600) URL de retorno ante pago aprobado.
pending String(600)
failure String(600) URL de retorno ante pago cancelado.
notification_url String(500) URL a la cual te gustaría recibir notificaciones de pagos.
statement_descriptor String Cómo aparecerá el pago en el resumen de tarjeta (ej.: MERCADOPAGO).
additional_info String(600) Información adicional.
auto_return String En el caso de estar especificado tu comprador sera redirigido a tu sitio inmediatamente después de la compra.
approved La redirección solo se realiza si el pago fue aprobado.
all La redirección solo se realiza si el pago fue aprobado, brindando compatibilidad solamente si se cambia el comportamiento por defecto.
external_reference String(256) Referencia que puedes sincronizar con tu sistema de pagos.
expires Boolean Preferencia que determina si una preferencia expira.
date_of_expiration Date(ISO_8601) Fecha de vencimiento del medio de pago en efectivo.
expiration_date_from Date(ISO_8601) Fecha a partir de la cual la preferencia estará activa.
expiration_date_to Date(ISO_8601) Fecha en la que la preferencia expirará.
marketplace String(256) Origen del pago. Valor por defecto: NONE
marketplace_fee Float Comisión de Marketplace cobrada por el dueño de la aplicación. Valor por defecto: 0 en moneda local
differential_pricing Object Configuración de precio diferencial para esta preferencia.
id Integer Identificador de precio diferenciado.
tracks Array (Object) Tracks que se ejecutarán durante la interacción de los usuarios en el flujo de Pago.
type String Tipo del track. Especifica a qué herramienta pertenecen los valores.
google_ad Permite configurar una etiqueta de seguimiento de conversiones de Google Ads de GTM. Valores necesarios: conversion_id y conversion_label.
facebook_ad Permite configurar un Pixel de Facebook. Valores necesarios: pixel_id.
values Map Valores de configuración de acuerdo al tipo de track.

HTTP Response

json

 {
    "collector_id": 202809963,
    "operation_type": "regular_payment",
    "items": [
        {
            "id": "",
            "picture_url": "",
            "title": "Dummy Item",
            "description": "Multicolor Item",
            "category_id": "",
            "currency_id": "[FAKER][CURRENCY][ACRONYM]",
            "quantity": 1,
            "unit_price": 10
        }
    ],
    "payer": {
        "name": "",
        "surname": "",
        "email": "",
        "date_created": "",
        "phone": {
            "area_code": "",
            "number": ""
        },
        "identification": {
            "type": "",
            "number": ""
        },
        "address": {
            "street_name": "",
            "street_number": null,
            "zip_code": ""
        }
    },
    "back_urls": {
        "success": "",
        "pending": "",
        "failure": ""
    },
    "auto_return": "",
    "payment_methods": {
        "excluded_payment_methods": [
            {
                "id": ""
            }
        ],
        "excluded_payment_types": [
            {
                "id": ""
            }
        ],
        "installments": null,
        "default_payment_method_id": null,
        "default_installments": null
    },
    "client_id": "6295877106812064",
    "marketplace": "MP-MKT-6295877106812064",
    "marketplace_fee": 0,
    "shipments": {
        "receiver_address": {
            "zip_code": "",
            "street_number": null,
            "street_name": "",
            "floor": "",
            "apartment": ""
        }
    },
    "notification_url": null,
    "statement_descriptor": "MERCADOPAGO",
    "external_reference": "",
    "additional_info": "",
    "expires": false,
    "expiration_date_from": null,
    "expiration_date_to": null,
    "date_created": "2018-02-02T15:22:23.535-04:00",
    "id": "202809963-920c288b-4ebb-40be-966f-700250fa5370",
    "init_point": "https://www.mercadopago.com/mla/checkout/start?pref_id=202809963-920c288b-4ebb-40be-966f-700250fa5370",
    "sandbox_init_point": "https://sandbox.mercadopago.com/mla/checkout/pay?pref_id=202809963-920c288b-4ebb-40be-966f-700250fa5370"
}
 

Error Codes

CodeDescription
400 bad_request
invalid_collector_id collector_id must be a number.
invalid_collector_id collector_id inválido.
invalid_sponsor_id sponsor_id not found.
invalid_sponsor_id invalid type () for field sponsor_id
invalid_sponsor_id sponsor_id should be different than collector_id.
invalid_sponsor_id sponsor_id site must be the same as collector_id.
invalid_sponsor_id sponsor_id didn't accept MercadoPago's Terms and Conditions.
invalid_sponsor_id sponsor_id is not an active user.
invalid_collector_email collector is not collector_email(secure) owner
invalid_collector_email collector is not collector_email owner
invalid_operation_type operation_type invalid.
invalid_expiration_date_to expiration_date_to invalid.
invalid_date invalid date of expiration.
invalid_expiration_date_from expiration_date_from invalid.
invalid_items amount cannot be paid with Mercado Pago.
invalid_items items needed.
invalid_items items must be a array.
invalid_items currency_id needed.
invalid_items currency_id invalid.
invalid_items quantity needed.
invalid_items items..quantity must be a integer.
invalid_items unit_price needed.
invalid_items unit_price must be a number.
invalid_items unit_price invalid.
invalid_back_urls back_urls invalid. Wrong format
invalid_payment_methods payment_methods invalid. Wrong format
invalid_payment_methods amount cannot be paid with MercadoPago.
invalid_payment_methods excluded_payment_methods invalid. Wrong format.
invalid_payment_methods id needed.
invalid_payment_methods account_money cannot be excluded.
invalid_payment_methods cannot exclude all payments methods.
invalid_payment_methods excluded_payment_types invalid. Wrong format.
invalid_payment_methods cannot exclude all payments types.
invalid_payment_methods client_id invalid.
invalid_payment_methods client_id must be a number.
invalid_payment_methods installments invalid. Should be a number between 1 and 36.
invalid_marketplace_fee invalid type () for field marketplace_fee.
invalid_marketplace_fee marketplace_fee must not be greater than total amount.
invalid_id preference_id not found.
invalid_access_token access denied
invalid_shipments invalid shipment mode
invalid_shipments collector doesn't have me2 active.
invalid_shipments invalid free_methods
invalid_shipments invalid shipments.default_shipping_method
invalid_shipments shipments.cost invalid
invalid_shipments Invalid dimensions format
invalid_shipments Invalid dimension values
invalid_shipments invalid dimension configuration for me2.
invalid_shipments Invalid total amount, with me2 it cannot be lesser than .
invalid_shipments invalid type () for field shipments.local_pickup.
invalid_shipments invalid type () for field shipments.dimensions.
invalid_shipments invalid type () for field shipments.free_shipping.
invalid_shipments invalid type () for field shipments.default_shipping_method.
invalid_shipments invalid type () for field shipments.cost.
invalid_binary_mode binary_mode debe ser booleano.

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.