Recursos para IA
Cancelar order por ID

Este endpoint permite cancelar uma order que ainda não foi paga, utilizando o ID obtido na resposta de sua criação. Apenas orders com status "created" ou "action_required" podem ser canceladas. O cancelamento libera qualquer saldo reservado quando aplicável. Em caso de sucesso, a requisição retornará uma resposta com o status 200.

POST

https://api.mercadopago.com/v1/orders/{order_id}/cancel
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Token de acesso para autenticar a requisição. Para mais informações, consulte a documentação de [Autenticação](https://www.mercadopago.com/developers/pt/docs/your-integrations/credentials).
X-Idempotency-Key
string

OBRIGATÓRIO

Esta função permite repetir solicitações de forma segura, sem o risco de realizar a mesma ação mais de uma vez por engano. Isso é útil para evitar erros, como a criação de duas orders idênticas. Para garantir que cada so
Path
order_id
string

OBRIGATÓRIO

ID da order a ser cancelada. Esse valor é retornado na resposta à requisição 'Criar order' ("/v1/orders").
Response parameters
id
string
Identificador da order criada na requisição, gerado automaticamente pelo Mercado Pago.
processing_mode
string

OBRIGATÓRIO

Modo de processamento da order. Para pagamentos com Checkout Pro, o único valor possível é "manual".
manual: O processamento da order será realizado manualmente. Este modo é utilizado pelo Checkout Pro, permitindo que a ordem seja processada posteriormente pelo seu fluxo de pagamento.
external_reference
string
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
total_amount
string
Valor total a ser pago.
Erros

400Erro de requisição.

empty_required_header

O header "X-Idempotency-Key" é requerido e não foi enviado. Faça a requisição novamente incluindo-o.

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.

409Conflito.

order_already_canceled

Não é possível cancelar a order. Apenas orders com status "created" ou "action_required" podem ser canceladas. Verifique a mensagem retornada nos detalhes do erro para identificar o problema e tente novamente.

500Erro genérico.

internal_error

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

Request
curl -X POST \
    'https://api.mercadopago.com/v1/orders/{order_id}/cancel'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer ' \
       -H 'X-Idempotency-Key: fd6e6313-33a7-47f7-b286-00576628140a' \
    
Response
{
  "id": "ORD01J49MMW3SSBK5PSV3DFR32959",
  "processing_mode": "manual",
  "external_reference": "ext_ref_1234",
  "total_amount": "50.00",
  "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": "PE",
  "type": "online",
  "status": "canceled",
  "status_detail": "canceled_transaction",
  "capture_mode": "automatic_async",
  "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"
        }
      }
    ]
  },
  "client_token": "eyJhbGciOiJSUzI1NiIs...",
  "description": "Smartphone",
  "items": [
    {
      "external_code": "ITEM-001",
      "title": "Product 001",
      "description": "Product description",
      "category_id": "travels",
      "picture_url": "https://example.com/img.jpg",
      "quantity": 1,
      "unit_price": "1000.00",
      "type": "travel",
      "warranty": true,
      "event_date": "2014-06-28T16:53:03.176-04:00"
    }
  ]
}