Este endpoint permite cancelar uma order criada para Mercado Pago Point e suas transações utilizando o ID de referência obtido na resposta à sua criação. Orders com status=created e status=at_terminal podem ser canceladas. Em caso de sucesso, a requisição de uma order com status=created retornará uma resposta com status 200, enquanto a requisição de uma order com status=at_terminal retornará uma resposta com status 202, indicando que a solicitação foi aceita, mas que o cancelamento só será efetivado após o recebimento de uma notificação de cancelamento.
POST
OBRIGATÓRIO
OBRIGATÓRIO CONDICIONAL
status=at_terminal e seu valor deve ser exatamente at_terminal. Para orders com status=created, o header é ignorado. O cancelamento de uma order com `statusOBRIGATÓRIO
OBRIGATÓRIO
400Erro.
empty_required_header
O header X-Idempotency-Key é requerido e não foi enviado. Faça a requisição novamente incluindo-o.
bad_request
O order_id fornecido no path da requisição não está correto. Verifique e forneça um ID válido para tentar novamente.
invalid_installments_cost_config
O vendedor tem uma restrição que impede o uso do financiamento PSJ/PCJ. Verifique que o vendedor tenha concluído a configuração de PSJ na conta do Mercado Pago.
invalid_default_installments
O número de parcelas solicitado não está entre as opções habilitadas pelo vendedor. Envie um valor de default_installments dentro das opções disponíveis para esse vendedor.
missing_installments_cost
default_installments > 1 foi enviado sem installments_cost. Adicione installments_cost com valor seller ou buyer.
invalid_installments_cost_single
installments_cost=buyer é inválido quando default_installments é 1, pois uma única parcela não tem custo financeiro. Use seller ou omita ambos os campos.
invalid_payment_method_for_installments
default_installments e installments_cost só podem ser enviados quando default_type for credit_card. Adicione default_type=credit_card ao payload, ou remova os campos de parcelamento se o pagamento for com cartão de débito.
minimum_amount_not_met
O valor da transação é menor que o mínimo exigido para o plano de parcelas solicitado. Aumente o valor ou reduza o número de parcelas.
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
O status da order não permite o cancelamento. Apenas orders com status=created ou status=at_terminal podem ser canceladas via API. Para cancelar uma order com status=at_terminal, envie o header x-allow-cancelable-status: at_terminal e utilize um terminal com versão de software compatível. Para mais informações sobre os modelos de terminal compatíveis, consulte Cancelar uma order. Se o header não for enviado ou for inválido, ou se o terminal não for compatível, este erro será retornado.
order_already_canceled
A order já foi cancelada.
500Erro.
idempotency_validation_failed
Falha na validação. Tente enviar a solicitação novamente.
500
Erro interno. Tente enviar a solicitação novamente.
curl -X POST \
'https://api.mercadopago.com/v1/orders/{order_id}/cancel'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer APP_USR-8*********88776-122*********fc20dede6*********a497d7225*********64' \
-H 'x-allow-cancelable-status: at_terminal' \
-H 'X-Idempotency-Key: fbd37ec1-ba14-4c8c-bb93-689768f254a0' \
{
"id": "ORD0000ABCD222233334444555566",
"user_id": "5238400195",
"type": "point",
"external_reference": "ext_ref_1234",
"description": "Point Smart Mini",
"expiration_time": "PT2M",
"country_code": "BR",
"processing_mode": "automatic",
"integration_data": {
"application_id": "1234567890",
"platform_id": "dev_1234567890",
"integrator_id": "dev_123456",
"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": {
"point": {
"terminal_id": "NEWLAND_N950__SBX0000001",
"print_on_terminal": "no_ticket"
},
"payment_method": {
"default_type": "credit_card",
"default_installments": 6,
"installments_cost": "seller"
}
},
"transactions": {
"payments": [
{
"id": "PAY01J67CQQH5904WDBVZEM4JMEP3",
"amount": "24.50",
"status": "canceled",
"status_detail": "canceled_by_api"
}
]
}
}