Inicio
Documentação
Recursos
Parcerias
Comunidade

Recursos

Confira as atualizaçÔes das nossas soluçÔes e do funcionamento do sistema ou peça suporte técnico.

Parcerias

Conheça nosso programa para agĂȘncias ou desenvolvedores que oferecem serviços de integração e vendedores que desejam contratĂĄ-los.

Comunidade

Fique por dentro das Ășltimas novidades, peça ajuda a outros integradores e compartilhe seu conhecimento.

Cancelar order por ID - Pagamentos online - Mercado Pago Developers

Busca inteligente powered by OpenAI 

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. Deve ser enviado com duas casas decimais.
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.

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' podem ser canceladas.

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.

500

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-7434*********159-03141*********cee51edf8*********f94f589-1*********' \
    
Resposta de exemplo
{
  "id": "123",
  "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": "cancelled",
  "status_detail": "canceled_transaction",
  "capture_mode": "manual",
  "payer": {
    "email": "test@test.com",
    "first_name": "John",
    "last_name": "Doe",
    "identification": {
      "type": "CPF",
      "number": "99999999999"
    },
    "phone": {
      "area_code": "11",
      "number": "987654321"
    },
    "address": {
      "zip_code": "12345678",
      "street_name": "Rua Teste",
      "street_number": "123"
    }
  },
  "transactions": {
    "payments": [
      {
        "id": "pay_01J67CQQH5904WDBVZEM4JMEP3",
        "amount": "24.90",
        "status": "processed",
        "status_detail": "accredited",
        "payment_method": {
          "id": "visa",
          "type": "credit_card",
          "token": "12345",
          "installments": 1,
          "statement_descriptor": "approved"
        }
      }
    ]
  },
  "description": "Point Mini",
  "marketplace": "MERCADOLIVRE",
  "items": [
    {
      "title": "Point Mini",
      "unit_price": "12.90",
      "quantity": 4,
      "description": "Point product for card payments via Bluetooth.",
      "id": "1234",
      "picture_url": "https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium2x.png",
      "category_id": "MLB1055"
    }
  ],
  "expiration_time": "P3Y6M4DT12H30M5S"
}