Create order

Create a new order.

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Request body

currencystring required

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

metadataobject

Metadata associated with the order

needs_shipping_contactboolean

Allows you to fill out the shipping information at checkout

pre_authorizeboolean

Indicates whether the order charges must be preauthorized

processing_modestring

Indicates the processing mode for the order, either ecommerce, recurrent or validation.

return_urlstring uri

Indicates the redirection callback upon completion of the 3DS2 flow. Do not use this parameter if your order has a checkout parameter

three_ds_modestring nullable

Indicates the 3DS2 mode for the order, either smart or strict. This property is only applicable when 3DS is enabled. When 3DS is disabled, this field should be null.

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
    }
  ],
  "processing_mode": "ecommerce",
  "return_url": "https://my-website.com",
  "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 operation

v1

Create order

Headers

Request body

Example request

Response