Create preference - Preferences - Mercado Pago Developers
What are you looking for?

Do not know how to start integrating? 

Check the first steps
Create preference

POST

https://api.mercadopago.com/checkout/preferences
Generate a preference with the information of a product or service and obtain the necessary URL to start the payment flow..
Request's parameters
BODY
additional_info
string
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.
back_urls
object
URLs to return to the sellers website.
differential_pricing
object
Differential pricing configuration for this preference. The seller can have their own configuration regarding payment methods and installments, and it`s in this parameter where they will include the numeric ID to indicat...View more
Response parameters
collector_id
number
Unique ID used to identify the collector. It is the same as the Cust ID.
operation_type
String
Operation data_type.
regular_payment: Normal payment.
money_transfer: Money request.
items
array
Items information.
payer
object
Buyer information, such as name, last name, e-mail, phone, personal identification, address, and registration date.
Errors

400Error

collector_does_not_comply_with_current_regulation

identity validation required.

invalid_collector_id

collector_id invalid.

invalid_sponsor_id

sponsor_id is not an active user.

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

unit_price invalid.

invalid_back_urls

back_urls invalid. Wrong format.

invalid_payment_methods

installments invalid. Should be a number between 1 and 36.

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 type (<type>) for field shipments.cost.

invalid_binary_mode

binary_mode must be boolean.

Request
curl -X POST \
    'https://api.mercadopago.com/checkout/preferences'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
    -d '{
  "additional_info": "Discount 12.00",
  "back_urls": {
    "success": "http://test.com/success",
    "pending": "http://test.com/pending",
    "failure": "http://test.com/failure"
  },
  "differential_pricing": {
    "id": 1
  },
  "expiration_date_from": "2024-05-01T00:00:00Z",
  "expiration_date_to": "2024-06-01T00:00:00Z",
  "expires": false,
  "external_reference": "1643827245",
  "items": [
    {
      "id": "Sound system",
      "title": "Dummy Title",
      "description": "Dummy description",
      "picture_url": "http://www.myapp.com/myimage.jpg",
      "category_id": "car_electronics",
      "quantity": 1,
      "currency_id": "BRL",
      "unit_price": 10
    }
  ],
  "marketplace": "NONE",
  "marketplace_fee": 0,
  "metadata": {},
  "notification_url": "http://notificationurl.com",
  "payer": {
    "name": "John",
    "surname": "Doe",
    "email": "john@doe.com",
    "phone": {
      "area_code": "11",
      "number": 988888888
    },
    "identification": {
      "type": "CPF",
      "number": "19119119100"
    },
    "address": {
      "zip_code": "06233200",
      "street_name": "Example Street",
      "street_number": 123
    },
    "date_created": "2024-04-01T00:00:00Z"
  },
  "payment_methods": {
    "excluded_payment_methods": [
      {
        "id": "master"
      }
    ],
    "excluded_payment_types": [
      {
        "id": "ticket"
      }
    ],
    "default_payment_method_id": "amex",
    "installments": 10,
    "default_installments": 5
  },
  "shipments": {
    "local_pickup": false,
    "dimensions": "32 x 25 x 16",
    "default_shipping_method": null,
    "free_methods": [
      {
        "id": null
      }
    ],
    "cost": 20,
    "free_shipping": false,
    "receiver_address": {
      "zip_code": "72549555",
      "street_name": "Street address test",
      "city_name": "São Paulo",
      "state_name": "São Paulo",
      "street_number": 100,
      "country_name": "Brazil"
    }
  },
  "tracks": [
    {
      "type": "google_ad",
      "values": "conversion_id"
    }
  ]
}'
Sample answer
{
  "collector_id": 202809963,
  "items": [
    {
      "title": "Dummy Item",
      "description": "Multicolor Item",
      "currency_id": "$",
      "quantity": 1,
      "unit_price": 10
    }
  ],
  "payer": {
    "phone": {},
    "identification": {},
    "address": {}
  },
  "back_urls": {
    "success": "http://test.com/success",
    "pending": "http://test.com/pending",
    "failure": "http://test.com/failure"
  },
  "payment_methods": {
    "excluded_payment_methods": [
      {}
    ],
    "excluded_payment_types": [
      {}
    ]
  },
  "client_id": 6295877106812064,
  "marketplace": "MP-MKT-6295877106812064",
  "marketplace_fee": 0,
  "shipments": {
    "receiver_address": {}
  },
  "notification_url": "http://notificationurl.com",
  "statement_descriptor": "MERCADOPAGO",
  "date_created": "2018-02-02T19:22:23.535Z",
  "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",
  "metadata": {}
}