Inicio
Documentação
Recursos
Certificações
Comunidade

Recursos

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

Comunidade

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

Cancelar order por ID - Pagamentos presenciais - Mercado Pago Developers

Busca inteligente powered by OpenAI 

Cancelar order por ID

POST

https://api.mercadopago.com/v1/orders/{order_id}/cancel
Cancela uma order criada para Mercado Pago Point e suas transações utilizando o ID de referência obtido na resposta à sua criação. Apenas uma order com status "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.
HEADER
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 dois pagamentos idênticos. Para garantir que cad...Ver mais
Parâmetros de resposta
id
string
Identificador da order cancelada na requisição.
type
string
Tipo de order.
point: Order criada para pagamentos com o Mercado Pago Point.
external_reference
string
É a referência externa da order, atribuída no momento da criação. O limite máximo permitido é de 64 caracteres e os permitidos são: letras maiúsculas e minúsculas, números e os símbolos de hífen (-) e sublinhado (_).
description
string
Descrição do produto comprado, a razão da order de pagamento.
Erros

400Erro.

empty_required_header

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

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.

unauthorized

O valor enviado como Access Token está incorreto. Verifique e tente a enviar requisição novamente com o valor correto.

404Erro.

order_not_found

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

409Erro.

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.

cannot_cancel_order

Há um conflito ao tentar cancelar o pedido devido ao seu estado atual. Lembre-se de que os pedidos só podem ser cancelados via API quando "status=created". Se você estiver tentando cancelar um pedido com o estado "status=at_terminal", deverá fazê-lo a partir do terminal.

500Erro.

idempotency_validation_failed

Falha na validação. Tente enviar a solicitação novamente.

500

Erro interno. 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 'X-Idempotency-Key: 0d5020ed-1af6-469c-ae06-c3bec19954bb' \
       -H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
    
Resposta de exemplo
{
  "id": "123",
  "type": "point",
  "external_reference": "ext_ref_1234",
  "description": "Point Smart Mini",
  "site_id": "MLB",
  "integration_data": {
    "application_id": 1234567890,
    "platform_id": "1234567890",
    "integrator_id": "1234567890",
    "sponsor": {
      "id": "446566691"
    }
  },
  "status": "cancelled",
  "created_date": "2024-09-10T14:26:42.109320977Z",
  "last_updated_date": "2024-09-10T14:26:42.109320977Z",
  "type_config": {
    "terminal_id": "PAX_A910__SMARTPOS1423",
    "ticket_number": "S0392JED",
    "flow_process": "credit_card"
  },
  "transactions": {
    "payments": [
      {
        "id": "pay_01J67CQQH5904WDBVZEM4JMEP3",
        "amount": "24.90",
        "status": "cancelled",
        "status_detail": "cancelled_by_api"
      }
    ]
  }
}