Orders

Get a list of Orders

Changed on

Get order details in the form of a list

get/orders

Request

Query parameters

limitinteger

The numbers of items to return, the maximum value is 250

searchstring

General order search, e.g. by mail, reference etc.

nextstring

next page

previousstring

previous page

payment_statusstring

Filters by order status

last_payment_info.statusstring

Filters by last payment info status

created_atinteger

created equal to

created_at.gteinteger

created at greater than or equal to

created_at.lteinteger

created at less than or equal to

updated_at.gteinteger

updated at greater than or equal to

updated_at.lteinteger

updated at less than or equal to

amountinteger

Filters by amount equal to the given value, in cents

Headers

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.

Response

successful operation

has_moreboolean required

Indicates if there are more pages to be requested

objectstring required

Object type, in this case is list

next_page_urlstring nullable

URL of the next page.

previous_page_urlstring nullable

Url of the previous page.

Example response

{
  "data": [
    {
      "amount": 21605,
      "channel": {
        "segment": "Checkout",
        "checkout_request_id": "6fca054a-8519-4c43-971e-cea35cc519bb",
        "checkout_request_type": "HostedPayment",
        "id": "channel_2tNDzhA4Akmzj11AU"
      },
      "charges": {
        "object": "list",
        "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
        "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
        "data": [
          {
            "amount": 4321,
            "channel": {
              "segment": "Checkout",
              "checkout_request_id": "6fca054a-8519-4c43-971e-cea35cc519bb",
              "checkout_request_type": "HostedPayment",
              "id": "channel_2tNDzhA4Akmzj11AU"
            },
            "conekta_account_id": "019ff731-2448-7a6b-b95b-5d4a36035da9",
            "created_at": 1676386026,
            "currency": "MXN",
            "description": "Payment from order",
            "device_fingerprint": "6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba",
            "failure_code": "suspected_fraud",
            "failure_message": "Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.",
            "id": "63efa757cf65380001aec040",
            "next_action": {
              "redirect_to_url": {
                "url": "https://pay.conekta.com/6fca054a85194c43971ecea35cc519bb",
                "return_url": "https://my-website.com\""
              },
              "type": "redirect_to_url"
            },
            "object": "charge",
            "order_id": "ord_2tN73UdUSNrYRPD9r",
            "paid_at": 1676390742,
            "payment_method": {
              "object": "payment_source",
              "agreement": "agreement_2tN73UdUSNrYRPD9r",
              "auth_code": 542563,
              "cashier_id": "OINM01010",
              "reference": "93000262276908",
              "barcode_url": "https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png",
              "product_type": "bbva_cash_in",
              "service_name": "store",
              "store": "10MON50EDI",
              "store_name": "wallmart",
              "customer_ip_address": "0.0.0.0"
            },
            "reference_id": "ref_2tN73UdUSNrYRPD9r",
            "refunds": {
              "object": "list",
              "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
              "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
              "data": [
                {
                  "amount": -15000,
                  "auth_code": "867372",
                  "created_at": 1678226878,
                  "expires_at": 1678226878,
                  "id": "6407b5bee1329a000175ba11",
                  "object": "refund",
                  "status": "pending"
                }
              ]
            },
            "chargeback": {
              "id": "chbk_2zPxWFUnGNLySoumn",
              "status": "lost",
              "reason": "unrecognized",
              "files": [
                {
                  "id": "chbkf_2zPxWFUnGNLySoums",
                  "file_name": "20251221500000000000201.pdf",
                  "created_at": 1768846800
                }
              ],
              "object": "chargeback",
              "charge_id": "6966a06c044243000156c24d",
              "created_at": 1768846800,
              "evidence_due_by": 1769126399
            },
            "status": "pending_payment"
          }
        ]
      },
      "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"
        ],
        "expires_at": 1676613599,
        "failure_url": "http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx",
        "id": "6fca054a-8519-4c43-971e-cea35cc519bb",
        "max_failed_retries": 3,
        "name": "ord-2tNDzhA4Akmzj11AS",
        "object": "checkout",
        "on_demand_enabled": true,
        "redirection_time": 2,
        "slug": "6fca054a85194c43971ecea35cc519bb",
        "success_url": "http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx",
        "starts_at": 1676354400,
        "status": "Issued",
        "type": "HostedPayment",
        "url": "https://pay.conekta.io/checkout/6fca054a85194c43971ecea35cc519bb"
      },
      "created_at": 1676328434,
      "currency": "MXN",
      "customer_info": {
        "object": "customer_info",
        "customer_custom_reference": "custom_reference",
        "name": "DevTest",
        "email": "test@conekta.com",
        "phone": "5522997233",
        "customer_id": "cus_23874283647"
      },
      "discount_lines": {
        "object": "list",
        "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
        "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
        "data": [
          {
            "amount": 500,
            "code": "123",
            "type": "loyalty",
            "id": "dis_lin_2tQQ58HPgPw7StE8z",
            "object": "discount_line",
            "parent_id": "ord_2tPAmKCEJqh8RE6nY"
          }
        ]
      },
      "tax_lines": {
        "object": "list",
        "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
        "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
        "data": [
          {
            "amount": 100,
            "description": "testing",
            "metadata": {
              "key": "value"
            },
            "id": "tax_lin_2tQ8dC5mg1UADmVPo",
            "object": "tax_line",
            "parent_id": "ord_2tPAmKCEJqh8RE6nY"
          }
        ]
      },
      "shipping_lines": {
        "object": "list",
        "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
        "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
        "data": [
          {
            "amount": 100,
            "carrier": "FEDEX",
            "tracking_number": "TRACK123",
            "method": "Same day",
            "metadata": {
              "key": "value"
            }
          }
        ]
      },
      "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",
          "object": "fiscal_entity_address"
        },
        "email": "test@gmail.com",
        "name": "Conekta Inc",
        "tax_id": "324234234",
        "id": "fis_ent_2tN85VYaSMyDvjB3M",
        "created_at": 1676328434,
        "object": "fiscal_entity",
        "phone": "+525511223344"
      },
      "id": "ord_2tMtQQpDvfnNjiuFG",
      "line_items": {
        "object": "list",
        "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
        "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
        "data": [
          {
            "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
          }
        ]
      },
      "next_action": {
        "redirect_to_url": {
          "url": "https://pay.conekta.com/6fca054a85194c43971ecea35cc519bb",
          "return_url": "https://my-website.com\""
        },
        "type": "redirect_to_url"
      },
      "object": "order",
      "payment_status": "paid",
      "processing_mode": "ecommerce",
      "shipping_contact": {
        "created_at": 1675715413,
        "id": "adr_1234567890",
        "object": "shipping_contact",
        "phone": "+525511223344",
        "receiver": "Marvin Fuller",
        "between_streets": "Ackerman Crescent",
        "address": {
          "object": "shipping_address",
          "street1": "Nuevo Leon 254",
          "street2": "Departamento 404",
          "postal_code": "06100",
          "city": "Ciudad de Mexico",
          "state": "Ciudad de Mexico",
          "country": "MX",
          "residential": true
        }
      },
      "updated_at": 1676328434
    }
  ],
  "object": "list",
  "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
  "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1"
}

Changes

    • breaking

      the response property //////// became optional for the status

    • info

      added the new optional query request parameter amount

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status