Cancelar order por ID - Código QR - Mercado Pago Developers
Cancelar order por ID

POST

https://api.mercadopago.com/v1/orders/{order_id}/cancel
Cancela una order creada para Código QR de Mercado Pago y todas sus transacciones utilizando el ID de referencia obtenido en la respuesta a su creación. Sólo puede ser cancelada una order en status "created". En caso de éxito, la solicitud devolverá una respuesta con el estado 200.
Parámetros para la solicitud
PATH
order_id
string

REQUERIDO

ID de la order a cancelar. Este valor es devuelto en la respuesta a la solicitud Crear order.
HEADER
X-Idempotency-Key
string

REQUERIDO

Esta función permite repetir solicitudes de manera segura, sin el riesgo de realizar la misma acción más de una vez por error. Esto es útil para evitar errores, como la creación de dos pagos idénticos. Para garantizar qu...Ver más
Parámetros de respuesta
id
string
Identificador de la order cancelada en la solicitud.
user_id
string
Identificador del usuario de Mercado Pago que creó la order.
type
string
Tipo de order.
qr: Order creada para pagos con Código QR de Mercado Pago.
external_reference
string
Es una referencia externa de la order, asignada al momento de su creación.
Errores

400Error.

empty_required_header

El header 'X-Idempotency-Key' es requerido y no fue enviado. Vuelve a realizar la petición incluyéndolo.

invalid_path_param

El Order ID proporcionado en el path de la requisición tiene un formato inválido. Este debe comenzar con el prefijo "ORD" y ser continuado por 26 caracteres. Compruébalo y proporciona un ID válido para volver a intentarlo.

401Error.

unauthorized

El valor enviado como Access Token es incorrecto. Por favor, verifícalo y vuelve a intentar realizar la peticion enviando el valor correcto.

404Error.

order_not_found

El valor enviado como Order ID no corresponde a una order creada, por lo que no puede ser encontrada. Por favor, verifícalo y vuelve a intentar realizar la solicitud enviando el valor correcto.

409Error.

idempotency_key_already_used

El valor enviado como header de idempotencia ya fue utilizado. Por favor, vuelve a intentar realizar la petición enviando un nuevo valor.

order_already_canceled

Hay un conflicto al intentar cancelar la order por su estado actual. Recuerda que las orders solo pueden ser canceladas vía API cuando "status=created".

500Error.

500

Error interno. Intenta enviar la solicitud nuevamente.

Solicitud
curl -X POST \
    'https://api.mercadopago.com/v1/orders/{order_id}/cancel'\
    -H 'Content-Type: application/json' \
       -H 'X-Idempotency-Key: 0d5020ed-1af6-469c-ae06-c3bec19954bb' \
       -H 'Authorization: Bearer TEST-3322*********190-03031*********46528954c*********0339910-1*********' \
    
Respuesta de ejemplo
{
  "id": "ORD00001111222233334444555566",
  "user_id": "5238400195",
  "type": "qr",
  "external_reference": "ext_ref_1234",
  "description": "Point Mini",
  "expiration_time": "PT16M",
  "processing_mode": "automatic",
  "total_amount": "50.00",
  "country_code": "CHL",
  "marketplace_fee": "11.22",
  "integration_data": {
    "application_id": "1234567890",
    "platform_id": "dev_1234567890",
    "integrator_id": "dev_1234",
    "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": {
    "qr": {
      "external_pos_id": "EXTERNALPOS019285",
      "mode": "static"
    }
  },
  "transactions": {
    "payments": [
      {
        "id": "PAY01J67CQQH5904WDBVZEM4JMEP3",
        "amount": "50.00",
        "status": "canceled",
        "status_detail": "canceled_by_api"
      }
    ]
  },
  "taxes": [
    {}
  ],
  "items": [
    {
      "title": "Point New Land",
      "unit_price": "50.00",
      "quantity": 1,
      "unit_measure": "kg",
      "external_code": "777489134",
      "external_categories": [
        {
          "id": "food"
        }
      ]
    }
  ],
  "discounts": {
    "payment_methods": [
      {
        "new_total_amount": "47.28",
        "type": "account_money"
      }
    ]
  }
}