Sign in

v1

latestOpenAPI 3.1.0MIT-LICENSE2026-07-24113190543.3 KB
Orders

Update Order

Update an existing Order.

put/orders/{id}

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Request body

currencystring

Currency with which the payment will be made. It uses the 3-letter code of the International Standard ISO 4217.

{"stackTrail":"components:schemas:order_update:properties:metadata","oasType":"schema","type":"unknown"}
pre_authorizeboolean

Indicates whether the order charges must be preauthorized

Example request

{
  "charges": [
    {
      "amount": 40000,
      "payment_method": {
        "type": "pay_by_bank",
        "expires_at": 1680397724,
        "product_type": "bbva_pay_by_bank"
      }
    }
  ],
  "checkout": {
    "allowed_payment_methods": [
      "cash",
      "card",
      "bank_transfer",
      "bnpl",
      "pay_by_bank",
      "apple",
      "google"
    ],
    "excluded_payment_methods": [
      "cash",
      "bank_transfer"
    ],
    "exclude_card_networks": [
      "visa",
      "amex"
    ],
    "plan_ids": [
      "plan_123",
      "plan_456"
    ],
    "failure_url": "https://www.mysite.com/failure",
    "monthly_installments_options": [
      3,
      6,
      12
    ],
    "max_failed_retries": 3,
    "on_demand_enabled": true,
    "redirection_time": 10,
    "success_url": "https://www.mysite.com/success"
  },
  "currency": "MXN",
  "customer_info": {
    "name": "DevTest",
    "email": "test@conekta.com",
    "phone": "5522997233",
    "object": "customer_info"
  },
  "discount_lines": [
    {
      "amount": 500,
      "code": "123",
      "type": "loyalty"
    }
  ],
  "fiscal_entity": {
    "address": {
      "street1": "Nuevo Leon 254",
      "street2": "Departamento 404",
      "postal_code": "06100",
      "city": "Ciudad de Mexico",
      "state": "Ciudad de Mexico",
      "country": "MX",
      "external_number": "123"
    },
    "email": "test@gmail.com",
    "name": "Conekta Inc",
    "phone": "+525511223344",
    "tax_id": "AAA010101AAA"
  },
  "line_items": [
    {
      "antifraud_info": {
        "key": "value"
      },
      "brand": "Cohiba",
      "description": "Imported From Mex.",
      "metadata": {
        "key": "value"
      },
      "name": "Box of Cohiba S1s",
      "quantity": 1,
      "sku": "XYZ12345",
      "tags": [
        "food",
        "mexican food"
      ],
      "unit_price": 20000
    }
  ],
  "shipping_contact": {
    "phone": "+525511223344",
    "receiver": "Marvin Fuller",
    "between_streets": "Ackerman Crescent",
    "address": {
      "street1": "Nuevo Leon 254",
      "street2": "Departamento 404",
      "postal_code": "06100",
      "city": "Ciudad de Mexico",
      "state": "Ciudad de Mexico",
      "country": "MX",
      "residential": true
    }
  },
  "shipping_lines": [
    {
      "amount": 100,
      "carrier": "FEDEX",
      "tracking_number": "TRACK123",
      "method": "Same day",
      "metadata": {
        "key": "value"
      }
    }
  ],
  "tax_lines": [
    {
      "amount": 100,
      "description": "testing",
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Response

successful