Home
Documentation
Resources
Partners
Community

Resources

Check for updates on our solutions and system performance, or request technical support.

Partners

Discover our program for agencies or developers that offer integration services and sellers who want to hire them.

Community

Get the latest news, ask others for help and share your knowledge.

Cancel order by ID - Online payments - Mercado Pago Developers

Intelligent search powered by OpenAI 

Cancel order by ID

POST

https://api.mercadopago.com/v1/orders/{order_id}/cancel
Cancel an order and its transactions using the reference ID obtained in the response to its creation. Only an order in status "action_required" or "created" can be canceled. In case of success, the request will return a response with status 200.
Request's parameters
PATH
order_id
string

REQUIRED

ID of the order that is being cancelled. This value is returned in the response to the Create order request.
Response parameters
id
string
Identifier of the order created in the request, automatically generated by Mercado Pago.
processing_mode
string
Order processing mode
manual: Order's processing will be made manually. It is the processing mode used for the "manual" option, as it sets the processing to be made afterwards, by using the "Process order by ID" endpoint.
automatic: Order's processing will be made instantly. It is the capture mode used for the "automatic" option.
external_reference
string

REQUIRED

It is an external reference of the order. It can be, for example, a hashcode from the Central Bank, functioning as an identifier of the transaction origin. This field must have a maximum of 64 characters and can only be ...View more
total_amount
string
Total amount to be paid. It must be sent with two decimals.
Errors

400Error. Invalid ID supplied

invalid_path_param

The order_id provided in the request path is not correct. Please confirm it and provide a valid ID to try again.

401Error. Access Token not authorized.

401

The value sent as Access Token is incorrect. Please check and try again with the correct value.

404Error. Order not found.

order_not_found

Order not found. Please check if you provided the correct order ID.

409Some specific system rule does not allow the action to be performed due to defined restrictions.

cannot_cancel_order

The status of the order does not allow its cancellation. Only orders with status 'action_required' can be cancelled.

idempotency_key_already_used

The value sent as the idempotency header has already been used. Please try the request again sending a new value.

500Generic error .

500

Generic error. Please try submitting the request again.

Request
curl -X POST \
    'https://api.mercadopago.com/v1/orders/{order_id}/cancel'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer TEST-8971*********918-01191*********5874530a4*********4799fdf-1*********' \
    
Sample answer
{
  "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"
}