mercadopago.preferences.create-preference

Creates a Checkout Pro preference. The response contains init_point (production) and Webhook events triggered: payment, merchant_order

Create a preference

Overview

Property	Value
Workflow type	Atomic
Library	App-mercadopago
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Mercadopago API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
items	list	Yes	—	List of products/services being purchased
payer	json	No	—	—
payment_methods	json	No	—	—
shipments	json	No	—	—
back_urls	json	No	—	Redirect URLs after checkout completion. Configure auto_return to control when automatic redirects happen.
notification_url	string	No	—	URL for IPN notifications. DEPRECATED — use Webhooks instead.
statement_descriptor	string	No	—	Text on the payer's card statement. Max 22 chars.
additional_info	string	No	—	Free-text additional info (returned in webhook notifications)
auto_return	string	No	—	approved — auto-redirect to success URL on approved payments; all — auto-redirect for any final status.
external_reference	string	No	—	Your internal order reference. Returned in webhook payloads.
expires	boolean	No	—	Whether this preference has an expiry window
expiration_date_from	string	No	—	Preference activation start time (ISO 8601)
expiration_date_to	string	No	—	Preference expiration time (ISO 8601)
marketplace	string	No	—	Marketplace identifier
marketplace_fee	float	No	—	Marketplace fee charged to the seller
differential_pricing	json	No	—	—
binary_mode	boolean	No	—	—

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Mercadopago API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
items	list	Yes	—	List of products/services being purchased
payer	json	No	—	—
payment_methods	json	No	—	—
shipments	json	No	—	—
back_urls	json	No	—	Redirect URLs after checkout completion. Configure auto_return to control when automatic redirects happen.
notification_url	string	No	—	URL for IPN notifications. DEPRECATED — use Webhooks instead.
statement_descriptor	string	No	—	Text on the payer's card statement. Max 22 chars.
additional_info	string	No	—	Free-text additional info (returned in webhook notifications)
auto_return	string	No	—	approved — auto-redirect to success URL on approved payments; all — auto-redirect for any final status.
external_reference	string	No	—	Your internal order reference. Returned in webhook payloads.
expires	boolean	No	—	Whether this preference has an expiry window
expiration_date_from	string	No	—	Preference activation start time (ISO 8601)
expiration_date_to	string	No	—	Preference expiration time (ISO 8601)
marketplace	string	No	—	Marketplace identifier
marketplace_fee	float	No	—	Marketplace fee charged to the seller
differential_pricing	json	No	—	—
binary_mode	boolean	No	—	—
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call POST /checkout/preferences
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform POST /checkout/preferences
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "mercadopago.preferences.create-preference",
  "initial_data": {
    "base_url": "value",
    "items": "value"
  }
}