Cancelar order por ID - Orders - Mercado Pago Developers
Cancelar order por ID

POST

https://api.mercadopago.com/v1/orders/{order_id}/cancel
Este endpoint permite cancelar uma order e suas transações utilizando o ID de referência obtido na resposta à sua criação. Apenas uma order com status "action_required" ou "created" pode ser cancelada. Em caso de sucesso, a requisição retornará uma resposta com o status 200.
Parâmetros de requisição
PATH
order_id
string

OBRIGATÓRIO

ID da order a ser cancelada. Esse valor é retornado na resposta à requisição Criar order.
Parâmetros de resposta
id
string
Identificador da order criada na requisição, gerado automaticamente pelo Mercado Pago.
processing_mode
string
Modo de processamento da order
manual: O processamento da order será realizado manualmente. É o modo de processamento utilizado para a opção "manual", enquanto configura o processamento para ser feito posteriormente, utilizando o endpoint "Processar order por ID".
automatic: O processamento da order será feito imediatamente. É o modo de processamento utilizado para a opção "automático".
external_reference
string

OBRIGATÓRIO

Referência externa da order. Pode ser, por exemplo, um hashcode do Banco Central, funcionando como identificador de origem da transação. Este campo deve ter no máximo 64 caracteres e deve conter apenas números, letras, h...Ver mais
total_amount
string
Valor total a ser pago.
Erros

400Erro. ID inválido.

invalid_path_param

O order_id fornecido no path da requisição não está correto. Verifique e forneça um ID válido para tentar novamente.

401Erro. Access Token não autorizado.

401

O Access Token enviado está incorreto. Revise o valor e tente enviar a requisição novamente com a informação correta.

invalid_credentials

Não há suporte para credenciais de teste. Utilize usuários de teste com credenciais de produção para o ambiente de teste (sandbox) e as suas credenciais de produção para o ambiente de produção.

404Error. Order não encontrada.

order_not_found

Order não encontrada. Verifique se o ID enviado está correto.

409Alguma regra específica do sistema não permite a realização da ação devido a restrições definidas.

cannot_cancel_order

O status da order não permite o seu cancelamento. Apenas orders com "status" 'action_required' ou 'created' podem ser canceladas.

order_already_canceled

A order já foi cancelada.

idempotency_key_already_used

O valor enviado como header de idempotência já foi utilizado. Por favor, tente a solicitação novamente enviando um novo valor.

500Erro genérico.

internal_error

Erro genérico. Tente enviar a solicitação novamente.

Requisição
curl -X POST \
    'https://api.mercadopago.com/v1/orders/{order_id}/cancel'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
    
Resposta de exemplo
{
  "id": "ORD01J49MMW3SSBK5PSV3DFR32959",
  "processing_mode": "automatic",
  "external_reference": "ext_ref_1234",
  "total_amount": "24.90",
  "integration_data": {
    "application_id": "1234",
    "integrator_id": "dev_123",
    "platform_id": "1234567890",
    "sponsor": {
      "id": "446566691"
    }
  },
  "user_id": "12345",
  "created_date": "2024-08-26T13:06:51.045317772Z",
  "last_updated_date": "2024-08-26T13:06:51.045317772Z",
  "country_code": "BRA",
  "type": "online",
  "status": "canceled",
  "status_detail": "canceled_transaction",
  "capture_mode": "automatic_async",
  "transactions": {
    "payments": [
      {
        "id": "PAY01J67CQQH5904WDBVZEM4JMEP3",
        "amount": "24.90",
        "reference_id": "01JEVQM899NWSQC4FYWWW7KTF9",
        "status": "canceled",
        "status_detail": "canceled_transaction",
        "expiration_time": "P3Y6M4DT12H30M5S",
        "payment_method": {
          "id": "visa",
          "type": "credit_card",
          "token": "12345",
          "installments": 1,
          "statement_descriptor": "My Store"
        }
      }
    ]
  },
  "description": "Smartphone",
  "items": [
    {
      "title": "Smartphone",
      "unit_price": "12.90",
      "quantity": 4,
      "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"
    }
  ]
}