This endpoint allows you to cancel an order created for Mercado Pago Point and its transactions using the reference ID obtained in the response to its creation. Orders with status=created and status=at_terminal can be canceled. If successful, a request for an order with status=created returns a response with status 200, while a request for an order with status=at_terminal returns a response with status 202, indicating that the request was accepted, but the cancellation will only take effect after a cancellation notification is received.
POST
REQUIRED
CONDITIONALLY REQUIRED
status=at_terminal, and its value must be exactly at_terminal. For orders with status=created, the header is ignored. Canceling an order with status=at_terminal alsREQUIRED
REQUIRED
400Error.
empty_required_header
The X-Idempotency-Key header is required and was not sent. Make the request again including it.
bad_request
The order_id provided in the request path is not correct. Please confirm it and provide a valid ID to try again.
invalid_installments_cost_config
The seller has a restriction that prevents the use of interest-free or interest-bearing installments. Verify that the seller has completed the installment configuration in their Mercado Pago account.
invalid_default_installments
The requested number of installments is not among the options enabled by the seller. Send a default_installments value within the available options configured for that seller in the Mercado Pago account.
missing_installments_cost
The number of installments (default_installments) is greater than 1 and no financial cost responsible was indicated for this installment (installments_cost). Redo the operation adding installments_cost with value seller or buyer.
invalid_installments_cost_single
Defining that the installment costs belong to the buyer (installments_cost=buyer) is invalid when default_installments=1 because a single installment has no financing cost. Redo the operation using installments_cost=seller or omit both fields.
invalid_payment_method_for_installments
The fields default_installments and installments_cost can only be sent when the defined payment method is credit card. Redo the operation adding default_type=credit_card to the payload or remove the installment fields if the payment is by debit card.
minimum_amount_not_met
The transaction amount is below the minimum required for the requested installment plan. Increase the amount or reduce the number of installments.
401Error.
unauthorized
The value sent as Access Token is incorrect. Please check and try again with the correct value.
404Error.
order_not_found
Order not found. Please check if you provided the correct order ID.
409Error.
idempotency_key_already_used
The value sent as the idempotency header has already been used. Please try the request again sending a new value.
cannot_cancel_order
The order status does not allow cancellation. Only orders with status=created or status=at_terminal can be canceled via API. To cancel an order with status=at_terminal, send the header x-allow-cancelable-status: at_terminal and use a terminal with a compatible software version. For more information about compatible terminal models, see Cancel an order. If the header is missing or invalid, or the terminal is not compatible, this error is returned.
order_already_canceled
The order has already been canceled.
500Error.
idempotency_validation_failed
Validation fail. Please try submitting the request again.
500
Internal server 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-8*********88776-122*********fc20dede6*********a497d7225*********64' \
-H 'x-allow-cancelable-status: at_terminal' \
-H 'X-Idempotency-Key: 89439efc-9bc6-4879-bfa4-03efc584de01' \
{
"id": "ORD0000ABCD222233334444555566",
"user_id": "5238400195",
"type": "point",
"external_reference": "ext_ref_1234",
"description": "Point Smart Mini",
"expiration_time": "PT2M",
"country_code": "BR",
"processing_mode": "automatic",
"integration_data": {
"application_id": "1234567890",
"platform_id": "dev_1234567890",
"integrator_id": "dev_123456",
"sponsor": {
"id": "446566691"
}
},
"status": "canceled",
"status_detail": "canceled",
"created_date": "2024-09-10T14:26:42.109320977Z",
"last_updated_date": "2024-09-10T14:26:42.109320977Z",
"config": {
"point": {
"terminal_id": "NEWLAND_N950__SBX0000001",
"print_on_terminal": "no_ticket"
},
"payment_method": {
"default_type": "credit_card",
"default_installments": 6,
"installments_cost": "seller"
}
},
"transactions": {
"payments": [
{
"id": "PAY01J67CQQH5904WDBVZEM4JMEP3",
"amount": "24.50",
"status": "canceled",
"status_detail": "canceled_by_api"
}
]
}
}