This endpoint allows canceling an order and its transactions using the reference ID obtained in the response to its creation. Only an order with "status=action_required" or "status=created" can be canceled. In case of success, the request will return a response with status 200.
POST
REQUIRED
REQUIRED
REQUIRED
Errors
Each API response includes an HTTP status code indicating the result of the request. Status code 200 indicates success, 400 indicates an error in the submitted data, and 500 indicates an internal server error.
Some 400 errors can be handled programmatically and include an error code that identifies the issue.
400Request error.
invalid_path_param
The "order_id" provided in the request path is not correct. Please confirm it and provide a valid ID to try again.
empty_required_header
The "X-Idempotency-Key" header is required and was not sent. Make the requisition again including it.
invalid_idempotency_key_length
The value sent in the "X-Idempotency-Key" header exceeded the allowed size. The header accepts values between 1 and 64 characters.
401Error. Access Token not authorized.
401
The value sent as Access Token is incorrect. Please check and try again with the correct value.
invalid_credentials
There is no support for test credentials. Use test users with production credentials for the sandbox environment and your production credentials for the production environment.
404Error. Order not found.
order_not_found
Order not found. Please check if you provided the correct order ID.
409Some specific system rule does not allow the action to be performed due to defined restrictions.
cannot_cancel_order
The status of the order does not allow its cancelation. Only orders with "status=action_required" or "status=created" can be canceled.
order_already_canceled
The order has already been canceled.
idempotency_key_already_used
The value sent as the idempotency header ("X-Idempotency-Key") has already been used. Please try the request again sending a new value.
429Request limit exceeded.
too_many_requests
"Client ID" blocked by the gateway because the request limit for the ID in question was reached. Read the "Retry-After" header from the response and wait the indicated number of seconds before retrying. For greater resilience, implement exponential backoff with jitter, that is, increase the wait time with each new attempt and add a random variation to avoid simultaneous retransmission of multiple requests.
usage_quota_exceeded
Quota enforced by the API backend because the per-client request limit was reached. Read the "Retry-After" header from the response and wait the indicated number of seconds before retrying. For greater resilience, implement exponential backoff with jitter, that is, increase the wait time with each new attempt and add a random variation to avoid simultaneous retransmission of multiple requests.
500Generic error.
internal_error
Generic error. Please try submitting the request again.
curl -X POST \
'https://api.mercadopago.com/v1/orders/{order_id}/cancel'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer APP_USR-5*********956537-12*********ff1a3d36d*********47e7b9985*********770' \
-H 'X-Idempotency-Key: dd567b12-ea8e-49f7-a3a1-42cbd74fcc32' \
{
"id": "ORD01J49MMW3SSBK5PSV3DFR32959",
"processing_mode": "automatic",
"external_reference": "ext_ref_1234",
"total_amount": "50.00",
"integration_data": {
"application_id": "1234",
"integrator_id": "dev_123",
"platform_id": "1234567890",
"sponsor": {
"id": "<YOUR_SPONSOR_ID>"
}
},
"user_id": "12345",
"created_date": "2024-08-26T13:06:51.045317772Z",
"last_updated_date": "2024-08-26T13:06:51.045317772Z",
"country_code": "UY",
"type": "online",
"status": "canceled",
"status_detail": "canceled_transaction",
"capture_mode": "automatic",
"transactions": {
"payments": [
{
"id": "PAY01J67CQQH5904WDBVZEM4JMEP3",
"amount": "24.50",
"reference_id": "01JEVQM899NWSQC4FYWWW7KTF9",
"status": "canceled",
"status_detail": "canceled_transaction",
"payment_method": {
"id": "master",
"type": "credit_card",
"token": "12345",
"installments": 1,
"statement_descriptor": "My Store"
}
}
]
},
"description": "Smartphone",
"items": [
{
"title": "Smartphone",
"unit_price": "24.50",
"quantity": 1,
"description": "Smartphone",
"external_code": "1234",
"picture_url": "https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium2x.png",
"category_id": "MLB1055",
"type": "MLB1055",
"warranty": "true",
"event_date": "2014-06-28T16:53:03.176-04:00"
}
]
}