--- title: "Void Order" method: POST path: "/orders/{id}/void" tags: ["Orders"] --- # Void Order `POST /orders/{id}/void` ## Request - Base URL: `https://api.conekta.io` - URL: `https://api.conekta.io/orders/{id}/void` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Void an order that has been previously authorized and not yet captured. The order and its charges are moved to the voided status. ## Path parameters - `id` string, required ## Headers - `Accept-Language` 'es' | 'en' - `X-Child-Company-Id` string ## Response `200` successful - OrderResponse: order response - `amount` integer, required: The total amount to be collected in cents - `amount_refunded` integer: The total amount refunded in cents - `channel` OrderChannelResponse - `segment` string - `checkout_request_id` string - `checkout_request_type` string - `id` string - `charges` OrderChargesResponse: The charges associated with the order - `has_more` boolean, required: Indicates if there are more pages to be requested - `object` string, required: Object type, in this case is list - `next_page_url` string, nullable: URL of the next page. - `previous_page_url` string, nullable: Url of the previous page. - `data` ChargesDataResponse[] - `amount` integer - `channel` ChargeResponseChannel - `segment` string - `checkout_request_id` string - `checkout_request_type` string - `id` string - `conekta_account_id` string, nullable: Conekta account ID of the charge, if the charge was paid through a Conekta account. - `created_at` integer, required: Charge creation date, in seconds since the Unix epoch - `currency` string, required: Currency of the charge, in ISO 4217 format - `customer_id` string - `description` string - `device_fingerprint` string - `failure_code` string - `failure_message` string - `id` string, required: Charge ID - `livemode` boolean, required: Whether the charge was made in live mode or not - `next_action` OrderNextActionResponse: contains the following attributes that will guide to continue the flow - `redirect_to_url` OrderNextActionResponseRedirectToUrl: contains the following attributes that will guide to continue the flow - `url` string, uri: pay.conekta.com/{id} Indicates the url of the Conekta component to authenticate the flow through 3DS2. - `return_url` string, uri: Indicates the url to which the 3DS2 flow returns at the end, when the integration is redirected. - `type` string: Indicates the type of action to be taken - `object` string, required - `order_id` string, required: Order ID - `paid_at` integer, nullable: charge Payment date - `payment_method` union - object: use for cash responses - `type` string - `object` string, required - `agreement` string: Agreement ID - `auth_code` integer, nullable - `cashier_id` string, nullable - `reference` string - `barcode_url` string - `expires_at` integer - `product_type` string: Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. - `service_name` string - `store` string, nullable - `store_name` string - `customer_ip_address` string - object: use for card responses - `type` string - `object` string, required - `account_type` string: Account type of the card - `auth_code` string - `brand` string: Brand of the card - `contract_id` string: Id sent for recurrent charges. - `country` string: Country of the card - `exp_month` string: Expiration month of the card - `exp_year` string: Expiration year of the card - `fraud_indicators` unknown[] - unknown - `issuer` string: Issuer of the card - `last4` string: Last 4 digits of the card - `name` string: Name of the cardholder - `customer_ip_address` string: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes - object: use for bank transfer responses - `type` string - `object` string, required - `bank` string - `clabe` string - `description` string, nullable - `executed_at` string, nullable - `expires_at` integer - `issuing_account_bank` string, nullable - `issuing_account_number` string, nullable - `issuing_account_holder_name` string, nullable - `issuing_account_tax_id` string, nullable - `payment_attempts` unknown[] - unknown - `receiving_account_holder_name` string, nullable - `receiving_account_number` string - `receiving_account_bank` string - `receiving_account_tax_id` string, nullable - `reference_number` string, nullable - `tracking_code` string, nullable - `customer_ip_address` string - object: use for bnpl payment responses - `type` string - `object` 'bnpl_payment', required - `cancel_url` string: URL to redirect the customer after a canceled payment - `expires_at` integer, required: Expiration date of the charge - `failure_url` string: URL to redirect the customer after a failed payment - `product_type` string, required: Product type of the charge - `redirect_url` string: URL to redirect the customer to complete the payment - `success_url` string: URL to redirect the customer after a successful payment - object: use for pbb payment responses - `type` string - `object` string, required - `deep_link` string, required: Deep link for the payment, use for mobile apps/flows - `expires_at` integer, required: Expiration date of the charge - `product_type` string, required: Product type of the charge - `redirect_url` string, required: URL to redirect the customer to complete the payment - `reference` string, required: Reference for the payment - `reference_id` string, nullable: Reference ID of the charge - `refunds` ChargeResponseRefunds: page metadata - `has_more` boolean, required: Indicates if there are more pages to be requested - `object` string, required: Object type, in this case is list - `next_page_url` string, nullable: URL of the next page. - `previous_page_url` string, nullable: Url of the previous page. - `data` ChargeResponseRefundsData[]: refunds - `amount` integer, required - `auth_code` string - `created_at` integer, required - `expires_at` integer: refund expiration date - `id` string, required - `object` string, required - `status` string: refund status - `chargeback` ChargebackResponse, nullable: Chargeback object - `id` string - `status` 'won' | 'lost' | 'action_required' | 'pending_review' | 'under_review' | 'covered' | 'rt' | 'rt_sent' | 'represented' - `reason` 'unrecognized' | 'unauthorized' | 'unauthorized_by_client' | 'unrecognized_like_fraud' | 'insufficient_evidence' | 'illegible_evidence' | 'general' | 'late_evidence' | 'incorrect_exchange' | 'fraudulent_business' | 'billing' | 'twice_transaction' | 'transaction_not_refunded' | 'bank_doc_request' | 'unrecognized_purchase' | 'subscription_canceled' | 'copy_of_purchase' | 'differents_amounts' | 'subscription_not_requested' | 'damaged_products' | 'show_documents' | 'duplicate' | 'fraudulent' | 'service_canceled' | 'product_unacceptable' | 'product_not_received' | 'incorrect_amount' | 'chip_liabiliaty_shift' | 'credit_not_processed' - `note` string, nullable - `followup_status` 'customer_uncontacted' | 'customer_contacted' | 'customer_unreachable', nullable - `response_from_client` string, nullable - `files` ChargebackFileResponse[] - `id` string - `file_name` string - `url` string, nullable - `created_at` integer - `object` string - `charge_id` string - `created_at` integer - `evidence_due_by` integer - `status` string, required: Charge status - `checkout` OrderResponseCheckout - `allowed_payment_methods` string[]: Are the payment methods available for this link - `excluded_payment_methods` string[]: Payment methods excluded from the checkout. This field is only returned when excluded_payment_methods is provided in the request. - `can_not_expire` boolean - `emails_sent` integer - `exclude_card_networks` string[] - `expires_at` integer - `failure_url` string - `force_3ds_flow` boolean - `force_save_card` boolean, nullable: Indicates whether the card used for the payment should be saved for future purchases. This field is only applicable for card payments. - `id` string, required - `is_redirect_on_failure` boolean - `livemode` boolean, required - `max_failed_retries` integer, nullable: Number of retries allowed before the checkout is marked as failed - `metadata` object - `monthly_installments_enabled` boolean - `monthly_installments_options` integer[] - `name` string, required - `needs_shipping_contact` boolean - `object` string, required - `on_demand_enabled` boolean, nullable - `paid_payments_count` integer - `recurrent` boolean - `redirection_time` integer, nullable: number of seconds to wait before redirecting to the success_url - `slug` string - `sms_sent` integer - `success_url` string, uri: Redirection url back to the site in case of successful payment, applies only to HostedPayment - `starts_at` integer - `status` string - `type` string, required: This field represents the type of checkout, which determines the user experience during the payment process. 'HostedPayment' will redirect the customer to a Conekta-hosted page to complete the payment, while 'Integration' allows the payment process to be handled entirely on your site using Conekta's APIs and SDKs. - `url` string, uri: Indicate the url of the Conekta component to complete the payment. For HostedPayment, this will be a Conekta-hosted page - `created_at` integer, required: The time at which the object was created in seconds since the Unix epoch - `currency` string, required: The three-letter ISO 4217 currency code. The currency of the order. - `customer_info` OrderResponseCustomerInfo - `object` string - `customer_custom_reference` string, nullable: Custom reference - `name` string - `email` string, email - `phone` string - `corporate` boolean - `customer_id` string - `discount_lines` OrderResponseDiscountLines, nullable: List of discounts that are applied to the order - `has_more` boolean, required: Indicates if there are more pages to be requested - `object` string, required: Object type, in this case is list - `next_page_url` string, nullable: URL of the next page. - `previous_page_url` string, nullable: Url of the previous page. - `data` DiscountLinesDataResponse[] - `amount` integer, required: The amount to be deducted from the total sum of all payments, in cents. - `code` string, required: Discount code. - `type` string, required: It can be 'loyalty', 'campaign', 'coupon' o 'sign' - `id` string, required: The discount line id - `object` string, required: The object name - `parent_id` string, required: The order id - `tax_lines` OrderResponseTaxLines, nullable: List of taxes that are applied to the order - `has_more` boolean, required: Indicates if there are more pages to be requested - `object` string, required: Object type, in this case is list - `next_page_url` string, nullable: URL of the next page. - `previous_page_url` string, nullable: Url of the previous page. - `data` TaxLinesDataResponse[] - `amount` integer, required: The amount to be collected for tax in cents - `description` string, required: description or tax's name - `metadata` object - `id` string, required - `object` string - `parent_id` string - `shipping_lines` OrderResponseShippingLines, nullable: List of shipping costs applied to the order - `has_more` boolean, required: Indicates if there are more pages to be requested - `object` string, required: Object type, in this case is list - `next_page_url` string, nullable: URL of the next page. - `previous_page_url` string, nullable: Url of the previous page. - `data` ShippingLinesDataResponse[] - `amount` integer, required: Shipping amount in cents - `carrier` string: Carrier name for the shipment - `tracking_number` string: Tracking number can be used to track the shipment - `method` string: Method of shipment - `metadata` object: Hash where the user can send additional information for each 'shipping'. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are not supported. - `id` string - `object` string - `parent_id` string - `fiscal_entity` OrderFiscalEntityResponse, nullable: Fiscal entity of the order, Currently it is a purely informative field - `address` OrderFiscalEntityAddressResponse, required: Address of the fiscal entity - `street1` string, required: Street name and number - `street2` string, nullable: Street name and number - `postal_code` string, required: Postal code - `city` string, required: City - `state` string: State - `country` string, required: this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `external_number` string, required: External number - `object` string - `email` string, nullable: Email of the fiscal entity - `metadata` object: Metadata associated with the fiscal entity - `name` string, nullable: Name of the fiscal entity - `tax_id` string, nullable: Tax ID of the fiscal entity - `id` string, required: ID of the fiscal entity - `created_at` integer, required: The time at which the object was created in seconds since the Unix epoch - `object` string, required - `phone` string, nullable: Phone of the fiscal entity - `id` string, required - `is_refundable` boolean - `line_items` OrderResponseProducts: page metadata - `has_more` boolean, required: Indicates if there are more pages to be requested - `object` string, required: Object type, in this case is list - `next_page_url` string, nullable: URL of the next page. - `previous_page_url` string, nullable: Url of the previous page. - `data` ProductDataResponse[] - `antifraud_info` object - `brand` string: The brand of the item. - `description` string: Short description of the item - `metadata` object: It is a key/value hash that can hold custom fields. Maximum 100 elements. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are not supported. - `name` string, required: The name of the item. It will be displayed in the order. - `quantity` integer, required: The quantity of the item in the order. - `sku` string: The stock keeping unit for the item. It is used to identify the item in the order. - `tags` string[]: List of tags for the item. It is used to identify the item in the order. - `unit_price` integer, required: The price of the item in cents. - `id` string - `object` string - `parent_id` string - `livemode` boolean, required: Whether the object exists in live mode or test mode - `metadata` object: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_action` OrderNextActionResponse: contains the following attributes that will guide to continue the flow - `redirect_to_url` OrderNextActionResponseRedirectToUrl: contains the following attributes that will guide to continue the flow - `url` string, uri: pay.conekta.com/{id} Indicates the url of the Conekta component to authenticate the flow through 3DS2. - `return_url` string, uri: Indicates the url to which the 3DS2 flow returns at the end, when the integration is redirected. - `type` string: Indicates the type of action to be taken - `object` string, required: String representing the object’s type. Objects of the same type share the same value. - `payment_status` string: The payment status of the order. - `processing_mode` string: Indicates the processing mode for the order, either ecommerce, recurrent or validation. - `shipping_contact` OrderResponseShippingContact: Contains the detail of the shipping addresses that the client has active or has used in Conekta - `created_at` integer - `id` string - `object` string - `phone` string - `receiver` string - `between_streets` string, nullable - `address` CustomerShippingContactsAddress - `object` string - `street1` string - `street2` string - `postal_code` string - `city` string - `state` string - `country` string - `residential` boolean, nullable - `parent_id` string - `default` boolean - `metadata` object: Metadata associated with the shipping contact - `deleted` boolean - `updated_at` integer: The time at which the object was last updated in seconds since the Unix epoch ## Other responses - `401`: authentication error - `402`: payment required error - `404`: not found entity - `428`: Precondition Required - `500`: internal server error ## Changes - **2026-11-03** `52f4c0dd8a1b`: 1 info - endpoint added [Operation history](https://skmtc.dev/conekta/apis/conekta-api/changes/orders/:id/void/post.md) --- [API](https://skmtc.dev/conekta/apis/conekta-api.md) - [All operations](https://skmtc.dev/conekta/apis/conekta-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conekta/apis/conekta-api/revisions/52f4c0dd8a1b?raw)