Get preference
GET
Products that use it:
Request's parameters
PATH
id
Preference ID.string
REQUIRED
Response parameters
additional_info
Additional information.string
auto_return
If specified, the buyer will be automatically redirected to the seller's site after the purchase is approved with a credit card.String
approved: The redirection takes place only for approved payments with a credit card.
all: The redirection takes place only for approved payments with a credit card, forward compatibility only if we change the default behavior.
back_urls
Return URLs to the seller's site, either automatically ("auto_return") or through the 'Return to site' button, depending on the payment status.object
client_id
Unique ID used to identify the client. It is obtained from the credentials used to create the preference. It´s the application ID.string
Errors
400Error
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_expiration_date_from
expiration_date_from invalid.
invalid_items
unit_price invalid.
invalid_payer
payer email invalid. Max length 150.
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 total amount, with me2 it cannot be lesser than <limit>.
Request
curl -X GET \
'https://api.mercadopago.com/checkout/preferences/{id}'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
curl -X GET \
'https://api.mercadopago.com/checkout/preferences/{id}'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
curl -X GET \
'https://api.mercadopago.com/checkout/preferences/{id}'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
curl -X GET \
'https://api.mercadopago.com/checkout/preferences/{id}'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
curl -X GET \
'https://api.mercadopago.com/checkout/preferences/{id}'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
curl -X GET \
'https://api.mercadopago.com/checkout/preferences/{id}'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
curl -X GET \
'https://api.mercadopago.com/checkout/preferences/{id}'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
Sample answer
{
"auto_return": "approved",
"back_urls": {},
"client_id": 6295877106812064,
"collector_id": 202809963,
"date_created": "2022-11-17T09:37:52.000-04:00",
"expiration_date_from": "2022-11-17T09:37:52.000-04:00",
"expiration_date_to": "2022-11-17T10:37:52.000-05:00",
"id": "202809963-a2201f8d-11cb-443f-adf6-de5a42eed67d",
"init_point": "https://www.mercadopago.com/mla/checkout/start?pref_id=202809963-a2201f8d-11cb-443f-adf6-de5a42eed67d",
"items": [
{
"id": "item-ID-1234",
"currency_id": "$",
"title": "Practical Granite Shirt",
"picture_url": "https://placehold.it/350x150",
"description": "This is my description",
"quantity": 2,
"unit_price": 14
}
],
"marketplace": "MP-MKT-6295877106812064",
"marketplace_fee": 0,
"statement_descriptor": "MERCADOPAGO",
"payer": {
"phone": {
"number": "631.586.0213"
},
"address": {
"zip_code": 76336,
"street_name": "Marjory Stream",
"street_number": 941
},
"identification": {
"number": 12345678,
"type": "DNI"
}
},
"payment_methods": {
"excluded_payment_methods": [
{}
],
"excluded_payment_types": [
{}
]
},
"sandbox_init_point": "https://sandbox.mercadopago.com/mla/checkout/pay?pref_id=202809963-a2201f8d-11cb-443f-adf6-de5a42eed67d",
"shipments": {
"receiver_address": {}
}
}