Create preference/checkout/preferencesGenerate a preference with the information of a product or service and obtain the necessary URL to start the payment flow.
POST
Products that use it:
Request's parameters
additional_info
Localization: bodyAdditional information.string
auto_return
Localization: bodyIf specified, your buyers will be redirected back to your site immediately after completing the purchase.String
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
Localization: bodyURLs to return to the sellers website.object
date_of_expiration
Localization: bodyExpiration date of cash payment.string
Response parameters
collector_id
Localization: bodyUnique ID used to identify the collector. It is the same as the Cust ID.number
operation_type
Localization: bodyOperation data_type.String
regular_payment: Normal payment.
money_transfer: Money request.
items
Localization: bodyItems information.array
payer
Localization: bodyBuyer information, such as name, last name, e-mail, phone, personal identification, address, and registration date.object
Request
curl
curl -X POST \
'https://api.mercadopago.com/checkout/preferences' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"items": [
{
"title": "Dummy Title",
"description": "Dummy description",
"picture_url": "http://www.myapp.com/myimage.jpg",
"category_id": "car_electronics",
"quantity": 1,
"currency_id": "U$",
"unit_price": 10
}
],
"payer": {
"phone": {},
"identification": {},
"address": {}
},
"payment_methods": {
"excluded_payment_methods": [
{}
],
"excluded_payment_types": [
{}
]
},
"shipments": {
"free_methods": [
{}
],
"receiver_address": {}
},
"back_urls": {},
"differential_pricing": {},
"tracks": [
{
"type": "google_ad"
}
],
"metadata": {}
}'
Answer
json
{
"collector_id": 202809963,
"items": [
{
"title": "Dummy Item",
"description": "Multicolor Item",
"currency_id": "$",
"quantity": 1,
"unit_price": 10
}
],
"payer": {
"phone": {},
"identification": {},
"address": {}
},
"back_urls": {},
"payment_methods": {
"excluded_payment_methods": [
{}
],
"excluded_payment_types": [
{}
]
},
"client_id": 6295877106812064,
"marketplace": "MP-MKT-6295877106812064",
"marketplace_fee": 0,
"shipments": {
"receiver_address": {}
},
"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": {}
}
Errors
400bad_request
collector_does_not_comply_with_current_regulation
invalid_collector_idcollector_id invalid.
invalid_sponsor_idsponsor_id is not an active user.
invalid_collector_emailcollector is not collector_email owner
invalid_operation_typeoperation_type invalid.
invalid_expiration_date_toexpiration_date_to invalid.
invalid_dateinvalid date of expiration.
invalid_expiration_date_fromexpiration_date_from invalid.
invalid_itemsunit_price invalid.
invalid_back_urlsback_urls invalid. Wrong format
invalid_payment_methodsinstallments invalid. Should be a number between 1 and 36.
invalid_marketplace_feemarketplace_fee must not be greater than total amount.
invalid_idpreference_id not found.
invalid_access_tokenaccess denied
invalid_shipmentsinvalid type (<type>) for field shipments.cost.
invalid_binary_modebinary_mode must be boolean.