From 1bef7cdf41e4a656970ad217ae08d937575dafef Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Mon, 29 Jun 2026 12:56:21 -0400 Subject: [PATCH 01/10] fix(orders): tighten shipping address, line, and item schema constraints Align the OpenAPI schemas with the validations enforced by payments-api's v200 param sanitizers, which were previously under-documented. - Extract the shipping-contact address into a shared schemas/customers/shipping_contact_address.yml and reference it from the create and update shipping-contact schemas, removing the duplicated inline address blocks. - Mark street1, postal_code, and country as required on the create path (matching ShippingContacts::Validator#validate_on_create); the update path keeps them optional. - Document the MX 5-digit postal code rule and add field descriptions. - Add maxLength: 250 to address fields, shipping line carrier/tracking_number/ method, and line-item name/brand/sku and tag items. - Regenerate _build/api.yaml. Co-Authored-By: Claude Opus 4.8 (1M context) --- _build/api.yaml | 137 ++++++++++++++---- .../customers/customer_shipping_contacts.yml | 33 +---- .../customer_update_shipping_contacts.yml | 28 +--- .../customers/shipping_contact_address.yml | 39 +++++ schemas/orders/product.yml | 4 + schemas/orders/shipping_request.yml | 7 +- 6 files changed, 168 insertions(+), 80 deletions(-) create mode 100644 schemas/customers/shipping_contact_address.yml diff --git a/_build/api.yaml b/_build/api.yaml index d2b1874..dd4b85e 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -17556,31 +17556,53 @@ components: title: customerPaymentMethods title: customer_payment_methods_response customer_shipping_contacts_request_address: - description: Address of the person who will receive the order - properties: - street1: - example: Nuevo Leon 254 - type: string - street2: - example: Departamento 404 - type: string - postal_code: - example: "06100" - type: string - city: - example: Ciudad de Mexico - type: string - state: - example: Ciudad de Mexico - type: string - country: - description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - example: MX - type: string - residential: - example: true - nullable: true - type: boolean + allOf: + - description: Address of the person who will receive the order + properties: + street1: + description: Street and number of the delivery address. + example: Nuevo Leon 254 + maxLength: 250 + type: string + street2: + description: "Apartment, suite or interior reference for the delivery\ + \ address." + example: Departamento 404 + maxLength: 250 + type: string + postal_code: + description: Postal code of the delivery address. For Mexican addresses + (country MX) it must be a 5-digit postal code. + example: "06100" + maxLength: 250 + type: string + city: + description: City of the delivery address. + example: Ciudad de Mexico + maxLength: 250 + type: string + state: + description: State of the delivery address. + example: Ciudad de Mexico + maxLength: 250 + type: string + country: + description: "Country of the delivery address. This field follows the\ + \ [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." + example: MX + maxLength: 250 + type: string + residential: + default: true + description: Indicates whether the delivery address is residential. + example: true + nullable: true + type: boolean + title: shipping_contact_address + required: + - country + - postal_code + - street1 customer_shipping_contacts_data_response: allOf: - description: |- @@ -19286,14 +19308,17 @@ components: carrier: description: Carrier name for the shipment example: FEDEX + maxLength: 250 type: string tracking_number: description: Tracking number can be used to track the shipment example: TRACK123 + maxLength: 250 type: string method: description: Method of shipment example: Same day + maxLength: 250 type: string metadata: additionalProperties: true @@ -19459,6 +19484,7 @@ components: brand: description: The brand of the item. example: Cohiba + maxLength: 250 type: string description: description: Short description of the item @@ -19477,6 +19503,7 @@ components: name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s + maxLength: 250 type: string quantity: description: The quantity of the item in the order. @@ -19488,6 +19515,7 @@ components: description: The stock keeping unit for the item. It is used to identify the item in the order. example: XYZ12345 + maxLength: 250 type: string tags: description: List of tags for the item. It is used to identify the item @@ -19496,6 +19524,7 @@ components: - food - mexican food items: + maxLength: 250 type: string type: array default: null @@ -20030,6 +20059,7 @@ components: brand: description: The brand of the item. example: Cohiba + maxLength: 250 type: string description: description: Short description of the item @@ -20048,6 +20078,7 @@ components: name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s + maxLength: 250 type: string quantity: description: The quantity of the item in the order. @@ -20059,6 +20090,7 @@ components: description: The stock keeping unit for the item. It is used to identify the item in the order. example: XYZ12345 + maxLength: 250 type: string tags: description: List of tags for the item. It is used to identify the item @@ -20067,6 +20099,7 @@ components: - food - mexican food items: + maxLength: 250 type: string type: array default: null @@ -20092,14 +20125,17 @@ components: carrier: description: Carrier name for the shipment example: FEDEX + maxLength: 250 type: string tracking_number: description: Tracking number can be used to track the shipment example: TRACK123 + maxLength: 250 type: string method: description: Method of shipment example: Same day + maxLength: 250 type: string metadata: additionalProperties: true @@ -20336,6 +20372,7 @@ components: brand: description: The brand of the item. example: Cohiba + maxLength: 250 type: string description: description: Short description of the item @@ -20354,6 +20391,7 @@ components: name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s + maxLength: 250 type: string quantity: description: The quantity of the item in the order. @@ -20365,6 +20403,7 @@ components: description: The stock keeping unit for the item. It is used to identify the item in the order. example: XYZ12345 + maxLength: 250 type: string tags: description: List of tags for the item. It is used to identify the item @@ -20373,6 +20412,7 @@ components: - food - mexican food items: + maxLength: 250 type: string type: array default: null @@ -21377,14 +21417,17 @@ components: carrier: description: Carrier name for the shipment example: FEDEX + maxLength: 250 type: string tracking_number: description: Tracking number can be used to track the shipment example: TRACK123 + maxLength: 250 type: string method: description: Method of shipment example: Same day + maxLength: 250 type: string metadata: additionalProperties: true @@ -21445,6 +21488,48 @@ components: example: false type: boolean title: customer_shipping_contacts_response + shipping_contact_address: + description: Address of the person who will receive the order + properties: + street1: + description: Street and number of the delivery address. + example: Nuevo Leon 254 + maxLength: 250 + type: string + street2: + description: "Apartment, suite or interior reference for the delivery address." + example: Departamento 404 + maxLength: 250 + type: string + postal_code: + description: Postal code of the delivery address. For Mexican addresses + (country MX) it must be a 5-digit postal code. + example: "06100" + maxLength: 250 + type: string + city: + description: City of the delivery address. + example: Ciudad de Mexico + maxLength: 250 + type: string + state: + description: State of the delivery address. + example: Ciudad de Mexico + maxLength: 250 + type: string + country: + description: "Country of the delivery address. This field follows the [ISO\ + \ 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." + example: MX + maxLength: 250 + type: string + residential: + default: true + description: Indicates whether the delivery address is residential. + example: true + nullable: true + type: boolean + title: shipping_contact_address customer_update_shipping_contacts_request: description: |- [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) @@ -21463,7 +21548,7 @@ components: example: Ackerman Crescent type: string address: - $ref: "#/components/schemas/customer_shipping_contacts_request_address" + $ref: "#/components/schemas/shipping_contact_address" parent_id: type: string default: diff --git a/schemas/customers/customer_shipping_contacts.yml b/schemas/customers/customer_shipping_contacts.yml index d876add..be383e2 100644 --- a/schemas/customers/customer_shipping_contacts.yml +++ b/schemas/customers/customer_shipping_contacts.yml @@ -17,32 +17,13 @@ properties: type: string example: "Ackerman Crescent" description: "The street names between which the order will be delivered." - address: - type: object - description: "Address of the person who will receive the order" - properties: - street1: - type: string - example: Nuevo Leon 254 - street2: - type: string - example: Departamento 404 - postal_code: - type: string - example: "06100" - city: - type: string - example: "Ciudad de Mexico" - state: - type: string - example: "Ciudad de Mexico" - country: - type: string - example: MX - description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - residential: - type: [boolean, "null"] - example: true + address: + allOf: + - $ref: shipping_contact_address.yml + required: + - street1 + - postal_code + - country parent_id: type: string default: diff --git a/schemas/customers/customer_update_shipping_contacts.yml b/schemas/customers/customer_update_shipping_contacts.yml index b26e0bf..04f74c0 100644 --- a/schemas/customers/customer_update_shipping_contacts.yml +++ b/schemas/customers/customer_update_shipping_contacts.yml @@ -15,32 +15,8 @@ properties: type: string example: "Ackerman Crescent" description: "The street names between which the order will be delivered." - address: - type: object - description: "Address of the person who will receive the order" - properties: - street1: - type: string - example: Nuevo Leon 254 - street2: - type: string - example: Departamento 404 - postal_code: - type: string - example: "06100" - city: - type: string - example: "Ciudad de Mexico" - state: - type: string - example: "Ciudad de Mexico" - country: - type: string - example: MX - description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - residential: - type: [boolean, "null"] - example: true + address: + $ref: shipping_contact_address.yml parent_id: type: string default: diff --git a/schemas/customers/shipping_contact_address.yml b/schemas/customers/shipping_contact_address.yml new file mode 100644 index 0000000..5d1b44f --- /dev/null +++ b/schemas/customers/shipping_contact_address.yml @@ -0,0 +1,39 @@ +title: shipping_contact_address +type: object +description: "Address of the person who will receive the order" +properties: + street1: + type: string + maxLength: 250 + example: Nuevo Leon 254 + description: "Street and number of the delivery address." + street2: + type: string + maxLength: 250 + example: Departamento 404 + description: "Apartment, suite or interior reference for the delivery address." + postal_code: + type: string + maxLength: 250 + example: "06100" + description: "Postal code of the delivery address. For Mexican addresses (country MX) it must be a 5-digit postal code." + city: + type: string + maxLength: 250 + example: "Ciudad de Mexico" + description: "City of the delivery address." + state: + type: string + maxLength: 250 + example: "Ciudad de Mexico" + description: "State of the delivery address." + country: + type: string + maxLength: 250 + example: MX + description: "Country of the delivery address. This field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." + residential: + type: [boolean, "null"] + default: true + example: true + description: "Indicates whether the delivery address is residential." diff --git a/schemas/orders/product.yml b/schemas/orders/product.yml index 21b4a5f..e49c642 100644 --- a/schemas/orders/product.yml +++ b/schemas/orders/product.yml @@ -11,6 +11,7 @@ properties: example: { "key": "value" } brand: type: string + maxLength: 250 example: "Cohiba" description: "The brand of the item." description: @@ -27,6 +28,7 @@ properties: default: {} name: type: string + maxLength: 250 example: "Box of Cohiba S1s" description: "The name of the item. It will be displayed in the order." quantity: @@ -37,12 +39,14 @@ properties: description: "The quantity of the item in the order." sku: type: string + maxLength: 250 example: "XYZ12345" description: "The stock keeping unit for the item. It is used to identify the item in the order." tags: type: array items: type: string + maxLength: 250 example: [ "food", "mexican food"] description: "List of tags for the item. It is used to identify the item in the order." unit_price: diff --git a/schemas/orders/shipping_request.yml b/schemas/orders/shipping_request.yml index dad8e73..c712eff 100644 --- a/schemas/orders/shipping_request.yml +++ b/schemas/orders/shipping_request.yml @@ -8,17 +8,20 @@ properties: example: 100 minimum: 0 description: Shipping amount in cents - carrier: + carrier: type: string + maxLength: 250 example: FEDEX description: Carrier name for the shipment tracking_number: type: string + maxLength: 250 example: "TRACK123" description: Tracking number can be used to track the shipment method: type: string - example: "Same day" + maxLength: 250 + example: "Same day" description: Method of shipment metadata: description: Hash where the user can send additional information for each 'shipping'. From 0408554c7f00e90edc26ebfad1541ddba77e3037 Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Mon, 29 Jun 2026 13:18:03 -0400 Subject: [PATCH 02/10] fix(orders): tighten shipping address, line, and item schema constraints Align the OpenAPI schemas with the validations enforced by payments-api's v200 param sanitizers, which were previously under-documented. - Extract the shipping-contact address into a shared schemas/customers/shipping_contact_address.yml and reference it from the create and update shipping-contact schemas, removing the duplicated inline address blocks. - Mark street1, postal_code, and country as required on the create path (matching ShippingContacts::Validator#validate_on_create); the update path keeps them optional. - Document the MX 5-digit postal code rule and add field descriptions. - Add min/max length constraints matching StringValidator (strict bounds: less_than/greater_than). String fields cap at maxLength 249 (the sanitizer rejects length >= 250); minLength derives from greater_than + 1. postal_code keeps maxLength 250, its only cap being the model-level zip validation. Applies to address fields, shipping line carrier/tracking_number/method, and line-item name/description/brand/sku/tags (create and update). - Regenerate _build/api.yaml. Co-Authored-By: Claude Opus 4.8 (1M context) --- _build/api.yaml | 111 ++++++++++++------ .../customers/shipping_contact_address.yml | 12 +- schemas/orders/product.yml | 16 ++- schemas/orders/shipping_request.yml | 9 +- schemas/orders/update_product.yml | 12 +- 5 files changed, 111 insertions(+), 49 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index dd4b85e..9e391a1 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -17562,13 +17562,14 @@ components: street1: description: Street and number of the delivery address. example: Nuevo Leon 254 - maxLength: 250 + maxLength: 249 + minLength: 2 type: string street2: description: "Apartment, suite or interior reference for the delivery\ \ address." example: Departamento 404 - maxLength: 250 + maxLength: 249 type: string postal_code: description: Postal code of the delivery address. For Mexican addresses @@ -17579,18 +17580,19 @@ components: city: description: City of the delivery address. example: Ciudad de Mexico - maxLength: 250 + maxLength: 249 type: string state: description: State of the delivery address. example: Ciudad de Mexico - maxLength: 250 + maxLength: 249 type: string country: description: "Country of the delivery address. This field follows the\ \ [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." example: MX - maxLength: 250 + maxLength: 249 + minLength: 2 type: string residential: default: true @@ -19308,17 +19310,20 @@ components: carrier: description: Carrier name for the shipment example: FEDEX - maxLength: 250 + maxLength: 249 + minLength: 3 type: string tracking_number: description: Tracking number can be used to track the shipment example: TRACK123 - maxLength: 250 + maxLength: 249 + minLength: 3 type: string method: description: Method of shipment example: Same day - maxLength: 250 + maxLength: 249 + minLength: 3 type: string metadata: additionalProperties: true @@ -19484,12 +19489,14 @@ components: brand: description: The brand of the item. example: Cohiba - maxLength: 250 + maxLength: 249 + minLength: 2 type: string description: description: Short description of the item example: Imported From Mex. - maxLength: 250 + maxLength: 249 + minLength: 3 type: string metadata: additionalProperties: true @@ -19503,7 +19510,8 @@ components: name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s - maxLength: 250 + maxLength: 249 + minLength: 3 type: string quantity: description: The quantity of the item in the order. @@ -19515,7 +19523,8 @@ components: description: The stock keeping unit for the item. It is used to identify the item in the order. example: XYZ12345 - maxLength: 250 + maxLength: 249 + minLength: 1 type: string tags: description: List of tags for the item. It is used to identify the item @@ -19524,8 +19533,10 @@ components: - food - mexican food items: - maxLength: 250 + maxLength: 249 + minLength: 2 type: string + minItems: 1 type: array default: null unit_price: @@ -20059,12 +20070,14 @@ components: brand: description: The brand of the item. example: Cohiba - maxLength: 250 + maxLength: 249 + minLength: 2 type: string description: description: Short description of the item example: Imported From Mex. - maxLength: 250 + maxLength: 249 + minLength: 3 type: string metadata: additionalProperties: true @@ -20078,7 +20091,8 @@ components: name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s - maxLength: 250 + maxLength: 249 + minLength: 3 type: string quantity: description: The quantity of the item in the order. @@ -20090,7 +20104,8 @@ components: description: The stock keeping unit for the item. It is used to identify the item in the order. example: XYZ12345 - maxLength: 250 + maxLength: 249 + minLength: 1 type: string tags: description: List of tags for the item. It is used to identify the item @@ -20099,8 +20114,10 @@ components: - food - mexican food items: - maxLength: 250 + maxLength: 249 + minLength: 2 type: string + minItems: 1 type: array default: null unit_price: @@ -20125,17 +20142,20 @@ components: carrier: description: Carrier name for the shipment example: FEDEX - maxLength: 250 + maxLength: 249 + minLength: 3 type: string tracking_number: description: Tracking number can be used to track the shipment example: TRACK123 - maxLength: 250 + maxLength: 249 + minLength: 3 type: string method: description: Method of shipment example: Same day - maxLength: 250 + maxLength: 249 + minLength: 3 type: string metadata: additionalProperties: true @@ -20372,12 +20392,14 @@ components: brand: description: The brand of the item. example: Cohiba - maxLength: 250 + maxLength: 249 + minLength: 2 type: string description: description: Short description of the item example: Imported From Mex. - maxLength: 250 + maxLength: 249 + minLength: 3 type: string metadata: additionalProperties: true @@ -20391,7 +20413,8 @@ components: name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s - maxLength: 250 + maxLength: 249 + minLength: 3 type: string quantity: description: The quantity of the item in the order. @@ -20403,7 +20426,8 @@ components: description: The stock keeping unit for the item. It is used to identify the item in the order. example: XYZ12345 - maxLength: 250 + maxLength: 249 + minLength: 1 type: string tags: description: List of tags for the item. It is used to identify the item @@ -20412,8 +20436,10 @@ components: - food - mexican food items: - maxLength: 250 + maxLength: 249 + minLength: 2 type: string + minItems: 1 type: array default: null unit_price: @@ -20441,12 +20467,17 @@ components: additionalProperties: type: object description: - maxLength: 250 + maxLength: 249 + minLength: 3 type: string sku: + maxLength: 249 + minLength: 1 type: string name: example: Box of Cohiba S1s + maxLength: 249 + minLength: 3 type: string unit_price: example: 20000 @@ -20460,10 +20491,15 @@ components: type: integer tags: items: + maxLength: 249 + minLength: 2 type: string + minItems: 1 type: array default: null brand: + maxLength: 249 + minLength: 2 type: string metadata: additionalProperties: @@ -21417,17 +21453,20 @@ components: carrier: description: Carrier name for the shipment example: FEDEX - maxLength: 250 + maxLength: 249 + minLength: 3 type: string tracking_number: description: Tracking number can be used to track the shipment example: TRACK123 - maxLength: 250 + maxLength: 249 + minLength: 3 type: string method: description: Method of shipment example: Same day - maxLength: 250 + maxLength: 249 + minLength: 3 type: string metadata: additionalProperties: true @@ -21494,12 +21533,13 @@ components: street1: description: Street and number of the delivery address. example: Nuevo Leon 254 - maxLength: 250 + maxLength: 249 + minLength: 2 type: string street2: description: "Apartment, suite or interior reference for the delivery address." example: Departamento 404 - maxLength: 250 + maxLength: 249 type: string postal_code: description: Postal code of the delivery address. For Mexican addresses @@ -21510,18 +21550,19 @@ components: city: description: City of the delivery address. example: Ciudad de Mexico - maxLength: 250 + maxLength: 249 type: string state: description: State of the delivery address. example: Ciudad de Mexico - maxLength: 250 + maxLength: 249 type: string country: description: "Country of the delivery address. This field follows the [ISO\ \ 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." example: MX - maxLength: 250 + maxLength: 249 + minLength: 2 type: string residential: default: true diff --git a/schemas/customers/shipping_contact_address.yml b/schemas/customers/shipping_contact_address.yml index 5d1b44f..1b3d28a 100644 --- a/schemas/customers/shipping_contact_address.yml +++ b/schemas/customers/shipping_contact_address.yml @@ -4,12 +4,13 @@ description: "Address of the person who will receive the order" properties: street1: type: string - maxLength: 250 + minLength: 2 + maxLength: 249 example: Nuevo Leon 254 description: "Street and number of the delivery address." street2: type: string - maxLength: 250 + maxLength: 249 example: Departamento 404 description: "Apartment, suite or interior reference for the delivery address." postal_code: @@ -19,17 +20,18 @@ properties: description: "Postal code of the delivery address. For Mexican addresses (country MX) it must be a 5-digit postal code." city: type: string - maxLength: 250 + maxLength: 249 example: "Ciudad de Mexico" description: "City of the delivery address." state: type: string - maxLength: 250 + maxLength: 249 example: "Ciudad de Mexico" description: "State of the delivery address." country: type: string - maxLength: 250 + minLength: 2 + maxLength: 249 example: MX description: "Country of the delivery address. This field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." residential: diff --git a/schemas/orders/product.yml b/schemas/orders/product.yml index e49c642..3e3d196 100644 --- a/schemas/orders/product.yml +++ b/schemas/orders/product.yml @@ -11,13 +11,15 @@ properties: example: { "key": "value" } brand: type: string - maxLength: 250 + minLength: 2 + maxLength: 249 example: "Cohiba" description: "The brand of the item." description: type: string example: "Imported From Mex." - maxLength: 250 + minLength: 3 + maxLength: 249 description: "Short description of the item" metadata: type: object @@ -28,7 +30,8 @@ properties: default: {} name: type: string - maxLength: 250 + minLength: 3 + maxLength: 249 example: "Box of Cohiba S1s" description: "The name of the item. It will be displayed in the order." quantity: @@ -39,14 +42,17 @@ properties: description: "The quantity of the item in the order." sku: type: string - maxLength: 250 + minLength: 1 + maxLength: 249 example: "XYZ12345" description: "The stock keeping unit for the item. It is used to identify the item in the order." tags: type: array + minItems: 1 items: type: string - maxLength: 250 + minLength: 2 + maxLength: 249 example: [ "food", "mexican food"] description: "List of tags for the item. It is used to identify the item in the order." unit_price: diff --git a/schemas/orders/shipping_request.yml b/schemas/orders/shipping_request.yml index c712eff..6798a9e 100644 --- a/schemas/orders/shipping_request.yml +++ b/schemas/orders/shipping_request.yml @@ -10,17 +10,20 @@ properties: description: Shipping amount in cents carrier: type: string - maxLength: 250 + minLength: 3 + maxLength: 249 example: FEDEX description: Carrier name for the shipment tracking_number: type: string - maxLength: 250 + minLength: 3 + maxLength: 249 example: "TRACK123" description: Tracking number can be used to track the shipment method: type: string - maxLength: 250 + minLength: 3 + maxLength: 249 example: "Same day" description: Method of shipment metadata: diff --git a/schemas/orders/update_product.yml b/schemas/orders/update_product.yml index c7fdd6a..9adda66 100644 --- a/schemas/orders/update_product.yml +++ b/schemas/orders/update_product.yml @@ -7,11 +7,16 @@ properties: type: object description: type: string - maxLength: 250 + minLength: 3 + maxLength: 249 sku: type: string + minLength: 1 + maxLength: 249 name: type: string + minLength: 3 + maxLength: 249 example: "Box of Cohiba S1s" unit_price: type: integer @@ -25,10 +30,15 @@ properties: minimum: 1 tags: type: array + minItems: 1 items: type: string + minLength: 2 + maxLength: 249 brand: type: string + minLength: 2 + maxLength: 249 metadata: type: object additionalProperties: From 95e2f09f55ef486711e99f6b8ab550859e08b5d5 Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Thu, 2 Jul 2026 14:41:02 -0400 Subject: [PATCH 03/10] fix: align checkout, order, card and bnpl schemas with enforced validations Applies verified corrections from the payments-api validator audit: - exclude_card_networks: real accepted vocabulary is [visa_master_card, amex] (exact-membership options_array validator); visa/mastercard as separate values are rejected. Responses echo stored values in CamelCase. - three_ds_mode: add the accepted value not_strict (shared constant ALLOWED_TYPES_FOR_3DS_BY_API allows strict/not_strict/smart); note the field is create-only and nullable. - metadata (orders, products, shipping/tax lines): values must be scalar string(<=249)/integer/number/boolean per nested_json_subtypes; replaces the too-loose additionalProperties:true and too-narrow {type: string}. - bnpl: cancel_url is optional by design (spec-pinned in payments-api); remove can_not_expire (not in the cleaner allowlist, silently stripped); add expires_at (the real expiry control). - card: document the enforced two-word cardholder name rule and maxLength; expose contract_id (10-char bank contract reference, create-only). - fiscal entity address: remove residential (stripped by cleaner and not storable on FiscalEntityAddress). - Rebuild _build/api.yaml. Co-Authored-By: Claude Fable 5 --- _build/api.yaml | 171 +++++++++++------- schemas/checkouts/checkout.yml | 15 +- schemas/checkouts/checkout_request.yml | 6 +- schemas/customers/customer_address.yml | 5 - .../customers/payment_method_bnpl_request.yml | 13 +- .../customers/payment_method_card_request.yml | 9 +- schemas/orders/order_request.yml | 19 +- schemas/orders/order_tax_request.yml | 8 +- schemas/orders/order_update_request.yml | 8 +- schemas/orders/product.yml | 10 +- schemas/orders/shipping_request.yml | 10 +- schemas/orders/update_order_tax_request.yml | 7 +- schemas/orders/update_product.yml | 8 +- 13 files changed, 188 insertions(+), 101 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index 9e391a1..04defa1 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -16611,13 +16611,15 @@ components: title: customer_payment_method_request - properties: cancel_url: - description: URL to redirect the customer after a canceled payment + description: Optional URL to redirect the customer after a canceled payment example: https://example.com/cancel type: string - can_not_expire: - description: Indicates if the payment method can not expire - example: true - type: boolean + expires_at: + description: "Optional expiry for the BNPL order, expressed in seconds\ + \ since the Unix epoch" + example: 1680397724 + format: int64 + type: integer failure_url: description: URL to redirect the customer after a failed payment example: https://example.com/failure @@ -16641,8 +16643,6 @@ components: example: bnpl type: string required: - - can_not_expire - - cancel_url - failure_url - product_type - success_url @@ -16680,13 +16680,25 @@ components: minLength: 4 type: string name: - description: Cardholder name + description: Cardholder name. Must include first and last name separated + by a space; single-word names are rejected. example: John Doe + maxLength: 249 type: string number: description: Card number example: "4242424242424242" type: string + contract_id: + description: Optional merchant-supplied identifier (exactly 10 characters) + that links a card transaction to a recurring/subscription contract at + the acquiring bank. Forwarded to the bank gateway and stored on the + resulting charge. Accepted on creation only; ignored on update. Do not + place sensitive bank data here — the value is returned in charge responses. + example: "3456788363" + maxLength: 10 + minLength: 10 + type: string customer_ip_address: description: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes @@ -17221,10 +17233,6 @@ components: description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" example: MX type: string - residential: - default: false - example: true - type: boolean external_number: type: string required: @@ -19219,6 +19227,13 @@ components: default: null description: List of discounts that are applied to the order nullable: true + order_tax_request_metadata_value: + oneOf: + - maxLength: 249 + type: string + - type: integer + - type: number + - type: boolean tax_lines_data_response: allOf: - allOf: @@ -19236,11 +19251,11 @@ components: minLength: 2 type: string metadata: - additionalProperties: true + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" example: key: value maxProperties: 100 - type: object required: - amount - description @@ -19326,13 +19341,14 @@ components: minLength: 3 type: string metadata: - additionalProperties: true - description: Hash where the user can send additional information for - each 'shipping'. + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "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 rejected." example: key: value maxProperties: 100 - type: object required: - amount title: shipping_request @@ -19499,14 +19515,15 @@ components: minLength: 3 type: string metadata: - additionalProperties: true + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" default: {} - description: It is a key/value hash that can hold custom fields. Maximum - 100 elements and allows special characters. + description: "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 rejected." example: key: value maxProperties: 100 - type: object name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s @@ -19865,15 +19882,15 @@ components: type: array default: null exclude_card_networks: - description: List of card networks to exclude from the checkout. This field - is only applicable for card payments. + description: "List of card networks to exclude from the checkout. This field\ + \ is only applicable for card payments. Accepted values: 'visa_master_card'\ + \ (a single token excluding both Visa and Mastercard) and 'amex'. Values\ + \ are echoed back in CamelCase (e.g. 'VisaMasterCard') in responses." example: - - visa - - amex + - visa_master_card items: enum: - - visa - - mastercard + - visa_master_card - amex type: string title: checkout_request_exclude_card_networks @@ -20080,14 +20097,15 @@ components: minLength: 3 type: string metadata: - additionalProperties: true + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" default: {} - description: It is a key/value hash that can hold custom fields. Maximum - 100 elements and allows special characters. + description: "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 rejected." example: key: value maxProperties: 100 - type: object name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s @@ -20158,13 +20176,14 @@ components: minLength: 3 type: string metadata: - additionalProperties: true - description: Hash where the user can send additional information for each - 'shipping'. + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "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 rejected." example: key: value maxProperties: 100 - type: object required: - amount title: shipping_request @@ -20183,11 +20202,11 @@ components: minLength: 2 type: string metadata: - additionalProperties: true + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" example: key: value maxProperties: 100 - type: object required: - amount - description @@ -20229,10 +20248,12 @@ components: type: array default: null metadata: - additionalProperties: true - description: Metadata associated with the order + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "Metadata associated with the order. Values must be scalar\ + \ (string of at most 249 characters, integer, number or boolean); nested\ + \ objects and arrays are rejected." maxProperties: 100 - type: object needs_shipping_contact: description: Allows you to fill out the shipping information at checkout example: false @@ -20268,9 +20289,15 @@ components: type: array default: null three_ds_mode: - description: "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." + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ + \ Accepted on creation only. This property is only applicable when 3DS\ + \ is enabled; when 3DS is disabled this field should be null (no 3DS flow\ + \ is applied)." + enum: + - strict + - not_strict + - smart + - null nullable: true type: string required: @@ -20351,7 +20378,8 @@ components: default: null metadata: additionalProperties: - type: string + $ref: "#/components/schemas/order_tax_request_metadata_value" + maxProperties: 100 pre_authorize: description: Indicates whether the order charges must be preauthorized type: boolean @@ -20402,14 +20430,15 @@ components: minLength: 3 type: string metadata: - additionalProperties: true + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" default: {} - description: It is a key/value hash that can hold custom fields. Maximum - 100 elements and allows special characters. + description: "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 rejected." example: key: value maxProperties: 100 - type: object name: description: The name of the item. It will be displayed in the order. example: Box of Cohiba S1s @@ -20503,7 +20532,8 @@ components: type: string metadata: additionalProperties: - type: string + $ref: "#/components/schemas/order_tax_request_metadata_value" + maxProperties: 100 title: update_product orderRefund_request: properties: @@ -21061,16 +21091,18 @@ components: type: array default: null exclude_card_networks: - description: List of card networks to exclude from the checkout. This field - is only applicable for card payments. + description: "List of card networks to exclude from the checkout. This field\ + \ is only applicable for card payments. Accepted request values: 'visa_master_card'\ + \ (a single token excluding both Visa and Mastercard) and 'amex'. Responses\ + \ echo the stored values in CamelCase (e.g. 'VisaMasterCard', 'Amex')." example: - - visa - - amex + - visa_master_card items: enum: - - visa - - mastercard + - visa_master_card - amex + - VisaMasterCard + - Amex type: string title: checkout_exclude_card_networks type: array @@ -21101,9 +21133,15 @@ components: type: array default: null three_ds_mode: - description: "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." + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ + \ Accepted on creation only. This property is only applicable when 3DS\ + \ is enabled; when 3DS is disabled this field should be null (no 3DS flow\ + \ is applied)." + enum: + - strict + - not_strict + - smart + - null nullable: true type: string name: @@ -21469,13 +21507,14 @@ components: minLength: 3 type: string metadata: - additionalProperties: true - description: Hash where the user can send additional information for each - 'shipping'. + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "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 rejected." example: key: value maxProperties: 100 - type: object required: - amount title: shipping_request @@ -21918,11 +21957,11 @@ components: minLength: 2 type: string metadata: - additionalProperties: true + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" example: key: value maxProperties: 100 - type: object required: - amount - description @@ -21957,7 +21996,7 @@ components: type: string metadata: additionalProperties: - type: object + $ref: "#/components/schemas/order_tax_request_metadata_value" maxProperties: 100 token_request_card: properties: diff --git a/schemas/checkouts/checkout.yml b/schemas/checkouts/checkout.yml index eed957d..ff84378 100644 --- a/schemas/checkouts/checkout.yml +++ b/schemas/checkouts/checkout.yml @@ -25,11 +25,11 @@ properties: exclude_card_networks: title: checkout_exclude_card_networks type: array - description: "List of card networks to exclude from the checkout. This field is only applicable for card payments." + description: "List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted request values: 'visa_master_card' (a single token excluding both Visa and Mastercard) and 'amex'. Responses echo the stored values in CamelCase (e.g. 'VisaMasterCard', 'Amex')." items: type: string - enum: ["visa", "mastercard", "amex"] - example: ["visa", "amex"] + enum: ["visa_master_card", "amex", "VisaMasterCard", "Amex"] + example: ["visa_master_card"] expires_at: type: integer example: 1680397724 @@ -51,12 +51,15 @@ properties: example: [3,6,12] three_ds_mode: type: [string, "null"] - description: "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." + enum: ["strict", "not_strict", "smart", null] + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. Accepted on creation only. This property is only applicable when 3DS is enabled; when 3DS is disabled this field should be null (no 3DS flow is applied)." examples: - value: "smart" - summary: "Those transactions that Conekta considers to present a risk to commerce will go through an additional verification flow (through 3DS2), provided that the issuing bank is compatible with this technology.If the transaction is not considered risky, it will continue its normal course, without going through 3DS2 authentication." + summary: "Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication." - value: "strict" - summary: "All transactions will require 3DS2 authentication as a complementary measure for the security of charges, except those that are rejected by our Anti-Fraud. The issuing bank must be compatible with 3DS2 technology." + summary: "All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2." + - value: "not_strict" + summary: "The 3DS2 challenge is also always initiated; intended as the more lenient variant of 'strict' where authentication attempts may be accepted." name: type: string description: Reason for charge diff --git a/schemas/checkouts/checkout_request.yml b/schemas/checkouts/checkout_request.yml index 0f759b4..4bb3aed 100644 --- a/schemas/checkouts/checkout_request.yml +++ b/schemas/checkouts/checkout_request.yml @@ -20,11 +20,11 @@ properties: exclude_card_networks: title: checkout_request_exclude_card_networks type: array - description: "List of card networks to exclude from the checkout. This field is only applicable for card payments." + description: "List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: 'visa_master_card' (a single token excluding both Visa and Mastercard) and 'amex'. Values are echoed back in CamelCase (e.g. 'VisaMasterCard') in responses." items: type: string - enum: ["visa", "mastercard", "amex"] - example: ["visa", "amex"] + enum: ["visa_master_card", "amex"] + example: ["visa_master_card"] plan_ids: type: array description: "List of plan IDs that will be available for subscription. This field is required for subscription payments." diff --git a/schemas/customers/customer_address.yml b/schemas/customers/customer_address.yml index 2fe1435..ec69fcd 100644 --- a/schemas/customers/customer_address.yml +++ b/schemas/customers/customer_address.yml @@ -23,10 +23,5 @@ properties: type: string example: MX description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - residential: - type: boolean - example: true - default: false external_number: type: string - \ No newline at end of file diff --git a/schemas/customers/payment_method_bnpl_request.yml b/schemas/customers/payment_method_bnpl_request.yml index 0330bf8..2296f4f 100644 --- a/schemas/customers/payment_method_bnpl_request.yml +++ b/schemas/customers/payment_method_bnpl_request.yml @@ -3,8 +3,6 @@ allOf: - $ref: './customer_payment_method_request.yml' - type: object required: - - can_not_expire - - cancel_url - failure_url - product_type - success_url @@ -12,12 +10,13 @@ allOf: properties: cancel_url: type: string - description: "URL to redirect the customer after a canceled payment" + description: "Optional URL to redirect the customer after a canceled payment" example: "https://example.com/cancel" - can_not_expire: - type: boolean - example: true - description: "Indicates if the payment method can not expire" + expires_at: + type: integer + format: int64 + example: 1680397724 + description: "Optional expiry for the BNPL order, expressed in seconds since the Unix epoch" failure_url: type: string description: "URL to redirect the customer after a failed payment" diff --git a/schemas/customers/payment_method_card_request.yml b/schemas/customers/payment_method_card_request.yml index 5b91543..9d6585d 100644 --- a/schemas/customers/payment_method_card_request.yml +++ b/schemas/customers/payment_method_card_request.yml @@ -29,12 +29,19 @@ allOf: minLength: 4 name: type: string + maxLength: 249 example: "John Doe" - description: "Cardholder name" + description: "Cardholder name. Must include first and last name separated by a space; single-word names are rejected." number: type: string example: "4242424242424242" description: "Card number" + contract_id: + type: string + minLength: 10 + maxLength: 10 + example: "3456788363" + description: "Optional merchant-supplied identifier (exactly 10 characters) that links a card transaction to a recurring/subscription contract at the acquiring bank. Forwarded to the bank gateway and stored on the resulting charge. Accepted on creation only; ignored on update. Do not place sensitive bank data here — the value is returned in charge responses." customer_ip_address: type: string example: "0.0.0.0" diff --git a/schemas/orders/order_request.yml b/schemas/orders/order_request.yml index ad7cd8f..57f9e55 100644 --- a/schemas/orders/order_request.yml +++ b/schemas/orders/order_request.yml @@ -66,9 +66,15 @@ properties: $ref: product.yml metadata: type: object - additionalProperties: true + additionalProperties: + oneOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean maxProperties: 100 - description: "Metadata associated with the order" + description: "Metadata associated with the order. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are rejected." needs_shipping_contact: type: boolean example: false @@ -99,9 +105,12 @@ properties: $ref: order_tax_request.yml three_ds_mode: type: [string, "null"] - description: "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." + enum: ["strict", "not_strict", "smart", null] + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. Accepted on creation only. This property is only applicable when 3DS is enabled; when 3DS is disabled this field should be null (no 3DS flow is applied)." examples: - value: "smart" - summary: "Those transactions that Conekta considers to present a risk to commerce will go through an additional verification flow (through 3DS2), provided that the issuing bank is compatible with this technology.If the transaction is not considered risky, it will continue its normal course, without going through 3DS2 authentication." + summary: "Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication." - value: "strict" - summary: "All transactions will require 3DS2 authentication as a complementary measure for the security of charges, except those that are rejected by our Anti-Fraud. The issuing bank must be compatible with 3DS2 technology." + summary: "All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2." + - value: "not_strict" + summary: "The 3DS2 challenge is also always initiated; intended as the more lenient variant of 'strict' where authentication attempts may be accepted." diff --git a/schemas/orders/order_tax_request.yml b/schemas/orders/order_tax_request.yml index 1c168c9..1c9b0d8 100644 --- a/schemas/orders/order_tax_request.yml +++ b/schemas/orders/order_tax_request.yml @@ -18,6 +18,12 @@ properties: description: description or tax's name metadata: type: object - additionalProperties: true + additionalProperties: + oneOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean example: { "key": "value" } maxProperties: 100 diff --git a/schemas/orders/order_update_request.yml b/schemas/orders/order_update_request.yml index 92bd302..5c33ca2 100644 --- a/schemas/orders/order_update_request.yml +++ b/schemas/orders/order_update_request.yml @@ -61,8 +61,14 @@ properties: $ref: product.yml metadata: type: object + maxProperties: 100 additionalProperties: - type: string + oneOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean pre_authorize: type: boolean description: "Indicates whether the order charges must be preauthorized" diff --git a/schemas/orders/product.yml b/schemas/orders/product.yml index 3e3d196..f72329f 100644 --- a/schemas/orders/product.yml +++ b/schemas/orders/product.yml @@ -24,8 +24,14 @@ properties: metadata: type: object maxProperties: 100 - description: It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. - additionalProperties: true + description: 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 rejected. + additionalProperties: + oneOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean example: { "key": "value" } default: {} name: diff --git a/schemas/orders/shipping_request.yml b/schemas/orders/shipping_request.yml index 6798a9e..db58a47 100644 --- a/schemas/orders/shipping_request.yml +++ b/schemas/orders/shipping_request.yml @@ -27,8 +27,14 @@ properties: example: "Same day" description: Method of shipment metadata: - description: Hash where the user can send additional information for each 'shipping'. + description: 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 rejected. type: object - additionalProperties: true + additionalProperties: + oneOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean example: { "key": "value" } maxProperties: 100 \ No newline at end of file diff --git a/schemas/orders/update_order_tax_request.yml b/schemas/orders/update_order_tax_request.yml index eaec2e2..e8e0dc6 100644 --- a/schemas/orders/update_order_tax_request.yml +++ b/schemas/orders/update_order_tax_request.yml @@ -15,5 +15,10 @@ properties: metadata: type: object additionalProperties: - type: object + oneOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean maxProperties: 100 diff --git a/schemas/orders/update_product.yml b/schemas/orders/update_product.yml index 9adda66..7866809 100644 --- a/schemas/orders/update_product.yml +++ b/schemas/orders/update_product.yml @@ -41,5 +41,11 @@ properties: maxLength: 249 metadata: type: object + maxProperties: 100 additionalProperties: - type: string \ No newline at end of file + oneOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean \ No newline at end of file From 56cd6707daae83e08b2b2635ed2b17a854622f8f Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Thu, 2 Jul 2026 14:55:23 -0400 Subject: [PATCH 04/10] fix: apply adversarial-review corrections to checkout, order and metadata schemas Four skeptic reviewers re-derived every changed constraint from payments-api source. Corrections from confirmed findings: - metadata additionalProperties: oneOf -> anyOf. type integer and type number both match an integer value, so strict oneOf validators reject integers the API accepts. - exclude_card_networks: remove the CamelCase echo claim and the CamelCase enum values. The mapper camelizes only the internal checkout service payload; Checkout.to_snake_case underscores values on every read (checkout.rb:418-420), so API responses return snake_case. - order three_ds_mode: drop "accepted on creation only" (the orders cleaner permits it on update via permitted_params_shared; it is only validated on create). Checkout keeps create-only wording (its update cleaner permits nothing). - three_ds_mode null semantics: null defers to the company-level 3DS configuration; it does not disable 3DS. - not_strict description: behaviorally identical to strict in payments-api; attempt acceptance is governed by company configuration. - shipping address city: document the enforced two-consecutive-letters pattern. - card name / bnpl expires_at descriptions enriched per review. - Rebuild _build/api.yaml. Co-Authored-By: Claude Fable 5 --- _build/api.yaml | 35 +++++++++---------- schemas/checkouts/checkout.yml | 8 ++--- schemas/checkouts/checkout_request.yml | 2 +- .../customers/payment_method_bnpl_request.yml | 2 +- .../customers/payment_method_card_request.yml | 2 +- .../customers/shipping_contact_address.yml | 3 +- schemas/orders/order_request.yml | 6 ++-- schemas/orders/order_tax_request.yml | 2 +- schemas/orders/order_update_request.yml | 2 +- schemas/orders/product.yml | 2 +- schemas/orders/shipping_request.yml | 2 +- schemas/orders/update_order_tax_request.yml | 2 +- schemas/orders/update_product.yml | 2 +- 13 files changed, 35 insertions(+), 35 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index 04defa1..6c8115e 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -16616,7 +16616,7 @@ components: type: string expires_at: description: "Optional expiry for the BNPL order, expressed in seconds\ - \ since the Unix epoch" + \ since the Unix epoch. Defaults to one month from creation when omitted." example: 1680397724 format: int64 type: integer @@ -16681,7 +16681,8 @@ components: type: string name: description: Cardholder name. Must include first and last name separated - by a space; single-word names are rejected. + by a space; single-word names are rejected. Letters only — digits and + most symbols are rejected. example: John Doe maxLength: 249 type: string @@ -17586,9 +17587,11 @@ components: maxLength: 250 type: string city: - description: City of the delivery address. + description: City of the delivery address. Must contain at least two consecutive + ASCII letters. example: Ciudad de Mexico maxLength: 249 + pattern: "[A-Za-z]{2}" type: string state: description: State of the delivery address. @@ -19228,7 +19231,7 @@ components: description: List of discounts that are applied to the order nullable: true order_tax_request_metadata_value: - oneOf: + anyOf: - maxLength: 249 type: string - type: integer @@ -19884,8 +19887,7 @@ components: exclude_card_networks: description: "List of card networks to exclude from the checkout. This field\ \ is only applicable for card payments. Accepted values: 'visa_master_card'\ - \ (a single token excluding both Visa and Mastercard) and 'amex'. Values\ - \ are echoed back in CamelCase (e.g. 'VisaMasterCard') in responses." + \ (a single token excluding both Visa and Mastercard) and 'amex'." example: - visa_master_card items: @@ -20290,9 +20292,8 @@ components: default: null three_ds_mode: description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ - \ Accepted on creation only. This property is only applicable when 3DS\ - \ is enabled; when 3DS is disabled this field should be null (no 3DS flow\ - \ is applied)." + \ The value is validated against the allowed set on creation. When this\ + \ field is null the order defers to the company-level 3DS configuration." enum: - strict - not_strict @@ -21092,17 +21093,14 @@ components: default: null exclude_card_networks: description: "List of card networks to exclude from the checkout. This field\ - \ is only applicable for card payments. Accepted request values: 'visa_master_card'\ - \ (a single token excluding both Visa and Mastercard) and 'amex'. Responses\ - \ echo the stored values in CamelCase (e.g. 'VisaMasterCard', 'Amex')." + \ is only applicable for card payments. Accepted values: 'visa_master_card'\ + \ (a single token excluding both Visa and Mastercard) and 'amex'." example: - visa_master_card items: enum: - visa_master_card - amex - - VisaMasterCard - - Amex type: string title: checkout_exclude_card_networks type: array @@ -21134,9 +21132,8 @@ components: default: null three_ds_mode: description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ - \ Accepted on creation only. This property is only applicable when 3DS\ - \ is enabled; when 3DS is disabled this field should be null (no 3DS flow\ - \ is applied)." + \ Accepted on creation only. When this field is null the checkout defers\ + \ to the company-level 3DS configuration." enum: - strict - not_strict @@ -21587,9 +21584,11 @@ components: maxLength: 250 type: string city: - description: City of the delivery address. + description: City of the delivery address. Must contain at least two consecutive + ASCII letters. example: Ciudad de Mexico maxLength: 249 + pattern: "[A-Za-z]{2}" type: string state: description: State of the delivery address. diff --git a/schemas/checkouts/checkout.yml b/schemas/checkouts/checkout.yml index ff84378..029c6b4 100644 --- a/schemas/checkouts/checkout.yml +++ b/schemas/checkouts/checkout.yml @@ -25,10 +25,10 @@ properties: exclude_card_networks: title: checkout_exclude_card_networks type: array - description: "List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted request values: 'visa_master_card' (a single token excluding both Visa and Mastercard) and 'amex'. Responses echo the stored values in CamelCase (e.g. 'VisaMasterCard', 'Amex')." + description: "List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: 'visa_master_card' (a single token excluding both Visa and Mastercard) and 'amex'." items: type: string - enum: ["visa_master_card", "amex", "VisaMasterCard", "Amex"] + enum: ["visa_master_card", "amex"] example: ["visa_master_card"] expires_at: type: integer @@ -52,14 +52,14 @@ properties: three_ds_mode: type: [string, "null"] enum: ["strict", "not_strict", "smart", null] - description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. Accepted on creation only. This property is only applicable when 3DS is enabled; when 3DS is disabled this field should be null (no 3DS flow is applied)." + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. Accepted on creation only. When this field is null the checkout defers to the company-level 3DS configuration." examples: - value: "smart" summary: "Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication." - value: "strict" summary: "All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2." - value: "not_strict" - summary: "The 3DS2 challenge is also always initiated; intended as the more lenient variant of 'strict' where authentication attempts may be accepted." + summary: "The 3DS2 challenge is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode." name: type: string description: Reason for charge diff --git a/schemas/checkouts/checkout_request.yml b/schemas/checkouts/checkout_request.yml index 4bb3aed..c5dcdc7 100644 --- a/schemas/checkouts/checkout_request.yml +++ b/schemas/checkouts/checkout_request.yml @@ -20,7 +20,7 @@ properties: exclude_card_networks: title: checkout_request_exclude_card_networks type: array - description: "List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: 'visa_master_card' (a single token excluding both Visa and Mastercard) and 'amex'. Values are echoed back in CamelCase (e.g. 'VisaMasterCard') in responses." + description: "List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: 'visa_master_card' (a single token excluding both Visa and Mastercard) and 'amex'." items: type: string enum: ["visa_master_card", "amex"] diff --git a/schemas/customers/payment_method_bnpl_request.yml b/schemas/customers/payment_method_bnpl_request.yml index 2296f4f..20249a5 100644 --- a/schemas/customers/payment_method_bnpl_request.yml +++ b/schemas/customers/payment_method_bnpl_request.yml @@ -16,7 +16,7 @@ allOf: type: integer format: int64 example: 1680397724 - description: "Optional expiry for the BNPL order, expressed in seconds since the Unix epoch" + description: "Optional expiry for the BNPL order, expressed in seconds since the Unix epoch. Defaults to one month from creation when omitted." failure_url: type: string description: "URL to redirect the customer after a failed payment" diff --git a/schemas/customers/payment_method_card_request.yml b/schemas/customers/payment_method_card_request.yml index 9d6585d..4230b1a 100644 --- a/schemas/customers/payment_method_card_request.yml +++ b/schemas/customers/payment_method_card_request.yml @@ -31,7 +31,7 @@ allOf: type: string maxLength: 249 example: "John Doe" - description: "Cardholder name. Must include first and last name separated by a space; single-word names are rejected." + description: "Cardholder name. Must include first and last name separated by a space; single-word names are rejected. Letters only — digits and most symbols are rejected." number: type: string example: "4242424242424242" diff --git a/schemas/customers/shipping_contact_address.yml b/schemas/customers/shipping_contact_address.yml index 1b3d28a..2e5425d 100644 --- a/schemas/customers/shipping_contact_address.yml +++ b/schemas/customers/shipping_contact_address.yml @@ -21,8 +21,9 @@ properties: city: type: string maxLength: 249 + pattern: "[A-Za-z]{2}" example: "Ciudad de Mexico" - description: "City of the delivery address." + description: "City of the delivery address. Must contain at least two consecutive ASCII letters." state: type: string maxLength: 249 diff --git a/schemas/orders/order_request.yml b/schemas/orders/order_request.yml index 57f9e55..aa5eae1 100644 --- a/schemas/orders/order_request.yml +++ b/schemas/orders/order_request.yml @@ -67,7 +67,7 @@ properties: metadata: type: object additionalProperties: - oneOf: + anyOf: - type: string maxLength: 249 - type: integer @@ -106,11 +106,11 @@ properties: three_ds_mode: type: [string, "null"] enum: ["strict", "not_strict", "smart", null] - description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. Accepted on creation only. This property is only applicable when 3DS is enabled; when 3DS is disabled this field should be null (no 3DS flow is applied)." + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. The value is validated against the allowed set on creation. When this field is null the order defers to the company-level 3DS configuration." examples: - value: "smart" summary: "Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication." - value: "strict" summary: "All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2." - value: "not_strict" - summary: "The 3DS2 challenge is also always initiated; intended as the more lenient variant of 'strict' where authentication attempts may be accepted." + summary: "The 3DS2 challenge is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode." diff --git a/schemas/orders/order_tax_request.yml b/schemas/orders/order_tax_request.yml index 1c9b0d8..ce2b0d6 100644 --- a/schemas/orders/order_tax_request.yml +++ b/schemas/orders/order_tax_request.yml @@ -19,7 +19,7 @@ properties: metadata: type: object additionalProperties: - oneOf: + anyOf: - type: string maxLength: 249 - type: integer diff --git a/schemas/orders/order_update_request.yml b/schemas/orders/order_update_request.yml index 5c33ca2..65ead04 100644 --- a/schemas/orders/order_update_request.yml +++ b/schemas/orders/order_update_request.yml @@ -63,7 +63,7 @@ properties: type: object maxProperties: 100 additionalProperties: - oneOf: + anyOf: - type: string maxLength: 249 - type: integer diff --git a/schemas/orders/product.yml b/schemas/orders/product.yml index f72329f..5b3beb6 100644 --- a/schemas/orders/product.yml +++ b/schemas/orders/product.yml @@ -26,7 +26,7 @@ properties: maxProperties: 100 description: 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 rejected. additionalProperties: - oneOf: + anyOf: - type: string maxLength: 249 - type: integer diff --git a/schemas/orders/shipping_request.yml b/schemas/orders/shipping_request.yml index db58a47..fdcb1c8 100644 --- a/schemas/orders/shipping_request.yml +++ b/schemas/orders/shipping_request.yml @@ -30,7 +30,7 @@ properties: description: 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 rejected. type: object additionalProperties: - oneOf: + anyOf: - type: string maxLength: 249 - type: integer diff --git a/schemas/orders/update_order_tax_request.yml b/schemas/orders/update_order_tax_request.yml index e8e0dc6..75db7a3 100644 --- a/schemas/orders/update_order_tax_request.yml +++ b/schemas/orders/update_order_tax_request.yml @@ -15,7 +15,7 @@ properties: metadata: type: object additionalProperties: - oneOf: + anyOf: - type: string maxLength: 249 - type: integer diff --git a/schemas/orders/update_product.yml b/schemas/orders/update_product.yml index 7866809..0a2a40a 100644 --- a/schemas/orders/update_product.yml +++ b/schemas/orders/update_product.yml @@ -43,7 +43,7 @@ properties: type: object maxProperties: 100 additionalProperties: - oneOf: + anyOf: - type: string maxLength: 249 - type: integer From cd48bb99c472b4453fc5c41d015e0cbaa27ad4ef Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Thu, 2 Jul 2026 15:00:10 -0400 Subject: [PATCH 05/10] fix: describe unsupported metadata value types as contract, not enforcement MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit payments-api will not change validation behavior for existing customers, so the partial per-key enforcement in NestedTypeValidator stays. State that nested objects/arrays in metadata are "not supported" rather than "rejected" — the contract is accurate without promising server-side rejection in every position. Co-Authored-By: Claude Fable 5 --- _build/api.yaml | 14 +++++++------- schemas/orders/order_request.yml | 2 +- schemas/orders/product.yml | 2 +- schemas/orders/shipping_request.yml | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index 6c8115e..134247e 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -19348,7 +19348,7 @@ components: $ref: "#/components/schemas/order_tax_request_metadata_value" description: "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 rejected." + \ integer, number or boolean); nested objects and arrays are not supported." example: key: value maxProperties: 100 @@ -19523,7 +19523,7 @@ components: default: {} description: "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 rejected." + \ integer, number or boolean); nested objects and arrays are not supported." example: key: value maxProperties: 100 @@ -20104,7 +20104,7 @@ components: default: {} description: "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 rejected." + \ integer, number or boolean); nested objects and arrays are not supported." example: key: value maxProperties: 100 @@ -20182,7 +20182,7 @@ components: $ref: "#/components/schemas/order_tax_request_metadata_value" description: "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 rejected." + \ integer, number or boolean); nested objects and arrays are not supported." example: key: value maxProperties: 100 @@ -20254,7 +20254,7 @@ components: $ref: "#/components/schemas/order_tax_request_metadata_value" description: "Metadata associated with the order. Values must be scalar\ \ (string of at most 249 characters, integer, number or boolean); nested\ - \ objects and arrays are rejected." + \ objects and arrays are not supported." maxProperties: 100 needs_shipping_contact: description: Allows you to fill out the shipping information at checkout @@ -20436,7 +20436,7 @@ components: default: {} description: "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 rejected." + \ integer, number or boolean); nested objects and arrays are not supported." example: key: value maxProperties: 100 @@ -21508,7 +21508,7 @@ components: $ref: "#/components/schemas/order_tax_request_metadata_value" description: "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 rejected." + \ integer, number or boolean); nested objects and arrays are not supported." example: key: value maxProperties: 100 diff --git a/schemas/orders/order_request.yml b/schemas/orders/order_request.yml index aa5eae1..7457c15 100644 --- a/schemas/orders/order_request.yml +++ b/schemas/orders/order_request.yml @@ -74,7 +74,7 @@ properties: - type: number - type: boolean maxProperties: 100 - description: "Metadata associated with the order. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are rejected." + description: "Metadata associated with the order. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are not supported." needs_shipping_contact: type: boolean example: false diff --git a/schemas/orders/product.yml b/schemas/orders/product.yml index 5b3beb6..04ea0a8 100644 --- a/schemas/orders/product.yml +++ b/schemas/orders/product.yml @@ -24,7 +24,7 @@ properties: metadata: type: object maxProperties: 100 - description: 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 rejected. + description: 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. additionalProperties: anyOf: - type: string diff --git a/schemas/orders/shipping_request.yml b/schemas/orders/shipping_request.yml index fdcb1c8..b4ed8a6 100644 --- a/schemas/orders/shipping_request.yml +++ b/schemas/orders/shipping_request.yml @@ -27,7 +27,7 @@ properties: example: "Same day" description: Method of shipment metadata: - description: 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 rejected. + description: 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. type: object additionalProperties: anyOf: From 8a4a4b25b32649c301645c09761b8da437ef37f9 Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Thu, 2 Jul 2026 15:22:50 -0400 Subject: [PATCH 06/10] fix: apply second adversarial-review pass corrections Five reviewers (two removal deep-dives + three full-quadrant passes) re-derived every changed line from payments-api validators, views and specs. Both questioned removals were confirmed correct: - can_not_expire (bnpl): never existed in the bnpl sanitizer (git -S empty since creation); all 26 code references are checkout/cash flows. Also cleaned the two stale bnpl request examples still sending it. - residential (fiscal address): unstorable (no Mongoid field, not in attr_accessible), stripped or blocked on every route including nested customer create, never rendered. Corrections from confirmed findings: - order three_ds_mode: explicit null is rejected (type: String check on create, empirically reproduced) -> type string, enum without null; omitting the field means no 3DS via the API (company-level 3DS applies only via Checkout or antifraud), replacing the wrong deferral claim. - checkout three_ds_mode: stays nullable (response schema) but explains null-in-responses vs omit-on-creation. - not_strict summaries: 3DS2 "flow" not "challenge" (challenge vs frictionless is issuer-side). - card name description: the regex allows , . ' - and accented letters; no longer implies punctuated names are rejected. - tax description minLength 2 -> 3 (greater_than: 2 is strict). - between_streets: document enforced maxLength 249 and two-letter pattern (city_validations). - klarna_bnpl intentionally NOT added to product_type despite being parser-accepted: not publicly available. Co-Authored-By: Claude Fable 5 --- _build/api.yaml | 40 +++++++++++-------- schemas/checkouts/checkout.yml | 4 +- .../customers/customer_shipping_contacts.yml | 6 ++- .../customer_update_shipping_contacts.yml | 6 ++- .../customers/payment_method_card_request.yml | 2 +- schemas/orders/order_request.yml | 8 ++-- schemas/orders/order_tax_request.yml | 2 +- .../orders/request_examples/charge_bnpl.yml | 3 +- .../order_with_charges_bnpl.yml | 1 - schemas/orders/update_order_tax_request.yml | 2 +- 10 files changed, 42 insertions(+), 32 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index 134247e..7b0523a 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -1499,7 +1499,6 @@ paths: bnpl: value: payment_method: - can_not_expire: true cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure product_type: aplazo_bnpl @@ -1641,7 +1640,6 @@ paths: bnpl: value: payment_method: - can_not_expire: true cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure product_type: aplazo_bnpl @@ -5094,7 +5092,6 @@ paths: checkout_request_type: PaymentLink charges: - payment_method: - can_not_expire: true cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure product_type: aplazo_bnpl @@ -16680,9 +16677,10 @@ components: minLength: 4 type: string name: - description: Cardholder name. Must include first and last name separated - by a space; single-word names are rejected. Letters only — digits and - most symbols are rejected. + description: "Cardholder name. Must include first and last name separated\ + \ by a space; single-word names are rejected. Letters (including accented\ + \ Latin characters), spaces, and the characters , . ' - are accepted;\ + \ digits and other symbols are rejected." example: John Doe maxLength: 249 type: string @@ -17632,7 +17630,10 @@ components: type: string between_streets: description: The street names between which the order will be delivered. + Must contain at least two consecutive ASCII letters. example: Ackerman Crescent + maxLength: 249 + pattern: "[A-Za-z]{2}" type: string address: $ref: "#/components/schemas/customer_shipping_contacts_request_address" @@ -17991,7 +17992,10 @@ components: type: string between_streets: description: The street names between which the order will be delivered. + Must contain at least two consecutive ASCII letters. example: Ackerman Crescent + maxLength: 249 + pattern: "[A-Za-z]{2}" type: string address: $ref: "#/components/schemas/customer_shipping_contacts_request_address" @@ -19251,7 +19255,7 @@ components: description: description: description or tax's name example: testing - minLength: 2 + minLength: 3 type: string metadata: additionalProperties: @@ -20201,7 +20205,7 @@ components: description: description: description or tax's name example: testing - minLength: 2 + minLength: 3 type: string metadata: additionalProperties: @@ -20292,14 +20296,14 @@ components: default: null three_ds_mode: description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ - \ The value is validated against the allowed set on creation. When this\ - \ field is null the order defers to the company-level 3DS configuration." + \ The value is validated against the allowed set on creation; sending\ + \ an explicit null is rejected. Omit the field to create the order without\ + \ requesting 3DS through the API (company-level 3DS applies only to orders\ + \ paid through Checkout or when antifraud forces 3DS)." enum: - strict - not_strict - smart - - null - nullable: true type: string required: - currency @@ -21132,8 +21136,9 @@ components: default: null three_ds_mode: description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ - \ Accepted on creation only. When this field is null the checkout defers\ - \ to the company-level 3DS configuration." + \ Accepted on creation only. Null appears in responses when no mode is\ + \ configured; to defer to the company-level 3DS configuration, omit the\ + \ field on creation (an explicit null is rejected)." enum: - strict - not_strict @@ -21624,7 +21629,10 @@ components: type: string between_streets: description: The street names between which the order will be delivered. + Must contain at least two consecutive ASCII letters. example: Ackerman Crescent + maxLength: 249 + pattern: "[A-Za-z]{2}" type: string address: $ref: "#/components/schemas/shipping_contact_address" @@ -21953,7 +21961,7 @@ components: description: description: description or tax's name example: testing - minLength: 2 + minLength: 3 type: string metadata: additionalProperties: @@ -21991,7 +21999,7 @@ components: description: description: description or tax's name example: testing - minLength: 2 + minLength: 3 type: string metadata: additionalProperties: diff --git a/schemas/checkouts/checkout.yml b/schemas/checkouts/checkout.yml index 029c6b4..86b839a 100644 --- a/schemas/checkouts/checkout.yml +++ b/schemas/checkouts/checkout.yml @@ -52,14 +52,14 @@ properties: three_ds_mode: type: [string, "null"] enum: ["strict", "not_strict", "smart", null] - description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. Accepted on creation only. When this field is null the checkout defers to the company-level 3DS configuration." + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. Accepted on creation only. Null appears in responses when no mode is configured; to defer to the company-level 3DS configuration, omit the field on creation (an explicit null is rejected)." examples: - value: "smart" summary: "Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication." - value: "strict" summary: "All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2." - value: "not_strict" - summary: "The 3DS2 challenge is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode." + summary: "The 3DS2 flow is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode." name: type: string description: Reason for charge diff --git a/schemas/customers/customer_shipping_contacts.yml b/schemas/customers/customer_shipping_contacts.yml index be383e2..979d54a 100644 --- a/schemas/customers/customer_shipping_contacts.yml +++ b/schemas/customers/customer_shipping_contacts.yml @@ -13,10 +13,12 @@ properties: type: string example: "Marvin Fuller" description: "Name of the person who will receive the order" - between_streets: + between_streets: type: string + maxLength: 249 + pattern: "[A-Za-z]{2}" example: "Ackerman Crescent" - description: "The street names between which the order will be delivered." + description: "The street names between which the order will be delivered. Must contain at least two consecutive ASCII letters." address: allOf: - $ref: shipping_contact_address.yml diff --git a/schemas/customers/customer_update_shipping_contacts.yml b/schemas/customers/customer_update_shipping_contacts.yml index 04f74c0..a0dec2f 100644 --- a/schemas/customers/customer_update_shipping_contacts.yml +++ b/schemas/customers/customer_update_shipping_contacts.yml @@ -11,10 +11,12 @@ properties: type: string example: "Marvin Fuller" description: "Name of the person who will receive the order" - between_streets: + between_streets: type: string + maxLength: 249 + pattern: "[A-Za-z]{2}" example: "Ackerman Crescent" - description: "The street names between which the order will be delivered." + description: "The street names between which the order will be delivered. Must contain at least two consecutive ASCII letters." address: $ref: shipping_contact_address.yml parent_id: diff --git a/schemas/customers/payment_method_card_request.yml b/schemas/customers/payment_method_card_request.yml index 4230b1a..0c703fc 100644 --- a/schemas/customers/payment_method_card_request.yml +++ b/schemas/customers/payment_method_card_request.yml @@ -31,7 +31,7 @@ allOf: type: string maxLength: 249 example: "John Doe" - description: "Cardholder name. Must include first and last name separated by a space; single-word names are rejected. Letters only — digits and most symbols are rejected." + description: "Cardholder name. Must include first and last name separated by a space; single-word names are rejected. Letters (including accented Latin characters), spaces, and the characters , . ' - are accepted; digits and other symbols are rejected." number: type: string example: "4242424242424242" diff --git a/schemas/orders/order_request.yml b/schemas/orders/order_request.yml index 7457c15..d1ead89 100644 --- a/schemas/orders/order_request.yml +++ b/schemas/orders/order_request.yml @@ -104,13 +104,13 @@ properties: items: $ref: order_tax_request.yml three_ds_mode: - type: [string, "null"] - enum: ["strict", "not_strict", "smart", null] - description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. The value is validated against the allowed set on creation. When this field is null the order defers to the company-level 3DS configuration." + type: string + enum: ["strict", "not_strict", "smart"] + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. The value is validated against the allowed set on creation; sending an explicit null is rejected. Omit the field to create the order without requesting 3DS through the API (company-level 3DS applies only to orders paid through Checkout or when antifraud forces 3DS)." examples: - value: "smart" summary: "Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication." - value: "strict" summary: "All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2." - value: "not_strict" - summary: "The 3DS2 challenge is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode." + summary: "The 3DS2 flow is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode." diff --git a/schemas/orders/order_tax_request.yml b/schemas/orders/order_tax_request.yml index ce2b0d6..8cdd6e0 100644 --- a/schemas/orders/order_tax_request.yml +++ b/schemas/orders/order_tax_request.yml @@ -14,7 +14,7 @@ properties: description: type: string example: "testing" - minLength: 2 + minLength: 3 description: description or tax's name metadata: type: object diff --git a/schemas/orders/request_examples/charge_bnpl.yml b/schemas/orders/request_examples/charge_bnpl.yml index 5bd311a..0af6aed 100644 --- a/schemas/orders/request_examples/charge_bnpl.yml +++ b/schemas/orders/request_examples/charge_bnpl.yml @@ -1,6 +1,5 @@ value: - payment_method: - can_not_expire: true + payment_method: cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure product_type: aplazo_bnpl diff --git a/schemas/orders/request_examples/order_with_charges_bnpl.yml b/schemas/orders/request_examples/order_with_charges_bnpl.yml index fce1192..8138419 100644 --- a/schemas/orders/request_examples/order_with_charges_bnpl.yml +++ b/schemas/orders/request_examples/order_with_charges_bnpl.yml @@ -6,7 +6,6 @@ value: checkout_request_type: "PaymentLink" charges: - payment_method: - can_not_expire: true cancel_url: "https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel" failure_url: "https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure" product_type: "aplazo_bnpl" diff --git a/schemas/orders/update_order_tax_request.yml b/schemas/orders/update_order_tax_request.yml index 75db7a3..68f2767 100644 --- a/schemas/orders/update_order_tax_request.yml +++ b/schemas/orders/update_order_tax_request.yml @@ -10,7 +10,7 @@ properties: description: type: string example: "testing" - minLength: 2 + minLength: 3 description: description or tax's name metadata: type: object From 4f726df4bde7a7118b63e2a998741e8b72ab7b90 Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Fri, 3 Jul 2026 17:28:48 -0400 Subject: [PATCH 07/10] fix: regenerate _build/api.yaml with redocly and align make merge with CI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit CI bundles with redocly/cli 2.34.0 and diffs against the committed _build/api.yaml, but the Makefile still used openapi-generator-cli v7.23.0, producing an incompatible serialization — so any bundle committed via `make merge` failed the up-to-date check. Regenerate the bundle with the CI command and point `make merge` at the same redocly invocation. Co-Authored-By: Claude Fable 5 --- Makefile | 8 +- _build/api.yaml | 29441 +++++++++++++++------------------------------- 2 files changed, 9352 insertions(+), 20097 deletions(-) diff --git a/Makefile b/Makefile index 138f3ac..64de214 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,8 @@ +# Must stay in sync with .github/workflows/ci.yml (Bundle OpenAPI document step), +# which diffs a fresh redocly bundle against the committed _build/api.yaml. merge: docker run --rm \ - -v ${PWD}:/local openapitools/openapi-generator-cli:v7.23.0 generate \ - -g openapi-yaml \ - -i /local/api.yaml \ - -p outputFile=local/_build/api.yaml \ - --skip-validate-spec + -v ${PWD}:/spec redocly/cli:2.34.0 bundle api.yaml -o /spec/_build/api.yaml update-readme: make merge && rdme openapi upload --key=${README_API_KEY} --branch=v2.3.0 --slug=conekta-api _build/api.yaml diff --git a/_build/api.yaml b/_build/api.yaml index 7b0523a..87fcd85 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -1,2111 +1,837 @@ openapi: 3.1.0 info: + description: Conekta sdk + version: 2.3.0 contact: - email: engineering@conekta.com name: Engineering Conekta url: https://github.com/conekta/openapi/issues - description: Conekta sdk + email: engineering@conekta.com + title: Conekta API license: name: MIT-LICENSE url: https://www.apache.org/licenses/LICENSE-2.0.html - title: Conekta API - version: 2.3.0 servers: -- description: Conekta main server - url: https://api.conekta.io + - url: https://api.conekta.io + description: Conekta main server security: -- bearerAuth: [] + - bearerAuth: [] tags: -- description: "All subscription-related endpoints including creation, management,\ - \ and events" - name: Subscriptions -- description: Customer portal endpoints for subscriptions - name: Subscriptions - Customer Portal + - name: Subscriptions + description: All subscription-related endpoints including creation, management, and events + - name: Subscriptions - Customer Portal + description: Customer portal endpoints for subscriptions paths: /antifraud/whitelists: get: - description: Return all rules + tags: + - Antifraud operationId: GetRuleWhitelist + description: Return all rules + summary: Get a list of whitelisted rules parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - $ref: '#/components/parameters/accept_language' responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/risk_rules_list" + '200': description: All the rules - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "403": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: "Unauthorized access service, please contact support team" - code: conekta.errors.forbidden.authentication.invalid_whitelist_access - debug_message: "Unauthorized access to whitelists service, please\ - \ contact support team" - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: forbidden error - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - summary: Get a list of whitelisted rules - tags: - - Antifraud + schema: + $ref: '#/components/schemas/risk_rules_list' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '500': + $ref: '#/components/responses/500' post: + tags: + - Antifraud operationId: CreateRuleWhitelist + summary: Create whitelisted rule parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateRuleWhitelist_request" + - $ref: '#/components/parameters/accept_language' responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/whitelistlist_rule_response" + '200': description: successfully registered rule - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "403": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: "Unauthorized access service, please contact support team" - code: conekta.errors.forbidden.authentication.invalid_whitelist_access - debug_message: "Unauthorized access to whitelists service, please\ - \ contact support team" - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: forbidden error - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - summary: Create whitelisted rule - tags: - - Antifraud + schema: + title: whitelistlist_rule_response + properties: + id: + type: string + example: 2fw8EWJusiRrxdPzT + description: Whitelist rule id + field: + type: string + example: email + description: field used for whitelists rule + value: + type: string + example: email@example.com + description: value used for whitelists rule + description: + type: string + example: banned customer example@example.com + description: use an description for whitelisted rule + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '500': + $ref: '#/components/responses/500' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/create_risk_rules_data' /antifraud/whitelists/{id}: delete: + tags: + - Antifraud operationId: DeleteRuleWhitelist parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + summary: Delete whitelisted rule responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/deleted_whitelist_rule_response" + '200': description: successfully deleted rule - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "403": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: "Unauthorized access service, please contact support team" - code: conekta.errors.forbidden.authentication.invalid_whitelist_access - debug_message: "Unauthorized access to whitelists service, please\ - \ contact support team" - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: forbidden error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - summary: Delete whitelisted rule - tags: - - Antifraud + schema: + title: deleted_whitelist_rule_response + properties: + id: + type: string + example: 2fw8EWJusiRrxdPzT + description: Whitelist rule id + field: + type: string + example: email + description: field used for whitelists rule deleted + value: + type: string + example: email@example.com + description: value used for whitelists rule deleted + description: + type: string + example: secure customer example@example.com + description: use an description for whitelisted rule + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' /antifraud/blacklists: get: - description: Return all rules + tags: + - Antifraud operationId: GetRuleBlacklist + description: Return all rules + summary: Get list of blacklisted rules parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - $ref: '#/components/parameters/accept_language' responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/risk_rules_list" + '200': description: All the rules - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - summary: Get list of blacklisted rules - tags: - - Antifraud + schema: + $ref: '#/components/schemas/risk_rules_list' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' post: + tags: + - Antifraud operationId: CreateRuleBlacklist + summary: Create blacklisted rule parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - $ref: '#/components/parameters/accept_language' + responses: + '200': + description: successfully registered rule + content: + application/vnd.conekta-v2.3.0+json: + schema: + title: blacklist_rule_response + properties: + id: + type: string + example: 2fw8EWJusiRrxdPzT + description: Blacklist rule id + field: + type: string + example: email + description: field used for blacklists rule + value: + type: string + example: email@example.com + description: value used for blacklists rule + description: + type: string + example: secure customer example@example.com + description: use an description for blacklisted rule + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' requestBody: + description: requested field for blacklist rule content: application/json: schema: - $ref: "#/components/schemas/CreateRuleWhitelist_request" - description: requested field for blacklist rule + $ref: '#/components/schemas/create_risk_rules_data' required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/blacklist_rule_response" - description: successfully registered rule - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - summary: Create blacklisted rule - tags: - - Antifraud /antifraud/blacklists/{id}: delete: + summary: Delete blacklisted rule + tags: + - Antifraud operationId: DeleteRuleBlacklist parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/deleted_blacklist_rule_response" + '200': description: successfully deleted rule - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - summary: Delete blacklisted rule - tags: - - Antifraud + schema: + title: deleted_blacklist_rule_response + properties: + id: + type: string + example: 2fw8EWJusiRrxdPzT + description: Blacklist rule id + field: + type: string + example: email + description: field used for blacklists rule deleted + value: + type: string + example: email@example.com + description: value used for blacklists rule deleted + description: + type: string + example: banned customer example@example.com + description: use an description for blacklisted rule + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' /api_keys: get: - description: Consume the list of api keys you have + tags: + - Api Keys operationId: getApiKeys - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - - description: "General search, e.g. by id, description, prefix" - explode: true - in: query - name: search - required: false - schema: - type: string - style: form + summary: Get list of Api Keys + description: Consume the list of api keys you have responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_api_keys_response" - description: successful + title: get_api_keys_response + allOf: + - $ref: '#/components/schemas/page' + - $ref: '#/components/schemas/pagination' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/api_key_response' headers: Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get list of Api Keys - tags: - - Api Keys + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + - description: General search, e.g. by id, description, prefix + in: query + name: search + required: false + schema: + type: string post: - description: Create a api key + tags: + - Api Keys operationId: createApiKey - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/api_key_request" - description: requested field for a api keys - required: true + summary: Create Api Key + description: Create a api key responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/api_key_create_response" - description: successful operation + title: api_key_create_response + allOf: + - type: object + properties: + authentication_token: + type: string + example: key_rpHzxufNgjFCdprEEFZRTKi + description: It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place. + - $ref: '#/components/schemas/api_key_response' headers: Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Api Key - tags: - - Api Keys - /api_keys/{id}: - delete: - description: Deletes a api key that corresponds to a api key ID - operationId: deleteApiKey + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/api_keys_create' parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /api_keys/{id}: + get: + tags: + - Api Keys + operationId: getApiKey + summary: Get Api Key + description: Gets a api key that corresponds to a api key ID responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/delete_api_keys_response" - description: successful + $ref: '#/components/schemas/api_key_response' headers: Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + put: + tags: + - Api Keys + operationId: updateApiKey + summary: Update Api Key + description: Update an existing api key + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/api_key_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Delete Api Key - tags: - - Api Keys - get: - description: Gets a api key that corresponds to a api key ID - operationId: getApiKey + - bearerAuth: [] + requestBody: + content: + application/json: + schema: + type: object + title: api_key_update_request + properties: + active: + type: boolean + example: true + description: Indicates if the webhook key is active + description: + type: string + example: online store + description: A name or brief explanation of what this api key is used for parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + delete: + tags: + - Api Keys + operationId: deleteApiKey + summary: Delete Api Key + description: Deletes a api key that corresponds to a api key ID responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/api_key_response" - description: successful + title: delete_api_keys_response + allOf: + - $ref: '#/components/schemas/api_key_response_on_delete' + - type: object + properties: + deleted: + type: boolean + example: true headers: Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Api Key - tags: - - Api Keys - put: - description: Update an existing api key - operationId: updateApiKey + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/api_key_update_request" - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/api_key_response" - description: successful operation - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Update Api Key - tags: - - Api Keys + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' /balance: get: - description: Get a company's balance + tags: + - Balances operationId: getBalance - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + summary: Get a company's balance + description: Get a company's balance responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/balance_response" - description: successful + $ref: '#/components/schemas/balance_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get a company's balance - tags: - - Balances + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' /charges: get: + tags: + - Charges operationId: getCharges - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + summary: Get A List of Charges responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_charges_response" - description: successful + title: get_charges_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/charge_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: The "custom_field" parameter is not allowed - message: El parametro "custom_field" no está permitido - code: conekta.errors.parameter_validation.whitelist - object: error - type: parameter_validation_error - log_id: 6462aa7c90fef20001633546 - schema: - $ref: "#/components/schemas/error" - description: whitelist validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '422': + $ref: '#/components/responses/422_whitelist' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get A List of Charges - tags: - - Charges + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' /charges/{id}: put: + tags: + - Charges operationId: updateCharge - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/charge_update_request" - description: requested field for update a charge - required: true + summary: Update a charge responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/charge_response" - description: successful + $ref: '#/components/schemas/charge_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: The "custom_field" parameter is not allowed - message: El parametro "custom_field" no está permitido - code: conekta.errors.parameter_validation.whitelist - object: error - type: parameter_validation_error - log_id: 6462aa7c90fef20001633546 - schema: - $ref: "#/components/schemas/error" - description: whitelist validation error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422_whitelist' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update a charge - tags: - - Charges + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/charge_update' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' /orders/{id}/charges: post: - description: Create charge for an existing orden + tags: + - Charges operationId: ordersCreateCharge - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - examples: - bnpl: - value: - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure - product_type: aplazo_bnpl - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success - type: bnpl - cash: - value: - payment_method: - type: cash - pay_by_bank: - value: - payment_method: - expires_at: 1680397724 - product_type: bbva_pay_by_bank - type: pay_by_bank - schema: - $ref: "#/components/schemas/charge_request" - description: requested field for a charge - required: true + summary: Create charge + description: Create charge for an existing orden responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/charge_order_response" + '200': description: successful - "401": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "428": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: The order cannot be modified because it has already - a charge which is pending payment. - message: The order cannot be modified because it has already a charge - which is pending payment. - code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge - log_id: 641b6e233cd9a50001515039 - object: error - type: precondition_required_error - schema: - $ref: "#/components/schemas/error" - description: Precondition Required - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/charge_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '428': + $ref: '#/components/responses/428' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create charge - tags: - - Charges + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/charge_create' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' /orders/{id}/add_charges: post: - description: Create charges for an existing orden + tags: + - Charges operationId: ordersCreateCharges - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - examples: - bnpl: - value: - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure - product_type: aplazo_bnpl - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success - type: bnpl - cash: - value: - payment_method: - type: cash - pay_by_bank: - value: - payment_method: - expires_at: 1680397724 - product_type: bbva_pay_by_bank - type: pay_by_bank - schema: - $ref: "#/components/schemas/charge_request" - description: requested field for a charge - required: true + summary: Create charges + description: Create charges for an existing orden responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/charges_order_response" + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "428": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: The order cannot be modified because it has already - a charge which is pending payment. - message: The order cannot be modified because it has already a charge - which is pending payment. - code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge - log_id: 641b6e233cd9a50001515039 - object: error - type: precondition_required_error - schema: - $ref: "#/components/schemas/error" - description: Precondition Required - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/charges_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '428': + $ref: '#/components/responses/428' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create charges - tags: - - Charges + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/charge_create' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' /companies: get: - description: Consume the list of child companies. This is used for holding - companies with several child entities. + tags: + - Companies operationId: getCompanies - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + summary: Get List of Companies + description: Consume the list of child companies. This is used for holding companies with several child entities. responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_companies_response" - description: successful + title: get_companies_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/company_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get List of Companies - tags: - - Companies + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' post: - description: Create a new company. + tags: + - Companies operationId: createCompany + summary: Create Company + description: Create a new company. requestBody: + description: Company data + required: true content: application/json: schema: - $ref: "#/components/schemas/Create_Company_Request" - description: Company data - required: true + $ref: '#/components/schemas/create_company_request' responses: - "201": + '201': + description: Company created successfully content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/company_response" - description: Company created successfully + $ref: '#/components/schemas/company_response' headers: Date: description: The date and time that the response was sent - explode: false schema: type: string - style: simple Content-Type: description: The format of the response body - explode: false schema: type: string - style: simple Content-Length: description: The length of the response body in bytes - explode: false schema: type: string - style: simple Connection: description: The type of connection used to transfer the response - explode: false schema: type: string - style: simple Conekta-Media-Type: - explode: false schema: type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Company - tags: - - Companies + - bearerAuth: [] /companies/{id}: get: + tags: + - Companies operationId: getCompany - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + summary: Get Company responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/company_response" - description: successful + $ref: '#/components/schemas/company_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Company - tags: - - Companies + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' /companies/current: get: - description: Retrieves information about the currently authenticated company. - This endpoint returns the same data as the standard company endpoint but automatically - uses the current company's context. + tags: + - Companies operationId: getCurrentCompany - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + summary: Get Current Company + description: Retrieves information about the currently authenticated company. This endpoint returns the same data as the standard company endpoint but automatically uses the current company's context. responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/company_response' example: id: 2a1b3c4d5e6f7g8h9i0j1k2l name: Mi Empresa S.A. de C.V. - mcc: "5311" + mcc: '5311' active: true account_status: activated antifraud_vertical: physical_goods @@ -2113,7 +839,7 @@ paths: payment_link_enabled: true commercial_info: web_page: https://miempresa.mx - facebook: "" + facebook: '' category: Venta al menudeo average_sale: Range10KPlus monthly_sales: Range0To100K @@ -2121,7 +847,7 @@ paths: physical: false already_selling: true tos_page: https://miempresa.com/terminos - website_instructions: "" + website_instructions: '' object: commercial_info legal_info: name: MARIA GONZALEZ @@ -2134,7 +860,7 @@ paths: tax_id: EMP121008MU7 legal_entity_name: Mi Empresa S.A. de C.V. business_type: Persona moral - phone: "5563794965" + phone: '5563794965' address: street1: AVENIDA INSURGENTES street2: ROMA NORTE @@ -2142,28 +868,27 @@ paths: city: México state: CIUDAD DE MEXICO country: MEX - zip: "06700" - external_number: "123" - internal_number: "201" + zip: '06700' + external_number: '123' + internal_number: '201' object: address bank_account: - account_number: "123456789012345678" + account_number: '123456789012345678' account_holder_name: Mi Empresa S.A. de C.V. - bank: "Sistema de Transferencias y Pagos STP, S.A. de C.V., SOFOM\ - \ E.N.R." + bank: Sistema de Transferencias y Pagos STP, S.A. de C.V., SOFOM E.N.R. object: fiscal_info_bank_account files: - - id: 1239z8y7x6w5v4u3t2s1r0q9p8o - file_name: constancia_fiscal.pdf - file_type: fiscal_id - url: https://example.com/documents/constancia-fiscal.pdf - object: file + - id: 1239z8y7x6w5v4u3t2s1r0q9p8o + file_name: constancia_fiscal.pdf + file_type: fiscal_id + url: https://example.com/documents/constancia-fiscal.pdf + object: file object: fiscal_info user_accounts: - - role: owner - token: "1234567890" - livemode: true - object: user_account + - role: owner + token: '1234567890' + livemode: true + object: user_account capture_fees: oxxo_commission: 0.035 banorte_commission: 0.01 @@ -2186,16 +911,16 @@ paths: amex_nine_month_installments_commission: 0.079 amex_twelve_month_installments_commission: 0.099 webhooks: - - id: "1234567890" - url: https://miempresa.com/api/webhook - subscribed_events: - - charge.created - - charge.paid - - order.paid - status: listening - object: webhook - production_enabled: true - development_enabled: false + - id: '1234567890' + url: https://miempresa.com/api/webhook + subscribed_events: + - charge.created + - charge.paid + - order.paid + status: listening + object: webhook + production_enabled: true + development_enabled: false object: company oxxo_payments_enabled: true spei_payments_enabled: true @@ -2206,16048 +931,5632 @@ paths: card_max_limit: 10000000 voucher_card_categories: [] internal_scopes: - - orders + - orders retention: true three_ds_enabled: true three_ds_mode: strict - schema: - $ref: "#/components/schemas/company_response" - description: successful headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - description: The version of the API used to process the request and - the format of the response body - explode: false + description: The version of the API used to process the request and the format of the response body schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Current Company - tags: - - Companies + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' /companies/{company_id}/document: - patch: - description: Updates an existing document associated with a specific company. - operationId: updateCompanyDocument + post: + tags: + - Companies + operationId: uploadCompanyDocument + summary: Upload Company Document + description: Uploads a document associated with a specific company. parameters: - - description: The unique identifier of the company. - explode: false - in: path - name: company_id - required: true - schema: - example: 6827206b1ec60400015eb09a - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - name: company_id + in: path + required: true + description: The unique identifier of the company. + schema: + type: string + example: 6827206b1ec60400015eb09a + - $ref: '#/components/parameters/accept_language' requestBody: + description: Document information to upload. + required: true content: application/json: schema: - $ref: "#/components/schemas/CompanyDocumentRequest" - description: Document information to update. - required: true + $ref: '#/components/schemas/company_document_request' responses: - "200": + '201': + description: Document uploaded successfully. content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/CompanyDocumentResponse" - description: Document updated successfully. + $ref: '#/components/schemas/company_document_response' headers: Date: description: The date and time that the response was sent - explode: false schema: type: string - style: simple Content-Type: description: The format of the response body - explode: false schema: type: string - style: simple Content-Length: description: The length of the response body in bytes - explode: false schema: type: string - style: simple Connection: description: The type of connection used to transfer the response - explode: false schema: type: string - style: simple Conekta-Media-Type: - explode: false schema: type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update Company Document + - bearerAuth: [] + patch: tags: - - Companies - post: - description: Uploads a document associated with a specific company. - operationId: uploadCompanyDocument + - Companies + operationId: updateCompanyDocument + summary: Update Company Document + description: Updates an existing document associated with a specific company. parameters: - - description: The unique identifier of the company. - explode: false - in: path - name: company_id - required: true - schema: - example: 6827206b1ec60400015eb09a - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - name: company_id + in: path + required: true + description: The unique identifier of the company. + schema: + type: string + example: 6827206b1ec60400015eb09a + - $ref: '#/components/parameters/accept_language' requestBody: + description: Document information to update. + required: true content: application/json: schema: - $ref: "#/components/schemas/CompanyDocumentRequest" - description: Document information to upload. - required: true + $ref: '#/components/schemas/company_document_request' responses: - "201": + '200': + description: Document updated successfully. content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/CompanyDocumentResponse" - description: Document uploaded successfully. + $ref: '#/components/schemas/company_document_response' headers: Date: description: The date and time that the response was sent - explode: false schema: type: string - style: simple Content-Type: description: The format of the response body - explode: false schema: type: string - style: simple Content-Length: description: The length of the response body in bytes - explode: false schema: type: string - style: simple Connection: description: The type of connection used to transfer the response - explode: false schema: type: string - style: simple Conekta-Media-Type: - explode: false schema: type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Upload Company Document - tags: - - Companies + - bearerAuth: [] /companies/{company_id}/documents: get: - description: Retrieve a list of documents associated with a specific company. + tags: + - Companies operationId: getCompanyDocuments + summary: Get Company Documents + description: Retrieve a list of documents associated with a specific company. parameters: - - description: The unique identifier of the company. - explode: false - in: path - name: company_id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - name: company_id + in: path + required: true + description: The unique identifier of the company. + schema: + type: string + example: 6307a60c41de27127515a575 + - $ref: '#/components/parameters/accept_language' responses: - "200": + '200': + description: A list of documents for the company. content: application/vnd.conekta-v2.3.0+json: schema: - items: - $ref: "#/components/schemas/CompanyDocumentResponse" type: array - default: null - description: A list of documents for the company. + items: + $ref: '#/components/schemas/company_document_response' headers: Date: description: The date and time that the response was sent - explode: false schema: type: string - style: simple Content-Type: description: The format of the response body - explode: false schema: type: string - style: simple Content-Length: description: The length of the response body in bytes - explode: false schema: type: string - style: simple Connection: description: The type of connection used to transfer the response - explode: false schema: type: string - style: simple Conekta-Media-Type: - explode: false schema: type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Company Documents - tags: - - Companies + - bearerAuth: [] /customers: - get: - description: "The purpose of business is to create and maintain a client, you\ - \ will learn what elements you need to obtain a list of clients, which can\ - \ be paged." - operationId: getCustomers - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + post: + tags: + - Customers + operationId: createCustomer + summary: Create customer + description: | + The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. + Remember the credit and debit card tokenization process: [https://developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer) responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/customers_response" - description: successful operation + $ref: '#/components/schemas/customer_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get a list of customers - tags: - - Customers - post: - description: | - The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. - Remember the credit and debit card tokenization process: [https://developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer) - operationId: createCustomer - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - bearerAuth: [] requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/customer" - description: requested field for customer - required: true + $ref: '#/components/requestBodies/customer' + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + tags: + - Customers + operationId: getCustomers + summary: Get a list of customers + description: The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged. responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/customer_response" - description: successful operation + title: customers_response + allOf: + - type: object + properties: + data: + title: customers_data_response + type: array + items: + $ref: '#/components/schemas/customer_response' + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + /customers/{id}: + get: + tags: + - Customers + operationId: getCustomerById + summary: Get Customer + description: Gets a customer resource that corresponds to a customer ID. + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/customer_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create customer - tags: - - Customers - /customers/{id}: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' delete: - description: Deleted a customer resource that corresponds to a customer ID. + tags: + - Customers operationId: deleteCustomerById - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + summary: Delete Customer + description: Deleted a customer resource that corresponds to a customer ID. responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/customer_response" - description: successful operation - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/customer_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Delete Customer - tags: - - Customers - get: - description: Gets a customer resource that corresponds to a customer ID. - operationId: getCustomerById + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/customer_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get Customer - tags: - - Customers + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' put: - description: You can update customer-related data + tags: + - Customers operationId: updateCustomer - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update_customer" - description: requested field for customer - required: true + summary: Update customer + description: You can update customer-related data responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/customer_response" + '200': description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "422": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/customer_response' + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update customer - tags: - - Customers + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/update_customer' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' /customers/{id}/fiscal_entities: post: - description: Create Fiscal entity resource that corresponds to a customer ID. + tags: + - Customers operationId: CreateCustomerFiscalEntities - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/fiscal_entity_request" - description: requested field for customer fiscal entities - required: true + summary: Create Fiscal Entity + description: Create Fiscal entity resource that corresponds to a customer ID. responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/create_customer_fiscal_entities_response" + '200': description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + title: create_customer_fiscal_entities_response + allOf: + - $ref: '#/components/schemas/customer_fiscal_entities_request' + - type: object + required: + - id + - object + - created_at + properties: + id: + type: string + example: ship_cont_2tKZsTYcsryyu7Ah8 + object: + type: string + example: shipping_contact + created_at: + type: integer + format: int64 + example: 1675715413 + parent_id: + type: string + example: cus_2tKcHxhTz7xU5SymF + default: + type: boolean + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Fiscal Entity - tags: - - Customers + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/customer_fiscal_entities' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' /customers/{id}/fiscal_entities/{fiscal_entities_id}: put: - description: Update Fiscal Entity resource that corresponds to a customer ID. + tags: + - Customers operationId: UpdateCustomerFiscalEntities - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: fiscal_entities_id - required: true - schema: - example: fis_ent_2tQ8HkkfbauaKP9Ho - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update_fiscal_entity_request" - description: requested field for customer update fiscal entities - required: true + summary: Update Fiscal Entity + description: Update Fiscal Entity resource that corresponds to a customer ID. responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/update_customer_fiscal_entities_response" + '200': description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + title: update_customer_fiscal_entities_response + allOf: + - $ref: '#/components/schemas/customer_fiscal_entities_request' + - type: object + required: + - id + - object + - created_at + properties: + id: + type: string + example: fis_ent_2tKZsTYcsryyu7Ah8 + object: + type: string + example: fiscal_entities + created_at: + type: integer + format: int64 + example: 1675715413 + parent_id: + type: string + example: cus_2tKcHxhTz7xU5SymF + default: + type: boolean + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update Fiscal Entity - tags: - - Customers - /orders/{id}/discount_lines: - get: - description: Get discount lines for an existing orden - operationId: ordersGetDiscountLines + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/customer_update_fiscal_entities' parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/fiscal_entities_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/discount_lines: + post: + tags: + - Discounts + operationId: ordersCreateDiscountLine + summary: Create Discount + description: Create discount lines for an existing orden responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/get_order_discount_lines_response" + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/discount_lines_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get a List of Discount - tags: - - Discounts - post: - description: Create discount lines for an existing orden - operationId: ordersCreateDiscountLine - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - bearerAuth: [] requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/order_discount_lines_request" - description: requested field for a discount lines - required: true + $ref: '#/components/requestBodies/discount_line_create' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + tags: + - Discounts + operationId: ordersGetDiscountLines + summary: Get a List of Discount + description: Get discount lines for an existing orden responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/discount_lines_response" + title: get_order_discount_lines_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/discount_lines_response' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + /orders/{id}/discount_lines/{discount_lines_id}: + put: + tags: + - Discounts + operationId: ordersUpdateDiscountLines + summary: Update Discount + description: Update an existing discount lines for an existing orden + responses: + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/discount_lines_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Discount - tags: - - Discounts - /orders/{id}/discount_lines/{discount_lines_id}: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/discount_line_update' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/discount_lines_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' delete: - description: Delete an existing discount lines for an existing orden + tags: + - Discounts operationId: ordersDeleteDiscountLines - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: discount line id identifier - explode: false - in: path - name: discount_lines_id - required: true - schema: - example: dis_lin_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + summary: Delete Discount + description: Delete an existing discount lines for an existing orden responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/discount_lines_response" + $ref: '#/components/schemas/discount_lines_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/discount_lines_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + tags: + - Discounts + operationId: ordersGetDiscountLine + summary: Get Discount + description: Get an existing discount lines for an existing orden + responses: + '200': description: successful - "401": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Delete Discount - tags: - - Discounts - get: - description: Get an existing discount lines for an existing orden - operationId: ordersGetDiscountLine - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: discount line id identifier - explode: false - in: path - name: discount_lines_id - required: true - schema: - example: dis_lin_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/discount_lines_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get Discount - tags: - - Discounts - put: - description: Update an existing discount lines for an existing orden - operationId: ordersUpdateDiscountLines - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: discount line id identifier - explode: false - in: path - name: discount_lines_id - required: true - schema: - example: dis_lin_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update_order_discount_lines_request" - description: requested field for a discount lines - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/discount_lines_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Update Discount - tags: - - Discounts - /events: - get: - operationId: getEvents - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - responses: - "200": + schema: + $ref: '#/components/schemas/discount_lines_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/discount_lines_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /events: + get: + tags: + - Events + operationId: getEvents + summary: Get list of Events + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_events_response" - description: successful + title: get_events_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/event_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get list of Events - tags: - - Events + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' /events/{id}: get: - description: Returns a single event + tags: + - Events operationId: getEvent - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple + summary: Get Event + description: Returns a single event responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/event_response" - description: successful + $ref: '#/components/schemas/event_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Event - tags: - - Events + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' /events/{event_id}/resend: post: - description: Resend event to selected webhooks + tags: + - Events operationId: resendEvent + summary: Resend Event + description: Resend event to selected webhooks + responses: + '200': + description: successful operation + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/events_resend_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] parameters: - - description: event identifier - explode: false - in: path - name: event_id - required: true - schema: - example: 6463d6e35a4c3e001819e760 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - $ref: '#/components/parameters/event_id' + - $ref: '#/components/parameters/accept_language' requestBody: + description: requested fields for resend an event content: application/json: schema: - $ref: "#/components/schemas/resendEvent_request" - description: requested fields for resend an event + $ref: '#/components/schemas/resend_request' required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/events_resend_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Resend Event - tags: - - Events /logs: get: - description: Get log details in the form of a list + tags: + - Logs operationId: getLogs - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + summary: Get List Of Logs + description: Get log details in the form of a list responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/logs_response_for_request" - description: successful + $ref: '#/components/schemas/logs_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get List Of Logs - tags: - - Logs + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' /logs/{id}: get: - description: Get the details of a specific log + tags: + - Logs operationId: getLogById - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + summary: Get Log + description: Get the details of a specific log responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/log_response_for_request" + '200': description: successful - "401": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": + schema: + $ref: '#/components/schemas/log_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders: + post: + tags: + - Orders + operationId: createOrder + summary: Create order + description: Create a new order. + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": + schema: + $ref: '#/components/schemas/order_response' + examples: + cash: + $ref: '#/components/examples/order_cash' + multiples_cash_charges: + $ref: '#/components/examples/order_cash_multiple' + card: + $ref: '#/components/examples/order_card' + bnpl: + $ref: '#/components/examples/order_bnpl' + pay_by_bank: + $ref: '#/components/examples/order_pbb' + checkout: + $ref: '#/components/examples/order_checkout' + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/order' + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + tags: + - Orders + operationId: getOrders + summary: Get a list of Orders + description: Get order details in the form of a list + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + title: get_orders_response + allOf: + - $ref: '#/components/schemas/orders_response' + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Log + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + - $ref: '#/components/parameters/payment_status' + - $ref: '#/components/parameters/last_payment_info.status' + - $ref: '#/components/parameters/created_at' + - $ref: '#/components/parameters/created_at_gte' + - $ref: '#/components/parameters/created_at_lte' + - $ref: '#/components/parameters/updated_at_gte' + - $ref: '#/components/parameters/updated_at_lte' + /orders/{id}: + get: tags: - - Logs - /orders: - get: - description: Get order details in the form of a list - operationId: getOrders - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - - description: Filters by order status - examples: - payment_status: - summary: Filters by order status - value: paid - explode: true - in: query - name: payment_status - required: false - schema: - type: string - style: form - - description: Filters by last payment info status - examples: - last_payment_info.status: - summary: Filters by last payment info status - value: pending_payment - explode: true - in: query - name: last_payment_info.status - required: false - schema: - type: string - style: form - - description: created equal to - examples: - created_at: - summary: created equal to - value: 1612137600 - explode: true - in: query - name: created_at - required: false - schema: - format: int64 - type: integer - style: form - - description: created at greater than or equal to - examples: - created_at.gte: - summary: created at greater than or equal to - value: 1612137600 - explode: true - in: query - name: created_at.gte - required: false - schema: - format: int64 - type: integer - style: form - - description: created at less than or equal to - examples: - created_at.lte: - summary: created at less than or equal to - value: 1612137600 - explode: true - in: query - name: created_at.lte - required: false - schema: - format: int64 - type: integer - style: form - - description: updated at greater than or equal to - examples: - updated_at.gte: - summary: updated at greater than or equal to - value: 1612137600 - explode: true - in: query - name: updated_at.gte - required: false - schema: - format: int64 - type: integer - style: form - - description: updated at less than or equal to - examples: - updated_at.lte: - summary: updated at less than or equal to - value: 1612137600 - explode: true - in: query - name: updated_at.lte - required: false - schema: - format: int64 - type: integer - style: form + - Orders + operationId: getOrderById + description: Info for a specific order + summary: Get Order responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_orders_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get a list of Orders - tags: - - Orders - post: - description: Create a new order. - operationId: createOrder + - bearerAuth: [] parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - examples: - order_with_charges: - summary: Create an order with charges - value: - charges: - - amount: 40000 - expires_at: 1677196303 - monthly_installments: 0 - payment_method: - type: card - token_id: tok_2897348234 - payment_source_id: src_2tLkkyfMPh6v7pFry - customer_ip_address: 0.0.0.0 - reference_id: string - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - object: customer_info - fiscal_entity: - tax_id: "1234567890" - name: Conekta Inc - email: test@gmail.com - phone: "525511223344" - metadata: - test: true - company_id: "123" - address: - street1: Nuevo Leon 254 - street2: Departamento 404 - postal_code: "06100" - city: Ciudad de Mexico - state: Ciudad de Mexico - country: MX - external_number: "123" - discount_lines: - - amount: 500 - code: "123" - type: loyalty - line_items: - - antifraud_info: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - metadata: - test: true - company_id: "123" - pre_authorize: false - shipping_contact: - phone: "525511223344" - receiver: Marvin Fuller - between_streets: Ackerman Crescent - metadata: - test: true - company_id: "123" - address: - street1: Nuevo Leon 254 - street2: Departamento 404 - postal_code: "06100" - city: Ciudad de Mexico - state: Ciudad de Mexico - country: MX - residential: true - parent_id: string - default: true - deleted: true - shipping_lines: - - amount: 100 - carrier: FEDEX - tracking_number: TRACK123 - method: TRAING - metadata: - key: value - tax_lines: - - amount: 100 - description: testing - metadata: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - order_with_bnpl_charges: - summary: Create an order with a bnpl charge - value: - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_name: Test creditea - checkout_request_type: PaymentLink - charges: - - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure - product_type: aplazo_bnpl - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success - type: bnpl - currency: MXN - customer_info: - customer_id: cus_2xZfwfjXxX9tZhVey - line_items: - - name: Test creditea - quantity: 1 - unit_price: 300000 - order_with_pbb_charges: - summary: Create an order with a pay by bank charge - value: - charges: - - payment_method: - product_type: bbva_pay_by_bank - type: pay_by_bank - currency: MXN - customer_info: - customer_id: cus_2xZfwfjXxX9tZhVey - line_items: - - name: Test pay by bank - quantity: 1 - unit_price: 300000 - order_with_checkout: - summary: Create an order with checkout - value: - checkout: - allowed_payment_methods: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - expires_at: 0 - failure_url: string - monthly_installments_enabled: false - monthly_installments_options: - - 0 - name: string - on_demand_enabled: true - success_url: string - type: Integration - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - object: customer_info - discount_lines: - - amount: 500 - code: "123" - type: loyalty - line_items: - - antifraud_info: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - pre_authorize: false - 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 - parent_id: string - default: true - deleted: true - shipping_lines: - - amount: 100 - carrier: FEDEX - tracking_number: TRACK123 - method: TRAING - metadata: - key: value - tax_lines: - - amount: 100 - description: testing - metadata: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - order_with_checkout_and_force_save_card: - summary: Create an order with checkout and force save card - value: - checkout: - allowed_payment_methods: - - card - force_save_card: true - name: Compra - type: Integration - currency: MXN - customer_info: - customer_id: cus_2n9g6x7q1w5k8v3a - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - order_with_subscription: - summary: Create an order with subscription plans - value: - checkout: - allowed_payment_methods: - - card - plan_ids: - - nuevo-plan - expires_at: 1746015865 - failure_url: string - monthly_installments_enabled: false - name: Embebido Prueba - on_demand_enabled: true - success_url: string - type: Integration - max_failed_retries: 3 - is_redirect_on_failure: true - currency: MXN - customer_info: - name: Prueba - email: prueba@prueba.com - phone: "+5218181818181" - corporate: false - object: customer_info - shipping_lines: - - amount: 0 - metadata: - key: value - split_payment_with_2_card_charges: - summary: Create an order with 2 card charges - value: - charges: - - amount: 40000 - payment_method: - type: card - token_id: tok_2897348234 - - amount: 40000 - payment_method: - type: card - token_id: tok_2897348235 - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 40000 - quantity: 2 - brand: string - split_payment_with_3_cash_charges: - summary: Create an order with 3 cash charges - value: - charges: - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 10000 - quantity: 3 - brand: string - split_payment_with_cash_card_charges: - summary: Create an order with 3 cash and 2 card charges - value: - charges: - - amount: 10000 - payment_method: - type: card - token_id: tok_2897348234 - - amount: 10000 - payment_method: - type: card - token_id: tok_2897348235 - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 50000 - quantity: 1 - brand: string - schema: - $ref: "#/components/schemas/order_request" - description: requested field for order - required: true + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + put: + tags: + - Orders + operationId: updateOrder + description: Update an existing Order. + summary: Update Order responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - examples: - cash: - value: - livemode: true - amount: 1560 - currency: MXN - payment_status: pending_payment - amount_refunded: 0 - split_payment: false - customer_info: - email: franco.longhi@conekta.com - phone: 539-933-3810 - name: franco golden - object: customer_info - object: order - id: ord_2xayxSvfWzQ2TLz7r - metadata: {} - is_refundable: false - created_at: 1741103510 - updated_at: 1741103510 - line_items: - object: list - has_more: false - total: 1 - data: - - name: APOYO URGENTE REFERENCIA - unit_price: 1560 - quantity: 1 - sku: COL094 - brand: CHEDRAUI - object: line_item - id: line_item_2xayxSvfWzQ2TLz7p - parent_id: ord_2xayxSvfWzQ2TLz7r - metadata: {} - antifraud_info: {} - charges: - object: list - has_more: false - total: 1 - data: - - id: 67c72196e777ac0001f2140c - livemode: true - created_at: 1741103510 - currency: MXN - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001140326893401915.png - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - reference: 10001140326893401915 - product_type: cash_in - object: charge - description: Payment from order - is_refundable: false - status: pending_payment - amount: 1560 - customer_id: "" - order_id: ord_2xayxSvfWzQ2TLz7r - multiples_cash_charges: - value: - livemode: true - amount: 156000 - currency: MXN - payment_status: pending_payment - amount_refunded: 0 - split_payment: false - customer_info: - email: franco.longhi@conekta.com - phone: 884-712-6894 - name: franco golden - object: customer_info - object: order - id: ord_2xazGvtKYTjxTUZU3 - metadata: {} - is_refundable: false - created_at: 1741104962 - updated_at: 1741104963 - line_items: - object: list - has_more: false - total: 1 - data: - - name: APOYO URGENTE REFERENCIA - unit_price: 156000 - quantity: 1 - sku: COL094 - brand: CHEDRAUI - object: line_item - id: line_item_2xazGvtKYTjxTUZU1 - parent_id: ord_2xazGvtKYTjxTUZU3 - metadata: {} - antifraud_info: {} - charges: - object: list - has_more: false - total: 2 - data: - - id: 67c72742e777ac0001f21463 - livemode: true - created_at: 1741104962 - currency: MXN - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/bbva/10830309851141878231.png - agreement: "2409992" - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - BBVA ATM - reference: 10830309851141878231 - product_type: bbva_cash_in - object: charge - description: Payment from order - is_refundable: false - status: pending_payment - amount: 156000 - customer_id: "" - order_id: ord_2xazGvtKYTjxTUZU3 - - id: 67c72742e777ac0001f2145b - livemode: true - created_at: 1741104962 - currency: MXN - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001244873740402013.png - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - reference: 10001244873740402013 - product_type: cash_in - object: charge - description: Payment from order - is_refundable: false - status: pending_payment - amount: 156000 - customer_id: "" - order_id: ord_2xazGvtKYTjxTUZU3 - card: - value: - id: 63dab7d00558720001bb3c7d - livemode: "true," - created_at: "1675278289," - currency: MXN - failure_code: suspected_fraud - failure_message: Este cargo ha sido declinado porque el comportamiento - del comprador es sospechoso. - device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - payment_method: - name: Fulanito Perez - exp_month: 2 - exp_year: 30 - object: card_payment - type: credit - last4: 4242 - brand: visa - issuer: BANAMEX - account_type: Credit - country: MX - fraud_indicators: - - description: El usuario está utilizando una tarjeta de crédito - o débito de prueba en modo producción. - object: charge - description: Payment from order - status: declined - amount: "20001," - fee: "116," - order_id: ord_2tHuwPhgSwq6Gt7Rg - bnpl: - value: - amount: 300000 - amount_refunded: 0 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pWw - segment: Checkout - charges: - data: - - amount: 300000 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pXA - segment: Checkout - created_at: 1741015718 - currency: MXN - customer_id: "" - description: Payment from order - id: 67c5caa665f9b400015dec40 - is_refundable: false - livemode: true - object: charge - order_id: ord_2xaegxs5s69VP4pWy - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - expires_at: 1743694118 - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - object: bnpl_payment - product_type: aplazo_bnpl - redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - type: bnpl - status: pending_payment - has_more: false - object: list - total: 1 - created_at: 1741015718 - currency: MXN - customer_info: - corporate: false - customer_id: cus_2xZfwfjXxX9tZhVey - email: alexis.ruiz@google.com - name: Pedro Ruiz - object: customer_info - phone: "+5215555555555" - id: ord_2xaegxs5s69VP4pWy - is_refundable: false - line_items: - data: - - antifraud_info: {} - id: line_item_2xaegxs5s69VP4pWv - metadata: {} - name: Test creditea - object: line_item - parent_id: ord_2xaegxs5s69VP4pWy - quantity: 1 - unit_price: 300000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - payment_status: pending_payment - split_payment: false - updated_at: 1741015718 - pay_by_bank: - value: - amount: 300000 - amount_refunded: 0 - charges: - data: - - amount: 300000 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pXA - segment: Checkout - created_at: 1741015718 - currency: MXN - customer_id: "" - description: Payment from order - id: 67c5caa665f9b400015dec40 - is_refundable: false - livemode: true - object: charge - order_id: ord_2xaegxs5s69VP4pWy - payment_method: - expires_at: 1743694118 - object: pay_by_bank_payment - product_type: bbva_pay_by_bank - redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ - deep_link: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 - type: pay_by_bank - reference: "22277523174328893295" - status: pending_payment - has_more: false - object: list - total: 1 - created_at: 1741015718 - currency: MXN - customer_info: - corporate: false - customer_id: cus_2xZfwfjXxX9tZhVey - email: alexis.ruiz@google.com - name: Pedro Ruiz - object: customer_info - phone: "+5215555555555" - id: ord_2xaegxs5s69VP4pWy - is_refundable: false - line_items: - data: - - antifraud_info: {} - id: line_item_2xaegxs5s69VP4pWv - metadata: {} - name: Test pay by bank - object: line_item - parent_id: ord_2xaegxs5s69VP4pWy - quantity: 1 - unit_price: 300000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - payment_status: pending_payment - split_payment: false - updated_at: 1741015718 - checkout: - value: - amount: 12000 - amount_refunded: 0 - checkout: - allowed_payment_methods: - - card - - bnpl - - cash - - pay_by_bank - - bank_transfer - - apple - can_not_expire: false - emails_sent: 0 - exclude_card_networks: [] - expires_at: 1772171999 - failure_url: https://natalie.net - force_3ds_flow: false - id: 1263626c-53ae-4829-b092-2e7393f2d1b7 - is_redirect_on_failure: true - livemode: true - metadata: {} - monthly_installments_enabled: false - monthly_installments_options: [] - name: Pago de Servicio - needs_shipping_contact: false - object: checkout - paid_payments_count: 0 - recurrent: false - slug: 1263626c53ae4829b0922e7393f2d1b7 - sms_sent: 0 - starts_at: 1771912800 - status: Issued - success_url: https://giovanna.info - type: HostedPayment - url: https://pay.conekta.com/checkout/1263626c53ae4829b0922e7393f2d1b7 - channel: - checkout_request_id: 1263626c-53ae-4829-b092-2e7393f2d1b7 - checkout_request_type: HostedPayment - id: channel_2zbhetCd6CmpJeFsY - segment: Checkout - created_at: 1771950546 - currency: MXN - customer_info: - email: xono.bernie@conekta.com - name: Juan Rosas - object: customer_info - phone: "5531431590" - id: ord_2zbhesToa1DAgNbP6 - is_refundable: false - line_items: - data: - - antifraud_info: {} - brand: addidas - id: line_item_2zbhesToa1DAgNbP3 - metadata: {} - name: Aretes Tres Círculos Numerales - object: line_item - parent_id: ord_2zbhesToa1DAgNbP6 - quantity: 1 - sku: COL094 - unit_price: 10000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - tax_lines: - data: - - amount: 2000 - description: test - id: tax_lin_2zbhesToa1DAgNbP4 - object: tax_line - parent_id: ord_2zbhesToa1DAgNbP6 - has_more: false - object: list - total: 1 - updated_at: 1771950546 - schema: - $ref: "#/components/schemas/order_response" - description: successful operation - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "500": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create order - tags: - - Orders - /orders/{id}: - get: - description: Info for a specific order - operationId: getOrderById + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/order_update' parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + /orders/{id}/cancel: + post: + tags: + - Orders + operationId: CancelOrder + description: Cancel an order that has been previously created. + summary: Cancel Order responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/order_response" + $ref: '#/components/schemas/order_response' + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '428': + $ref: '#/components/responses/428' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/capture: + post: + tags: + - Orders + operationId: ordersCreateCapture + description: Processes an order that has been previously authorized. + summary: Capture Order + responses: + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '428': + $ref: '#/components/responses/428' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Order - tags: - - Orders - put: - description: Update an existing Order. - operationId: updateOrder - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - bearerAuth: [] requestBody: + description: requested fields for capture order content: application/json: schema: - $ref: "#/components/schemas/order_update" - description: requested field for an order - required: true + title: order_capture_request + required: + - amount + properties: + amount: + type: integer + format: int64 + example: 500 + description: Amount to capture + minimum: 1 + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/line_items: + post: + tags: + - Products + operationId: ordersCreateProduct + summary: Create Product + description: Create a new product for an existing order. responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/order_response" + $ref: '#/components/schemas/product_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/product_create' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/line_items/{line_item_id}: + put: + tags: + - Products + operationId: ordersUpdateProduct + description: Update an existing product for an existing orden + summary: Update Product + responses: + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/product_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update Order - tags: - - Orders - /orders/{id}/cancel: - post: - description: Cancel an order that has been previously created. - operationId: CancelOrder + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/product_update' parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/line_items_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + delete: + tags: + - Products + operationId: ordersDeleteProduct + description: Delete product for an existing orden + summary: Delete Product responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/order_response" + $ref: '#/components/schemas/product_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/line_items_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/refunds: + post: + tags: + - Orders + operationId: orderRefund + description: A refunded order describes the items, amount, and reason an order is being refunded. + summary: Refund Order + responses: + '200': description: successful - "401": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": + schema: + $ref: '#/components/schemas/order_response' + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/order_refunds_request' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/refunds/{refund_id}: + delete: + tags: + - Orders + operationId: orderCancelRefund + description: A refunded order describes the items, amount, and reason an order is being refunded. + summary: Cancel Refund + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": + schema: + $ref: '#/components/schemas/order_response' + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/refund_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /payout_orders: + post: + tags: + - Payout Orders + operationId: createPayoutOrder + summary: Create payout order + description: Create a new payout order. + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "428": + schema: + $ref: '#/components/schemas/payout_order_response' + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/payout_order' + parameters: + - $ref: '#/components/parameters/accept_language' + get: + tags: + - Payout Orders + operationId: getPayoutOrders + summary: Get a list of Payout Orders + description: Get Payout order details in the form of a list + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: The order cannot be modified because it has already - a charge which is pending payment. - message: The order cannot be modified because it has already a charge - which is pending payment. - code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge - log_id: 641b6e233cd9a50001515039 - object: error - type: precondition_required_error - schema: - $ref: "#/components/schemas/error" - description: Precondition Required - "500": + schema: + title: payout_orders_response + allOf: + - type: object + properties: + data: + title: payout_orders_data_response + type: array + items: + $ref: '#/components/schemas/payout_order_response' + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + /payout_orders/{id}: + get: + tags: + - Payout Orders + operationId: getPayoutOrderById + summary: Get Payout Order + description: Gets a payout Order resource that corresponds to a payout order ID. + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/payout_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Cancel Order - tags: - - Orders - /orders/{id}/capture: - post: - description: Processes an order that has been previously authorized. - operationId: ordersCreateCapture + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/order_capture_request" - description: requested fields for capture order + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + /payout_orders/{id}/cancel: + put: + tags: + - Payout Orders + operationId: cancelPayoutOrderById + summary: Cancel Payout Order + description: Cancel a payout Order resource that corresponds to a payout order ID. responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/order_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "428": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: The order cannot be modified because it has already - a charge which is pending payment. - message: The order cannot be modified because it has already a charge - which is pending payment. - code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge - log_id: 641b6e233cd9a50001515039 - object: error - type: precondition_required_error - schema: - $ref: "#/components/schemas/error" - description: Precondition Required - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/payout_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Capture Order - tags: - - Orders - /orders/{id}/line_items: - post: - description: Create a new product for an existing order. - operationId: ordersCreateProduct + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/product" - description: requested field for a product - required: true + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + /checkouts: + get: + tags: + - Payment Link + operationId: getCheckouts + summary: Get a list of payment links + description: Returns a list of links generated by the merchant responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/product_order_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + title: checkouts_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/checkout_response' + headers: + Date: + description: The date and time that the response was sent + schema: + type: string + example: Fri, 03 Feb 2023 16:57:48 GMT + Content-Type: + description: The format of the response body + schema: + type: string + example: application/json; charset=utf-8 + Content-Length: + description: The length of the response body in bytes + schema: + type: string + example: '2737' + Connection: + description: The type of connection used to transfer the response + schema: + type: string + example: keep-alive + Conekta-Media-Type: + schema: + type: string + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Product - tags: - - Products - /orders/{id}/line_items/{line_item_id}: - delete: - description: Delete product for an existing orden - operationId: ordersDeleteProduct + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: line_item_id - required: true - schema: - example: line_item_2tQ8HkkfbauaKP9Ho - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + post: + tags: + - Payment Link + operationId: createCheckout + summary: Create Unique Payment Link responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/product_order_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/checkout_response' + headers: + Date: + description: The date and time that the response was sent + schema: + type: string + example: Fri, 03 Feb 2023 16:57:48 GMT + Content-Type: + description: The format of the response body + schema: + type: string + example: application/json; charset=utf-8 + Content-Length: + description: The length of the response body in bytes + schema: + type: string + example: '2737' + Connection: + description: The type of connection used to transfer the response + schema: + type: string + example: keep-alive + Conekta-Media-Type: + description: The version of the API used to process the request and the format of the response body + schema: + type: string + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Delete Product - tags: - - Products - put: - description: Update an existing product for an existing orden - operationId: ordersUpdateProduct - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: line_item_id - required: true - schema: - example: line_item_2tQ8HkkfbauaKP9Ho - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - bearerAuth: [] requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update_product" - description: requested field for products - required: true + $ref: '#/components/requestBodies/checkout' + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /checkouts/{id}: + get: + tags: + - Payment Link + operationId: getCheckout + summary: Get a payment link by ID responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/product_order_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/checkout_response' + headers: + Date: + description: The date and time that the response was sent + schema: + type: string + example: Fri, 03 Feb 2023 16:57:48 GMT + Content-Type: + description: The format of the response body + schema: + type: string + example: application/json; charset=utf-8 + Content-Length: + description: The length of the response body in bytes + schema: + type: string + example: '2737' + Connection: + description: The type of connection used to transfer the response + schema: + type: string + example: keep-alive + Conekta-Media-Type: + schema: + type: string + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update Product - tags: - - Products - /orders/{id}/refunds: - post: - description: "A refunded order describes the items, amount, and reason an order\ - \ is being refunded." - operationId: orderRefund + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/orderRefund_request" - description: requested field for a refund - required: true + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' + /checkouts/{id}/cancel: + put: + tags: + - Payment Link + operationId: cancelCheckout + summary: Cancel Payment Link responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/order_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Refund Order - tags: - - Orders - /orders/{id}/refunds/{refund_id}: - delete: - description: "A refunded order describes the items, amount, and reason an order\ - \ is being refunded." - operationId: orderCancelRefund - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: refund identifier - explode: false - in: path - name: refund_id - required: true - schema: - example: 6407b5bee1329a000175ba11 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/order_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Cancel Refund - tags: - - Orders - /payout_orders: - get: - description: Get Payout order details in the form of a list - operationId: getPayoutOrders - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/payout_orders_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get a list of Payout Orders - tags: - - Payout Orders - post: - description: Create a new payout order. - operationId: createPayoutOrder - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/payout_order_request" - description: requested field for payout order - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/payout_order_response" - description: successful operation - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Create payout order - tags: - - Payout Orders - /payout_orders/{id}: - get: - description: Gets a payout Order resource that corresponds to a payout order - ID. - operationId: getPayoutOrderById - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/payout_order_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get Payout Order - tags: - - Payout Orders - /payout_orders/{id}/cancel: - put: - description: Cancel a payout Order resource that corresponds to a payout order - ID. - operationId: cancelPayoutOrderById - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/payout_order_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Cancel Payout Order - tags: - - Payout Orders - /checkouts: - get: - description: Returns a list of links generated by the merchant - operationId: getCheckouts - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/checkouts_response" - description: successful operation + $ref: '#/components/schemas/checkout_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get a list of payment links - tags: - - Payment Link - post: - operationId: createCheckout + - bearerAuth: [] parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - examples: - create_checkout_with_plan_ids: - summary: Create Checkout with Plan IDs - value: - name: Payment Link con Plan - type: PaymentLink - recurrent: false - expires_at: 1745331574 - allowed_payment_methods: - - card - needs_shipping_contact: false - plan_ids: - - plan_ejemplo_1 - - plan_ejemplo_2 - order_template: - line_items: - - name: Producto de Ejemplo - unit_price: 15000 - quantity: 1 - currency: MXN - customer_info: - name: Cliente Ejemplo - email: ejemplo@conekta.com - phone: "5555555555" - metadata: - reference: mi_referencia_123 - more_info: datos_adicionales - schema: - $ref: "#/components/schemas/checkout" - description: requested field for checkout - required: true + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' + /checkouts/{id}/email: + post: + tags: + - Payment Link + operationId: emailCheckout + summary: Send an email responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/checkout_response" - description: successful operation + $ref: '#/components/schemas/checkout_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - description: The version of the API used to process the request and - the format of the response body - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Unique Payment Link - tags: - - Payment Link - /checkouts/{id}: - get: - operationId: getCheckout + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/checkout_email' parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' + /checkouts/{id}/sms: + post: + tags: + - Payment Link + operationId: smsCheckout + summary: Send an sms responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/checkout_response" - description: successful operation + $ref: '#/components/schemas/checkout_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/checkout_sms' + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' + /customers/{id}/payment_sources: + post: + tags: + - Payment Methods + operationId: CreateCustomerPaymentMethods + summary: Create Payment Method + description: Create a payment method for a customer. + responses: + '200': + description: successful operation + content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": + schema: + title: create_customer_payment_methods_response + discriminator: + propertyName: type + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + oneOf: + - $ref: '#/components/schemas/payment_method_cash_response' + - $ref: '#/components/schemas/payment_method_cash_recurrent_response' + - $ref: '#/components/schemas/payment_method_card_response' + - $ref: '#/components/schemas/payment_method_spei_recurrent_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/customer_payment_methods' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + tags: + - Payment Methods + operationId: GetCustomerPaymentMethods + summary: Get Payment Methods + description: Get a list of Payment Methods + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": + schema: + title: get_payment_method_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + title: get_customer_payment_method_data_response + discriminator: + propertyName: type + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + oneOf: + - $ref: '#/components/schemas/payment_method_cash_recurrent_response' + - $ref: '#/components/schemas/payment_method_cash_response' + - $ref: '#/components/schemas/payment_method_card_response' + - $ref: '#/components/schemas/payment_method_spei_recurrent_response' + examples: + cash: + $ref: '#/components/examples/customer_payment_source_cash_example' + summary: Cash + card: + value: + next_page_url: null + previous_page_url: null + has_more: false + object: list + data: + - id: src_2tbd5Bg327RL9oyas + object: payment_source + type: card + created_at: 1679958561 + last4: '0526' + bin: '41898989' + card_type: debit + exp_month: '01' + exp_year: '25' + brand: visa + issuer: santander + name: random name + parent_id: cus_2tUkvasdas1s4ihjs + default: false + payment_source_status: active + visible_on_checkout: false + summary: Card + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + - $ref: '#/components/parameters/search' + /customers/{id}/payment_sources/{payment_method_id}: + put: + tags: + - Payment Methods + operationId: UpdateCustomerPaymentMethods + summary: Update Payment Method + description: Gets a payment Method that corresponds to a customer ID. + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + title: update_customer_payment_methods_response + discriminator: + propertyName: type + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + oneOf: + - $ref: '#/components/schemas/payment_method_cash_response' + - $ref: '#/components/schemas/payment_method_cash_recurrent_response' + - $ref: '#/components/schemas/payment_method_card_response' + - $ref: '#/components/schemas/payment_method_spei_recurrent_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get a payment link by ID + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/customer_update_payment_methods' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/payment_method_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + delete: tags: - - Payment Link - /checkouts/{id}/cancel: - put: - operationId: cancelCheckout + - Payment Methods + operationId: DeleteCustomerPaymentMethods + summary: Delete Payment Method + description: Delete an existing payment method + responses: + '200': + description: successful operation + content: + application/vnd.conekta-v2.3.0+json: + schema: + title: update_customer_payment_methods_response + discriminator: + propertyName: type + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + oneOf: + - $ref: '#/components/schemas/payment_method_cash_response' + - $ref: '#/components/schemas/payment_method_cash_recurrent_response' + - $ref: '#/components/schemas/payment_method_card_response' + - $ref: '#/components/schemas/payment_method_spei_recurrent_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/payment_method_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /plans: + get: + tags: + - Plans + operationId: getPlans + summary: Get A List of Plans responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/checkout_response" - description: successful operation + title: get_plans_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/plan_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Cancel Payment Link - tags: - - Payment Link - /checkouts/{id}/email: - post: - operationId: emailCheckout + - bearerAuth: [] parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/emailCheckout_request" - description: requested field for sms checkout - required: true + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + post: + tags: + - Plans + operationId: createPlan + summary: Create Plan + description: Create a new plan for an existing order responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/checkout_response" - description: successful operation + $ref: '#/components/schemas/plan_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Send an email - tags: - - Payment Link - /checkouts/{id}/sms: - post: - operationId: smsCheckout - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple + - bearerAuth: [] requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/smsCheckout_request" - description: requested field for sms checkout - required: true + $ref: '#/components/requestBodies/plan' + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /plans/{id}: + get: + tags: + - Plans + operationId: getPlan + summary: Get Plan responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/checkout_response" - description: successful operation + $ref: '#/components/schemas/plan_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Send an sms - tags: - - Payment Link - /customers/{id}/payment_sources: - get: - description: Get a list of Payment Methods - operationId: GetCustomerPaymentMethods + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - examples: - cash: - summary: Cash - value: - next_page_url: "null," - previous_page_url: "null," - has_more: "false," - object: "list," - data: - - id: off_ref_2xayPUpcxeTrotDHr - object: payment_source - provider: Cash - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - - BBVA ATM - type: cash_recurrent - reference: 10001189383263801812_caca - barcode: 10001189383263801812 - barcode_url: https://barcode.conekta.com/cash/cashin/10001189383263801812.png - expires_at: 0 - created_at: 1741100921 - parent_id: cus_2xayPFXsb4LBZ2GUL - agreements: - - provider: bbva_cash_in - agreement: 2409526 - card: - summary: Card - value: - has_more: false - object: list - data: - - id: src_2tbd5Bg327RL9oyas - object: payment_source - type: card - created_at: 1679958561 - last4: "0526" - bin: "41898989" - card_type: debit - exp_month: "01" - exp_year: "25" - brand: visa - issuer: santander - name: random name - parent_id: cus_2tUkvasdas1s4ihjs - default: false - payment_source_status: active - visible_on_checkout: false - schema: - $ref: "#/components/schemas/get_payment_method_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get Payment Methods + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + put: tags: - - Payment Methods - post: - description: Create a payment method for a customer. - operationId: CreateCustomerPaymentMethods - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - examples: - card: - value: - type: card - token_id: tok_test_visa_4242 - cash: - value: - type: spei_recurrent - expires_at: 1553273553 - schema: - $ref: "#/components/schemas/CreateCustomerPaymentMethods_request" - description: requested field for customer payment methods - required: true + - Plans + operationId: updatePlan + summary: Update Plan responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/create_customer_payment_methods_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Create Payment Method - tags: - - Payment Methods - /customers/{id}/payment_sources/{payment_method_id}: - delete: - description: Delete an existing payment method - operationId: DeleteCustomerPaymentMethods - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Identifier of the payment method - explode: false - in: path - name: payment_method_id - required: true - schema: - example: src_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: + $ref: '#/components/schemas/plan_response' + headers: + Date: + description: The date and time that the response was sent schema: - $ref: "#/components/schemas/update_customer_payment_methods_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Delete Payment Method - tags: - - Payment Methods - put: - description: Gets a payment Method that corresponds to a customer ID. - operationId: UpdateCustomerPaymentMethods - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Identifier of the payment method - explode: false - in: path - name: payment_method_id - required: true - schema: - example: src_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update_payment_methods_card" - description: requested field for customer payment methods - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: + type: string + example: Fri, 03 Feb 2023 16:57:48 GMT + Content-Type: + description: The format of the response body schema: - $ref: "#/components/schemas/update_customer_payment_methods_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + type: string + example: application/json; charset=utf-8 + Content-Length: + description: The length of the response body in bytes + schema: + type: string + example: '2737' + Connection: + description: The type of connection used to transfer the response + schema: + type: string + example: keep-alive + Conekta-Media-Type: + schema: + type: string + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update Payment Method - tags: - - Payment Methods - /plans: - get: - operationId: getPlans + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/plan_update' parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - - description: currency of the object to be retrieved - examples: - currency: - summary: currency of the object to be retrieved - value: MXN - explode: true - in: query - name: currency - required: false - schema: - type: string - style: form - - description: frequency of the object to be retrieved - examples: - frequency: - summary: Frequency of the object to be retrieved - value: 1 - explode: true - in: query - name: frequency - required: false - schema: - type: integer - style: form + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + delete: + tags: + - Plans + operationId: deletePlan + summary: Delete Plan responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_plans_response" - description: successful + $ref: '#/components/schemas/plan_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + /orders/{id}/shipping_lines: + post: + tags: + - Shippings + operationId: ordersCreateShipping + summary: Create Shipping + description: Create new shipping for an existing orden + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": + schema: + $ref: '#/components/schemas/shipping_order_response' + examples: + sucessfull: + $ref: '#/components/examples/shipping' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/shipping_create' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/shipping_lines/{shipping_id}: + put: + tags: + - Shippings + operationId: ordersUpdateShipping + summary: Update Shipping + description: Update existing shipping for an existing orden + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": + schema: + $ref: '#/components/schemas/shipping_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/shipping_create' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/shipping_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + delete: + tags: + - Shippings + operationId: ordersDeleteShipping + summary: Delete Shipping + description: Delete shipping + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/shipping_order_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '428': + $ref: '#/components/responses/428' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get A List of Plans - tags: - - Plans + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/shipping_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{id}/shipping_contacts: post: - description: Create a new plan for an existing order - operationId: createPlan + tags: + - Shipping Contacts + operationId: CreateCustomerShippingContacts + summary: Create a shipping contacts + description: Create a shipping contacts for a customer. + responses: + '200': + description: successful operation + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/customer_shipping_contacts_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/customer_shipping_contacts' parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{id}/shipping_contacts/{shipping_contacts_id}: + put: + tags: + - Shipping Contacts + operationId: UpdateCustomerShippingContacts + summary: Update shipping contacts + description: Update shipping contact that corresponds to a customer ID. + responses: + '200': + description: successful operation + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/customer_shipping_contacts_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/plan_request" - description: requested field for plan - required: true + $ref: '#/components/requestBodies/customer_update_shipping_contacts' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/shipping_contacts_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + delete: + tags: + - Shipping Contacts + operationId: DeleteCustomerShippingContacts + summary: Delete shipping contacts + description: Delete shipping contact that corresponds to a customer ID. responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/plan_response" + $ref: '#/components/schemas/customer_shipping_contacts_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/shipping_contacts_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{customer_id}/subscriptions: + get: + tags: + - Subscriptions + operationId: subscriptionList + summary: List Subscriptions + description: Get a list of subscriptions for a customer + responses: + '200': description: successful + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Plan - tags: - - Plans - /plans/{id}: - delete: - operationId: deletePlan + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + post: + tags: + - Subscriptions + operationId: subscriptionCreate + summary: Create Subscription + description: Create a new subscription for a customer (keeps existing subscriptions active) responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/plan_response" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Delete Plan - tags: - - Plans - get: - operationId: getPlan + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/subscription' parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{customer_id}/subscriptions/{id}: + put: + tags: + - Subscriptions + operationId: subscriptionUpdate + summary: Update Subscription + description: Update a specific subscription responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/plan_response" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Plan - tags: - - Plans - put: - operationId: updatePlan - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - bearerAuth: [] requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update_plan" - description: requested field for plan - required: true + $ref: '#/components/requestBodies/subscription_update' + parameters: + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/subscription_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + tags: + - Subscriptions + operationId: subscriptionsGet + summary: Get Subscription + description: Retrieve a specific subscription responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/plan_response" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Update Plan - tags: - - Plans - /orders/{id}/shipping_lines: - post: - description: Create new shipping for an existing orden - operationId: ordersCreateShipping + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/shipping_request" - description: requested field for a shipping - required: true + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/subscription_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{customer_id}/subscriptions/{id}/events: + get: + tags: + - Subscriptions + operationId: subscriptionEvents + summary: Get Subscription Events + description: Get events for a specific subscription responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - examples: - sucessfull: - value: - amount: 0 - carrier: Fedex - method: Airplane - tracking_number: TRACK123 - object: shipping_line - id: ship_lin_2sLxi45ZFs1GHJmzx - parent_id: ord_2sLxi3MqYFJ1QfTmP - deleted: true - schema: - $ref: "#/components/schemas/shipping_order_response" + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + title: subscription_events_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/event_response' + headers: + Date: + description: The date and time that the response was sent + schema: + type: string + example: Fri, 03 Feb 2023 16:57:48 GMT + Content-Type: + description: The format of the response body + schema: + type: string + example: application/json; charset=utf-8 + Content-Length: + description: The length of the response body in bytes + schema: + type: string + example: '2737' + Connection: + description: The type of connection used to transfer the response + schema: + type: string + example: keep-alive + Conekta-Media-Type: + schema: + type: string + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Shipping - tags: - - Shippings - /orders/{id}/shipping_lines/{shipping_id}: - delete: - description: Delete shipping - operationId: ordersDeleteShipping + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: shipping_id - required: true - schema: - example: ship_lin_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/subscription_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + /customers/{customer_id}/subscriptions/{id}/cancel: + post: + tags: + - Subscriptions + operationId: subscriptionCancel + summary: Cancel Subscription + description: Cancel a specific subscription responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/shipping_order_response" + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "428": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: The order cannot be modified because it has already - a charge which is pending payment. - message: The order cannot be modified because it has already a charge - which is pending payment. - code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge - log_id: 641b6e233cd9a50001515039 - object: error - type: precondition_required_error - schema: - $ref: "#/components/schemas/error" - description: Precondition Required - "500": content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/subscription_response' + headers: + Date: + description: The date and time that the response was sent + schema: + type: string + example: Fri, 03 Feb 2023 16:57:48 GMT + Content-Type: + description: The format of the response body + schema: + type: string + example: application/json; charset=utf-8 + Content-Length: + description: The length of the response body in bytes + schema: + type: string + example: '2737' + Connection: + description: The type of connection used to transfer the response + schema: + type: string + example: keep-alive + Conekta-Media-Type: + schema: + type: string + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Delete Shipping - tags: - - Shippings - put: - description: Update existing shipping for an existing orden - operationId: ordersUpdateShipping + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: shipping_id - required: true - schema: - example: ship_lin_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/shipping_request" - description: requested field for a shipping - required: true + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/subscription_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{customer_id}/subscriptions/{id}/pause: + post: + tags: + - Subscriptions + operationId: subscriptionPause + summary: Pause Subscription + description: Pause a specific subscription responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/shipping_order_response" + '200': description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Update Shipping - tags: - - Shippings - /customers/{id}/shipping_contacts: - post: - description: Create a shipping contacts for a customer. - operationId: CreateCustomerShippingContacts - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/customer_shipping_contacts_request" - description: requested field for customer shippings contacts - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/customer_shipping_contacts_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Create a shipping contacts - tags: - - Shipping Contacts - /customers/{id}/shipping_contacts/{shipping_contacts_id}: - delete: - description: Delete shipping contact that corresponds to a customer ID. - operationId: DeleteCustomerShippingContacts - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: shipping_contacts_id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/customer_shipping_contacts_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Delete shipping contacts - tags: - - Shipping Contacts - put: - description: Update shipping contact that corresponds to a customer ID. - operationId: UpdateCustomerShippingContacts - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: shipping_contacts_id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/customer_update_shipping_contacts_request" - description: requested field for customer update shippings contacts - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/customer_shipping_contacts_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Update shipping contacts - tags: - - Shipping Contacts - /customers/{customer_id}/subscriptions: - get: - description: Get a list of subscriptions for a customer - operationId: subscriptionList - parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - responses: - "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: List Subscriptions - tags: - - Subscriptions - post: - description: Create a new subscription for a customer (keeps existing subscriptions - active) - operationId: subscriptionCreate + - bearerAuth: [] parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/subscription_request" - description: requested field for subscriptions - required: true + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/subscription_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{customer_id}/subscriptions/{id}/resume: + post: + tags: + - Subscriptions + operationId: subscriptionResume + summary: Resume Subscription + description: Resume a specific paused subscription responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Subscription - tags: - - Subscriptions - /customers/{customer_id}/subscriptions/{id}: - get: - description: Retrieve a specific subscription - operationId: subscriptionsGet + - bearerAuth: [] parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Identifier of the subscription resource - explode: false - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/subscription_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{customer_id}/subscriptions/{id}/retry: + post: + tags: + - Subscriptions + operationId: subscriptionsRetry + summary: Retry Failed Payment + description: Retry a failed payment for a specific subscription responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Subscription - tags: - - Subscriptions - put: - description: Update a specific subscription - operationId: subscriptionUpdate + - bearerAuth: [] parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Identifier of the subscription resource - explode: false - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/updates_a_subscription" - description: requested field for update a subscription - required: true + - $ref: '#/components/parameters/customer_id' + - $ref: '#/components/parameters/subscription_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /subscriptions/{subscription_id}/customer_portal: + post: + tags: + - Subscriptions - Customer Portal + operationId: createCustomerPortal + summary: Create customer portal + description: Creates a customer portal for a subscription. If a portal already exists, returns the existing one. responses: - "200": + '201': + description: Customer portal created successfully content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/customer_portal_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' security: - - bearerAuth: [] - summary: Update Subscription - tags: - - Subscriptions - /customers/{customer_id}/subscriptions/{id}/events: - get: - description: Get events for a specific subscription - operationId: subscriptionEvents + - bearerAuth: [] parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Identifier of the subscription resource - explode: false - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + - in: path + name: subscription_id + description: Identifier of the subscription resource + required: true + schema: + type: string + example: sub_2tGzG1GxtDAZHEGPH + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + tags: + - Subscriptions - Customer Portal + operationId: getCustomerPortal + summary: Get customer portal + description: Retrieves the customer portal for a subscription responses: - "200": + '200': + description: Customer portal retrieved successfully content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_events_response" - description: successful + $ref: '#/components/schemas/customer_portal_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' security: - - bearerAuth: [] - summary: Get Subscription Events - tags: - - Subscriptions - /customers/{customer_id}/subscriptions/{id}/cancel: - post: - description: Cancel a specific subscription - operationId: subscriptionCancel + - bearerAuth: [] parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Identifier of the subscription resource - explode: false - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - in: path + name: subscription_id + description: Identifier of the subscription resource + required: true + schema: + type: string + example: sub_2tGzG1GxtDAZHEGPH + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{id}/subscription: + post: + deprecated: true + tags: + - Subscriptions + operationId: createSubscription + summary: Create Subscription [Deprecated] + description: 'DEPRECATED: This endpoint will be removed in version 2.3.0. You can create the subscription to include the plans that your customers consume' responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Cancel Subscription - tags: - - Subscriptions - /customers/{customer_id}/subscriptions/{id}/pause: - post: - description: Pause a specific subscription - operationId: subscriptionPause + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/subscription' parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Identifier of the subscription resource - explode: false - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + put: + deprecated: true + tags: + - Subscriptions + operationId: updateSubscription + summary: Update Subscription [Deprecated] + description: 'DEPRECATED: This endpoint will be removed in version 2.3.0. You can modify the subscription to change the plans that your customers consume' responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Pause Subscription - tags: - - Subscriptions - /customers/{customer_id}/subscriptions/{id}/resume: - post: - description: Resume a specific paused subscription - operationId: subscriptionResume + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/subscription_update' parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Identifier of the subscription resource - explode: false - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + get: + deprecated: true + tags: + - Subscriptions + operationId: getSubscription + summary: Get Subscription [Deprecated] + description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Resume Subscription - tags: - - Subscriptions - /customers/{customer_id}/subscriptions/{id}/retry: - post: - description: Retry a failed payment for a specific subscription - operationId: subscriptionsRetry + - bearerAuth: [] parameters: - - description: Identifier of the customer resource - explode: false - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Identifier of the subscription resource - explode: false - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + /customers/{id}/subscription/cancel: + post: + deprecated: true + tags: + - Subscriptions + operationId: cancelSubscription + summary: Cancel Subscription [Deprecated] + description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Retry Failed Payment - tags: - - Subscriptions - /subscriptions/{subscription_id}/customer_portal: - get: - description: Retrieves the customer portal for a subscription - operationId: getCustomerPortal + - bearerAuth: [] parameters: - - description: Identifier of the subscription resource - explode: false - in: path - name: subscription_id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{id}/subscription/events: + get: + deprecated: true + tags: + - Subscriptions + operationId: getSubscriptionEvents + summary: Get Subscription Events [Deprecated] + description: 'DEPRECATED: This endpoint will be removed in version 2.3.0. You can get the events of the subscription(s) of a client, with the customer id' responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/customer_portal_response" - description: Customer portal retrieved successfully + title: subscription_events_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/event_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get customer portal - tags: - - Subscriptions - Customer Portal - post: - description: "Creates a customer portal for a subscription. If a portal already\ - \ exists, returns the existing one." - operationId: createCustomerPortal + - bearerAuth: [] parameters: - - description: Identifier of the subscription resource - explode: false - in: path - name: subscription_id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{id}/subscription/pause: + post: + deprecated: true + tags: + - Subscriptions + operationId: pauseSubscription + summary: Pause Subscription [Deprecated] + description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' responses: - "201": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/customer_portal_response" - description: Customer portal created successfully + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create customer portal - tags: - - Subscriptions - Customer Portal - /customers/{id}/subscription: - get: - deprecated: true - description: "DEPRECATED: This endpoint will be removed in version 2.3.0." - operationId: getSubscription + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - responses: - "200": + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /customers/{id}/subscription/resume: + post: + deprecated: true + tags: + - Subscriptions + operationId: resumeSubscription + summary: Resume Subscription [Deprecated] + description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/subscription_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '402': + $ref: '#/components/responses/402' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/tax_lines: + post: + tags: + - Taxes + operationId: ordersCreateTaxes + description: Create new taxes for an existing orden + summary: Create Tax + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": + schema: + $ref: '#/components/schemas/update_order_tax_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/order_tax' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /orders/{id}/tax_lines/{tax_id}: + put: + tags: + - Taxes + operationId: ordersUpdateTaxes + summary: Update Tax + description: Update taxes for an existing orden + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": + schema: + $ref: '#/components/schemas/update_order_tax_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/order_tax_update' + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/tax_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + delete: + tags: + - Taxes + operationId: ordersDeleteTaxes + summary: Delete Tax + description: Delete taxes for an existing orden + responses: + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/update_order_tax_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: "Get Subscription [Deprecated]" - tags: - - Subscriptions - post: - deprecated: true - description: "DEPRECATED: This endpoint will be removed in version 2.3.0. You\ - \ can create the subscription to include the plans that your customers consume" - operationId: createSubscription + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/subscription_request" - description: requested field for subscriptions - required: true + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/tax_id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + /tokens: + post: + tags: + - Tokens + operationId: createToken + summary: Create Token + description: | + Generate a payment token, to associate it with a card, Endpoint could be use directly only for PCI compliance account responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/token_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '422': + $ref: '#/components/responses/422' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: "Create Subscription [Deprecated]" - tags: - - Subscriptions - put: - deprecated: true - description: "DEPRECATED: This endpoint will be removed in version 2.3.0. You\ - \ can modify the subscription to change the plans that your customers consume" - operationId: updateSubscription - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - bearerAuth: [] requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/updates_a_subscription" - description: requested field for update a subscription - required: true + $ref: '#/components/requestBodies/token' + parameters: + - $ref: '#/components/parameters/accept_language' + /transactions: + get: + tags: + - Transactions + operationId: getTransactions + summary: Get List transactions + description: Get transaction details in the form of a list responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + title: get_transactions_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + description: Transactions + type: array + items: + $ref: '#/components/schemas/transaction_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: "Update Subscription [Deprecated]" - tags: - - Subscriptions - /customers/{id}/subscription/cancel: - post: - deprecated: true - description: "DEPRECATED: This endpoint will be removed in version 2.3.0." - operationId: cancelSubscription + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + - $ref: '#/components/parameters/id_query' + - $ref: '#/components/parameters/charge_id' + - $ref: '#/components/parameters/type' + - $ref: '#/components/parameters/currency' + /transactions/{id}: + get: + tags: + - Transactions + operationId: getTransaction + summary: Get transaction + description: Get the details of a transaction responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/transaction_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: "Cancel Subscription [Deprecated]" - tags: - - Subscriptions - /customers/{id}/subscription/events: - get: - deprecated: true - description: "DEPRECATED: This endpoint will be removed in version 2.3.0. You\ - \ can get the events of the subscription(s) of a client, with the customer\ - \ id" - operationId: getSubscriptionEvents + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' + /transfers: + get: + tags: + - Transfers + operationId: getTransfers + summary: Get a list of transfers + description: Get transfers details in the form of a list responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_events_response" - description: successful + title: get_transfers_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + description: Transfers + type: array + items: + $ref: '#/components/schemas/transfers_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: "Get Subscription Events [Deprecated]" - tags: - - Subscriptions - /customers/{id}/subscription/pause: - post: - deprecated: true - description: "DEPRECATED: This endpoint will be removed in version 2.3.0." - operationId: pauseSubscription + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + /transfers/{id}: + get: + tags: + - Transfers + operationId: getTransfer + summary: Get Transfer + description: Get the details of a Transfer responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + $ref: '#/components/schemas/transfer_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: "Pause Subscription [Deprecated]" + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' + /webhook_keys: + get: tags: - - Subscriptions - /customers/{id}/subscription/resume: - post: - deprecated: true - description: "DEPRECATED: This endpoint will be removed in version 2.3.0." - operationId: resumeSubscription - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - Webhook keys + operationId: getWebhookKeys + summary: Get List of Webhook Keys + description: Consume the list of webhook keys you have responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/subscription_response_1" - description: successful + title: get_webhook_keys_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/webhook-key_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "402": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - schema: - $ref: "#/components/schemas/error" - description: payment required error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: "Resume Subscription [Deprecated]" - tags: - - Subscriptions - /orders/{id}/tax_lines: - post: - description: Create new taxes for an existing orden - operationId: ordersCreateTaxes + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/order_tax_request" - description: requested field for a taxes - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/order_tax_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Create Tax + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + post: tags: - - Taxes - /orders/{id}/tax_lines/{tax_id}: - delete: - description: Delete taxes for an existing orden - operationId: ordersDeleteTaxes - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: tax_id - required: true - schema: - example: tax_lin_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - Webhook keys + operationId: createWebhookKey + summary: Create Webhook Key + description: Create a webhook key responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/order_tax_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/webhook-key_create_response' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Delete Tax - tags: - - Taxes - put: - description: Update taxes for an existing orden - operationId: ordersUpdateTaxes - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: identifier - explode: false - in: path - name: tax_id - required: true - schema: - example: tax_lin_2tQ974hSHcsdeSZHG - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple + - bearerAuth: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/ordersUpdateTaxes_request" - description: requested field for taxes - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/order_tax_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Update Tax - tags: - - Taxes - /tokens: - post: - description: | - Generate a payment token, to associate it with a card, Endpoint could be use directly only for PCI compliance account - operationId: createToken + type: object + title: webhook_key_request + properties: + active: + type: boolean + example: true + description: Indicates if the webhook key is active + default: true parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/token_request" - description: requested field for token - required: true + - $ref: '#/components/parameters/accept_language' + /webhook_keys/{id}: + get: + tags: + - Webhook keys + operationId: getWebhookKey + summary: Get Webhook Key responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/token_response" - description: successful operation + $ref: '#/components/schemas/webhook-key_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "422": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - schema: - $ref: "#/components/schemas/error" - description: parameter validation error - "500": + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + put: + tags: + - Webhook keys + operationId: updateWebhookKey + summary: Update Webhook Key + description: updates an existing webhook key + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/webhook-key_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Token - tags: - - Tokens - /transactions: - get: - description: Get transaction details in the form of a list - operationId: getTransactions + - bearerAuth: [] + requestBody: + content: + application/json: + schema: + type: object + title: webhook_key_update_request + properties: + active: + type: boolean + example: false + description: Indicates if the webhook key is active + default: false parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - - description: id of the object to be retrieved - examples: - id: - summary: id of the object to be retrieved - value: 65412a893cd69a0001c25892 - explode: true - in: query - name: id - required: false - schema: - type: string - style: form - - description: id of the charge used for filtering - examples: - charge_id: - summary: id of the charge used for filtering - value: 65412a893cd69a0001c25892 - explode: true - in: query - name: charge_id - required: false - schema: - type: string - style: form - - description: type of the object to be retrieved - examples: - type: - summary: type of the object to be retrieved - value: capture - explode: true - in: query - name: type - required: false - schema: - type: string - style: form - - description: currency of the object to be retrieved - examples: - currency: - summary: currency of the object to be retrieved - value: MXN - explode: true - in: query - name: currency - required: false - schema: - type: string - style: form + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + delete: + tags: + - Webhook keys + operationId: deleteWebhookKey + summary: Delete Webhook key responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_transactions_response" - description: successful + $ref: '#/components/schemas/webhook-key_delete_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get List transactions - tags: - - Transactions - /transactions/{id}: - get: - description: Get the details of a transaction - operationId: getTransaction + - bearerAuth: [] parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + /webhooks: + get: + tags: + - Webhooks + operationId: getWebhooks + summary: Get List of Webhooks + description: Consume the list of webhooks you have, each environment supports 10 webhooks (For production and testing) responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/transaction_response" - description: successful + title: get_webhooks_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/webhook_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/url' + - $ref: '#/components/parameters/next_page' + - $ref: '#/components/parameters/previous_page' + post: + tags: + - Webhooks + operationId: createWebhook + summary: Create Webhook + description: 'What we do at Conekta translates into events. For example, an event of interest to us occurs at the time a payment is successfully processed. At that moment we will be interested in doing several things: Send an email to the buyer, generate an invoice, start the process of shipping the product, etc.' + responses: + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + schema: + $ref: '#/components/schemas/webhook_response' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get transaction - tags: - - Transactions - /transfers: - get: - description: Get transfers details in the form of a list - operationId: getTransfers + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/webhook' parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + - $ref: '#/components/parameters/accept_language' + /webhooks/{id}: + get: + tags: + - Webhooks + operationId: getWebhook + summary: Get Webhook responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_transfers_response" - description: successful + $ref: '#/components/schemas/webhook_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get a list of transfers - tags: - - Transfers - /transfers/{id}: - get: - description: Get the details of a Transfer - operationId: getTransfer + - bearerAuth: [] parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + put: + tags: + - Webhooks + operationId: updateWebhook + summary: Update Webhook + description: updates an existing webhook responses: - "200": + '200': + description: successful operation content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/transfer_response" - description: successful - headers: - Date: - description: The date and time that the response was sent - explode: false - schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" - type: string - style: simple - Content-Type: - description: The format of the response body - explode: false - schema: - example: application/json; charset=utf-8 - type: string - style: simple - Content-Length: - description: The length of the response body in bytes - explode: false - schema: - example: "2737" - type: string - style: simple - Connection: - description: The type of connection used to transfer the response - explode: false - schema: - example: keep-alive - type: string - style: simple - Conekta-Media-Type: - explode: false - schema: - example: conekta-v2.3.0; format=application/json - type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/webhook_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get Transfer - tags: - - Transfers - /webhook_keys: - get: - description: Consume the list of webhook keys you have - operationId: getWebhookKeys + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/webhook_update' parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form + - $ref: '#/components/parameters/accept_language' + - $ref: '#/components/parameters/x_child_company_id' + - $ref: '#/components/parameters/id' + delete: + tags: + - Webhooks + operationId: deleteWebhook + summary: Delete Webhook responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/get_webhook_keys_response" - description: successful + $ref: '#/components/schemas/webhook_response' headers: Date: description: The date and time that the response was sent - explode: false schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - style: simple + example: Fri, 03 Feb 2023 16:57:48 GMT Content-Type: description: The format of the response body - explode: false schema: - example: application/json; charset=utf-8 type: string - style: simple + example: application/json; charset=utf-8 Content-Length: description: The length of the response body in bytes - explode: false schema: - example: "2737" type: string - style: simple + example: '2737' Connection: description: The type of connection used to transfer the response - explode: false schema: - example: keep-alive type: string - style: simple + example: keep-alive Conekta-Media-Type: - explode: false schema: - example: conekta-v2.3.0; format=application/json type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + example: conekta-v2.3.0; format=application/json + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Get List of Webhook Keys - tags: - - Webhook keys - post: - description: Create a webhook key - operationId: createWebhookKey + - bearerAuth: [] parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/webhook_key_request" + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' + /webhooks/{id}/test: + post: + tags: + - Webhooks + operationId: testWebhook + summary: Test Webhook + description: Send a webhook.ping event responses: - "200": + '200': + description: successful content: application/vnd.conekta-v2.3.0+json: schema: - $ref: "#/components/schemas/webhook_key_create_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error + $ref: '#/components/schemas/webhook_response' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' security: - - bearerAuth: [] - summary: Create Webhook Key - tags: - - Webhook keys - /webhook_keys/{id}: - delete: - operationId: deleteWebhookKey + - bearerAuth: [] parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en + - $ref: '#/components/parameters/id' + - $ref: '#/components/parameters/accept_language' +components: + schemas: + event_types: + title: event_types + type: string + description: It is a parameter that allows to identify in the response, the type of event that is being generated. + enum: + - webhook_ping + - order.paid + - order.expired + - order.canceled + - order.pending_payment + pagination: + title: pagination metadata + description: pagination metadata + type: object + required: + - object + - has_more + properties: + has_more: + type: boolean + example: false + description: Indicates if there are more pages to be requested + object: type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_key_delete_response" - description: successful - headers: - Date: - description: The date and time that the response was sent - explode: false - schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" - type: string - style: simple - Content-Type: - description: The format of the response body - explode: false - schema: - example: application/json; charset=utf-8 - type: string - style: simple - Content-Length: - description: The length of the response body in bytes - explode: false - schema: - example: "2737" + example: list + description: Object type, in this case is list + page: + title: page metadata + description: page metadata + type: object + properties: + next_page_url: + description: URL of the next page. + type: + - string + - 'null' + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + previous_page_url: + description: Url of the previous page. + type: + - string + - 'null' + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + risk_rules_list: + title: risk_rules_list + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + type: object + title: risk_rules_data + properties: + id: + type: string + example: 618c3f2fdb8b8da9be376af9 + description: rule id + field: + type: string + example: email + description: field to be used for the rule + created_at: + type: string + example: '2021-11-10T21:52:47.339Z' + description: rule creation date + value: + type: string + example: email@example.com + description: value to be used for the rule + is_global: + type: boolean + example: false + description: if the rule is global + is_test: + type: boolean + example: false + description: if the rule is test + description: + type: string + example: secure customer example@example.com + description: description of the rule + details: + type: object + properties: + details: + type: array + items: + type: object + title: details_error + properties: + code: type: string - style: simple - Connection: - description: The type of connection used to transfer the response - explode: false - schema: - example: keep-alive + example: conekta.errors.authentication.missing_key + param: + type: + - string + - 'null' + message: type: string - style: simple - Conekta-Media-Type: - explode: false - schema: - example: conekta-v2.3.0; format=application/json + example: Acceso no autorizado. + debug_message: type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Delete Webhook key - tags: - - Webhook keys - get: - operationId: getWebhookKey - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 + example: Please include your access key in your request. + error: + title: error + description: err model + allOf: + - $ref: '#/components/schemas/details' + - type: object + properties: + log_id: + description: log id + type: + - string + - 'null' + example: 507f1f77bcf86cd799439011 + type: + type: string + example: authentication_error + object: + type: string + example: error + create_risk_rules_data: + type: object + required: + - description + - field + - value + properties: + description: type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en + example: this client email was verified at 20/09/22 by internal process + description: Description of the rule + field: type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_key_response" - description: successful - headers: - Date: - description: The date and time that the response was sent - explode: false - schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" - type: string - style: simple - Content-Type: - description: The format of the response body - explode: false - schema: - example: application/json; charset=utf-8 - type: string - style: simple - Content-Length: - description: The length of the response body in bytes - explode: false - schema: - example: "2737" - type: string - style: simple - Connection: - description: The type of connection used to transfer the response - explode: false - schema: - example: keep-alive - type: string - style: simple - Conekta-Media-Type: - explode: false - schema: - example: conekta-v2.3.0; format=application/json - type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get Webhook Key - tags: - - Webhook keys - put: - description: updates an existing webhook key - operationId: updateWebhookKey - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/webhook_key_update_request" - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_key_response" - description: successful operation - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Update Webhook Key - tags: - - Webhook keys - /webhooks: - get: - description: "Consume the list of webhooks you have, each environment supports\ - \ 10 webhooks (For production and testing)" - operationId: getWebhooks - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: "The numbers of items to return, the maximum value is 250" - explode: true - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - style: form - - description: "General order search, e.g. by mail, reference etc." - explode: true - in: query - name: search - required: false - schema: - type: string - style: form - - description: url for webhook filter - explode: true - in: query - name: url - required: false - schema: - type: string - style: form - - description: next page - explode: true - in: query - name: next - required: false - schema: - type: string - style: form - - description: previous page - explode: true - in: query - name: previous - required: false - schema: - type: string - style: form - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/get_webhooks_response" - description: successful - headers: - Date: - description: The date and time that the response was sent - explode: false - schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" - type: string - style: simple - Content-Type: - description: The format of the response body - explode: false - schema: - example: application/json; charset=utf-8 - type: string - style: simple - Content-Length: - description: The length of the response body in bytes - explode: false - schema: - example: "2737" - type: string - style: simple - Connection: - description: The type of connection used to transfer the response - explode: false - schema: - example: keep-alive - type: string - style: simple - Conekta-Media-Type: - explode: false - schema: - example: conekta-v2.3.0; format=application/json - type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get List of Webhooks - tags: - - Webhooks - post: - description: "What we do at Conekta translates into events. For example, an\ - \ event of interest to us occurs at the time a payment is successfully processed.\ - \ At that moment we will be interested in doing several things: Send an email\ - \ to the buyer, generate an invoice, start the process of shipping the product,\ - \ etc." - operationId: createWebhook - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/webhook_request" - description: requested field for webhook - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_response" - description: successful operation - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Create Webhook - tags: - - Webhooks - /webhooks/{id}: - delete: - operationId: deleteWebhook - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_response" - description: successful - headers: - Date: - description: The date and time that the response was sent - explode: false - schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" - type: string - style: simple - Content-Type: - description: The format of the response body - explode: false - schema: - example: application/json; charset=utf-8 - type: string - style: simple - Content-Length: - description: The length of the response body in bytes - explode: false - schema: - example: "2737" - type: string - style: simple - Connection: - description: The type of connection used to transfer the response - explode: false - schema: - example: keep-alive - type: string - style: simple - Conekta-Media-Type: - explode: false - schema: - example: conekta-v2.3.0; format=application/json - type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Delete Webhook - tags: - - Webhooks - get: - operationId: getWebhook - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_response" - description: successful - headers: - Date: - description: The date and time that the response was sent - explode: false - schema: - example: "Fri, 03 Feb 2023 16:57:48 GMT" - type: string - style: simple - Content-Type: - description: The format of the response body - explode: false - schema: - example: application/json; charset=utf-8 - type: string - style: simple - Content-Length: - description: The length of the response body in bytes - explode: false - schema: - example: "2737" - type: string - style: simple - Connection: - description: The type of connection used to transfer the response - explode: false - schema: - example: keep-alive - type: string - style: simple - Conekta-Media-Type: - explode: false - schema: - example: conekta-v2.3.0; format=application/json - type: string - style: simple - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Get Webhook - tags: - - Webhooks - put: - description: updates an existing webhook - operationId: updateWebhook - parameters: - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - explode: false - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - style: simple - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update_webhook" - description: requested fields in order to update a webhook - required: true - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_response" - description: successful operation - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Update Webhook - tags: - - Webhooks - /webhooks/{id}/test: - post: - description: Send a webhook.ping event - operationId: testWebhook - parameters: - - description: Identifier of the resource - explode: false - in: path - name: id - required: true - schema: - example: 6307a60c41de27127515a575 - type: string - style: simple - - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - explode: false - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - style: simple - responses: - "200": - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: "#/components/schemas/webhook_response" - description: successful - "401": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: Please include your access key in your request. - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - schema: - $ref: "#/components/schemas/error" - description: authentication error - "404": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - message: The resource was not found. - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could - not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - schema: - $ref: "#/components/schemas/error" - description: not found entity - "500": - content: - application/vnd.conekta-v2.3.0+json: - example: - details: - - debug_message: There was a runtime error and Conekta engineers have - been notified. - message: There was a runtime error and Conekta engineers have been - notified. - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: "#/components/schemas/error" - description: internal server error - security: - - bearerAuth: [] - summary: Test Webhook - tags: - - Webhooks -components: - schemas: - event_types: - description: "It is a parameter that allows to identify in the response, the\ - \ type of event that is being generated." - enum: - - webhook_ping - - order.paid - - order.expired - - order.canceled - - order.pending_payment - title: event_types - type: string - risk_rules_data: - properties: - id: - description: rule id - example: 618c3f2fdb8b8da9be376af9 - type: string - field: - description: field to be used for the rule - example: email - type: string - created_at: - description: rule creation date - example: 2021-11-10T21:52:47.339Z - type: string - value: - description: value to be used for the rule - example: email@example.com - type: string - is_global: - description: if the rule is global - example: false - type: boolean - is_test: - description: if the rule is test - example: false - type: boolean - description: - description: description of the rule - example: secure customer example@example.com - type: string - title: risk_rules_data - risk_rules_list: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/risk_rules_data" - type: array - default: null - title: risk_rules_list - details_error: - properties: - code: - example: conekta.errors.authentication.missing_key - type: string - param: - nullable: true - type: string - message: - example: Acceso no autorizado. - type: string - debug_message: - example: Please include your access key in your request. - type: string - title: details_error - error: - allOf: - - properties: - details: - items: - $ref: "#/components/schemas/details_error" - type: array - default: null - - properties: - log_id: - description: log id - example: 507f1f77bcf86cd799439011 - nullable: true - type: string - type: - example: authentication_error - type: string - object: - example: error - type: string - description: err model - title: error - CreateRuleWhitelist_request: - properties: - description: - description: Description of the rule - example: this client email was verified at 20/09/22 by internal process - type: string - field: - description: Field to be used for the rule - example: email | phone | card_token - type: string - value: - description: Value to be used for the rule - example: email@example.com | 818081808180 | src_2qUCNd5AyQqfPMBuV - type: string - required: - - description - - field - - value - whitelistlist_rule_response: - properties: - id: - description: Whitelist rule id - example: 2fw8EWJusiRrxdPzT - type: string - field: - description: field used for whitelists rule - example: email - type: string - value: - description: value used for whitelists rule - example: email@example.com - type: string - description: - description: use an description for whitelisted rule - example: banned customer example@example.com - type: string - title: whitelistlist_rule_response - deleted_whitelist_rule_response: - properties: - id: - description: Whitelist rule id - example: 2fw8EWJusiRrxdPzT - type: string - field: - description: field used for whitelists rule deleted - example: email - type: string - value: - description: value used for whitelists rule deleted - example: email@example.com - type: string - description: - description: use an description for whitelisted rule - example: secure customer example@example.com - type: string - title: deleted_whitelist_rule_response - blacklist_rule_response: - properties: - id: - description: Blacklist rule id - example: 2fw8EWJusiRrxdPzT - type: string - field: - description: field used for blacklists rule - example: email - type: string - value: - description: value used for blacklists rule - example: email@example.com - type: string - description: - description: use an description for blacklisted rule - example: secure customer example@example.com - type: string - title: blacklist_rule_response - deleted_blacklist_rule_response: - properties: - id: - description: Blacklist rule id - example: 2fw8EWJusiRrxdPzT - type: string - field: - description: field used for blacklists rule deleted - example: email - type: string - value: - description: value used for blacklists rule deleted - example: email@example.com - type: string - description: - description: use an description for blacklisted rule - example: banned customer example@example.com - type: string - title: deleted_blacklist_rule_response - api_key_response: - description: api keys model - properties: - active: - description: Indicates if the api key is active - example: true - type: boolean - created_at: - description: Unix timestamp in seconds of when the api key was created - example: 1684167881 - format: int64 - type: integer - updated_at: - description: Unix timestamp in seconds of when the api key was last updated - example: 1684167923 - format: int64 - type: integer - deactivated_at: - description: Unix timestamp in seconds of when the api key was deleted - format: int64 - nullable: true - type: integer - last_used_at: - description: Unix timestamp in seconds with the api key was used - format: int64 - nullable: true - type: integer - description: - description: A name or brief explanation of what this api key is used for - example: online store - type: string - id: - description: Unique identifier of the api key - example: 64625cc9f3e02c00163f5e4d - type: string - livemode: - description: Indicates if the api key is in production - example: false - type: boolean - object: - description: "Object name, value is 'api_key'" - example: api_key - type: string - prefix: - description: The first few characters of the authentication_token - example: key_rp - type: string - role: - description: Indicates if the api key is private or public - example: private - type: string - title: api_key_response - get_api_keys_response: - allOf: - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - properties: - data: - items: - $ref: "#/components/schemas/api_key_response" - type: array - default: null - title: get_api_keys_response - api_key_request: - properties: - description: - description: A name or brief explanation of what this api key is used for - example: online store - type: string - role: - example: private - type: string - descripción: Indicates if the api key is private or public - required: - - role - title: api_key_request - name: api_key_request - api_key_create_response: - allOf: - - properties: - authentication_token: - description: "It is occupied as a user when authenticated with basic authentication,\ - \ with a blank password. This value will only appear once, in the request\ - \ to create a new key. Copy and save it in a safe place." - example: key_rpHzxufNgjFCdprEEFZRTKi - type: string - - description: api keys model - properties: - active: - description: Indicates if the api key is active - example: true - type: boolean - created_at: - description: Unix timestamp in seconds of when the api key was created - example: 1684167881 - format: int64 - type: integer - updated_at: - description: Unix timestamp in seconds of when the api key was last updated - example: 1684167923 - format: int64 - type: integer - deactivated_at: - description: Unix timestamp in seconds of when the api key was deleted - format: int64 - nullable: true - type: integer - last_used_at: - description: Unix timestamp in seconds with the api key was used - format: int64 - nullable: true - type: integer - description: - description: A name or brief explanation of what this api key is used - for - example: online store - type: string - id: - description: Unique identifier of the api key - example: 64625cc9f3e02c00163f5e4d - type: string - livemode: - description: Indicates if the api key is in production - example: false - type: boolean - object: - description: "Object name, value is 'api_key'" - example: api_key - type: string - prefix: - description: The first few characters of the authentication_token - example: key_rp - type: string - role: - description: Indicates if the api key is private or public - example: private - type: string - title: api_key_response - title: api_key_create_response - api_key_update_request: - properties: - active: - description: Indicates if the webhook key is active - example: true - type: boolean - description: - description: A name or brief explanation of what this api key is used for - example: online store - type: string - title: api_key_update_request - delete_api_keys_response: - allOf: - - description: api keys model - properties: - active: - description: Indicates if the api key is active - example: true - type: boolean - created_at: - description: Unix timestamp in seconds of when the api key was created - example: 1684167881 - format: int64 - type: integer - description: - description: A name or brief explanation of what this api key is used - for - example: online store - type: string - livemode: - description: Indicates if the api key is in production - example: false - type: boolean - prefix: - description: The first few characters of the authentication_token - example: key_rp - type: string - id: - description: Unique identifier of the api key - example: 64625cc9f3e02c00163f5e4d - type: string - object: - description: "Object name, value is 'api_key'" - example: api_key - type: string - last_used_at: - description: Unix timestamp in seconds with the api key was used - format: int64 - nullable: true - type: integer - role: - description: Indicates if the api key is private or public - example: private - type: string - title: api_key_response_delete - - properties: - deleted: - example: true - type: boolean - title: delete_api_keys_response - balance_common_fiels_response: - description: balance common fields model - properties: - amount: - description: The balance's amount - example: 100 - format: int64 - type: integer - currency: - description: The balance's currency - example: MXN - type: string - title: balance_common_fiels_response - balance_response: - description: balance model - properties: - available: - description: The balance's available - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - cashout_retention_amount: - description: The balance's cashout retention amount - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - conekta_retention: - description: The balance's conekta retention - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - gateway: - description: The balance's gateway - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - pending: - description: The balance's pending - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - retained: - description: The balance's retained - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - retention_amount: - description: The balance's retention amount - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - target_collateral_amount: - description: The balance's target collateral amount - type: object - target_retention_amount: - description: The balance's target retention amount - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - temporarily_retained: - description: The balance's temporarily retained - items: - $ref: "#/components/schemas/balance_common_fiels_response" - type: array - default: null - title: balance_response - charge_response_channel: - properties: - segment: - example: Checkout - type: string - checkout_request_id: - example: 6fca054a-8519-4c43-971e-cea35cc519bb - type: string - checkout_request_type: - example: HostedPayment - type: string - id: - example: channel_2tNDzhA4Akmzj11AU - type: string - payment_method_cash: - allOf: - - properties: - type: - type: string - object: - example: payment_source - type: string - required: - - object - - description: use for cash responses - properties: - agreement: - description: Agreement ID - example: agreement_2tN73UdUSNrYRPD9r - type: string - auth_code: - example: 542563 - nullable: true - type: integer - cashier_id: - example: OINM01010 - nullable: true - type: string - reference: - example: "93000262276908" - type: string - barcode_url: - example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png - type: string - expires_at: - example: 0 - format: int64 - type: integer - product_type: - description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\ - \ etc." - example: bbva_cash_in - type: string - service_name: - example: store - type: string - store: - example: 10MON50EDI - nullable: true - type: string - store_name: - example: wallmart - type: string - customer_ip_address: - example: 0.0.0.0 - type: string - title: charge_data_payment_method_cash_response - title: payment_method_cash - x-discriminator-value: cash_payment - payment_method_card: - allOf: - - properties: - type: - type: string - object: - example: payment_source - type: string - required: - - object - - description: use for card responses - properties: - account_type: - description: Account type of the card - example: Credit - type: string - auth_code: - example: "867372" - type: string - brand: - description: Brand of the card - example: visa - type: string - contract_id: - description: Id sent for recurrent charges. - example: S781317595 - type: string - country: - description: Country of the card - example: MX - type: string - exp_month: - description: Expiration month of the card - example: "02" - type: string - exp_year: - description: Expiration year of the card - example: "2026" - type: string - fraud_indicators: - items: {} - type: array - default: null - issuer: - description: Issuer of the card - example: BANAMEX - type: string - last4: - description: Last 4 digits of the card - example: "4242" - type: string - name: - description: Name of the cardholder - example: Fulanito Perez - type: string - customer_ip_address: - description: Optional field used to capture the customer's IP address - for fraud prevention and security monitoring purposes - example: 0.0.0.0 - type: string - title: charge_data_payment_method_card_response - title: payment_method_card - x-discriminator-value: card_payment - payment_method_bank_transfer: - allOf: - - properties: - type: - type: string - object: - example: payment_source - type: string - required: - - object - - description: use for bank transfer responses - properties: - bank: - example: STP - type: string - clabe: - example: "646180111805034237" - type: string - description: - nullable: true - type: string - executed_at: - nullable: true - type: string - expires_at: - example: 1683053729 - format: int64 - type: integer - issuing_account_bank: - nullable: true - type: string - issuing_account_number: - nullable: true - type: string - issuing_account_holder_name: - nullable: true - type: string - issuing_account_tax_id: - nullable: true - type: string - payment_attempts: - items: {} - type: array - default: null - receiving_account_holder_name: - nullable: true - type: string - receiving_account_number: - example: "646180111805034237" - type: string - receiving_account_bank: - example: STP - type: string - receiving_account_tax_id: - nullable: true - type: string - reference_number: - nullable: true - type: string - tracking_code: - nullable: true - type: string - customer_ip_address: - example: 0.0.0.0 - type: string - title: charge_data_payment_method_bank_transfer_response - title: payment_method_bank_transfer - x-discriminator-value: bank_transfer_payment - payment_method_bnpl_payment: - allOf: - - properties: - type: - type: string - object: - example: payment_source - type: string - required: - - object - - description: use for bnpl payment responses - properties: - object: - enum: - - bnpl_payment - type: string - cancel_url: - description: URL to redirect the customer after a canceled payment - example: https://example.com/cancel - type: string - expires_at: - description: Expiration date of the charge - example: 1683053729 - format: int64 - type: integer - failure_url: - description: URL to redirect the customer after a failed payment - example: https://example.com/failure - type: string - product_type: - description: Product type of the charge - type: string - redirect_url: - description: URL to redirect the customer to complete the payment - example: https://example.com/redirect - type: string - success_url: - description: URL to redirect the customer after a successful payment - example: https://example.com/success - type: string - required: - - expires_at - - product_type - title: charge_data_payment_method_bnpl_payment_response - title: payment_method_bnpl_payment - x-discriminator-value: bnpl_payment - payment_method_pbb_payment: - allOf: - - properties: - type: - type: string - object: - example: payment_source - type: string - required: - - object - - description: use for pbb payment responses - properties: - deep_link: - description: "Deep link for the payment, use for mobile apps/flows" - example: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 - type: string - expires_at: - description: Expiration date of the charge - example: 1683053729 - exclusiveMinimum: true - format: int64 - minimum: 0 - type: integer - product_type: - description: Product type of the charge - type: string - redirect_url: - description: URL to redirect the customer to complete the payment - example: https://example.com/redirect - type: string - reference: - description: Reference for the payment - example: "22277523174328893295" - type: string - required: - - deep_link - - expires_at - - product_type - - redirect_url - - reference - title: charge_data_payment_method_pbb_payment_response - title: payment_method_pbb_payment - x-discriminator-value: pay_by_bank_payment - charge_response_payment_method: - discriminator: - mapping: - cash_payment: payment_method_cash - card_payment: payment_method_card - bank_transfer_payment: payment_method_bank_transfer - bnpl_payment: payment_method_bnpl_payment - pay_by_bank_payment: payment_method_pbb_payment - propertyName: object - oneOf: - - $ref: "#/components/schemas/payment_method_cash" - - $ref: "#/components/schemas/payment_method_card" - - $ref: "#/components/schemas/payment_method_bank_transfer" - - $ref: "#/components/schemas/payment_method_bnpl_payment" - - $ref: "#/components/schemas/payment_method_pbb_payment" - title: charge_response_payment_method - propertyName: object - charge_response_refunds_data: - properties: - amount: - example: -15000 - format: int64 - type: integer - auth_code: - example: "867372" - type: string - created_at: - example: 1678226878 - format: int64 - type: integer - expires_at: - description: refund expiration date - example: 1678226878 - format: int64 - type: integer - id: - example: 6407b5bee1329a000175ba11 - type: string - object: - example: refund - type: string - status: - description: refund status - example: pending - type: string - required: - - amount - - created_at - - id - - object - title: charge_response_refunds_data - charge_response_refunds: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - description: refunds - items: - $ref: "#/components/schemas/charge_response_refunds_data" - type: array - default: null - title: charge_response_refunds - chargeback_file_response: - description: A file associated with a chargeback (e.g. evidence document) - properties: - id: - example: chbkf_2zPxWFUnGNLySoums - type: string - file_name: - example: 20251221500000000000201.pdf - type: string - url: - nullable: true - type: string - created_at: - example: 1768846800 - format: int64 - type: integer - title: chargeback_file_response - chargeback_response: - description: Chargeback object - nullable: true - properties: - id: - example: chbk_2zPxWFUnGNLySoumn - type: string - status: - enum: - - won - - lost - - action_required - - pending_review - - under_review - - covered - - rt - - rt_sent - - represented - example: lost - type: string - reason: - enum: - - 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 - example: unrecognized - type: string - note: - nullable: true - type: string - followup_status: - enum: - - customer_uncontacted - - customer_contacted - - customer_unreachable - nullable: true - type: string - response_from_client: - nullable: true - type: string - files: - items: - $ref: "#/components/schemas/chargeback_file_response" - type: array - default: null - object: - example: chargeback - type: string - charge_id: - example: 6966a06c044243000156c24d - type: string - created_at: - example: 1768846800 - format: int64 - type: integer - evidence_due_by: - example: 1769126399 - format: int64 - type: integer - title: chargeback_response - charge_response: - properties: - amount: - example: 4321 - type: integer - channel: - $ref: "#/components/schemas/charge_response_channel" - created_at: - example: 1676386026 - format: int64 - type: integer - currency: - example: MXN - type: string - customer_id: - type: string - description: - example: Payment from order - type: string - device_fingerprint: - example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - type: string - failure_code: - example: suspected_fraud - type: string - failure_message: - example: Este cargo ha sido declinado porque el comportamiento del comprador - es sospechoso. - type: string - id: - description: Charge ID - example: 63efa757cf65380001aec040 - type: string - livemode: - description: Whether the charge was made in live mode or not - example: false - type: boolean - object: - example: charge - type: string - order_id: - description: Order ID - example: ord_2tN73UdUSNrYRPD9r - type: string - paid_at: - description: charge Payment date - example: 1676390742 - format: int64 - nullable: true - type: integer - payment_method: - $ref: "#/components/schemas/charge_response_payment_method" - reference_id: - description: Reference ID of the charge - example: ref_2tN73UdUSNrYRPD9r - nullable: true - type: string - refunds: - $ref: "#/components/schemas/charge_response_refunds" - chargeback: - $ref: "#/components/schemas/chargeback_response" - status: - description: Charge status - example: pending_payment - type: string - required: - - amount - - created_at - - currency - - id - - livemode - - object - - order_id - - status - title: charge_response - get_charges_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/charge_response" - type: array - default: null - title: get_charges_response - charge_update_request: - description: requested field for update a charge - properties: - reference_id: - description: custom reference id - example: "278482642" - type: string - title: charge_update_request - payment_method_pbb_request: - allOf: - - description: Contains details of the payment methods that the customer has - active or has used in Conekta - properties: - type: - description: Type of payment method - example: card | cash | spei | bnpl | pay_by_bank - type: string - required: - - type - title: customer_payment_method_request - - properties: - expires_at: - description: "Expiration date of the payment method, in Unix timestamp\ - \ format" - example: 1680397724 - format: int64 - minimum: 0 - type: integer - product_type: - description: "Product type of the payment method, use for the payment\ - \ method to know the product type" - enum: - - bbva_pay_by_bank - example: bbva_pay_by_bank - type: string - type: - description: Type of the payment method - example: pay_by_bank - type: string - required: - - product_type - - type - title: payment_method_pbb_request - payment_method_bnpl_request: - allOf: - - description: Contains details of the payment methods that the customer has - active or has used in Conekta - properties: - type: - description: Type of payment method - example: card | cash | spei | bnpl | pay_by_bank - type: string - required: - - type - title: customer_payment_method_request - - properties: - cancel_url: - description: Optional URL to redirect the customer after a canceled payment - example: https://example.com/cancel - type: string - expires_at: - description: "Optional expiry for the BNPL order, expressed in seconds\ - \ since the Unix epoch. Defaults to one month from creation when omitted." - example: 1680397724 - format: int64 - type: integer - failure_url: - description: URL to redirect the customer after a failed payment - example: https://example.com/failure - type: string - product_type: - description: "Product type of the payment method, use for the payment\ - \ method to know the product type" - enum: - - aplazo_bnpl - - azteca_bnpl - - coppel_bnpl - - creditea_bnpl - example: aplazo_bnpl - type: string - success_url: - description: URL to redirect the customer after a successful payment - example: https://example.com/success - type: string - type: - description: Type of the payment method - example: bnpl - type: string - required: - - failure_url - - product_type - - success_url - - type - title: payment_method_bnpl_request - payment_method_card_request: - allOf: - - description: Contains details of the payment methods that the customer has - active or has used in Conekta - properties: - type: - description: Type of payment method - example: card | cash | spei | bnpl | pay_by_bank - type: string - required: - - type - title: customer_payment_method_request - - properties: - cvc: - description: Card security code - example: "198" - maxLength: 4 - minLength: 3 - type: string - exp_month: - description: Card expiration month - example: "12" - maxLength: 2 - minLength: 2 - type: string - exp_year: - description: Card expiration year - example: "2025" - maxLength: 4 - minLength: 4 - type: string - name: - description: "Cardholder name. Must include first and last name separated\ - \ by a space; single-word names are rejected. Letters (including accented\ - \ Latin characters), spaces, and the characters , . ' - are accepted;\ - \ digits and other symbols are rejected." - example: John Doe - maxLength: 249 - type: string - number: - description: Card number - example: "4242424242424242" - type: string - contract_id: - description: Optional merchant-supplied identifier (exactly 10 characters) - that links a card transaction to a recurring/subscription contract at - the acquiring bank. Forwarded to the bank gateway and stored on the - resulting charge. Accepted on creation only; ignored on update. Do not - place sensitive bank data here — the value is returned in charge responses. - example: "3456788363" - maxLength: 10 - minLength: 10 - type: string - customer_ip_address: - description: Optional field used to capture the customer's IP address - for fraud prevention and security monitoring purposes - example: 0.0.0.0 - type: string - required: - - cvc - - exp_month - - exp_year - - name - - number - title: payment_method_card_request - payment_method_general_request: - description: | - Payment method used in the charge. Go to the [payment methods](https://developers.conekta.com/reference/m%C3%A9todos-de-pago) section for more details - properties: - expires_at: - description: Method expiration date as unix timestamp - example: 1677196303 - format: int64 - type: integer - monthly_installments: - description: "How many months without interest to apply, it can be 3, 6,\ - \ 9, 12 or 18" - format: int8 - type: integer - type: - description: Type of payment method - example: card - type: string - token_id: - example: tok_2897348234 - type: string - payment_source_id: - example: src_2tLkkyfMPh6v7pFry - type: string - cvc: - description: "Optional, It is a value that allows identifying the security\ - \ code of the card. Only for PCI merchants" - example: "123" - type: string - contract_id: - description: Optional id sent to indicate the bank contract for recurrent - card charges. - example: S781317595 - type: string - customer_ip_address: - description: Optional field used to capture the customer's IP address for - fraud prevention and security monitoring purposes - example: 0.0.0.0 - type: string - required: - - type - title: payment_method_general_request - charge_request_payment_method: - oneOf: - - $ref: "#/components/schemas/payment_method_pbb_request" - - $ref: "#/components/schemas/payment_method_bnpl_request" - - $ref: "#/components/schemas/payment_method_card_request" - - $ref: "#/components/schemas/payment_method_general_request" - title: charge_request_payment_method - charge_request: - description: The charges to be made - properties: - amount: - description: Amount to be charged in cents - example: 40000 - format: int64 - type: integer - payment_method: - $ref: "#/components/schemas/charge_request_payment_method" - reference_id: - description: Custom reference to add to the charge - type: string - required: - - payment_method - title: charge_request - charge_order_response_payment_method: - discriminator: - mapping: - cash_payment: payment_method_cash - card_payment: payment_method_card - bank_transfer_payment: payment_method_bank_transfer - bnpl_payment: payment_method_bnpl_payment - pay_by_bank_payment: payment_method_pbb_payment - propertyName: object - oneOf: - - $ref: "#/components/schemas/payment_method_cash" - - $ref: "#/components/schemas/payment_method_card" - - $ref: "#/components/schemas/payment_method_bank_transfer" - - $ref: "#/components/schemas/payment_method_bnpl_payment" - - $ref: "#/components/schemas/payment_method_pbb_payment" - title: charge_order_response_payment_method - propertyName: object - charge_order_response: - properties: - amount: - example: 4321 - type: integer - channel: - $ref: "#/components/schemas/charge_response_channel" - created_at: - example: 1676386026 - format: int64 - type: integer - currency: - example: MXN - type: string - customer_id: - type: string - description: - example: Payment from order - type: string - device_fingerprint: - example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - nullable: true - type: string - failure_code: - example: suspected_fraud - type: string - failure_message: - example: Este cargo ha sido declinado porque el comportamiento del comprador - es sospechoso. - type: string - id: - example: 63efa757cf65380001aec040 - type: string - livemode: - example: true - type: boolean - monthly_installments: - nullable: true - type: integer - object: - type: string - order_id: - example: ord_2tN73UdUSNrYRPD9r - type: string - paid_at: - example: 1676390742 - nullable: true - type: integer - payment_method: - $ref: "#/components/schemas/charge_order_response_payment_method" - reference_id: - description: Reference ID of the charge - example: ref_2tN73UdUSNrYRPD9r - nullable: true - type: string - refunds: - items: {} - type: array - default: null - status: - example: pending_payment - type: string - title: charge_order_response - charges_order_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/charge_response" - type: array - default: null - description: The charges associated with the order - title: charges_order_response - company_document_response: - properties: - file_classification: - description: | - Classification of the document. - - | Tipo de archivo | Descripción | - | :--------------------------- | :-------------------------------------------------------- | - | `id_legal_representative` | identificación oficial frente | - | `id_legal_representative_back` | identificación oficial atrás | - | `cfdi` | Prueba de situación fiscal | - | `constitutive_act_basic` | Acta constitutiva | - | `proof_of_address` | Comprobante de domicilio del negocio | - | `power_of_attonery` | Poderes de representación | - | `deposit_account_cover` | Carátula de la cuenta de depósito | - | `permit_casino` | Permiso ante SEGOB | - | `license_sanitation` | Licencia sanitaria de COFEPRIS | - | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | - enum: - - id_legal_representative - - id_legal_representative_back - - cfdi - - constitutive_act_basic - - proof_of_address - - power_of_attonery - - deposit_account_cover - - permit_casino - - license_sanitation - - registration_tourism - example: deposit_account_cover - type: string - status: - description: The status of the document. - example: pending - type: string - file_name: - description: The name of the file. - nullable: true - type: string - title: company_document_response - company_response: - properties: - id: - description: The unique identifier for the company. - example: 6827305a1ec60400015eb116 - type: string - name: - description: The name of the company. - example: test - type: string - active: - description: Indicates if the company is active. - example: false - type: boolean - account_status: - description: The current status of the company's account. - example: signed_up - type: string - parent_company_id: - description: "The identifier of the parent company, if any." - example: 680bf1da38716d00013543bc - nullable: true - type: string - onboarding_status: - description: The current status of the company's onboarding process. - example: pending - type: string - documents: - description: A list of documents related to the company. - items: - $ref: "#/components/schemas/company_document_response" - type: array - default: null - created_at: - description: Timestamp of when the company was created. - example: 1748968241 - format: int64 - type: integer - object: - description: "The type of object, typically \"company\"." - example: company - type: string - three_ds_enabled: - description: Indicates if 3DS authentication is enabled for the company. - example: true - type: boolean - three_ds_mode: - description: "The 3DS mode for the company, either 'smart' or 'strict'.\ - \ This property is only applicable when three_ds_enabled is true. When\ - \ three_ds_enabled is false, this field will be null." - enum: - - smart - - strict - example: strict - nullable: true - type: string - required: - - account_status - - active - - created_at - - documents - - id - - name - - object - - onboarding_status - title: company_response - get_companies_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/company_response" - type: array - default: null - title: get_companies_response - Create_Company_Request_comercial_info: - description: Commercial information for the company. - properties: - website: - description: The company's website URL. - example: http://www.test.com - format: url - type: string - mcc: - description: The Merchant Category Code (MCC) for the company. - example: "5812" - type: string - merchant_support_email: - description: Email address for merchant support. - example: test@test.com - format: email - type: string - merchant_support_phone: - description: Phone number for merchant support. - example: "5300000000" + example: email | phone | card_token + description: Field to be used for the rule + value: type: string - Create_Company_Request_fiscal_info: - description: Fiscal information for the company. + example: email@example.com | 818081808180 | src_2qUCNd5AyQqfPMBuV + description: Value to be used for the rule + api_key_response: + title: api_key_response + description: api keys model + type: object properties: - business_phone: - description: The business phone number for fiscal purposes. - example: "5300000000" + active: + type: boolean + description: Indicates if the api key is active + example: true + created_at: + type: integer + description: Unix timestamp in seconds of when the api key was created + example: 1684167881 + format: int64 + updated_at: + type: integer + description: Unix timestamp in seconds of when the api key was last updated + example: 1684167923 + format: int64 + deactivated_at: + type: + - integer + - 'null' + description: Unix timestamp in seconds of when the api key was deleted + example: null + format: int64 + last_used_at: + type: + - integer + - 'null' + description: Unix timestamp in seconds with the api key was used + example: null + format: int64 + description: type: string - fiscal_type: - description: "The fiscal type of the company (e.g., 'moral', 'persona_fisica')." - example: moral + description: A name or brief explanation of what this api key is used for + example: online store + id: type: string - Create_Company_Request_bank_account_info: - description: Bank account information for the company. - properties: - clabe: - description: The 18-digit CLABE for the bank account. - example: "002010077777777771" + example: 64625cc9f3e02c00163f5e4d + description: Unique identifier of the api key + livemode: + type: boolean + description: Indicates if the api key is in production + example: false + object: type: string - Create_Company_Request: - properties: - name: - description: The name of the company. - example: test + description: Object name, value is 'api_key' + example: api_key + prefix: type: string - type_company: - description: "The type of company, 'owner'" - example: owner + description: The first few characters of the authentication_token + example: key_rp + role: type: string - comercial_info: - $ref: "#/components/schemas/Create_Company_Request_comercial_info" - fiscal_info: - $ref: "#/components/schemas/Create_Company_Request_fiscal_info" - bank_account_info: - $ref: "#/components/schemas/Create_Company_Request_bank_account_info" - title: Create Company Request - CompanyDocumentRequest: - description: Request body for uploading a company document. - example: - file_classification: id_legal_representative - content_type: application/pdf - international: false - file_name: example_document.pdf - file_data: VGhpcyBpcyBhIHRlc3QgZmlsZSBkYXRhIGluIGJhc2UgNjQu + description: Indicates if the api key is private or public + example: private + api_key_request: + title: api_key_request + name: api_key_request + required: + - role properties: - file_classification: - description: | - Classification of the document. - - | Tipo de archivo | Descripción | - | :--------------------------- | :-------------------------------------------------------- | - | `id_legal_representative` | identificación oficial frente | - | `id_legal_representative_back` | identificación oficial atrás | - | `cfdi` | Prueba de situación fiscal | - | `constitutive_act_basic` | Acta constitutiva | - | `proof_of_address` | Comprobante de domicilio del negocio | - | `power_of_attonery` | Poderes de representación | - | `deposit_account_cover` | Carátula de la cuenta de depósito | - | `permit_casino` | Permiso ante SEGOB | - | `license_sanitation` | Licencia sanitaria de COFEPRIS | - | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | - enum: - - id_legal_representative - - id_legal_representative_back - - cfdi - - constitutive_act_basic - - proof_of_address - - power_of_attonery - - deposit_account_cover - - permit_casino - - license_sanitation - - registration_tourism - example: id_legal_representative + description: type: string - content_type: - description: | - MIME type of the file. Allowed values depend on the `file_classification`. - - `image/jpeg` - - `image/png` - - `application/pdf` - example: application/pdf + description: A name or brief explanation of what this api key is used for + example: online store + role: type: string - international: - description: Indicates if the document is international. Defaults to false. - example: false + example: private + descripción: Indicates if the api key is private or public + api_key_response_on_delete: + title: api_key_response_delete + description: api keys model + type: object + properties: + active: type: boolean - file_name: - description: Name of the file being uploaded. - example: example_document.pdf + description: Indicates if the api key is active + example: true + created_at: + type: integer + description: Unix timestamp in seconds of when the api key was created + example: 1684167881 + format: int64 + description: type: string - file_data: - description: Base64 encoded content of the file. - example: VGhpcyBpcyBhIHRlc3QgZmlsZSBkYXRhIGluIGJhc2UgNjQu - format: byte + description: A name or brief explanation of what this api key is used for + example: online store + livemode: + type: boolean + description: Indicates if the api key is in production + example: false + prefix: type: string - required: - - content_type - - file_classification - - file_data - - file_name - title: CompanyDocumentRequest - CompanyDocumentResponse: - description: Response body after uploading a company document. - properties: - file_classification: - description: | - Classification of the document. - - | Tipo de archivo | Descripción | - | :--------------------------- | :-------------------------------------------------------- | - | `id_legal_representative` | identificación oficial frente | - | `id_legal_representative_back` | identificación oficial atrás | - | `cfdi` | Prueba de situación fiscal | - | `constitutive_act_basic` | Acta constitutiva | - | `proof_of_address` | Comprobante de domicilio del negocio | - | `power_of_attonery` | Poderes de representación | - | `deposit_account_cover` | Carátula de la cuenta de depósito | - | `permit_casino` | Permiso ante SEGOB | - | `license_sanitation` | Licencia sanitaria de COFEPRIS | - | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | - enum: - - id_legal_representative - - id_legal_representative_back - - cfdi - - constitutive_act_basic - - proof_of_address - - power_of_attonery - - deposit_account_cover - - permit_casino - - license_sanitation - - registration_tourism - example: id_legal_representative + description: The first few characters of the authentication_token + example: key_rp + id: type: string - file_name: - description: Name of the file as stored or processed. - example: prueba3.pdf + example: 64625cc9f3e02c00163f5e4d + description: Unique identifier of the api key + object: type: string - status: - description: Current status of the document. - example: uploaded + description: Object name, value is 'api_key' + example: api_key + last_used_at: + type: + - integer + - 'null' + description: Unix timestamp in seconds with the api key was used + example: null + format: int64 + role: type: string - required: - - file_classification - - file_name - - status - title: CompanyDocumentResponse - customer_antifraud_info_response: + description: Indicates if the api key is private or public + example: private + balance_common_field: + title: balance_common_fiels_response + description: balance common fields model + type: object properties: - first_paid_at: - example: 1485151007 + amount: type: integer - account_created_at: - example: 1484040996 + example: 100 + description: The balance's amount format: int64 - type: integer - title: customer_antifraud_info_response - fiscal_entity_request_address: - allOf: - - properties: - street1: - example: Nuevo Leon 254 - type: string - street2: - example: Departamento 404 - type: string - postal_code: - example: "06100" - type: string - city: - example: Ciudad de Mexico - type: string - state: - example: Ciudad de Mexico - type: string - country: - description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - example: MX - type: string - external_number: - type: string - required: - - city - - postal_code - - street1 - customer_fiscal_entities_data_response: - allOf: - - properties: - address: - $ref: "#/components/schemas/fiscal_entity_request_address" - tax_id: - type: string - email: - type: string - phone: - type: string - metadata: - additionalProperties: - type: object - company_name: - example: conekta - type: string - required: - - address - title: fiscal_entity_request - - properties: - id: - example: ship_cont_2tKZsTYcsryyu7Ah8 - type: string - object: - example: shipping_contact - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2tKcHxhTz7xU5SymF - type: string - default: - type: boolean - required: - - created_at - - id - - object - title: customer_fiscal_entities_data_response - customer_fiscal_entities_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more + currency: + type: string + example: MXN + description: The balance's currency + balance_response: + title: balance_response + description: balance model + type: object + properties: + available: + type: array + description: The balance's available + items: + $ref: '#/components/schemas/balance_common_field' + cashout_retention_amount: + type: array + description: The balance's cashout retention amount + items: + $ref: '#/components/schemas/balance_common_field' + conekta_retention: + type: array + description: The balance's conekta retention + items: + $ref: '#/components/schemas/balance_common_field' + gateway: + type: array + description: The balance's gateway + items: + $ref: '#/components/schemas/balance_common_field' + pending: + type: array + description: The balance's pending + items: + $ref: '#/components/schemas/balance_common_field' + retained: + type: array + description: The balance's retained + items: + $ref: '#/components/schemas/balance_common_field' + retention_amount: + type: array + description: The balance's retention amount + items: + $ref: '#/components/schemas/balance_common_field' + target_collateral_amount: + type: object + description: The balance's target collateral amount + target_retention_amount: + type: array + description: The balance's target retention amount + items: + $ref: '#/components/schemas/balance_common_field' + temporarily_retained: + type: array + description: The balance's temporarily retained + items: + $ref: '#/components/schemas/balance_common_field' + payment_method: + type: object + required: - object - title: pagination metadata - - properties: - data: - items: - $ref: "#/components/schemas/customer_fiscal_entities_data_response" - type: array - default: null - title: customer_fiscal_entities_response - cash_agreements_response: properties: - agreement: - description: "Agreement number, you can use this number to pay in the store/bbva" - example: "2409526" + type: type: string - provider: - description: "Provider name, you can use this to know where to pay" - example: bbva_cash_in + object: type: string - title: cash_agreements_response - payment_method_cash_response: - allOf: - - properties: - type: - type: string - id: - example: src_2s8K1B3PBKDontpi9 - type: string - object: - example: payment_source - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2s8K1B3PBKDontpi8 - type: string - required: - - created_at - - id - - object - - type - - description: use for cash responses - properties: - agreements: - items: - $ref: "#/components/schemas/cash_agreements_response" - type: array - default: null - reference: - example: "93000262276908" - type: string - barcode: - example: "93000262276908" - type: string - barcode_url: - description: "URL to the barcode image, reference is the same as barcode" - example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png - type: string - expires_at: - example: 1742483424 - format: int64 - type: integer - provider: - example: Cash - type: string - title: payment_method_cash_response - x-discriminator-value: cash - payment_method_cash_recurrent_response: + example: payment_source + payment_method_cash: + title: payment_method_cash + x-discriminator-value: cash_payment allOf: - - allOf: - - properties: - type: + - $ref: '#/components/schemas/payment_method' + - type: object + title: charge_data_payment_method_cash_response + description: use for cash responses + properties: + agreement: type: string - id: - example: src_2s8K1B3PBKDontpi9 + example: agreement_2tN73UdUSNrYRPD9r + description: Agreement ID + auth_code: + type: + - integer + - 'null' + example: 542563 + cashier_id: + type: + - string + - 'null' + example: OINM01010 + reference: type: string - object: - example: payment_source + example: '93000262276908' + barcode_url: type: string - created_at: - example: 1675715413 - format: int64 + example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png + expires_at: type: integer - parent_id: - example: cus_2s8K1B3PBKDontpi8 + format: int64 + example: 0 + product_type: type: string - required: - - created_at - - id - - object - - type - - description: use for cash responses + example: bbva_cash_in + description: Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. + service_name: + type: string + example: store + store: + type: + - string + - 'null' + example: 10MON50EDI + store_name: + type: string + example: wallmart + customer_ip_address: + type: string + example: 0.0.0.0 + payment_method_card: + title: payment_method_card + x-discriminator-value: card_payment + allOf: + - $ref: '#/components/schemas/payment_method' + - type: object + title: charge_data_payment_method_card_response + description: use for card responses properties: - agreements: - items: - $ref: "#/components/schemas/cash_agreements_response" + account_type: + type: string + example: Credit + description: Account type of the card + auth_code: + type: string + example: '867372' + brand: + type: string + example: visa + description: Brand of the card + contract_id: + type: string + description: Id sent for recurrent charges. + example: S781317595 + country: + type: string + example: MX + description: Country of the card + exp_month: + type: string + example: '02' + description: Expiration month of the card + exp_year: + type: string + example: '2026' + description: Expiration year of the card + fraud_indicators: type: array - default: null - reference: - example: "93000262276908" + items: {} + issuer: type: string - barcode: - example: "93000262276908" + example: BANAMEX + description: Issuer of the card + last4: type: string - barcode_url: - description: "URL to the barcode image, reference is the same as barcode" - example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png + example: '4242' + description: Last 4 digits of the card + name: + type: string + example: Fulanito Perez + description: Name of the cardholder + customer_ip_address: + type: string + example: 0.0.0.0 + description: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes + payment_method_bank_transfer: + title: payment_method_bank_transfer + x-discriminator-value: bank_transfer_payment + allOf: + - $ref: '#/components/schemas/payment_method' + - type: object + title: charge_data_payment_method_bank_transfer_response + description: use for bank transfer responses + properties: + bank: + type: string + example: STP + clabe: type: string + example: '646180111805034237' + description: + type: + - string + - 'null' + executed_at: + type: + - string + - 'null' expires_at: - example: 1742483424 - format: int64 type: integer - provider: - example: Cash + example: 1683053729 + format: int64 + issuing_account_bank: + type: + - string + - 'null' + issuing_account_number: + type: + - string + - 'null' + issuing_account_holder_name: + type: + - string + - 'null' + issuing_account_tax_id: + type: + - string + - 'null' + payment_attempts: + type: array + items: {} + receiving_account_holder_name: + type: + - string + - 'null' + receiving_account_number: type: string - title: payment_method_cash_response - x-discriminator-value: cash - description: Alias of cash response used when type=cash_recurrent - title: payment_method_cash_recurrent_response - x-discriminator-value: cash_recurrent - payment_method_card_response: - allOf: - - properties: - type: - type: string - id: - example: src_2s8K1B3PBKDontpi9 - type: string - object: - example: payment_source - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2s8K1B3PBKDontpi8 - type: string - required: - - created_at - - id - - object - - type - - description: use for card responses - properties: - last4: - example: "6410" - type: string - bin: - example: "40276657" - type: string - card_type: - example: debit - type: string - exp_month: - example: "10" - type: string - exp_year: - example: "25" - type: string - brand: - example: visa - type: string - issuer: - description: Name of the institution that issued the card - example: santander - type: string - name: - example: Fulano Perez" - type: string - default: - type: boolean - visible_on_checkout: - type: boolean - payment_source_status: - example: active - type: string - title: payment_method_card_response - payment_method_spei_recurrent_response: - allOf: - - properties: - type: - type: string - id: - example: src_2s8K1B3PBKDontpi9 - type: string - object: - example: payment_source - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2s8K1B3PBKDontpi8 - type: string - required: - - created_at - - id - - object - - type - - description: use for spei responses - properties: - bank: - description: Bank name for the SPEI payment method - example: STP - type: string - reference: - example: "93000262276908" - type: string - expires_at: - example: none - type: string - title: payment_method_spei_recurrent_response - x-discriminator-value: spei_recurrent - customer_payment_methods_data: - discriminator: - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - propertyName: type - oneOf: - - $ref: "#/components/schemas/payment_method_cash_response" - - $ref: "#/components/schemas/payment_method_cash_recurrent_response" - - $ref: "#/components/schemas/payment_method_card_response" - - $ref: "#/components/schemas/payment_method_spei_recurrent_response" - title: customer_payment_methods_data - customer_payment_methods_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/customer_payment_methods_data" - title: customer_payment_methods_data - type: array - default: null - title: customerPaymentMethods - title: customer_payment_methods_response - customer_shipping_contacts_request_address: - allOf: - - description: Address of the person who will receive the order - properties: - street1: - description: Street and number of the delivery address. - example: Nuevo Leon 254 - maxLength: 249 - minLength: 2 - type: string - street2: - description: "Apartment, suite or interior reference for the delivery\ - \ address." - example: Departamento 404 - maxLength: 249 - type: string - postal_code: - description: Postal code of the delivery address. For Mexican addresses - (country MX) it must be a 5-digit postal code. - example: "06100" - maxLength: 250 - type: string - city: - description: City of the delivery address. Must contain at least two consecutive - ASCII letters. - example: Ciudad de Mexico - maxLength: 249 - pattern: "[A-Za-z]{2}" - type: string - state: - description: State of the delivery address. - example: Ciudad de Mexico - maxLength: 249 - type: string - country: - description: "Country of the delivery address. This field follows the\ - \ [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." - example: MX - maxLength: 249 - minLength: 2 - type: string - residential: - default: true - description: Indicates whether the delivery address is residential. - example: true - nullable: true - type: boolean - title: shipping_contact_address - required: - - country - - postal_code - - street1 - customer_shipping_contacts_data_response: + example: '646180111805034237' + receiving_account_bank: + type: string + example: STP + receiving_account_tax_id: + type: + - string + - 'null' + reference_number: + type: + - string + - 'null' + tracking_code: + type: + - string + - 'null' + customer_ip_address: + type: string + example: 0.0.0.0 + payment_method_bnpl_payment: + title: payment_method_bnpl_payment + x-discriminator-value: bnpl_payment allOf: - - description: |- - [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) - details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. - properties: - phone: - description: Phone contact - example: "+525511223344" - type: string - receiver: - description: Name of the person who will receive the order - example: Marvin Fuller - type: string - between_streets: - description: The street names between which the order will be delivered. - Must contain at least two consecutive ASCII letters. - example: Ackerman Crescent - maxLength: 249 - pattern: "[A-Za-z]{2}" - type: string - address: - $ref: "#/components/schemas/customer_shipping_contacts_request_address" - parent_id: - type: string - default: - nullable: true - type: boolean - deleted: - nullable: true - type: boolean - metadata: - additionalProperties: true - description: Metadata associated with the shipping contact - maxProperties: 100 - type: object - required: - - address - title: customer_shipping_contacts_request - - properties: - id: - example: ship_cont_2tKZsTYcsryyu7Ah8 - type: string - object: - example: shipping_contact - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - required: - - created_at - - id - - object - title: customer_shipping_contacts_data_response - customer_response_shipping_contacts: + - $ref: '#/components/schemas/payment_method' + - type: object + title: charge_data_payment_method_bnpl_payment_response + description: use for bnpl payment responses + required: + - product_type + - expires_at + properties: + object: + type: string + enum: + - bnpl_payment + cancel_url: + type: string + description: URL to redirect the customer after a canceled payment + example: https://example.com/cancel + expires_at: + type: integer + example: 1683053729 + format: int64 + description: Expiration date of the charge + failure_url: + type: string + description: URL to redirect the customer after a failed payment + example: https://example.com/failure + product_type: + type: string + description: Product type of the charge + examples: + - value: aplazo_bnpl + - value: azteca_bnpl + - value: coppel_bnpl + - value: creditea_bnpl + redirect_url: + type: string + description: URL to redirect the customer to complete the payment + example: https://example.com/redirect + success_url: + type: string + description: URL to redirect the customer after a successful payment + example: https://example.com/success + payment_method_pbb_payment: + title: payment_method_pbb_payment + x-discriminator-value: pay_by_bank_payment allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - properties: - data: - items: - $ref: "#/components/schemas/customer_shipping_contacts_data_response" - type: array - default: null - subscription_response: - description: subscription model - nullable: true + - $ref: '#/components/schemas/payment_method' + - type: object + title: charge_data_payment_method_pbb_payment_response + description: use for pbb payment responses + required: + - deep_link + - expires_at + - product_type + - redirect_url + - reference + properties: + deep_link: + type: string + description: Deep link for the payment, use for mobile apps/flows + example: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 + expires_at: + type: integer + example: 1683053729 + format: int64 + minimum: 0 + exclusiveMinimum: 7 + description: Expiration date of the charge + product_type: + type: string + description: Product type of the charge + examples: + - value: bbva_pay_by_bank + redirect_url: + type: string + description: URL to redirect the customer to complete the payment + example: https://example.com/redirect + reference: + type: string + description: Reference for the payment + example: '22277523174328893295' + chargeback_file_response: + title: chargeback_file_response + type: object + description: A file associated with a chargeback (e.g. evidence document) properties: - billing_cycle_start: - example: 1677626827 - format: int64 - nullable: true - type: integer - billing_cycle_end: - example: 1677626827 - format: int64 - nullable: true - type: integer - canceled_at: - example: 1678258162 - format: int64 - nullable: true - type: integer - canceled_reason: - description: Reason for cancellation. This field appears when the subscription - status is 'canceled'. - example: user_cancelation - type: string - card_id: - example: src_2tKcHxhTz7xU5SymL + id: type: string - charge_id: - example: 2tKcHxhTz7xU5SymL - nullable: true + example: chbkf_2zPxWFUnGNLySoums + file_name: type: string + example: 20251221500000000000201.pdf + url: + type: + - string + - 'null' created_at: - example: 1677626837 - format: int64 type: integer - customer_custom_reference: - example: dotnet_123456 - type: string - customer_id: - example: cus_2tKcHxhTz7xU5SymF - type: string + format: int64 + example: 1768846800 + chargeback_response: + title: chargeback_response + type: object + description: Chargeback object + properties: id: - example: gold-plan type: string - last_billing_cycle_order_id: - example: ord_2tSoMP7bZJbLiq4z8 + example: chbk_2zPxWFUnGNLySoumn + status: type: string - object: - example: subscription + example: lost + enum: + - won + - lost + - action_required + - pending_review + - under_review + - covered + - rt + - rt_sent + - represented + reason: type: string - paused_at: - example: 1678258162 - format: int64 - nullable: true - type: integer - plan_id: - example: plan_2tXx672QLQ68CkmMn + example: unrecognized + enum: + - 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: + type: + - string + - 'null' + followup_status: + type: + - string + - 'null' + enum: + - customer_uncontacted + - customer_contacted + - customer_unreachable + response_from_client: + type: + - string + - 'null' + files: + type: array + items: + $ref: '#/components/schemas/chargeback_file_response' + object: type: string - status: - example: past_due + example: chargeback + charge_id: type: string - subscription_start: - example: 1677626837 + example: 6966a06c044243000156c24d + created_at: type: integer - trial_start: - example: 1677626837 format: int64 - nullable: true + example: 1768846800 + evidence_due_by: type: integer - trial_end: - example: 1677626837 format: int64 - nullable: true - type: integer - title: subscription_response - customer_response: - description: customer response + example: 1769126399 + charge_response: + title: charge_response + type: object + required: + - amount + - created_at + - currency + - id + - livemode + - object + - status + - order_id properties: - antifraud_info: - $ref: "#/components/schemas/customer_antifraud_info_response" - corporate: - description: true if the customer is a company - type: boolean + amount: + type: integer + example: 4321 + channel: + type: object + properties: + segment: + type: string + example: Checkout + checkout_request_id: + type: string + example: 6fca054a-8519-4c43-971e-cea35cc519bb + checkout_request_type: + type: string + example: HostedPayment + id: + type: string + example: channel_2tNDzhA4Akmzj11AU created_at: - description: Creation date of the object - example: 1485151007 - format: int64 type: integer - custom_reference: - description: Custom reference - example: custom_reference + example: 1676386026 + format: int64 + currency: type: string - date_of_birth: - description: It is a parameter that allows to identify the date of birth - of the client. - example: 24/07/1992 + example: MXN + customer_id: type: string - default_fiscal_entity_id: - example: fis_ent_2tKqqAfqPi21oCmEJ - nullable: true + description: type: string - default_shipping_contact_id: - example: ship_cont_2tKZsTYcsryyu7Ah8 + example: Payment from order + device_fingerprint: type: string - default_payment_source_id: - example: src_2tHJfJ79KyUwpxTio - nullable: true + example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba + failure_code: type: string - email: - example: Felipe@gmail.com - format: email + example: suspected_fraud + failure_message: type: string - fiscal_entities: - $ref: "#/components/schemas/customer_fiscal_entities_response" + example: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso. id: - description: Customer's ID - example: cus_2tHJfJ79KyUwpxTik type: string + example: 63efa757cf65380001aec040 + description: Charge ID livemode: - description: true if the object exists in live mode or the value false if - the object exists in test mode - example: true type: boolean - name: - description: Customer's name - example: Felipe - type: string - national_id: - description: It is a parameter that allows to identify the national identification - number of the client. - example: HEGG560427MVZRRL04 - type: string - metadata: - additionalProperties: true - maxProperties: 100 - type: object + example: false + description: Whether the charge was made in live mode or not object: - example: customer type: string - payment_sources: - $ref: "#/components/schemas/customer_payment_methods_response" - phone: - description: Customer's phone number - example: "+5215555555555" + example: charge + order_id: type: string - shipping_contacts: - $ref: "#/components/schemas/customer_response_shipping_contacts" - subscription: - $ref: "#/components/schemas/subscription_response" - required: - - created_at - - id - - livemode - - name - - object - title: customer response - customers_response: - allOf: - - properties: - data: - items: - $ref: "#/components/schemas/customer_response" - title: customers_data_response - type: array - default: null - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - title: customers_response - customer_antifraud_info: - properties: - account_created_at: - example: 1484040996 - format: int64 - type: integer - first_paid_at: - example: 1485151007 + example: ord_2tN73UdUSNrYRPD9r + description: Order ID + paid_at: + type: + - integer + - 'null' format: int64 - type: integer - fiscal_entity_request: - properties: - address: - $ref: "#/components/schemas/fiscal_entity_request_address" - tax_id: - type: string - email: - type: string - phone: + example: 1676390742 + description: charge Payment date + payment_method: + title: charge_response_payment_method + propertyName: object + oneOf: + - $ref: '#/components/schemas/payment_method_cash' + - $ref: '#/components/schemas/payment_method_card' + - $ref: '#/components/schemas/payment_method_bank_transfer' + - $ref: '#/components/schemas/payment_method_bnpl_payment' + - $ref: '#/components/schemas/payment_method_pbb_payment' + discriminator: + propertyName: object + mapping: + cash_payment: payment_method_cash + card_payment: payment_method_card + bank_transfer_payment: payment_method_bank_transfer + bnpl_payment: payment_method_bnpl_payment + pay_by_bank_payment: payment_method_pbb_payment + reference_id: + type: + - string + - 'null' + description: Reference ID of the charge + example: ref_2tN73UdUSNrYRPD9r + refunds: + type: + - object + - 'null' + title: charge_response_refunds + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + description: refunds + type: array + items: + title: charge_response_refunds_data + required: + - object + - id + - amount + - created_at + properties: + amount: + type: integer + format: int64 + example: -15000 + auth_code: + type: string + example: '867372' + created_at: + type: integer + example: 1678226878 + format: int64 + expires_at: + type: integer + example: 1678226878 + format: int64 + description: refund expiration date + id: + type: string + example: 6407b5bee1329a000175ba11 + object: + type: string + example: refund + status: + type: string + example: pending + description: refund status + chargeback: + description: Present only when the charge has a chargeback + oneOf: + - $ref: '#/components/schemas/chargeback_response' + - type: 'null' + status: type: string - metadata: - additionalProperties: - type: object - company_name: - example: conekta + example: pending_payment + description: Charge status + charge_update_request: + title: charge_update_request + description: requested field for update a charge + properties: + reference_id: type: string + example: '278482642' + description: custom reference id + customer_payment_method_request: + description: Contains details of the payment methods that the customer has active or has used in Conekta + title: customer_payment_method_request required: - - address - title: fiscal_entity_request - payment_method_token_request: - allOf: - - description: Contains details of the payment methods that the customer has - active or has used in Conekta - properties: - type: - description: Type of payment method - example: card | cash | spei | bnpl | pay_by_bank - type: string - required: - type - title: customer_payment_method_request - - properties: - token_id: - description: "Token id that will be used to create a \"card\" type payment\ - \ method. See the (subscriptions)[https://developers.conekta.com/v2.3.0/reference/createsubscription]\ - \ tutorial for more information on how to tokenize cards." - example: tok_32hj4g234as - type: string - required: - - token_id - title: payment_method_token_request - payment_method_cash_request: + properties: + type: + type: string + example: card | cash | spei | bnpl | pay_by_bank + description: Type of payment method + payment_method_pbb_request: + title: payment_method_pbb_request allOf: - - description: Contains details of the payment methods that the customer has - active or has used in Conekta - properties: - type: - description: Type of payment method - example: card | cash | spei | bnpl | pay_by_bank - type: string - required: - - type - title: customer_payment_method_request - - properties: - expires_at: - example: 1553273553 - format: int64 - type: integer - title: payment_method_cash_request - payment_method_spei_request: + - $ref: '#/components/schemas/customer_payment_method_request' + - type: object + required: + - product_type + - type + properties: + expires_at: + type: integer + example: 1680397724 + format: int64 + description: Expiration date of the payment method, in Unix timestamp format + minimum: 0 + product_type: + type: string + example: bbva_pay_by_bank + description: Product type of the payment method, use for the payment method to know the product type + enum: + - bbva_pay_by_bank + type: + type: string + example: pay_by_bank + description: Type of the payment method + payment_method_bnpl_request: + title: payment_method_bnpl_request allOf: - - description: Contains details of the payment methods that the customer has - active or has used in Conekta - properties: - type: - description: Type of payment method - example: card | cash | spei | bnpl | pay_by_bank - type: string - required: - - type - title: customer_payment_method_request - - properties: - expires_at: - example: 1553273553 - format: int64 - type: integer - title: payment_method_spei_request - customer_payment_methods_request: - oneOf: - - $ref: "#/components/schemas/payment_method_token_request" - - $ref: "#/components/schemas/payment_method_cash_request" - - $ref: "#/components/schemas/payment_method_spei_request" - title: customer_payment_methods_request - customer_shipping_contacts_request: - description: |- - [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) - details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. + - $ref: '#/components/schemas/customer_payment_method_request' + - type: object + required: + - failure_url + - product_type + - success_url + - type + properties: + cancel_url: + type: string + description: Optional URL to redirect the customer after a canceled payment + example: https://example.com/cancel + expires_at: + type: integer + format: int64 + example: 1680397724 + description: Optional expiry for the BNPL order, expressed in seconds since the Unix epoch. Defaults to one month from creation when omitted. + failure_url: + type: string + description: URL to redirect the customer after a failed payment + example: https://example.com/failure + product_type: + type: string + example: aplazo_bnpl + description: Product type of the payment method, use for the payment method to know the product type + enum: + - aplazo_bnpl + - azteca_bnpl + - coppel_bnpl + - creditea_bnpl + success_url: + type: string + description: URL to redirect the customer after a successful payment + example: https://example.com/success + type: + type: string + example: bnpl + description: Type of the payment method + payment_method_card_request: + title: payment_method_card_request + allOf: + - $ref: '#/components/schemas/customer_payment_method_request' + - type: object + required: + - cvc + - name + - number + - exp_month + - exp_year + properties: + cvc: + type: string + example: '198' + description: Card security code + maxLength: 4 + minLength: 3 + exp_month: + type: string + example: '12' + description: Card expiration month + maxLength: 2 + minLength: 2 + exp_year: + type: string + example: '2025' + description: Card expiration year + maxLength: 4 + minLength: 4 + name: + type: string + maxLength: 249 + example: John Doe + description: Cardholder name. Must include first and last name separated by a space; single-word names are rejected. Letters (including accented Latin characters), spaces, and the characters , . ' - are accepted; digits and other symbols are rejected. + number: + type: string + example: '4242424242424242' + description: Card number + contract_id: + type: string + minLength: 10 + maxLength: 10 + example: '3456788363' + description: Optional merchant-supplied identifier (exactly 10 characters) that links a card transaction to a recurring/subscription contract at the acquiring bank. Forwarded to the bank gateway and stored on the resulting charge. Accepted on creation only; ignored on update. Do not place sensitive bank data here — the value is returned in charge responses. + customer_ip_address: + type: string + example: 0.0.0.0 + description: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes + charge_request: + title: charge_request + description: The charges to be made + required: + - payment_method properties: - phone: - description: Phone contact - example: "+525511223344" + amount: + type: integer + example: 40000 + format: int64 + description: Amount to be charged in cents + payment_method: + title: charge_request_payment_method + oneOf: + - $ref: '#/components/schemas/payment_method_pbb_request' + - $ref: '#/components/schemas/payment_method_bnpl_request' + - $ref: '#/components/schemas/payment_method_card_request' + - required: + - type + type: object + title: payment_method_general_request + description: | + Payment method used in the charge. Go to the [payment methods](https://developers.conekta.com/reference/m%C3%A9todos-de-pago) section for more details + properties: + expires_at: + type: integer + format: int64 + description: Method expiration date as unix timestamp + example: 1677196303 + monthly_installments: + type: integer + format: int8 + description: How many months without interest to apply, it can be 3, 6, 9, 12 or 18 + type: + type: string + description: Type of payment method + example: card + token_id: + type: string + example: tok_2897348234 + payment_source_id: + type: string + example: src_2tLkkyfMPh6v7pFry + cvc: + type: string + example: '123' + description: Optional, It is a value that allows identifying the security code of the card. Only for PCI merchants + contract_id: + type: string + description: Optional id sent to indicate the bank contract for recurrent card charges. + example: S781317595 + customer_ip_address: + type: string + description: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes + example: 0.0.0.0 + reference_id: + description: Custom reference to add to the charge + type: string + charge_order_response: + title: charge_order_response + type: object + properties: + amount: + type: integer + example: 4321 + channel: + type: object + properties: + segment: + type: string + example: Checkout + checkout_request_id: + type: string + example: 6fca054a-8519-4c43-971e-cea35cc519bb + checkout_request_type: + type: string + example: HostedPayment + id: + type: string + example: channel_2tNDzhA4Akmzj11AU + created_at: + type: integer + example: 1676386026 + format: int64 + currency: type: string - receiver: - description: Name of the person who will receive the order - example: Marvin Fuller + example: MXN + customer_id: type: string - between_streets: - description: The street names between which the order will be delivered. - Must contain at least two consecutive ASCII letters. - example: Ackerman Crescent - maxLength: 249 - pattern: "[A-Za-z]{2}" + description: type: string - address: - $ref: "#/components/schemas/customer_shipping_contacts_request_address" - parent_id: + example: Payment from order + device_fingerprint: + type: + - string + - 'null' + example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba + failure_code: type: string - default: - nullable: true - type: boolean - deleted: - nullable: true + example: suspected_fraud + failure_message: + type: string + example: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso. + id: + type: string + example: 63efa757cf65380001aec040 + livemode: type: boolean - metadata: - additionalProperties: true - description: Metadata associated with the shipping contact - maxProperties: 100 - type: object - required: - - address - title: customer_shipping_contacts_request - subscription_request: - description: "It is a parameter that allows to identify in the response, the\ - \ detailed content of the plans to which the client has subscribed" - properties: - plan_id: - example: f84gdgf5g48r15fd21g8w424fd1 + example: true + monthly_installments: + type: + - integer + - 'null' + object: type: string - card_id: - example: src_2qUCNd5AyQqfPMBuV + order_id: type: string - trial_end: - example: 1484040996 - type: integer - required: - - plan_id - title: subscription_request - customer: - description: a customer + example: ord_2tN73UdUSNrYRPD9r + paid_at: + type: + - integer + - 'null' + example: 1676390742 + payment_method: + title: charge_order_response_payment_method + propertyName: object + oneOf: + - $ref: '#/components/schemas/payment_method_cash' + - $ref: '#/components/schemas/payment_method_card' + - $ref: '#/components/schemas/payment_method_bank_transfer' + - $ref: '#/components/schemas/payment_method_bnpl_payment' + - $ref: '#/components/schemas/payment_method_pbb_payment' + discriminator: + propertyName: object + mapping: + cash_payment: payment_method_cash + card_payment: payment_method_card + bank_transfer_payment: payment_method_bank_transfer + bnpl_payment: payment_method_bnpl_payment + pay_by_bank_payment: payment_method_pbb_payment + reference_id: + type: + - string + - 'null' + description: Reference ID of the charge + example: ref_2tN73UdUSNrYRPD9r + refunds: + type: array + items: {} + status: + type: string + example: pending_payment + charges_order_response: + description: The charges associated with the order + title: charges_order_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/charge_response' + company_response: + type: object + title: company_response properties: - antifraud_info: - $ref: "#/components/schemas/customer_antifraud_info" - corporate: - default: false - description: It is a value that allows identifying if the email is corporate - or not. - example: false + id: + type: string + description: The unique identifier for the company. + example: 6827305a1ec60400015eb116 + name: + type: string + description: The name of the company. + example: test + active: type: boolean - custom_reference: - description: It is an undefined value. + description: Indicates if the company is active. + example: false + account_status: type: string - date_of_birth: - description: It is a parameter that allows to identify the date of birth - of the client. - example: 24/07/1992 + description: The current status of the company's account. + example: signed_up + parent_company_id: + type: + - string + - 'null' + description: The identifier of the parent company, if any. + example: 680bf1da38716d00013543bc + onboarding_status: type: string - email: - description: "An email address is a series of customizable characters followed\ - \ by a universal Internet symbol, the at symbol (@), the name of a host\ - \ server, and a web domain ending (.mx, .com, .org, . net, etc)." - example: miguel@gmail.com - format: email + description: The current status of the company's onboarding process. + example: pending + documents: + type: array + description: A list of documents related to the company. + items: + title: company_document_response + type: object + properties: + file_classification: + type: string + description: | + Classification of the document. + + | Tipo de archivo | Descripción | + | :--------------------------- | :-------------------------------------------------------- | + | `id_legal_representative` | identificación oficial frente | + | `id_legal_representative_back` | identificación oficial atrás | + | `cfdi` | Prueba de situación fiscal | + | `constitutive_act_basic` | Acta constitutiva | + | `proof_of_address` | Comprobante de domicilio del negocio | + | `power_of_attonery` | Poderes de representación | + | `deposit_account_cover` | Carátula de la cuenta de depósito | + | `permit_casino` | Permiso ante SEGOB | + | `license_sanitation` | Licencia sanitaria de COFEPRIS | + | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | + example: deposit_account_cover + enum: + - id_legal_representative + - id_legal_representative_back + - cfdi + - constitutive_act_basic + - proof_of_address + - power_of_attonery + - deposit_account_cover + - permit_casino + - license_sanitation + - registration_tourism + status: + type: string + description: The status of the document. + example: pending + file_name: + type: + - string + - 'null' + description: The name of the file. + example: null + created_at: + type: integer + format: int64 + description: Timestamp of when the company was created. + example: 1748968241 + object: type: string - default_payment_source_id: - description: "It is a parameter that allows to identify in the response,\ - \ the Conekta ID of a payment method (payment_id)" - example: src_1a2b3c4d5e6f7g8h + description: The type of object, typically "company". + example: company + three_ds_enabled: + type: boolean + description: Indicates if 3DS authentication is enabled for the company. + example: true + three_ds_mode: + type: + - string + - 'null' + description: The 3DS mode for the company, either 'smart' or 'strict'. This property is only applicable when three_ds_enabled is true. When three_ds_enabled is false, this field will be null. + example: strict + enum: + - smart + - strict + required: + - id + - name + - active + - account_status + - onboarding_status + - documents + - created_at + - object + create_company_request: + title: Create Company Request + type: object + properties: + name: type: string - default_shipping_contact_id: - description: "It is a parameter that allows to identify in the response,\ - \ the Conekta ID of the shipping address (shipping_contact)" - example: ship_cont_1a2b3c4d5e6f7g8h + description: The name of the company. + example: test + type_company: type: string - fiscal_entities: - items: - $ref: "#/components/schemas/fiscal_entity_request" - type: array - default: null - metadata: - additionalProperties: true - maxProperties: 100 + description: The type of company, 'owner' + example: owner + comercial_info: type: object - name: - description: Client's name - example: miguel + description: Commercial information for the company. + properties: + website: + type: string + format: url + description: The company's website URL. + example: http://www.test.com + mcc: + type: string + description: The Merchant Category Code (MCC) for the company. + example: '5812' + merchant_support_email: + type: string + format: email + description: Email address for merchant support. + example: test@test.com + merchant_support_phone: + type: string + description: Phone number for merchant support. + example: '5300000000' + fiscal_info: + type: object + description: Fiscal information for the company. + properties: + business_phone: + type: string + description: The business phone number for fiscal purposes. + example: '5300000000' + fiscal_type: + type: string + description: The fiscal type of the company (e.g., 'moral', 'persona_fisica'). + example: moral + bank_account_info: + type: object + description: Bank account information for the company. + properties: + clabe: + type: string + description: The 18-digit CLABE for the bank account. + example: '002010077777777771' + company_document_request: + type: object + title: CompanyDocumentRequest + description: Request body for uploading a company document. + properties: + file_classification: type: string - national_id: - description: It is a parameter that allows to identify the national identification - number of the client. - example: HEGG560427MVZRRL04 + description: | + Classification of the document. + + | Tipo de archivo | Descripción | + | :--------------------------- | :-------------------------------------------------------- | + | `id_legal_representative` | identificación oficial frente | + | `id_legal_representative_back` | identificación oficial atrás | + | `cfdi` | Prueba de situación fiscal | + | `constitutive_act_basic` | Acta constitutiva | + | `proof_of_address` | Comprobante de domicilio del negocio | + | `power_of_attonery` | Poderes de representación | + | `deposit_account_cover` | Carátula de la cuenta de depósito | + | `permit_casino` | Permiso ante SEGOB | + | `license_sanitation` | Licencia sanitaria de COFEPRIS | + | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | + example: id_legal_representative + enum: + - id_legal_representative + - id_legal_representative_back + - cfdi + - constitutive_act_basic + - proof_of_address + - power_of_attonery + - deposit_account_cover + - permit_casino + - license_sanitation + - registration_tourism + content_type: type: string - payment_sources: - description: Contains details of the payment methods that the customer has - active or has used in Conekta - items: - $ref: "#/components/schemas/customer_payment_methods_request" - type: array - default: null - phone: - description: Is the customer's phone number - example: "+5215555555555" + description: | + MIME type of the file. Allowed values depend on the `file_classification`. + - `image/jpeg` + - `image/png` + - `application/pdf` + example: application/pdf + international: + type: boolean + description: Indicates if the document is international. Defaults to false. + example: false + file_name: type: string - plan_id: - description: "Contains the ID of a plan, which could together with name,\ - \ email and phone create a client directly to a subscription" - example: plan_987234823 + description: Name of the file being uploaded. + example: example_document.pdf + file_data: type: string - shipping_contacts: - description: Contains the detail of the shipping addresses that the client - has active or has used in Conekta - items: - $ref: "#/components/schemas/customer_shipping_contacts_request" - type: array - default: null - subscription: - $ref: "#/components/schemas/subscription_request" + format: byte + description: Base64 encoded content of the file. + example: VGhpcyBpcyBhIHRlc3QgZmlsZSBkYXRhIGluIGJhc2UgNjQu required: - - email - - name - - phone - title: customer - update_customer_antifraud_info: - properties: - account_created_at: - example: 1484040996 - format: int64 - type: integer - first_paid_at: - example: 1485151007 - type: integer - update_customer: - description: update customer + - file_classification + - content_type + - file_name + - file_data + company_document_response: + type: object + title: CompanyDocumentResponse + description: Response body after uploading a company document. properties: - antifraud_info: - $ref: "#/components/schemas/update_customer_antifraud_info" - date_of_birth: - description: It is a parameter that allows to identify the date of birth - of the client. - example: 24/07/1992 + file_classification: + type: string + description: | + Classification of the document. + + | Tipo de archivo | Descripción | + | :--------------------------- | :-------------------------------------------------------- | + | `id_legal_representative` | identificación oficial frente | + | `id_legal_representative_back` | identificación oficial atrás | + | `cfdi` | Prueba de situación fiscal | + | `constitutive_act_basic` | Acta constitutiva | + | `proof_of_address` | Comprobante de domicilio del negocio | + | `power_of_attonery` | Poderes de representación | + | `deposit_account_cover` | Carátula de la cuenta de depósito | + | `permit_casino` | Permiso ante SEGOB | + | `license_sanitation` | Licencia sanitaria de COFEPRIS | + | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | + example: id_legal_representative + enum: + - id_legal_representative + - id_legal_representative_back + - cfdi + - constitutive_act_basic + - proof_of_address + - power_of_attonery + - deposit_account_cover + - permit_casino + - license_sanitation + - registration_tourism + file_name: type: string - default_payment_source_id: - description: "It is a parameter that allows to identify in the response,\ - \ the Conekta ID of a payment method (payment_id)" - example: src_1a2b3c4d5e6f7g8h + description: Name of the file as stored or processed. + example: prueba3.pdf + status: type: string - email: - description: "An email address is a series of customizable characters followed\ - \ by a universal Internet symbol, the at symbol (@), the name of a host\ - \ server, and a web domain ending (.mx, .com, .org, . net, etc)." - example: miguel@gmail.com + description: Current status of the document. + example: uploaded + required: + - file_classification + - file_name + - status + customer_address: + type: object + required: + - street1 + - city + - postal_code + properties: + street1: type: string - name: - description: Client's name - example: miguel + example: Nuevo Leon 254 + street2: type: string - phone: - description: Is the customer's phone number - example: "+5215555555555" + example: Departamento 404 + postal_code: type: string - plan_id: - description: "Contains the ID of a plan, which could together with name,\ - \ email and phone create a client directly to a subscription" - example: plan_987234823 + example: '06100' + city: type: string - default_shipping_contact_id: - description: "It is a parameter that allows to identify in the response,\ - \ the Conekta ID of the shipping address (shipping_contact)" - example: ship_cont_1a2b3c4d5e6f7g8h + example: Ciudad de Mexico + state: type: string - corporate: - default: false - description: It is a value that allows identifying if the email is corporate - or not. - example: false - type: boolean - custom_reference: - description: It is an undefined value. + example: Ciudad de Mexico + country: type: string - fiscal_entities: - items: - $ref: "#/components/schemas/fiscal_entity_request" - type: array - default: null - metadata: - additionalProperties: true - maxProperties: 100 - type: object - national_id: - description: It is a parameter that allows to identify the national identification - number of the client. - example: HEGG560427MVZRRL04 + example: MX + description: this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + external_number: type: string - payment_sources: - description: Contains details of the payment methods that the customer has - active or has used in Conekta - items: - $ref: "#/components/schemas/customer_payment_methods_request" - type: array - default: null - shipping_contacts: - description: Contains the detail of the shipping addresses that the client - has active or has used in Conekta - items: - $ref: "#/components/schemas/customer_shipping_contacts_request" - type: array - default: null - subscription: - $ref: "#/components/schemas/subscription_request" - title: update_customer - create_customer_fiscal_entities_response: - allOf: - - properties: - address: - $ref: "#/components/schemas/fiscal_entity_request_address" - tax_id: - type: string - email: - type: string - phone: - type: string - metadata: - additionalProperties: - type: object - company_name: - example: conekta - type: string - required: + customer_fiscal_entities_request: + title: fiscal_entity_request + required: - address - title: fiscal_entity_request - - properties: - id: - example: ship_cont_2tKZsTYcsryyu7Ah8 - type: string - object: - example: shipping_contact - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2tKcHxhTz7xU5SymF - type: string - default: - type: boolean - required: - - created_at - - id - - object - title: create_customer_fiscal_entities_response - update_fiscal_entity_request: properties: address: - $ref: "#/components/schemas/fiscal_entity_request_address" + allOf: + - $ref: '#/components/schemas/customer_address' tax_id: type: string email: @@ -18255,4538 +6564,5486 @@ components: phone: type: string metadata: + type: object additionalProperties: type: object company_name: - example: conekta type: string - title: update_fiscal_entity_request - update_customer_fiscal_entities_response: - allOf: - - properties: - address: - $ref: "#/components/schemas/fiscal_entity_request_address" - tax_id: - type: string - email: - type: string - phone: - type: string - metadata: - additionalProperties: - type: object - company_name: - example: conekta - type: string - required: - - address - title: fiscal_entity_request - - properties: - id: - example: fis_ent_2tKZsTYcsryyu7Ah8 - type: string - object: - example: fiscal_entities - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2tKcHxhTz7xU5SymF - type: string - default: - type: boolean - required: - - created_at - - id - - object - title: update_customer_fiscal_entities_response - discount_lines_response: - allOf: - - description: List of discounts that apply to the order. - properties: - amount: - description: "The amount to be deducted from the total sum of all payments,\ - \ in cents." - example: 500 - format: int64 - minimum: 0 - type: integer - code: - description: Discount code. - example: "123" - type: string - type: - description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" - example: loyalty - type: string - required: - - amount - - code + example: conekta + payment_method_response: + type: object + required: - type - title: order_discount_lines_request - name: order_discount_lines_request - - properties: - id: - description: The discount line id - example: dis_lin_2tQQ58HPgPw7StE8z - type: string - object: - description: The object name - example: discount_line - type: string - parent_id: - description: The order id - example: ord_2tPAmKCEJqh8RE6nY - type: string - required: - id - object - - parent_id - title: discount_lines_response - get_order_discount_lines_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/discount_lines_response" - type: array - default: null - title: get_order_discount_lines_response - order_discount_lines_request: - description: List of discounts that apply to the order. - properties: - amount: - description: "The amount to be deducted from the total sum of all payments,\ - \ in cents." - example: 500 - format: int64 - minimum: 0 - type: integer - code: - description: Discount code. - example: "123" - type: string - type: - description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" - example: loyalty - type: string - required: - - amount - - code - - type - title: order_discount_lines_request - name: order_discount_lines_request - update_order_discount_lines_request: - description: List of discounts that apply to the order. + - created_at properties: - amount: - example: 500 - format: int64 - minimum: 0 - type: integer - code: - description: Discount code. - example: "123" - type: string type: - example: loyalty type: string - title: update_order_discount_lines_request - WebhookLog: - properties: - failed_attempts: - example: 10 - type: integer id: - example: webhl_2svd2sh6GbqzyWBNZ type: string - last_attempted_at: - example: 1669651274 - type: integer - last_http_response_status: - example: 200 - format: int32 - type: integer + example: src_2s8K1B3PBKDontpi9 object: - example: webhook_log - type: string - response_data: - additionalProperties: true - example: - amount: 3000 - payable: true - maxProperties: 100 - type: object - url: - example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval - format: uri type: string - title: WebhookLog - event_response: - description: event model - properties: + example: payment_source created_at: - example: 1661445644 - format: int64 type: integer - data: - additionalProperties: true - example: - action: ping - livemode: true - maxProperties: 100 - type: object - id: - example: 6307a60c41de27127515a575 - type: string - livemode: - example: true - type: boolean - object: - example: event - type: string - type: - example: webhook_ping - type: string - webhook_logs: - items: - $ref: "#/components/schemas/WebhookLog" - type: array - default: null - webhook_status: - example: successful + format: int64 + example: 1675715413 + parent_id: type: string - title: event_response - get_events_response: + example: cus_2s8K1B3PBKDontpi8 + payment_method_cash_response: + x-discriminator-value: cash + title: payment_method_cash_response allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/event_response" - type: array - default: null - title: get_events_response - resendEvent_request: - properties: - webhooks_ids: - description: webhooks ids to resend event - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - items: - type: string - type: array - default: null - required: - - webhooks_ids - events_resend_response: - description: event model + - $ref: '#/components/schemas/payment_method_response' + - type: object + description: use for cash responses + properties: + agreements: + type: array + items: + type: object + title: cash_agreements_response + properties: + agreement: + type: string + example: '2409526' + description: Agreement number, you can use this number to pay in the store/bbva + provider: + type: string + example: bbva_cash_in + description: Provider name, you can use this to know where to pay + reference: + type: string + example: '93000262276908' + barcode: + type: string + example: '93000262276908' + barcode_url: + type: string + example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png + description: URL to the barcode image, reference is the same as barcode + expires_at: + type: integer + format: int64 + example: 1742483424 + provider: + type: string + example: Cash + payment_method_cash_recurrent_response: + title: payment_method_cash_recurrent_response + allOf: + - $ref: '#/components/schemas/payment_method_cash_response' + description: Alias of cash response used when type=cash_recurrent + x-discriminator-value: cash_recurrent + payment_method_card_response: + title: payment_method_card_response + allOf: + - $ref: '#/components/schemas/payment_method_response' + - type: object + description: use for card responses + properties: + last4: + type: string + example: '6410' + bin: + type: string + example: '40276657' + card_type: + type: string + example: debit + exp_month: + type: string + example: '10' + exp_year: + type: string + example: '25' + brand: + type: string + example: visa + issuer: + type: string + example: santander + description: Name of the institution that issued the card + name: + type: string + example: Fulano Perez" + default: + type: boolean + visible_on_checkout: + type: boolean + payment_source_status: + type: string + example: active + payment_method_spei_recurrent_response: + title: payment_method_spei_recurrent_response + x-discriminator-value: spei_recurrent + allOf: + - $ref: '#/components/schemas/payment_method_response' + - type: object + description: use for spei responses + properties: + bank: + type: string + example: STP + description: Bank name for the SPEI payment method + reference: + type: string + example: '93000262276908' + expires_at: + type: string + example: none + shipping_contact_address: + title: shipping_contact_address + type: object + description: Address of the person who will receive the order properties: - failed_attempts: - example: 6 - type: integer - id: - example: webhl_2svd2sh6GbqzyWBNZ + street1: type: string - last_attempted_at: - example: 1684265970 - type: integer - last_http_response_status: - example: 405 - format: int32 - type: integer - response_data: - additionalProperties: true - example: {} - maxProperties: 100 - type: object - url: - example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval - format: uri + minLength: 2 + maxLength: 249 + example: Nuevo Leon 254 + description: Street and number of the delivery address. + street2: type: string - title: events_resend_response - logs_response_data: - properties: - created_at: - example: 1661445644 - format: int64 - type: integer - id: - example: 6307a60c41de27127515a575 + maxLength: 249 + example: Departamento 404 + description: Apartment, suite or interior reference for the delivery address. + postal_code: type: string - ip_address: - example: 54.235.131.48 - format: ipv4 + maxLength: 250 + example: '06100' + description: Postal code of the delivery address. For Mexican addresses (country MX) it must be a 5-digit postal code. + city: type: string - livemode: + maxLength: 249 + pattern: '[A-Za-z]{2}' + example: Ciudad de Mexico + description: City of the delivery address. Must contain at least two consecutive ASCII letters. + state: + type: string + maxLength: 249 + example: Ciudad de Mexico + description: State of the delivery address. + country: + type: string + minLength: 2 + maxLength: 249 + example: MX + description: Country of the delivery address. This field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + residential: + type: + - boolean + - 'null' + default: true example: true - type: boolean - loggable_id: - example: ord_87632467832 - nullable: true + description: Indicates whether the delivery address is residential. + customer_shipping_contacts: + title: customer_shipping_contacts_request + description: |- + [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) + details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. + required: + - address + properties: + phone: type: string - loggable_type: - example: order - nullable: true + example: '+525511223344' + description: Phone contact + receiver: type: string - method: - example: POST + example: Marvin Fuller + description: Name of the person who will receive the order + between_streets: type: string - oauth_token_id: - nullable: true + maxLength: 249 + pattern: '[A-Za-z]{2}' + example: Ackerman Crescent + description: The street names between which the order will be delivered. Must contain at least two consecutive ASCII letters. + address: + allOf: + - $ref: '#/components/schemas/shipping_contact_address' + required: + - street1 + - postal_code + - country + parent_id: type: string - query_string: - additionalProperties: true - example: - amount: 3000 - payable: true + default: + type: + - boolean + - 'null' + deleted: + type: + - boolean + - 'null' + metadata: type: object - related: - example: FilterResource + additionalProperties: true + maxProperties: 100 + description: Metadata associated with the shipping contact + subscription_response: + title: subscription_response + description: subscription model + type: object + properties: + billing_cycle_start: + type: + - integer + - 'null' + example: 1677626827 + format: int64 + billing_cycle_end: + type: + - integer + - 'null' + example: 1677626827 + format: int64 + canceled_at: + type: + - integer + - 'null' + example: 1678258162 + format: int64 + canceled_reason: type: string - request_body: - example: - filters: - amount: - amount_from: 0 - amount_to: 0 - created_at: - date_from: 1653627600 - date_to: 1661489999 - filterName: Payments - sort_by: created_at - sort_direction: desc - status: [] - type: [] - id: 78e65162-0f37-4942-847c-9bf7081d54c2 - page: "0" - report_type: charges - testMode: false - type: object - request_headers: - additionalProperties: - type: string - example: - Accept: application/vnd.conekta-v2.3.0+json - Accept-Encoding: "gzip, deflate, br" - Accept-Language: "es-419, es; q=0.9, en; q=0.8" - Activitypermission: orders:read - Apiversion: 2.3.0 - response_body: - type: object - response_headers: - additionalProperties: - type: string - example: - Access-Control-Allow-Headers: "Content-Type, Depth, User-Agent, X-File-Size,\ - \ X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version,\ - \ Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection,\ - \ X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding,\ - \ Accept-Language, Referer, Origin, Activitypermission, Apiversion,\ - \ Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform,\ - \ Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id,\ - \ X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host,\ - \ X-Forwarded-Server, X-Real-Ip" - Access-Control-Allow-Methods: "POST, GET, PUT, OPTIONS" - Access-Control-Allow-Origin: '*' - Access-Control-Max-Age: "1728000" - Conekta-Media-Type: conekta-v2.3.0; format=application/json - Content-Type: application/json; charset=utf-8 - Referrer-Policy: strict-origin-when-cross-origin - Strict-Transport-Security: max-age=31536000; includeSubDomains - X-Content-Type-Options: nosniff - X-Download-Options: noopen - X-Frame-Options: SAMEORIGIN - X-Permitted-Cross-Domain-Policies: none - X-XSS-Protection: 1; mode=block - searchable_tags: - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - items: - type: string - type: array - default: null - status: - example: 200 + example: user_cancelation + description: Reason for cancellation. This field appears when the subscription status is 'canceled'. + card_id: type: string - updated_at: - example: 2022-08-25T16:40:44.887Z + example: src_2tKcHxhTz7xU5SymL + charge_id: + type: + - string + - 'null' + example: 2tKcHxhTz7xU5SymL + created_at: + type: integer + example: 1677626837 + format: int64 + customer_custom_reference: type: string - url: - example: /filter_resource + example: dotnet_123456 + customer_id: type: string - user_account_id: - example: 5a0b7001edbb6e1725b0b2c6 + example: cus_2tKcHxhTz7xU5SymF + id: type: string - version: - example: 2.3.0 + example: gold-plan + last_billing_cycle_order_id: type: string - title: logs_response_data - logs_response_for_request: - description: logs model - properties: - has_more: - description: "True, if there are more pages." - readOnly: true - type: boolean + example: ord_2tSoMP7bZJbLiq4z8 object: - description: The object type - readOnly: true type: string - next_page_url: - description: URL of the next page. - nullable: true + example: subscription + paused_at: + type: + - integer + - 'null' + example: 1678258162 + format: int64 + plan_id: type: string - previous_page_url: - description: Url of the previous page. - nullable: true + example: plan_2tXx672QLQ68CkmMn + status: type: string - data: - description: set to page results. - items: - $ref: "#/components/schemas/logs_response_data" - nullable: true - type: array - default: null - title: logs_response_for_request - log_response_for_request: - description: log model + example: past_due + subscription_start: + type: integer + example: 1677626837 + trial_start: + type: + - integer + - 'null' + example: 1677626837 + format: int64 + trial_end: + type: + - integer + - 'null' + example: 1677626837 + format: int64 + customer_response: + title: customer response + description: customer response + type: object + required: + - id + - livemode + - created_at + - object + - name properties: + antifraud_info: + title: customer_antifraud_info_response + type: + - object + - 'null' + properties: + first_paid_at: + type: integer + example: 1485151007 + account_created_at: + type: integer + example: 1484040996 + format: int64 + corporate: + type: boolean + description: true if the customer is a company created_at: - example: 1661445644 - format: int64 type: integer - id: - example: 6307a60c41de27127515a575 + format: int64 + example: 1485151007 + description: Creation date of the object + custom_reference: type: string - ip_address: - example: 54.235.131.48 - format: ipv4 + example: custom_reference + description: Custom reference + date_of_birth: type: string - livemode: - example: true - type: boolean - loggable_id: - example: ord_87632467832 - nullable: true + description: It is a parameter that allows to identify the date of birth of the client. + example: 24/07/1992 + default_fiscal_entity_id: + type: + - string + - 'null' + example: fis_ent_2tKqqAfqPi21oCmEJ + default_shipping_contact_id: type: string - loggable_type: - example: order - nullable: true + example: ship_cont_2tKZsTYcsryyu7Ah8 + default_payment_source_id: + type: + - string + - 'null' + example: src_2tHJfJ79KyUwpxTio + email: type: string - method: - example: POST + example: Felipe@gmail.com + format: email + fiscal_entities: + title: customer_fiscal_entities_response + allOf: + - $ref: '#/components/schemas/pagination' + - type: object + properties: + data: + type: array + items: + title: customer_fiscal_entities_data_response + allOf: + - $ref: '#/components/schemas/customer_fiscal_entities_request' + - type: object + required: + - id + - object + - created_at + properties: + id: + type: string + example: ship_cont_2tKZsTYcsryyu7Ah8 + object: + type: string + example: shipping_contact + created_at: + type: integer + format: int64 + example: 1675715413 + parent_id: + type: string + example: cus_2tKcHxhTz7xU5SymF + default: + type: boolean + id: type: string - oauth_token_id: - nullable: true + example: cus_2tHJfJ79KyUwpxTik + description: Customer's ID + livemode: + type: boolean + example: true + description: true if the object exists in live mode or the value false if the object exists in test mode + name: type: string - query_string: - additionalProperties: true - example: - amount: 3000 - payable: true - type: object - related: - example: FilterResource + example: Felipe + description: Customer's name + national_id: type: string - request_body: - example: - filters: - amount: - amount_from: 0 - amount_to: 0 - created_at: - date_from: 1653627600 - date_to: 1661489999 - filterName: Payments - sort_by: created_at - sort_direction: desc - status: [] - type: [] - id: 78e65162-0f37-4942-847c-9bf7081d54c2 - page: "0" - report_type: charges - testMode: false - type: object - request_headers: - additionalProperties: - type: string - example: - Accept: application/vnd.conekta-v2.3.0+json - Accept-Encoding: "gzip, deflate, br" - Accept-Language: "es-419, es; q=0.9, en; q=0.8" - Activitypermission: orders:read - Apiversion: 2.3.0 - response_body: + description: It is a parameter that allows to identify the national identification number of the client. + example: HEGG560427MVZRRL04 + metadata: type: object - response_headers: - additionalProperties: - type: string - example: - Access-Control-Allow-Headers: "Content-Type, Depth, User-Agent, X-File-Size,\ - \ X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version,\ - \ Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection,\ - \ X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding,\ - \ Accept-Language, Referer, Origin, Activitypermission, Apiversion,\ - \ Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform,\ - \ Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id,\ - \ X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host,\ - \ X-Forwarded-Server, X-Real-Ip" - Access-Control-Allow-Methods: "POST, GET, PUT, OPTIONS" - Access-Control-Allow-Origin: '*' - Access-Control-Max-Age: "1728000" - Conekta-Media-Type: conekta-v2.3.0; format=application/json - Content-Type: application/json; charset=utf-8 - Referrer-Policy: strict-origin-when-cross-origin - Strict-Transport-Security: max-age=31536000; includeSubDomains - X-Content-Type-Options: nosniff - X-Download-Options: noopen - X-Frame-Options: SAMEORIGIN - X-Permitted-Cross-Domain-Policies: none - X-XSS-Protection: 1; mode=block - searchable_tags: - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - items: - type: string - type: array - default: null - status: - example: 200 - type: string - updated_at: - example: 2022-08-25T16:40:44.887Z + additionalProperties: true + maxProperties: 100 + object: type: string - url: - example: /filter_resource + example: customer + payment_sources: + title: customer_payment_methods_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + title: customerPaymentMethods + properties: + data: + type: array + title: customer_payment_methods_data + items: + title: customer_payment_methods_data + discriminator: + propertyName: type + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + oneOf: + - $ref: '#/components/schemas/payment_method_cash_response' + - $ref: '#/components/schemas/payment_method_cash_recurrent_response' + - $ref: '#/components/schemas/payment_method_card_response' + - $ref: '#/components/schemas/payment_method_spei_recurrent_response' + phone: type: string - user_account_id: - example: 5a0b7001edbb6e1725b0b2c6 + example: '+5215555555555' + description: Customer's phone number + shipping_contacts: + allOf: + - $ref: '#/components/schemas/pagination' + - type: object + properties: + data: + type: array + items: + title: customer_shipping_contacts_data_response + allOf: + - $ref: '#/components/schemas/customer_shipping_contacts' + - type: object + required: + - id + - object + - created_at + properties: + id: + type: string + example: ship_cont_2tKZsTYcsryyu7Ah8 + object: + type: string + example: shipping_contact + created_at: + type: integer + format: int64 + example: 1675715413 + subscription: + title: customer_subscription_response + anyOf: + - $ref: '#/components/schemas/subscription_response' + - type: 'null' + payment_method_token_request: + title: payment_method_token_request + allOf: + - $ref: '#/components/schemas/customer_payment_method_request' + - type: object + required: + - token_id + properties: + token_id: + type: string + example: tok_32hj4g234as + description: Token id that will be used to create a "card" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.3.0/reference/createsubscription] tutorial for more information on how to tokenize cards. + payment_method_cash_request: + title: payment_method_cash_request + allOf: + - $ref: '#/components/schemas/customer_payment_method_request' + - type: object + properties: + expires_at: + type: integer + example: 1553273553 + format: int64 + payment_method_spei_request: + title: payment_method_spei_request + allOf: + - $ref: '#/components/schemas/customer_payment_method_request' + - type: object + properties: + expires_at: + type: integer + example: 1553273553 + format: int64 + subscription_request: + title: subscription_request + description: It is a parameter that allows to identify in the response, the detailed content of the plans to which the client has subscribed + type: object + required: + - plan_id + properties: + plan_id: type: string - version: - example: 2.3.0 + example: f84gdgf5g48r15fd21g8w424fd1 + card_id: type: string + example: src_2qUCNd5AyQqfPMBuV + trial_end: + type: integer + example: 1484040996 + customer: + title: customer + description: a customer + type: object required: - - created_at - - id - - livemode - title: log_response_for_request - order_channel_response: + - name + - email + - phone properties: - segment: - example: Checkout + antifraud_info: + type: + - object + - 'null' + properties: + account_created_at: + type: integer + example: 1484040996 + format: int64 + first_paid_at: + type: integer + format: int64 + example: 1485151007 + corporate: + type: boolean + description: It is a value that allows identifying if the email is corporate or not. + example: false + default: false + custom_reference: type: string - checkout_request_id: - example: 6fca054a-8519-4c43-971e-cea35cc519bb + description: It is an undefined value. + date_of_birth: type: string - checkout_request_type: - example: HostedPayment + description: It is a parameter that allows to identify the date of birth of the client. + example: 24/07/1992 + email: type: string - id: - example: channel_2tNDzhA4Akmzj11AU + description: An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). + example: miguel@gmail.com + format: email + default_payment_source_id: type: string - title: order_channel_response - charges_data_response: - allOf: - - properties: - amount: - example: 4321 - type: integer - channel: - $ref: "#/components/schemas/charge_response_channel" - created_at: - example: 1676386026 - format: int64 - type: integer - currency: - example: MXN - type: string - customer_id: - type: string - description: - example: Payment from order - type: string - device_fingerprint: - example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - type: string - failure_code: - example: suspected_fraud - type: string - failure_message: - example: Este cargo ha sido declinado porque el comportamiento del comprador - es sospechoso. - type: string - id: - description: Charge ID - example: 63efa757cf65380001aec040 - type: string - livemode: - description: Whether the charge was made in live mode or not - example: false - type: boolean - object: - example: charge - type: string - order_id: - description: Order ID - example: ord_2tN73UdUSNrYRPD9r - type: string - paid_at: - description: charge Payment date - example: 1676390742 - format: int64 - nullable: true - type: integer - payment_method: - $ref: "#/components/schemas/charge_response_payment_method" - reference_id: - description: Reference ID of the charge - example: ref_2tN73UdUSNrYRPD9r - nullable: true - type: string - refunds: - $ref: "#/components/schemas/charge_response_refunds" - chargeback: - $ref: "#/components/schemas/chargeback_response" - status: - description: Charge status - example: pending_payment - type: string - required: - - amount - - created_at - - currency - - id - - livemode - - object - - order_id - - status - title: charge_response - title: charges_data_response - order_charges_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/charges_data_response" - type: array - default: null - description: The charges associated with the order - title: order_charges_response - order_response_checkout: - properties: - allowed_payment_methods: - description: Are the payment methods available for this link - example: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - - apple - - google - items: - type: string + description: It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) + example: src_1a2b3c4d5e6f7g8h + default_shipping_contact_id: + type: string + description: It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) + example: ship_cont_1a2b3c4d5e6f7g8h + fiscal_entities: type: array - default: null - excluded_payment_methods: - description: Payment methods excluded from the checkout. This field is only - returned when excluded_payment_methods is provided in the request. - example: - - cash - - bank_transfer items: - enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - type: string - title: order_response_excluded_payment_methods + $ref: '#/components/schemas/customer_fiscal_entities_request' + metadata: + type: object + additionalProperties: true + maxProperties: 100 + name: + type: string + description: Client's name + example: miguel + national_id: + type: string + description: It is a parameter that allows to identify the national identification number of the client. + example: HEGG560427MVZRRL04 + payment_sources: + description: Contains details of the payment methods that the customer has active or has used in Conekta type: array - default: null - can_not_expire: - example: false - type: boolean - emails_sent: - example: 0 - type: integer - exclude_card_networks: - example: - - visa - - amex items: - enum: - - visa - - mastercard - - amex - type: string - title: order_response_exclude_card_networks + title: customer_payment_methods_request + oneOf: + - $ref: '#/components/schemas/payment_method_token_request' + - $ref: '#/components/schemas/payment_method_cash_request' + - $ref: '#/components/schemas/payment_method_spei_request' + phone: + type: string + description: Is the customer's phone number + example: '+5215555555555' + plan_id: + type: string + example: plan_987234823 + description: Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription + shipping_contacts: + description: Contains the detail of the shipping addresses that the client has active or has used in Conekta type: array - default: null - expires_at: - example: 1676613599 - format: int64 - type: integer - failure_url: - example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx + items: + $ref: '#/components/schemas/customer_shipping_contacts' + subscription: + description: It is a parameter that allows to identify in the response, the detailed content of the plans to which the client has subscribed + $ref: '#/components/schemas/subscription_request' + update_customer: + title: update_customer + description: update customer + type: object + properties: + antifraud_info: + type: + - object + - 'null' + properties: + account_created_at: + type: integer + example: 1484040996 + format: int64 + first_paid_at: + type: integer + example: 1485151007 + date_of_birth: type: string - force_3ds_flow: - example: false - type: boolean - force_save_card: - description: Indicates whether the card used for the payment should be saved - for future purchases. This field is only applicable for card payments. - example: false - nullable: true - type: boolean - id: - example: 6fca054a-8519-4c43-971e-cea35cc519bb + description: It is a parameter that allows to identify the date of birth of the client. + example: 24/07/1992 + default_payment_source_id: type: string - is_redirect_on_failure: - example: false + description: It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) + example: src_1a2b3c4d5e6f7g8h + email: + type: string + description: An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). + example: miguel@gmail.com + name: + type: string + description: Client's name + example: miguel + phone: + type: string + description: Is the customer's phone number + example: '+5215555555555' + plan_id: + type: string + example: plan_987234823 + description: Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription + default_shipping_contact_id: + type: string + description: It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) + example: ship_cont_1a2b3c4d5e6f7g8h + corporate: type: boolean - livemode: + description: It is a value that allows identifying if the email is corporate or not. example: false - type: boolean - max_failed_retries: - description: Number of retries allowed before the checkout is marked as - failed - example: 3 - format: int8 - nullable: true - type: integer + default: false + custom_reference: + type: string + description: It is an undefined value. + fiscal_entities: + type: array + items: + $ref: '#/components/schemas/customer_fiscal_entities_request' metadata: + type: object additionalProperties: true maxProperties: 100 - type: object - monthly_installments_enabled: - example: false - type: boolean - monthly_installments_options: + national_id: + type: string + description: It is a parameter that allows to identify the national identification number of the client. + example: HEGG560427MVZRRL04 + payment_sources: + description: Contains details of the payment methods that the customer has active or has used in Conekta + type: array items: - format: int8 - type: integer + title: customer_payment_methods_request + oneOf: + - $ref: '#/components/schemas/payment_method_token_request' + - $ref: '#/components/schemas/payment_method_cash_request' + - $ref: '#/components/schemas/payment_method_spei_request' + shipping_contacts: + description: Contains the detail of the shipping addresses that the client has active or has used in Conekta type: array - default: null - name: - example: ord-2tNDzhA4Akmzj11AS + items: + $ref: '#/components/schemas/customer_shipping_contacts' + subscription: + description: It is a parameter that allows to identify in the response, the detailed content of the plans to which the client has subscribed + $ref: '#/components/schemas/subscription_request' + customer_update_fiscal_entities_request: + title: update_fiscal_entity_request + properties: + address: + allOf: + - $ref: '#/components/schemas/customer_address' + tax_id: type: string - needs_shipping_contact: - example: false - type: boolean - object: - example: checkout + email: type: string - on_demand_enabled: - example: true - nullable: true - type: boolean - paid_payments_count: - example: 0 - type: integer - recurrent: - example: false - type: boolean - redirection_time: - description: number of seconds to wait before redirecting to the success_url - example: 2 - format: int8 - nullable: true - type: integer - slug: - example: 6fca054a85194c43971ecea35cc519bb + phone: type: string - sms_sent: - example: 0 - type: integer - success_url: - description: "Redirection url back to the site in case of successful payment,\ - \ applies only to HostedPayment" - example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx - format: uri + metadata: + type: object + additionalProperties: + type: object + company_name: type: string - starts_at: - example: 1676354400 + example: conekta + order_discount_lines_request: + title: order_discount_lines_request + name: order_discount_lines_request + description: List of discounts that apply to the order. + required: + - amount + - code + - type + properties: + amount: type: integer - status: - example: Issued + format: int64 + example: 500 + minimum: 0 + description: The amount to be deducted from the total sum of all payments, in cents. + code: type: string + description: Discount code. + example: '123' type: - description: "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." - example: HostedPayment type: string - url: - description: "Indicate the url of the Conekta component to complete the\ - \ payment. For HostedPayment, this will be a Conekta-hosted page" - example: https://pay.conekta.io/checkout/6fca054a85194c43971ecea35cc519bb - format: uri - type: string - required: - - id - - livemode - - name - - object - - type - order_response_customer_info: - allOf: - - properties: - object: - example: customer_info - type: string - - properties: - customer_custom_reference: - description: Custom reference - example: custom_reference - nullable: true - type: string - name: - example: DevTest - type: string - email: - example: test@conekta.com - format: email - type: string - phone: - example: "5522997233" - type: string - corporate: - default: false - type: boolean - object: - example: customer_info - type: string - title: order_customer_info_response - - properties: - customer_id: - example: cus_23874283647 - type: string - title: customer_info_response - discount_lines_data_response: + example: loyalty + description: It can be 'loyalty', 'campaign', 'coupon' o 'sign' + discount_lines_response: + title: discount_lines_response allOf: - - allOf: - - description: List of discounts that apply to the order. - properties: - amount: - description: "The amount to be deducted from the total sum of all payments,\ - \ in cents." - example: 500 - format: int64 - minimum: 0 - type: integer - code: - description: Discount code. - example: "123" - type: string - type: - description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" - example: loyalty - type: string - required: - - amount - - code - - type - title: order_discount_lines_request - name: order_discount_lines_request - - properties: - id: - description: The discount line id - example: dis_lin_2tQQ58HPgPw7StE8z - type: string - object: - description: The object name - example: discount_line - type: string - parent_id: - description: The order id - example: ord_2tPAmKCEJqh8RE6nY - type: string + - $ref: '#/components/schemas/order_discount_lines_request' + - type: object required: - - id - - object - - parent_id - title: discount_lines_response - title: discount_lines_data_response - order_response_discount_lines: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/discount_lines_data_response" - type: array - default: null - description: List of discounts that are applied to the order - nullable: true - order_tax_request_metadata_value: - anyOf: - - maxLength: 249 - type: string - - type: integer - - type: number - - type: boolean - tax_lines_data_response: - allOf: - - allOf: - - description: create new taxes for an existing order + - id + - object + - parent_id properties: - amount: - description: The amount to be collected for tax in cents - example: 100 - format: int64 - minimum: 0 - type: integer - description: - description: description or tax's name - example: testing - minLength: 3 - type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - example: - key: value - maxProperties: 100 - required: - - amount - - description - title: order_tax_request - - properties: - id: - example: tax_lin_2tQ8dC5mg1UADmVPo - type: string - object: - example: tax_line - type: string - parent_id: - example: ord_2tPAmKCEJqh8RE6nY - type: string - description: create new taxes for an existing order response - required: - - id - title: order_tax_response - title: tax_lines_data_response - order_response_tax_lines: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/tax_lines_data_response" - type: array - default: null - description: List of taxes that are applied to the order - nullable: true - shipping_lines_data_response: - allOf: - - allOf: - - properties: - amount: - description: Shipping amount in cents - example: 100 - format: int64 - minimum: 0 - type: integer - carrier: - description: Carrier name for the shipment - example: FEDEX - maxLength: 249 - minLength: 3 - type: string - tracking_number: - description: Tracking number can be used to track the shipment - example: TRACK123 - maxLength: 249 - minLength: 3 - type: string - method: - description: Method of shipment - example: Same day - maxLength: 249 - minLength: 3 - type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - description: "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." - example: - key: value - maxProperties: 100 - required: - - amount - title: shipping_request - - properties: id: - type: string - object: - type: string - parent_id: - type: string - title: shipping_order_response - title: shipping_lines_data_response - order_response_shipping_lines: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/shipping_lines_data_response" - type: array - default: null - description: List of shipping costs applied to the order - nullable: true - order_fiscal_entity_address_response: - allOf: - - description: Address of the fiscal entity - properties: - street1: - description: Street name and number - example: Nuevo Leon 254 - type: string - street2: - description: Street name and number - example: Departamento 404 - nullable: true - type: string - postal_code: - description: Postal code - example: "06100" - type: string - city: - description: City - example: Ciudad de Mexico - type: string - state: - description: State - example: Ciudad de Mexico - type: string - country: - description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - example: MX - type: string - external_number: - description: External number - example: "123" - type: string - required: - - city - - country - - external_number - - postal_code - - street1 - title: fiscal_entity_address - - properties: - object: - example: fiscal_entity_address - type: string - description: Address of the fiscal entity - title: order_fiscal_entity_address_response - order_fiscal_entity_response: - description: "Fiscal entity of the order, Currently it is a purely informative\ - \ field" + type: string + example: dis_lin_2tQQ58HPgPw7StE8z + description: The discount line id + object: + type: string + example: discount_line + description: The object name + parent_id: + type: string + example: ord_2tPAmKCEJqh8RE6nY + description: The order id + update_order_discount_lines_request: + title: update_order_discount_lines_request + description: List of discounts that apply to the order. properties: - address: - $ref: "#/components/schemas/order_fiscal_entity_address_response" - email: - description: Email of the fiscal entity - example: test@gmail.com - nullable: true + amount: + type: integer + format: int64 + example: 500 + minimum: 0 + code: type: string - metadata: + description: Discount code. + example: '123' + type: + type: string + example: loyalty + event_response: + title: event_response + description: event model + type: object + properties: + created_at: + type: integer + format: int64 + example: 1661445644 + data: additionalProperties: true - description: Metadata associated with the fiscal entity maxProperties: 100 type: object - name: - description: Name of the fiscal entity - example: Conekta Inc - nullable: true - type: string - tax_id: - description: Tax ID of the fiscal entity - example: "324234234" - nullable: true - type: string + example: + action: ping + livemode: true id: - description: ID of the fiscal entity - example: fis_ent_2tN85VYaSMyDvjB3M type: string - created_at: - description: The time at which the object was created in seconds since the - Unix epoch - example: 1676328434 - format: int64 - type: integer + example: 6307a60c41de27127515a575 + livemode: + type: boolean + example: true object: - example: fiscal_entity type: string - phone: - description: Phone of the fiscal entity - example: "+525511223344" - nullable: true + example: event + type: type: string - required: - - address - - created_at - - id - - object - title: order_fiscal_entity_response - product_data_response: - allOf: - - properties: - antifraud_info: - additionalProperties: true - example: - key: value + example: webhook_ping + webhook_logs: + type: array + items: type: object - brand: - description: The brand of the item. - example: Cohiba - maxLength: 249 - minLength: 2 - type: string - description: - description: Short description of the item - example: Imported From Mex. - maxLength: 249 - minLength: 3 - type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - default: {} - description: "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." - example: - key: value - maxProperties: 100 - name: - description: The name of the item. It will be displayed in the order. - example: Box of Cohiba S1s - maxLength: 249 - minLength: 3 - type: string - quantity: - description: The quantity of the item in the order. - example: 1 - format: int32 - minimum: 1 - type: integer - sku: - description: The stock keeping unit for the item. It is used to identify - the item in the order. - example: XYZ12345 - maxLength: 249 - minLength: 1 - type: string - tags: - description: List of tags for the item. It is used to identify the item - in the order. - example: - - food - - mexican food - items: - maxLength: 249 - minLength: 2 - type: string - minItems: 1 - type: array - default: null - unit_price: - description: The price of the item in cents. - example: 20000 - format: int32 - minimum: 0 - type: integer - required: - - name - - quantity - - unit_price - title: product - - properties: - id: - type: string - object: - type: string - parent_id: - type: string - title: product_data_response - order_response_products: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true + title: WebhookLog + properties: + failed_attempts: + type: integer + example: 10 + id: + type: string + example: webhl_2svd2sh6GbqzyWBNZ + last_attempted_at: + type: integer + example: 1669651274 + last_http_response_status: + type: integer + format: int32 + example: 200 + object: + type: string + example: webhook_log + response_data: + additionalProperties: true + maxProperties: 100 + type: object + example: + amount: 3000 + payable: true + url: + type: string + example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval + format: uri + webhook_status: + type: string + example: successful + resend_request: + type: object + required: + - webhooks_ids + properties: + webhooks_ids: + type: array + items: type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/product_data_response" - type: array - default: null - title: order_response_products - order_next_action_response_redirect_to_url: - description: contains the following attributes that will guide to continue the - flow + example: + - 6307a60c41de27127515a575 + - 6307a60c41de27127515a571 + description: webhooks ids to resend event + events_resend_response: + title: events_resend_response + description: event model + type: object properties: + failed_attempts: + type: integer + example: 6 + id: + type: string + example: webhl_2svd2sh6GbqzyWBNZ + last_attempted_at: + type: integer + example: 1684265970 + last_http_response_status: + type: integer + format: int32 + example: 405 + response_data: + additionalProperties: true + maxProperties: 100 + type: object + example: {} url: - description: "pay.conekta.com/{id} Indicates the url of the Conekta component\ - \ to authenticate the flow through 3DS2." - example: https://pay.conekta.com/6fca054a85194c43971ecea35cc519bb - format: uri type: string - return_url: - description: "Indicates the url to which the 3DS2 flow returns at the end,\ - \ when the integration is redirected." - example: https://my-website.com" + example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval format: uri - type: string - order_next_action_response: - description: contains the following attributes that will guide to continue the - flow - properties: - redirect_to_url: - $ref: "#/components/schemas/order_next_action_response_redirect_to_url" - type: - description: Indicates the type of action to be taken - example: redirect_to_url - type: string - title: order_next_action_response - customer_shipping_contacts_address: + logs_response: + title: logs_response_for_request + description: logs model + type: object properties: + has_more: + description: True, if there are more pages. + type: boolean + readOnly: true object: - example: shipping_address - type: string - street1: - example: Nuevo Leon 254 - type: string - street2: - example: Departamento 404 - type: string - postal_code: - example: "06100" - type: string - city: - example: Ciudad de Mexico - type: string - state: - example: Ciudad de Mexico - type: string - country: - example: MX + description: The object type type: string - residential: - example: true - nullable: true - type: boolean - title: customer_shipping_contacts_address - order_response_shipping_contact: - allOf: - - properties: - created_at: - format: int64 - type: integer - id: - type: string - object: - type: string - - description: Contains the detail of the shipping addresses that the client - has active or has used in Conekta - properties: - phone: - example: "+525511223344" - type: string - receiver: - example: Marvin Fuller - type: string - between_streets: - example: Ackerman Crescent - nullable: true - type: string - address: - $ref: "#/components/schemas/customer_shipping_contacts_address" - parent_id: - type: string - default: - example: false - type: boolean - id: - example: adr_1234567890 - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - metadata: - additionalProperties: true - description: Metadata associated with the shipping contact - maxProperties: 100 - type: object - object: - example: shipping_contact - type: string - deleted: - example: false - type: boolean - title: customer_shipping_contacts_response - order_response: - description: order response + readOnly: true + next_page_url: + description: URL of the next page. + type: + - string + - 'null' + previous_page_url: + description: Url of the previous page. + type: + - string + - 'null' + data: + description: set to page results. + type: + - array + - 'null' + items: + title: logs_response_data + properties: + created_at: + type: integer + format: int64 + example: 1661445644 + id: + type: string + example: 6307a60c41de27127515a575 + ip_address: + type: string + format: ipv4 + example: 54.235.131.48 + livemode: + type: boolean + example: true + loggable_id: + type: + - string + - 'null' + example: ord_87632467832 + loggable_type: + type: + - string + - 'null' + example: order + method: + type: string + example: POST + oauth_token_id: + type: + - string + - 'null' + query_string: + type: object + additionalProperties: true + example: + amount: 3000 + payable: true + related: + type: string + example: FilterResource + request_body: + type: object + example: + filters: + amount: + amount_from: 0 + amount_to: 0 + created_at: + date_from: 1653627600 + date_to: 1661489999 + filterName: Payments + search_term: null + sort_by: created_at + sort_direction: desc + status: [] + type: [] + id: 78e65162-0f37-4942-847c-9bf7081d54c2 + page: '0' + report_type: charges + testMode: false + request_headers: + type: object + additionalProperties: + type: string + example: + Accept: application/vnd.conekta-v2.3.0+json + Accept-Encoding: gzip, deflate, br + Accept-Language: es-419, es; q=0.9, en; q=0.8 + Activitypermission: orders:read + Apiversion: 2.3.0 + response_body: + type: object + response_headers: + type: object + additionalProperties: + type: string + example: + Access-Control-Allow-Headers: Content-Type, Depth, User-Agent, X-File-Size, X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version, Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection, X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding, Accept-Language, Referer, Origin, Activitypermission, Apiversion, Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform, Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id, X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host, X-Forwarded-Server, X-Real-Ip + Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS + Access-Control-Allow-Origin: '*' + Access-Control-Max-Age: '1728000' + Conekta-Media-Type: conekta-v2.3.0; format=application/json + Content-Type: application/json; charset=utf-8 + Referrer-Policy: strict-origin-when-cross-origin + Strict-Transport-Security: max-age=31536000; includeSubDomains + X-Content-Type-Options: nosniff + X-Download-Options: noopen + X-Frame-Options: SAMEORIGIN + X-Permitted-Cross-Domain-Policies: none + X-XSS-Protection: 1; mode=block + searchable_tags: + type: array + items: + type: string + example: + - 6307a60c41de27127515a575 + - 6307a60c41de27127515a571 + status: + type: string + example: 200 + updated_at: + type: string + example: '2022-08-25T16:40:44.887Z' + url: + type: string + example: /filter_resource + user_account_id: + type: string + example: 5a0b7001edbb6e1725b0b2c6 + version: + type: string + example: 2.3.0 + log_response: + title: log_response_for_request + description: log model + type: object + required: + - created_at + - id + - livemode properties: - amount: - description: The total amount to be collected in cents - example: 21605 - type: integer - amount_refunded: - description: The total amount refunded in cents - example: 0 - type: integer - channel: - $ref: "#/components/schemas/order_channel_response" - charges: - $ref: "#/components/schemas/order_charges_response" - checkout: - $ref: "#/components/schemas/order_response_checkout" created_at: - description: The time at which the object was created in seconds since the - Unix epoch - example: 1676328434 - format: int64 type: integer - currency: - description: The three-letter ISO 4217 currency code. The currency of the - order. - example: MXN - type: string - customer_info: - $ref: "#/components/schemas/order_response_customer_info" - discount_lines: - $ref: "#/components/schemas/order_response_discount_lines" - tax_lines: - $ref: "#/components/schemas/order_response_tax_lines" - shipping_lines: - $ref: "#/components/schemas/order_response_shipping_lines" - fiscal_entity: - $ref: "#/components/schemas/order_fiscal_entity_response" + format: int64 + example: 1661445644 id: - example: ord_2tMtQQpDvfnNjiuFG type: string - is_refundable: - example: false - type: boolean - line_items: - $ref: "#/components/schemas/order_response_products" + example: 6307a60c41de27127515a575 + ip_address: + type: string + format: ipv4 + example: 54.235.131.48 livemode: - description: Whether the object exists in live mode or test mode - example: false type: boolean - metadata: - additionalProperties: true - description: 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. - maxProperties: 100 - type: object - next_action: - $ref: "#/components/schemas/order_next_action_response" - object: - description: String representing the object’s type. Objects of the same - type share the same value. + example: true + loggable_id: + type: + - string + - 'null' + example: ord_87632467832 + loggable_type: + type: + - string + - 'null' example: order + method: type: string - payment_status: - description: The payment status of the order. - example: paid - type: string - processing_mode: - description: "Indicates the processing mode for the order, either ecommerce,\ - \ recurrent or validation." - example: ecommerce + example: POST + oauth_token_id: + type: + - string + - 'null' + query_string: + type: object + additionalProperties: true + example: + amount: 3000 + payable: true + related: type: string - shipping_contact: - $ref: "#/components/schemas/order_response_shipping_contact" - updated_at: - description: The time at which the object was last updated in seconds since - the Unix epoch - example: 1676328434 - format: int64 - type: integer - title: order_response - get_orders_response: - allOf: - - properties: - data: - items: - $ref: "#/components/schemas/order_response" - type: array - default: null - required: - - data - title: orders_response - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - title: get_orders_response - order_checkout_request: - description: | - [Checkout](https://developers.conekta.com/v2.3.0/reference/payment-link) details - properties: - allowed_payment_methods: - description: "Are the payment methods available for this link. For subscriptions,\ - \ only 'card' is allowed due to the recurring nature of the payments.\ - \ This field is mutually exclusive with excluded_payment_methods." + example: FilterResource + request_body: + type: object example: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - - apple - - google - items: - enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - - apple - - google + filters: + amount: + amount_from: 0 + amount_to: 0 + created_at: + date_from: 1653627600 + date_to: 1661489999 + filterName: Payments + search_term: null + sort_by: created_at + sort_direction: desc + status: [] + type: [] + id: 78e65162-0f37-4942-847c-9bf7081d54c2 + page: '0' + report_type: charges + testMode: false + request_headers: + type: object + additionalProperties: type: string - type: array - default: null - excluded_payment_methods: - description: Payment methods to be excluded from the checkout. This field - is mutually exclusive with allowed_payment_methods. example: - - cash - - bank_transfer - items: - enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank + Accept: application/vnd.conekta-v2.3.0+json + Accept-Encoding: gzip, deflate, br + Accept-Language: es-419, es; q=0.9, en; q=0.8 + Activitypermission: orders:read + Apiversion: 2.3.0 + response_body: + type: object + response_headers: + type: object + additionalProperties: type: string - title: checkout_request_excluded_payment_methods - type: array - default: null - exclude_card_networks: - description: "List of card networks to exclude from the checkout. This field\ - \ is only applicable for card payments. Accepted values: 'visa_master_card'\ - \ (a single token excluding both Visa and Mastercard) and 'amex'." example: - - visa_master_card - items: - enum: - - visa_master_card - - amex - type: string - title: checkout_request_exclude_card_networks + Access-Control-Allow-Headers: Content-Type, Depth, User-Agent, X-File-Size, X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version, Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection, X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding, Accept-Language, Referer, Origin, Activitypermission, Apiversion, Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform, Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id, X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host, X-Forwarded-Server, X-Real-Ip + Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS + Access-Control-Allow-Origin: '*' + Access-Control-Max-Age: '1728000' + Conekta-Media-Type: conekta-v2.3.0; format=application/json + Content-Type: application/json; charset=utf-8 + Referrer-Policy: strict-origin-when-cross-origin + Strict-Transport-Security: max-age=31536000; includeSubDomains + X-Content-Type-Options: nosniff + X-Download-Options: noopen + X-Frame-Options: SAMEORIGIN + X-Permitted-Cross-Domain-Policies: none + X-XSS-Protection: 1; mode=block + searchable_tags: type: array - default: null - plan_ids: - description: List of plan IDs that will be available for subscription. This - field is required for subscription payments. - example: - - plan_123 - - plan_456 items: type: string - type: array - default: null - expires_at: - description: "It is the time when the link will expire. \nIt is expressed\ - \ in seconds since the Unix epoch. The valid range is from 5 minutes to\ - \ 365 days from the creation date.\n" - format: int64 - minimum: 1 - type: integer - failure_url: - description: "Redirection url back to the site in case of failed payment,\ - \ applies only to HostedPayment." - example: https://www.mysite.com/failure - format: uri - type: string - force_save_card: - description: Indicates whether the card used for the payment should be saved - for future purchases. This field is only applicable for card payments. - example: false - type: boolean - monthly_installments_enabled: - example: false - type: boolean - monthly_installments_options: example: - - 3 - - 6 - - 12 - items: - format: int8 - type: integer - type: array - default: null - max_failed_retries: - description: Number of retries allowed before the checkout is marked as - failed - example: 3 - format: int8 - type: integer - name: - description: Reason for payment + - 6307a60c41de27127515a575 + - 6307a60c41de27127515a571 + status: type: string - on_demand_enabled: - example: true - type: boolean - redirection_time: - description: number of seconds to wait before redirecting to the success_url - example: 10 - format: int8 - type: integer - success_url: - description: "Redirection url back to the site in case of successful payment,\ - \ applies only to HostedPayment" - example: https://www.mysite.com/success - format: uri + example: 200 + updated_at: type: string - type: - description: "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." - enum: - - Integration - - HostedPayment + example: '2022-08-25T16:40:44.887Z' + url: type: string - title: order_checkout_request - customer_info: + example: /filter_resource + user_account_id: + type: string + example: 5a0b7001edbb6e1725b0b2c6 + version: + type: string + example: 2.3.0 + order_customer_info_response: + title: order_customer_info_response + type: object properties: + customer_custom_reference: + type: + - string + - 'null' + example: custom_reference + description: Custom reference name: - example: DevTest type: string + example: DevTest email: - example: test@conekta.com - format: email type: string + format: email + example: test@conekta.com phone: - example: "5522997233" type: string + example: '5522997233' corporate: + default: false type: boolean object: - example: customer_info type: string - required: - - email - - name - - phone - title: customer_info - customer_info_customer_id: + example: customer_info + customer_info_just_customer_id_response: + title: customer_info_response + type: object properties: customer_id: + type: string example: cus_23874283647 + order_tax_request: + title: order_tax_request + description: create new taxes for an existing order + type: object + required: + - amount + - description + properties: + amount: + type: integer + example: '100' + format: int64 + minimum: 0 + description: The amount to be collected for tax in cents + description: type: string + example: testing + minLength: 3 + description: description or tax's name + metadata: + type: object + additionalProperties: + anyOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean + example: + key: value + maxProperties: 100 + update_order_tax_response: + title: order_tax_response + description: create new taxes for an existing order response required: - - customer_id - title: customer_info_customer_id - order_request_customer_info: - description: Customer information - oneOf: - - $ref: "#/components/schemas/customer_info" - - $ref: "#/components/schemas/customer_info_customer_id" + - id + allOf: + - $ref: '#/components/schemas/order_tax_request' + - type: object + properties: + id: + type: string + example: tax_lin_2tQ8dC5mg1UADmVPo + object: + type: string + example: tax_line + parent_id: + type: string + example: ord_2tPAmKCEJqh8RE6nY + shipping_request: + title: shipping_request + required: + - amount + properties: + amount: + type: integer + format: int64 + example: 100 + minimum: 0 + description: Shipping amount in cents + carrier: + type: string + minLength: 3 + maxLength: 249 + example: FEDEX + description: Carrier name for the shipment + tracking_number: + type: string + minLength: 3 + maxLength: 249 + example: TRACK123 + description: Tracking number can be used to track the shipment + method: + type: string + minLength: 3 + maxLength: 249 + example: Same day + description: Method of shipment + metadata: + description: 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. + type: object + additionalProperties: + anyOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean + example: + key: value + maxProperties: 100 + shipping_order_response: + title: shipping_order_response + allOf: + - $ref: '#/components/schemas/shipping_request' + - type: object + properties: + id: + type: string + object: + type: string + parent_id: + type: string fiscal_entity_address: + title: fiscal_entity_address + required: + - street1 + - city + - country + - postal_code + - external_number + type: object description: Address of the fiscal entity properties: street1: - description: Street name and number - example: Nuevo Leon 254 type: string - street2: + example: Nuevo Leon 254 description: Street name and number + street2: + type: + - string + - 'null' example: Departamento 404 - nullable: true - type: string + description: Street name and number postal_code: - description: Postal code - example: "06100" type: string + example: '06100' + description: Postal code city: - description: City - example: Ciudad de Mexico type: string - state: - description: State example: Ciudad de Mexico + description: City + state: type: string + example: Ciudad de Mexico + description: State country: - description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - example: MX type: string + example: MX + description: this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) external_number: - description: External number - example: "123" - type: string - required: - - city - - country - - external_number - - postal_code - - street1 - title: fiscal_entity_address - order_fiscal_entity_request: - description: "Fiscal entity of the order, Currently it is a purely informative\ - \ field" - properties: - address: - $ref: "#/components/schemas/fiscal_entity_address" - email: - description: Email of the fiscal entity - example: test@gmail.com - type: string - metadata: - additionalProperties: true - description: Metadata associated with the fiscal entity - maxProperties: 100 - type: object - name: - description: Name of the fiscal entity - example: Conekta Inc - nullable: true - type: string - phone: - description: Phone of the fiscal entity - example: "+525511223344" - type: string - tax_id: - description: Tax ID of the fiscal entity - example: AAA010101AAA - nullable: true type: string - required: - - address - title: order_fiscal_entity_request + example: '123' + description: External number product: + type: object + title: product + required: + - name + - unit_price + - quantity properties: antifraud_info: + type: object additionalProperties: true example: key: value - type: object brand: - description: The brand of the item. - example: Cohiba - maxLength: 249 - minLength: 2 type: string + minLength: 2 + maxLength: 249 + example: Cohiba + description: The brand of the item. description: - description: Short description of the item + type: string example: Imported From Mex. - maxLength: 249 minLength: 3 - type: string + maxLength: 249 + description: Short description of the item metadata: + type: object + maxProperties: 100 + description: 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. additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - default: {} - description: "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." + anyOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean example: key: value - maxProperties: 100 + default: {} name: - description: The name of the item. It will be displayed in the order. - example: Box of Cohiba S1s - maxLength: 249 - minLength: 3 type: string + minLength: 3 + maxLength: 249 + example: Box of Cohiba S1s + description: The name of the item. It will be displayed in the order. quantity: - description: The quantity of the item in the order. - example: 1 + type: integer format: int32 + example: 1 minimum: 1 - type: integer + description: The quantity of the item in the order. sku: - description: The stock keeping unit for the item. It is used to identify - the item in the order. - example: XYZ12345 - maxLength: 249 + type: string minLength: 1 + maxLength: 249 + example: XYZ12345 + description: The stock keeping unit for the item. It is used to identify the item in the order. + tags: + type: array + minItems: 1 + items: + type: string + minLength: 2 + maxLength: 249 + example: + - food + - mexican food + description: List of tags for the item. It is used to identify the item in the order. + unit_price: + type: integer + format: int32 + example: 20000 + minimum: 0 + description: The price of the item in cents. + customer_shipping_contacts_response: + title: customer_shipping_contacts_response + description: Contains the detail of the shipping addresses that the client has active or has used in Conekta + properties: + phone: + type: string + example: '+525511223344' + receiver: + type: string + example: Marvin Fuller + between_streets: + type: + - string + - 'null' + example: Ackerman Crescent + address: + title: customer_shipping_contacts_address + type: object + properties: + object: + type: string + example: shipping_address + street1: + type: string + example: Nuevo Leon 254 + street2: + type: string + example: Departamento 404 + postal_code: + type: string + example: '06100' + city: + type: string + example: Ciudad de Mexico + state: + type: string + example: Ciudad de Mexico + country: + type: string + example: MX + residential: + type: + - boolean + - 'null' + example: true + parent_id: + type: string + default: + type: boolean + example: false + id: + type: string + example: adr_1234567890 + created_at: + type: integer + format: int64 + example: 1675715413 + metadata: + type: object + additionalProperties: true + maxProperties: 100 + description: Metadata associated with the shipping contact + object: + type: string + example: shipping_contact + deleted: + type: boolean + example: false + order_response: + title: order_response + description: order response + properties: + amount: + type: integer + example: 21605 + description: The total amount to be collected in cents + amount_refunded: + type: integer + example: 0 + description: The total amount refunded in cents + channel: + type: object + title: order_channel_response + properties: + segment: + type: string + example: Checkout + checkout_request_id: + type: string + example: 6fca054a-8519-4c43-971e-cea35cc519bb + checkout_request_type: + type: string + example: HostedPayment + id: + type: string + example: channel_2tNDzhA4Akmzj11AU + charges: + description: The charges associated with the order + title: order_charges_response + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + title: charges_data_response + allOf: + - $ref: '#/components/schemas/charge_response' + checkout: + type: object + required: + - id + - livemode + - name + - object + - type + properties: + allowed_payment_methods: + type: array + example: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + - apple + - google + description: Are the payment methods available for this link + items: + type: string + excluded_payment_methods: + title: order_response_excluded_payment_methods + type: array + items: + type: string + enum: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + example: + - cash + - bank_transfer + description: Payment methods excluded from the checkout. This field is only returned when excluded_payment_methods is provided in the request. + can_not_expire: + type: boolean + example: false + emails_sent: + type: integer + example: 0 + exclude_card_networks: + title: order_response_exclude_card_networks + type: array + items: + type: string + enum: + - visa + - mastercard + - amex + example: + - visa + - amex + expires_at: + type: integer + example: 1676613599 + format: int64 + failure_url: + type: string + example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx + force_3ds_flow: + type: boolean + example: false + force_save_card: + type: + - boolean + - 'null' + example: false + description: Indicates whether the card used for the payment should be saved for future purchases. This field is only applicable for card payments. + id: + type: string + example: 6fca054a-8519-4c43-971e-cea35cc519bb + is_redirect_on_failure: + type: boolean + example: false + livemode: + type: boolean + example: false + max_failed_retries: + type: + - integer + - 'null' + example: 3 + format: int8 + description: Number of retries allowed before the checkout is marked as failed + metadata: + additionalProperties: true + maxProperties: 100 + type: object + monthly_installments_enabled: + type: boolean + example: false + monthly_installments_options: + type: array + items: + type: integer + format: int8 + name: + type: string + example: ord-2tNDzhA4Akmzj11AS + needs_shipping_contact: + type: boolean + example: false + object: + type: string + example: checkout + on_demand_enabled: + type: + - boolean + - 'null' + example: true + paid_payments_count: + type: integer + example: 0 + recurrent: + type: boolean + example: false + redirection_time: + type: + - integer + - 'null' + example: 2 + format: int8 + description: number of seconds to wait before redirecting to the success_url + slug: + type: string + example: 6fca054a85194c43971ecea35cc519bb + sms_sent: + type: integer + example: 0 + success_url: + type: string + description: Redirection url back to the site in case of successful payment, applies only to HostedPayment + example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx + format: uri + starts_at: + type: integer + example: 1676354400 + status: + type: string + example: Issued + type: + type: string + description: 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. + example: HostedPayment + url: + type: string + description: Indicate the url of the Conekta component to complete the payment. For HostedPayment, this will be a Conekta-hosted page + example: https://pay.conekta.io/checkout/6fca054a85194c43971ecea35cc519bb + format: uri + created_at: + type: integer + example: 1676328434 + format: int64 + description: The time at which the object was created in seconds since the Unix epoch + currency: + type: string + example: MXN + description: The three-letter ISO 4217 currency code. The currency of the order. + customer_info: + allOf: + - type: object + properties: + object: + type: string + example: customer_info + - $ref: '#/components/schemas/order_customer_info_response' + - $ref: '#/components/schemas/customer_info_just_customer_id_response' + discount_lines: + description: List of discounts that are applied to the order + title: order_discount_lines_response + anyOf: + - type: 'null' + - allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + title: discount_lines_data_response + allOf: + - $ref: '#/components/schemas/discount_lines_response' + tax_lines: + description: List of taxes that are applied to the order + title: order_tax_lines_response + anyOf: + - type: 'null' + - allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + title: tax_lines_data_response + allOf: + - $ref: '#/components/schemas/update_order_tax_response' + shipping_lines: + description: List of shipping costs applied to the order + title: order_shipping_lines_response + anyOf: + - type: 'null' + - allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + title: shipping_lines_data_response + allOf: + - $ref: '#/components/schemas/shipping_order_response' + fiscal_entity: + type: + - object + - 'null' + title: order_fiscal_entity_response + description: Fiscal entity of the order, Currently it is a purely informative field + required: + - address + - id + - object + - created_at + properties: + address: + title: order_fiscal_entity_address_response + description: Address of the fiscal entity + allOf: + - $ref: '#/components/schemas/fiscal_entity_address' + - type: object + properties: + object: + type: string + example: fiscal_entity_address + email: + type: + - string + - 'null' + example: test@gmail.com + description: Email of the fiscal entity + metadata: + type: object + additionalProperties: true + maxProperties: 100 + description: Metadata associated with the fiscal entity + name: + type: + - string + - 'null' + example: Conekta Inc + description: Name of the fiscal entity + tax_id: + type: + - string + - 'null' + example: '324234234' + description: Tax ID of the fiscal entity + id: + type: string + example: fis_ent_2tN85VYaSMyDvjB3M + description: ID of the fiscal entity + created_at: + type: integer + format: int64 + example: 1676328434 + description: The time at which the object was created in seconds since the Unix epoch + object: + type: string + example: fiscal_entity + phone: + type: + - string + - 'null' + example: '+525511223344' + description: Phone of the fiscal entity + id: + type: string + example: ord_2tMtQQpDvfnNjiuFG + is_refundable: + type: boolean + example: false + line_items: + title: order_response_products + allOf: + - $ref: '#/components/schemas/pagination' + - $ref: '#/components/schemas/page' + - type: object + properties: + data: + type: array + items: + title: product_data_response + allOf: + - $ref: '#/components/schemas/product' + - type: object + properties: + id: + type: string + object: + type: string + parent_id: + type: string + livemode: + type: boolean + example: false + description: Whether the object exists in live mode or test mode + metadata: + additionalProperties: true + maxProperties: 100 + type: object + description: 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: + title: order_next_action_response + type: object + description: contains the following attributes that will guide to continue the flow + properties: + redirect_to_url: + type: object + description: contains the following attributes that will guide to continue the flow + properties: + url: + type: string + format: uri + description: pay.conekta.com/{id} Indicates the url of the Conekta component to authenticate the flow through 3DS2. + example: https://pay.conekta.com/6fca054a85194c43971ecea35cc519bb + return_url: + type: string + format: uri + description: Indicates the url to which the 3DS2 flow returns at the end, when the integration is redirected. + example: https://my-website.com" + type: + type: string + example: redirect_to_url + description: Indicates the type of action to be taken + object: + type: string + example: order + description: String representing the object’s type. Objects of the same type share the same value. + payment_status: + type: string + example: paid + description: The payment status of the order. + processing_mode: type: string - tags: - description: List of tags for the item. It is used to identify the item - in the order. + description: Indicates the processing mode for the order, either ecommerce, recurrent or validation. + example: ecommerce + shipping_contact: + allOf: + - type: object + properties: + created_at: + type: integer + format: int64 + id: + type: string + object: + type: string + - $ref: '#/components/schemas/customer_shipping_contacts_response' + updated_at: + type: integer + example: 1676328434 + format: int64 + description: The time at which the object was last updated in seconds since the Unix epoch + orders_response: + title: orders_response + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/order_response' + checkout_request: + title: order_checkout_request + description: | + [Checkout](https://developers.conekta.com/v2.3.0/reference/payment-link) details + properties: + allowed_payment_methods: + type: array + description: Are the payment methods available for this link. For subscriptions, only 'card' is allowed due to the recurring nature of the payments. This field is mutually exclusive with excluded_payment_methods. + items: + type: string + enum: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + - apple + - google + example: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + - apple + - google + excluded_payment_methods: + title: checkout_request_excluded_payment_methods + type: array + description: Payment methods to be excluded from the checkout. This field is mutually exclusive with allowed_payment_methods. + items: + type: string + enum: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank example: - - food - - mexican food + - cash + - bank_transfer + exclude_card_networks: + title: checkout_request_exclude_card_networks + type: array + description: 'List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: ''visa_master_card'' (a single token excluding both Visa and Mastercard) and ''amex''.' items: - maxLength: 249 - minLength: 2 type: string - minItems: 1 + enum: + - visa_master_card + - amex + example: + - visa_master_card + plan_ids: type: array - default: null - unit_price: - description: The price of the item in cents. - example: 20000 - format: int32 - minimum: 0 + description: List of plan IDs that will be available for subscription. This field is required for subscription payments. + items: + type: string + example: + - plan_123 + - plan_456 + expires_at: type: integer - required: - - name - - quantity - - unit_price - title: product - shipping_request: - properties: - amount: - description: Shipping amount in cents - example: 100 + minimum: 1 format: int64 - minimum: 0 + description: | + It is the time when the link will expire. + It is expressed in seconds since the Unix epoch. The valid range is from 5 minutes to 365 days from the creation date. + failure_url: + type: string + format: uri + description: Redirection url back to the site in case of failed payment, applies only to HostedPayment. + example: https://www.mysite.com/failure + force_save_card: + type: boolean + example: false + description: Indicates whether the card used for the payment should be saved for future purchases. This field is only applicable for card payments. + monthly_installments_enabled: + type: boolean + example: false + monthly_installments_options: + type: array + items: + type: integer + format: int8 + example: + - 3 + - 6 + - 12 + max_failed_retries: type: integer - carrier: - description: Carrier name for the shipment - example: FEDEX - maxLength: 249 - minLength: 3 + format: int8 + description: Number of retries allowed before the checkout is marked as failed + example: 3 + name: type: string - tracking_number: - description: Tracking number can be used to track the shipment - example: TRACK123 - maxLength: 249 - minLength: 3 + description: Reason for payment + on_demand_enabled: + type: boolean + example: true + redirection_time: + type: integer + format: int8 + description: number of seconds to wait before redirecting to the success_url + example: 10 + success_url: type: string - method: - description: Method of shipment - example: Same day - maxLength: 249 - minLength: 3 + format: uri + description: Redirection url back to the site in case of successful payment, applies only to HostedPayment + example: https://www.mysite.com/success + type: type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - description: "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." - example: - key: value - maxProperties: 100 + description: 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. + enum: + - Integration + - HostedPayment + customer_info: + title: customer_info + type: object required: - - amount - title: shipping_request - order_tax_request: - description: create new taxes for an existing order + - name + - phone + - email properties: - amount: - description: The amount to be collected for tax in cents - example: 100 - format: int64 - minimum: 0 - type: integer - description: - description: description or tax's name - example: testing - minLength: 3 + name: type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - example: - key: value - maxProperties: 100 + example: DevTest + email: + type: string + format: email + example: test@conekta.com + phone: + type: string + example: '5522997233' + corporate: + type: boolean + object: + type: string + example: customer_info + customer_info_just_customer_id: + title: customer_info_customer_id + type: object required: - - amount - - description - title: order_tax_request + - customer_id + properties: + customer_id: + type: string + example: cus_23874283647 order_request: + title: order_request description: a order + type: object + required: + - currency + - customer_info + - line_items properties: charges: - description: "List of [charges](https://developers.conekta.com/v2.3.0/reference/orderscreatecharge)\ - \ that are applied to the order" - items: - $ref: "#/components/schemas/charge_request" + description: List of [charges](https://developers.conekta.com/v2.3.0/reference/orderscreatecharge) that are applied to the order type: array - default: null + items: + $ref: '#/components/schemas/charge_request' checkout: - $ref: "#/components/schemas/order_checkout_request" + $ref: '#/components/schemas/checkout_request' currency: - description: "Currency with which the payment will be made. It uses the\ - \ 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" + type: string + description: Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) example: MXN maxLength: 3 - type: string customer_info: - $ref: "#/components/schemas/order_request_customer_info" + description: Customer information + oneOf: + - $ref: '#/components/schemas/customer_info' + - $ref: '#/components/schemas/customer_info_just_customer_id' discount_lines: - description: "List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline)\ - \ that are applied to the order." - items: - $ref: "#/components/schemas/order_discount_lines_request" + description: List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline) that are applied to the order. type: array - default: null + items: + $ref: '#/components/schemas/order_discount_lines_request' fiscal_entity: - $ref: "#/components/schemas/order_fiscal_entity_request" + title: order_fiscal_entity_request + type: object + description: Fiscal entity of the order, Currently it is a purely informative field + required: + - address + properties: + address: + $ref: '#/components/schemas/fiscal_entity_address' + email: + type: string + example: test@gmail.com + description: Email of the fiscal entity + metadata: + type: object + additionalProperties: true + maxProperties: 100 + description: Metadata associated with the fiscal entity + name: + type: + - string + - 'null' + example: Conekta Inc + description: Name of the fiscal entity + phone: + type: string + example: '+525511223344' + description: Phone of the fiscal entity + tax_id: + type: + - string + - 'null' + example: AAA010101AAA + description: Tax ID of the fiscal entity line_items: - description: "List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct)\ - \ that are sold in the order. You must have at least one product." - items: - $ref: "#/components/schemas/product" + description: List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product. type: array - default: null + items: + $ref: '#/components/schemas/product' metadata: + type: object additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - description: "Metadata associated with the order. Values must be scalar\ - \ (string of at most 249 characters, integer, number or boolean); nested\ - \ objects and arrays are not supported." + anyOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean maxProperties: 100 + description: Metadata associated with the order. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are not supported. needs_shipping_contact: - description: Allows you to fill out the shipping information at checkout - example: false type: boolean + example: false + description: Allows you to fill out the shipping information at checkout pre_authorize: - description: Indicates whether the order charges must be preauthorized type: boolean + description: Indicates whether the order charges must be preauthorized processing_mode: - description: "Indicates the processing mode for the order, either ecommerce,\ - \ recurrent or validation." - example: ecommerce type: string + description: Indicates the processing mode for the order, either ecommerce, recurrent or validation. + example: ecommerce return_url: - description: Indicates the redirection callback upon completion of the 3DS2 - flow. Do not use this parameter if your order has a checkout parameter - example: https://my-website.com - format: uri type: string + format: uri + description: Indicates the redirection callback upon completion of the 3DS2 flow. Do not use this parameter if your order has a checkout parameter + example: https://my-website.com shipping_contact: - $ref: "#/components/schemas/customer_shipping_contacts_request" + $ref: '#/components/schemas/customer_shipping_contacts' shipping_lines: - description: "List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping).\ - \ If the online store offers digital products." - items: - $ref: "#/components/schemas/shipping_request" + description: List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping). If the online store offers digital products. type: array - default: null - tax_lines: - description: "List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes)\ - \ that are applied to the order." items: - $ref: "#/components/schemas/order_tax_request" + $ref: '#/components/schemas/shipping_request' + tax_lines: + description: List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes) that are applied to the order. type: array - default: null + items: + $ref: '#/components/schemas/order_tax_request' three_ds_mode: - description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ - \ The value is validated against the allowed set on creation; sending\ - \ an explicit null is rejected. Omit the field to create the order without\ - \ requesting 3DS through the API (company-level 3DS applies only to orders\ - \ paid through Checkout or when antifraud forces 3DS)." - enum: - - strict - - not_strict - - smart - type: string - required: - - currency - - customer_info - - line_items - title: order_request - order_update_customer_info: - oneOf: - - $ref: "#/components/schemas/customer_info" - - $ref: "#/components/schemas/customer_info_customer_id" - title: order_update_customer_info - order_update_fiscal_entity_request: - description: "Fiscal entity of the order, Currently it is a purely informative\ - \ field" - properties: - address: - $ref: "#/components/schemas/fiscal_entity_address" - email: - description: Email of the fiscal entity - example: test@gmail.com - type: string - name: - description: Name of the fiscal entity - example: Conekta Inc - nullable: true type: string - metadata: - additionalProperties: true - description: Metadata associated with the fiscal entity - maxProperties: 100 - type: object - phone: - description: Phone of the fiscal entity - example: "+525511223344" - type: string - tax_id: - description: Tax ID of the fiscal entity - example: AAA010101AAA - nullable: true - type: string - required: - - address - title: order_update_fiscal_entity_request - order_update: + enum: + - strict + - not_strict + - smart + description: 'Indicates the 3DS2 mode: ''strict'', ''not_strict'' or ''smart''. The value is validated against the allowed set on creation; sending an explicit null is rejected. Omit the field to create the order without requesting 3DS through the API (company-level 3DS applies only to orders paid through Checkout or when antifraud forces 3DS).' + examples: + - value: smart + summary: 'Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication.' + - value: strict + summary: All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2. + - value: not_strict + summary: The 3DS2 flow is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode. + order_update_request: + title: order_update description: a order + type: object properties: charges: - items: - $ref: "#/components/schemas/charge_request" type: array - default: null + items: + $ref: '#/components/schemas/charge_request' checkout: - $ref: "#/components/schemas/order_checkout_request" + $ref: '#/components/schemas/checkout_request' currency: - description: "Currency with which the payment will be made. It uses the\ - \ 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" + type: string + description: Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) example: MXN maxLength: 3 - type: string customer_info: - $ref: "#/components/schemas/order_update_customer_info" + title: order_update_customer_info + oneOf: + - $ref: '#/components/schemas/customer_info' + - $ref: '#/components/schemas/customer_info_just_customer_id' discount_lines: - description: "List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline)\ - \ that are applied to the order." - items: - $ref: "#/components/schemas/order_discount_lines_request" + description: List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline) that are applied to the order. type: array - default: null + items: + $ref: '#/components/schemas/order_discount_lines_request' fiscal_entity: - $ref: "#/components/schemas/order_update_fiscal_entity_request" + title: order_update_fiscal_entity_request + type: object + description: Fiscal entity of the order, Currently it is a purely informative field + required: + - address + properties: + address: + $ref: '#/components/schemas/fiscal_entity_address' + email: + type: string + example: test@gmail.com + description: Email of the fiscal entity + name: + type: + - string + - 'null' + example: Conekta Inc + description: Name of the fiscal entity + metadata: + type: object + additionalProperties: true + maxProperties: 100 + description: Metadata associated with the fiscal entity + phone: + type: string + example: '+525511223344' + description: Phone of the fiscal entity + tax_id: + type: + - string + - 'null' + example: AAA010101AAA + description: Tax ID of the fiscal entity line_items: - description: "List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct)\ - \ that are sold in the order. You must have at least one product." - items: - $ref: "#/components/schemas/product" + description: List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product. type: array - default: null + items: + $ref: '#/components/schemas/product' metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" + type: object maxProperties: 100 + additionalProperties: + anyOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean pre_authorize: - description: Indicates whether the order charges must be preauthorized type: boolean - shipping_contact: - $ref: "#/components/schemas/customer_shipping_contacts_request" - shipping_lines: - description: "List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping).\ - \ If the online store offers digital products." - items: - $ref: "#/components/schemas/shipping_request" - type: array - default: null - tax_lines: - items: - $ref: "#/components/schemas/order_tax_request" - type: array - default: null - title: order_update - order_capture_request: - properties: - amount: - description: Amount to capture - example: 500 - format: int64 - minimum: 1 - type: integer - required: - - amount - title: order_capture_request + description: Indicates whether the order charges must be preauthorized + shipping_contact: + $ref: '#/components/schemas/customer_shipping_contacts' + shipping_lines: + type: array + description: List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping). If the online store offers digital products. + items: + $ref: '#/components/schemas/shipping_request' + tax_lines: + type: array + items: + $ref: '#/components/schemas/order_tax_request' product_order_response: + title: product order response allOf: - - properties: - antifraud_info: - additionalProperties: true - example: - key: value - type: object - brand: - description: The brand of the item. - example: Cohiba - maxLength: 249 - minLength: 2 - type: string - description: - description: Short description of the item - example: Imported From Mex. - maxLength: 249 - minLength: 3 - type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - default: {} - description: "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." - example: - key: value - maxProperties: 100 - name: - description: The name of the item. It will be displayed in the order. - example: Box of Cohiba S1s - maxLength: 249 - minLength: 3 - type: string - quantity: - description: The quantity of the item in the order. - example: 1 - format: int32 - minimum: 1 - type: integer - sku: - description: The stock keeping unit for the item. It is used to identify - the item in the order. - example: XYZ12345 - maxLength: 249 - minLength: 1 - type: string - tags: - description: List of tags for the item. It is used to identify the item - in the order. - example: - - food - - mexican food - items: - maxLength: 249 - minLength: 2 + - $ref: '#/components/schemas/product' + - type: object + properties: + id: + type: string + object: + type: string + parent_id: type: string - minItems: 1 - type: array - default: null - unit_price: - description: The price of the item in cents. - example: 20000 - format: int32 - minimum: 0 - type: integer - required: - - name - - quantity - - unit_price - title: product - - properties: - id: - type: string - object: - type: string - parent_id: - type: string - title: product order response update_product: + type: object + title: update_product properties: antifraud_info: + type: object additionalProperties: type: object description: - maxLength: 249 - minLength: 3 type: string - sku: + minLength: 3 maxLength: 249 - minLength: 1 + sku: type: string - name: - example: Box of Cohiba S1s + minLength: 1 maxLength: 249 - minLength: 3 + name: type: string + minLength: 3 + maxLength: 249 + example: Box of Cohiba S1s unit_price: - example: 20000 + type: integer format: int64 + example: 20000 minimum: 0 - type: integer quantity: - example: 1 + type: integer format: int32 + example: 1 minimum: 1 - type: integer tags: + type: array + minItems: 1 items: - maxLength: 249 - minLength: 2 type: string - minItems: 1 - type: array - default: null + minLength: 2 + maxLength: 249 brand: - maxLength: 249 - minLength: 2 type: string + minLength: 2 + maxLength: 249 metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" + type: object maxProperties: 100 - title: update_product - orderRefund_request: - properties: - amount: - description: Amount to be refunded in cents - example: 500 - type: integer - expires_at: - example: 1553273553 - format: int64 - type: integer - reason: - description: Reason for the refund - example: suspected_fraud - type: string - required: - - amount - - reason - payout_order_response_customer_info: - allOf: - - properties: - id: - description: The id of the customer. - example: cus_23874283647 - type: string - required: - - id - - properties: - customer_custom_reference: - description: Custom reference - example: custom_reference - nullable: true - type: string - name: - example: DevTest - type: string - email: - example: test@conekta.com - format: email - type: string - phone: - example: "5522997233" - type: string - corporate: - default: false - type: boolean - object: - example: customer_info - type: string - title: order_customer_info_response - description: The customer information of the payout order. - payout_order_payouts_item: - properties: - amount: - description: The amount of the payout. - example: 3000 - type: integer - currency: - description: The currency in which the payout is made. - example: MXN - type: string - expires_at: - description: The expiration date of the payout. - example: 1677626837 - format: int64 - type: integer - id: - description: The id of the payout. - example: payout_2vZwsRAhhGp2dFDJx - type: string - livemode: - description: The live mode of the payout. - example: true - type: boolean - object: - description: The object of the payout. - example: payout - type: string - payout_order_id: - description: The id of the payout order. - example: f2654d66-d740-457a-9a8c-f96b5196f44e - type: string - status: - description: The status of the payout. - example: open - type: string - required: - - amount - - currency - - id - - livemode - - object - title: payout_order_payouts_item + additionalProperties: + anyOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean payout_order_response: + title: payout_order_response description: payout order model response + type: object + required: + - allowed_payout_methods + - amount + - created_at + - currency + - customer_info + - id + - livemode + - object + - payouts + - reason + - updated_at + - expires_at + - status properties: allowed_payout_methods: + type: array description: The payout methods that are allowed for the payout order. - example: - - cashout items: type: string + example: + - cashout minItems: 1 - type: array - default: null amount: + type: integer description: The amount of the payout order. - example: 100 format: int64 - type: integer + example: 100 created_at: + type: integer description: The creation date of the payout order. example: 1677626837 format: int64 - type: integer currency: - default: MXN + type: string description: The currency in which the payout order is made. example: MXN - type: string + default: MXN customer_info: - $ref: "#/components/schemas/payout_order_response_customer_info" + description: The customer information of the payout order. + allOf: + - type: object + required: + - id + properties: + id: + type: string + example: cus_23874283647 + description: The id of the customer. + - $ref: '#/components/schemas/order_customer_info_response' expires_at: + type: integer description: The expiration date of the payout order. - example: 1677626837 format: int64 - type: integer + example: 1677626837 id: + type: string description: The id of the payout order. example: f2654d66-d740-457a-9a8c-f96b5196f44e - type: string livemode: + type: boolean description: The live mode of the payout order. example: true - type: boolean object: + type: string description: The object of the payout order. example: payout_order - type: string metadata: - additionalProperties: true + type: object description: The metadata of the payout order. - example: - custom_client_id: "12345" + additionalProperties: true maxProperties: 100 - type: object + example: + custom_client_id: '12345' payouts: + type: array description: The payout information of the payout order. - items: - $ref: "#/components/schemas/payout_order_payouts_item" title: payout_order_payouts - type: array - default: null + items: + type: object + title: payout_order_payouts_item + required: + - id + - amount + - currency + - livemode + - object + properties: + amount: + type: integer + description: The amount of the payout. + example: 3000 + currency: + type: string + description: The currency in which the payout is made. + example: MXN + expires_at: + format: int64 + type: integer + description: The expiration date of the payout. + example: 1677626837 + id: + type: string + description: The id of the payout. + example: payout_2vZwsRAhhGp2dFDJx + livemode: + type: boolean + description: The live mode of the payout. + example: true + object: + type: string + description: The object of the payout. + example: payout + payout_order_id: + type: string + description: The id of the payout order. + example: f2654d66-d740-457a-9a8c-f96b5196f44e + status: + type: string + description: The status of the payout. + example: open reason: + type: string description: The reason for the payout order. example: Payout order for the customer - type: string status: + type: string description: The status of the payout order. example: open - type: string updated_at: + type: integer description: The update date of the payout order. example: 1677626837 format: int64 - type: integer - required: - - allowed_payout_methods - - amount - - created_at - - currency - - customer_info - - expires_at - - id - - livemode - - object - - payouts - - reason - - status - - updated_at - title: payout_order_response - payout_orders_response: - allOf: - - properties: - data: - items: - $ref: "#/components/schemas/payout_order_response" - title: payout_orders_data_response - type: array - default: null - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - title: payout_orders_response - payout_order_request_customer_info: - allOf: - - properties: - customer_id: - example: cus_23874283647 - type: string - required: - - customer_id - title: customer_info_customer_id - description: The customer information to whom the payout order is made. - payout_method: - description: The payout method of the payout order. - properties: - type: - description: The type of the payout method. - example: cashout - type: string - required: - - type - title: payout_method - payout: - description: The payout information of the payout order. - properties: - payout_method: - $ref: "#/components/schemas/payout_method" - required: - - payout_method - title: payout - payout_order_request: + payout_order: + title: payout_order_request description: a payout order + type: object + required: + - allowed_payout_methods + - amount + - currency + - customer_info + - payout + - reason + - expires_at properties: allowed_payout_methods: + type: array description: The payout methods that are allowed for the payout order. - example: - - cashout items: type: string - type: array - default: null + example: + - cashout amount: + type: integer description: The amount of the payout order. example: 100 format: int64 - type: integer currency: - default: MXN + type: string description: The currency in which the payout order is made. example: MXN - type: string + default: MXN customer_info: - $ref: "#/components/schemas/payout_order_request_customer_info" + allOf: + - $ref: '#/components/schemas/customer_info_just_customer_id' + description: The customer information to whom the payout order is made. expires_at: + type: integer description: The expiration time of the payout order in Unix timestamp. example: 1700000000 format: int64 - type: integer metadata: - additionalProperties: true + type: object description: The metadata of the payout order. - example: - custom_client_id: "12345" + additionalProperties: true maxProperties: 100 - type: object + example: + custom_client_id: '12345' payout: - $ref: "#/components/schemas/payout" + title: payout + required: + - payout_method + type: object + description: The payout information of the payout order. + properties: + payout_method: + title: payout_method + required: + - type + type: object + description: The payout method of the payout order. + properties: + type: + type: string + description: The type of the payout method. + example: cashout reason: + type: string description: The reason for the payout order. example: Payout order for the customer - type: string - required: - - allowed_payout_methods - - amount - - currency - - customer_info - - expires_at - - payout - - reason - title: payout_order_request checkout_response: + title: checkout_response description: checkout response + type: object + required: + - id + - livemode + - object + - name properties: allowed_payment_methods: - description: Are the payment methods available for this link - example: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank + type: array items: type: string - type: array - default: null - excluded_payment_methods: - description: Payment methods excluded from the checkout. This field is only - returned when excluded_payment_methods is provided in the request. example: - - cash - - bank_transfer - items: - enum: - cash - card - bank_transfer - bnpl - pay_by_bank - type: string + description: Are the payment methods available for this link + excluded_payment_methods: title: checkout_response_excluded_payment_methods type: array - default: null + items: + type: string + enum: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + example: + - cash + - bank_transfer + description: Payment methods excluded from the checkout. This field is only returned when excluded_payment_methods is provided in the request. plan_ids: + type: array description: List of plan IDs that are available for subscription - example: - - plan_123 - - plan_456 items: type: string - type: array - default: null + example: + - plan_123 + - plan_456 can_not_expire: - example: false type: boolean + example: false emails_sent: - example: 0 type: integer + example: 0 exclude_card_networks: - example: - - visa - - amex + title: checkout_response_exclude_card_networks + type: array items: + type: string enum: + - visa + - mastercard + - amex + example: - visa - - mastercard - amex - type: string - title: checkout_response_exclude_card_networks - type: array - default: null expires_at: + type: integer example: 1680397724 format: int64 - type: integer failure_url: - example: https://pay.conekta.com/failure type: string + example: https://pay.conekta.com/failure force_3ds_flow: - example: false type: boolean + example: false id: - example: b0bf16c4-18b9-445e-ba24-01604f329dbf type: string + example: b0bf16c4-18b9-445e-ba24-01604f329dbf livemode: - example: true type: boolean + example: true metadata: + type: object additionalProperties: true example: key: value - type: object monthly_installments_enabled: - example: false type: boolean + example: false monthly_installments_options: - example: - - 3 - - 6 - - 12 + type: array items: - format: int8 type: integer - type: array - default: null + format: int8 + example: + - 3 + - 6 + - 12 name: + type: string description: Reason for charge example: Payment Link Name 1594138857 - type: string needs_shipping_contact: - example: false type: boolean + example: false object: - example: checkout type: string + example: checkout paid_payments_count: - example: 0 type: integer + example: 0 payments_limit_count: - example: 5 + type: + - integer + - 'null' format: int8 - nullable: true - type: integer + example: 5 recurrent: - example: false type: boolean + example: false slug: - example: b0bf16c418b9445eba2401604f329dbf type: string + example: b0bf16c418b9445eba2401604f329dbf sms_sent: - example: 0 type: integer + example: 0 starts_at: - example: 1677650400 type: integer + example: 1677650400 status: - example: Issued type: string + example: Issued success_url: - description: The URL to redirect to after a successful payment. - example: https://pay.conekta.com/success type: string + example: https://pay.conekta.com/success + description: The URL to redirect to after a successful payment. type: - example: PaymentLink type: string + example: PaymentLink url: - example: https://pay.conekta.com/link/b0bf16c418b9445eba2401604f329dbf - format: uri - type: string - required: - - id - - livemode - - name - - object - title: checkout_response - checkouts_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/checkout_response" - type: array - default: null - title: checkouts_response - checkout_order_template: - description: It maintains the attributes with which the order will be created - when receiving a new payment. - properties: - currency: - description: It is the currency in which the order will be created. It must - be a valid ISO 4217 currency code. - example: MXN - maxLength: 3 type: string - customer_info: - $ref: "#/components/schemas/order_request_customer_info" - line_items: - description: They are the products to buy. Each contains the "unit price" - and "quantity" parameters that are used to calculate the total amount - of the order. - items: - $ref: "#/components/schemas/product" - type: array - default: null - metadata: - additionalProperties: true - description: It is a set of key-value pairs that you can attach to the order. - It can be used to store additional information about the order in a structured - format. - example: - key: value - maxProperties: 100 - type: object - tax_lines: - description: "List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes)\ - \ that are applied to the order." - items: - $ref: "#/components/schemas/order_tax_request" - type: array - default: null - discount_lines: - description: "List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline)\ - \ that are applied to the order." - items: - $ref: "#/components/schemas/order_discount_lines_request" - type: array - default: null - required: - - currency - - line_items + format: uri + example: https://pay.conekta.com/link/b0bf16c418b9445eba2401604f329dbf checkout: - description: It is a sub-resource of the Order model that can be stipulated - in order to configure its corresponding checkout + title: checkout + description: It is a sub-resource of the Order model that can be stipulated in order to configure its corresponding checkout + type: object + required: + - name + - type + - order_template + - recurrent + - expires_at properties: allowed_payment_methods: - description: Those are the payment methods that will be available for the - link. This field is mutually exclusive with excluded_payment_methods. - example: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank + type: array items: type: string - type: array - default: null - excluded_payment_methods: - description: Payment methods to be excluded from the checkout. This field - is mutually exclusive with allowed_payment_methods. example: - - cash - - bank_transfer - items: - enum: - cash - card - bank_transfer - bnpl - pay_by_bank - type: string + description: Those are the payment methods that will be available for the link. This field is mutually exclusive with excluded_payment_methods. + excluded_payment_methods: title: checkout_excluded_payment_methods type: array - default: null - exclude_card_networks: - description: "List of card networks to exclude from the checkout. This field\ - \ is only applicable for card payments. Accepted values: 'visa_master_card'\ - \ (a single token excluding both Visa and Mastercard) and 'amex'." - example: - - visa_master_card + description: Payment methods to be excluded from the checkout. This field is mutually exclusive with allowed_payment_methods. items: - enum: - - visa_master_card - - amex type: string + enum: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + example: + - cash + - bank_transfer + exclude_card_networks: title: checkout_exclude_card_networks type: array - default: null + description: 'List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: ''visa_master_card'' (a single token excluding both Visa and Mastercard) and ''amex''.' + items: + type: string + enum: + - visa_master_card + - amex + example: + - visa_master_card expires_at: - description: "It is the time when the link will expire. \nIt is expressed\ - \ in seconds since the Unix epoch. The valid range is from 5 minutes to\ - \ 365 days from the creation date.\n" + type: integer example: 1680397724 format: int64 minimum: 1 - type: integer + description: | + It is the time when the link will expire. + It is expressed in seconds since the Unix epoch. The valid range is from 5 minutes to 365 days from the creation date. monthly_installments_enabled: - description: This flag allows you to specify if months without interest - will be active. - example: true type: boolean + example: true + description: This flag allows you to specify if months without interest will be active. monthly_installments_options: - description: This field allows you to specify the number of months without - interest. - example: - - 3 - - 6 - - 12 + description: This field allows you to specify the number of months without interest. + type: array items: - format: int8 type: integer - type: array - default: null + format: int8 + example: + - 3 + - 6 + - 12 three_ds_mode: - description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ - \ Accepted on creation only. Null appears in responses when no mode is\ - \ configured; to defer to the company-level 3DS configuration, omit the\ - \ field on creation (an explicit null is rejected)." + type: + - string + - 'null' enum: - - strict - - not_strict - - smart - - null - nullable: true - type: string + - strict + - not_strict + - smart + - null + description: 'Indicates the 3DS2 mode: ''strict'', ''not_strict'' or ''smart''. Accepted on creation only. Null appears in responses when no mode is configured; to defer to the company-level 3DS configuration, omit the field on creation (an explicit null is rejected).' + examples: + - value: smart + summary: 'Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication.' + - value: strict + summary: All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2. + - value: not_strict + summary: The 3DS2 flow is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode. name: + type: string description: Reason for charge example: Payment Link Name 1594138857 - type: string needs_shipping_contact: - description: This flag allows you to fill in the shipping information at - checkout. - example: false type: boolean + example: false + description: This flag allows you to fill in the shipping information at checkout. on_demand_enabled: - description: This flag allows you to specify if the link will be on demand. + type: + - boolean + - 'null' example: true - nullable: true - type: boolean + description: This flag allows you to specify if the link will be on demand. plan_ids: description: It is a list of plan IDs that will be associated with the order. - example: - - plan_123 - - plan_456 + type: array items: type: string - type: array - default: null + example: + - plan_123 + - plan_456 order_template: - $ref: "#/components/schemas/checkout_order_template" + description: It maintains the attributes with which the order will be created when receiving a new payment. + type: object + required: + - currency + - line_items + properties: + currency: + type: string + example: MXN + maxLength: 3 + description: It is the currency in which the order will be created. It must be a valid ISO 4217 currency code. + customer_info: + description: It is the information of the customer who will be created when receiving a new payment. + oneOf: + - $ref: '#/components/schemas/customer_info' + - $ref: '#/components/schemas/customer_info_just_customer_id' + line_items: + description: They are the products to buy. Each contains the "unit price" and "quantity" parameters that are used to calculate the total amount of the order. + type: array + items: + $ref: '#/components/schemas/product' + metadata: + type: object + additionalProperties: true + example: + key: value + maxProperties: 100 + description: It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format. + tax_lines: + description: List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes) that are applied to the order. + type: array + items: + $ref: '#/components/schemas/order_tax_request' + discount_lines: + description: List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline) that are applied to the order. + type: array + items: + $ref: '#/components/schemas/order_discount_lines_request' payments_limit_count: - description: It is the number of payments that can be made through the link. - example: 5 + type: integer format: int8 + example: 5 minimum: 1 - type: integer + description: It is the number of payments that can be made through the link. success_url: - description: The URL to redirect to after a successful payment. - example: https://www.conekta.com/success type: string + example: https://www.conekta.com/success + description: The URL to redirect to after a successful payment. recurrent: - description: "false: single use. true: multiple payments" - example: false type: boolean + example: false + description: 'false: single use. true: multiple payments' type: - description: It is the type of link that will be created. It must be a valid - type. - example: PaymentLink - type: string - required: - - expires_at - - name - - order_template - - recurrent - - type - title: checkout - emailCheckout_request: - properties: - email: - example: example@conekta.com - format: email - type: string - required: - - email - smsCheckout_request: - properties: - phonenumber: - example: "5566982090" type: string - required: - - phonenumber - get_customer_payment_method_data_response: - discriminator: - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - propertyName: type - oneOf: - - $ref: "#/components/schemas/payment_method_cash_recurrent_response" - - $ref: "#/components/schemas/payment_method_cash_response" - - $ref: "#/components/schemas/payment_method_card_response" - - $ref: "#/components/schemas/payment_method_spei_recurrent_response" - title: get_customer_payment_method_data_response - get_payment_method_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/get_customer_payment_method_data_response" - type: array - default: null - title: get_payment_method_response - CreateCustomerPaymentMethods_request: - description: Contains details of the payment methods that the customer has active - or has used in Conekta - oneOf: - - $ref: "#/components/schemas/payment_method_token_request" - - $ref: "#/components/schemas/payment_method_cash_request" - - $ref: "#/components/schemas/payment_method_spei_request" - create_customer_payment_methods_response: - discriminator: - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - propertyName: type - oneOf: - - $ref: "#/components/schemas/payment_method_cash_response" - - $ref: "#/components/schemas/payment_method_cash_recurrent_response" - - $ref: "#/components/schemas/payment_method_card_response" - - $ref: "#/components/schemas/payment_method_spei_recurrent_response" - title: create_customer_payment_methods_response - update_payment_methods_card: + example: PaymentLink + description: It is the type of link that will be created. It must be a valid type. + update_payment_methods: + title: update_payment_methods_card + type: object properties: name: - description: The name of the payment method holder - example: Payment recurrent type: string + example: Payment recurrent + description: The name of the payment method holder expires_at: - description: The expiration date of the payment method in Unix timestamp - format + type: integer + description: The expiration date of the payment method in Unix timestamp format example: 1760457350 format: int64 minimum: 1 - type: integer - title: update_payment_methods_card - update_customer_payment_methods_response: - discriminator: - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - propertyName: type - oneOf: - - $ref: "#/components/schemas/payment_method_cash_response" - - $ref: "#/components/schemas/payment_method_cash_recurrent_response" - - $ref: "#/components/schemas/payment_method_card_response" - - $ref: "#/components/schemas/payment_method_spei_recurrent_response" - title: update_customer_payment_methods_response plan_response: + title: plan_response description: plans model + type: object properties: amount: - example: 10000 type: integer + example: 10000 created_at: + type: integer example: 1666900846 format: int64 - type: integer currency: + type: string example: MXN maxLength: 3 - type: string expiry_count: + type: + - integer + - 'null' example: 12 - nullable: true - type: integer frequency: - example: 1 type: integer + example: 1 id: - example: gold-plan type: string + example: gold-plan interval: - example: month type: string + example: month livemode: - example: true type: boolean + example: true name: - example: Extra Plan3 type: string + example: Extra Plan3 object: - example: plan type: string + example: plan trial_period_days: + type: + - integer + - 'null' example: 0 - nullable: true - type: integer max_retries: - example: 3 type: integer + example: 3 retry_delay_hours: - example: 48 type: integer - title: plan_response - get_plans_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/plan_response" - type: array - default: null - title: get_plans_response + example: 48 plan_request: + title: plan_request description: a plan + type: object + required: + - amount + - frequency + - interval + - name properties: amount: - description: The amount in cents that will be charged on the interval specified. + type: integer example: 10000 minimum: 1 - type: integer + description: The amount in cents that will be charged on the interval specified. currency: - description: "ISO 4217 for currencies, for the Mexican peso it is MXN/USD" + type: string example: MXN maxLength: 3 - type: string + description: ISO 4217 for currencies, for the Mexican peso it is MXN/USD expiry_count: - description: "Number of repetitions of the frequency NUMBER OF CHARGES TO\ - \ BE MADE, considering the interval and frequency, this evolves over time,\ - \ but is subject to the expiration count." - example: 12 type: integer + example: 12 + description: Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. frequency: - description: "Frequency of the charge, which together with the interval,\ - \ can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights" + type: integer example: 1 minimum: 1 - type: integer + description: Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights id: - description: internal reference id - example: plan_24234 type: string + example: plan_24234 + description: internal reference id interval: - description: The interval of time between each charge. - enum: - - week - - half_month - - month - - year type: string + enum: + - week + - half_month + - month + - year + description: The interval of time between each charge. name: - description: The name of the plan. - example: Extra Plan3 type: string + example: Extra Plan3 + description: The name of the plan. trial_period_days: - description: The number of days the customer will have a free trial. - example: 0 type: integer + example: 0 + description: The number of days the customer will have a free trial. max_retries: - description: (optional) Specifies the maximum number of retry attempts for - a subscription payment before it is canceled. - example: 3 - minimum: 3 type: integer + minimum: 3 + example: 3 + description: (optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled. retry_delay_hours: - description: (optional) Defines the number of hours between subscription - payment retry attempts. - example: 50 - minimum: 48 type: integer - required: - - amount - - frequency - - interval - - name - title: plan_request - update_plan: + minimum: 48 + example: 50 + description: (optional) Defines the number of hours between subscription payment retry attempts. + plan_update_request: + title: update_plan description: a plan + type: object properties: amount: - description: The amount in cents that will be charged on the interval specified. + type: integer example: 10000 minimum: 1 - type: integer + description: The amount in cents that will be charged on the interval specified. currency: - description: "ISO 4217 for currencies, for the Mexican peso it is MXN/USD" + type: string example: MXN maxLength: 3 - type: string + description: ISO 4217 for currencies, for the Mexican peso it is MXN/USD expiry_count: - description: "Number of repetitions of the frequency NUMBER OF CHARGES TO\ - \ BE MADE, considering the interval and frequency, this evolves over time,\ - \ but is subject to the expiration count." - example: 12 type: integer + example: 12 + description: Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. name: - description: The name of the plan. - example: Extra Plan3 - type: string - title: update_plan - shipping_order_response: - allOf: - - properties: - amount: - description: Shipping amount in cents - example: 100 - format: int64 - minimum: 0 - type: integer - carrier: - description: Carrier name for the shipment - example: FEDEX - maxLength: 249 - minLength: 3 - type: string - tracking_number: - description: Tracking number can be used to track the shipment - example: TRACK123 - maxLength: 249 - minLength: 3 - type: string - method: - description: Method of shipment - example: Same day - maxLength: 249 - minLength: 3 - type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - description: "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." - example: - key: value - maxProperties: 100 - required: - - amount - title: shipping_request - - properties: - id: - type: string - object: - type: string - parent_id: - type: string - title: shipping_order_response - customer_shipping_contacts_response: - description: Contains the detail of the shipping addresses that the client has - active or has used in Conekta - properties: - phone: - example: "+525511223344" - type: string - receiver: - example: Marvin Fuller - type: string - between_streets: - example: Ackerman Crescent - nullable: true - type: string - address: - $ref: "#/components/schemas/customer_shipping_contacts_address" - parent_id: - type: string - default: - example: false - type: boolean - id: - example: adr_1234567890 - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - metadata: - additionalProperties: true - description: Metadata associated with the shipping contact - maxProperties: 100 - type: object - object: - example: shipping_contact - type: string - deleted: - example: false - type: boolean - title: customer_shipping_contacts_response - shipping_contact_address: - description: Address of the person who will receive the order - properties: - street1: - description: Street and number of the delivery address. - example: Nuevo Leon 254 - maxLength: 249 - minLength: 2 - type: string - street2: - description: "Apartment, suite or interior reference for the delivery address." - example: Departamento 404 - maxLength: 249 type: string - postal_code: - description: Postal code of the delivery address. For Mexican addresses - (country MX) it must be a 5-digit postal code. - example: "06100" - maxLength: 250 - type: string - city: - description: City of the delivery address. Must contain at least two consecutive - ASCII letters. - example: Ciudad de Mexico - maxLength: 249 - pattern: "[A-Za-z]{2}" - type: string - state: - description: State of the delivery address. - example: Ciudad de Mexico - maxLength: 249 - type: string - country: - description: "Country of the delivery address. This field follows the [ISO\ - \ 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." - example: MX - maxLength: 249 - minLength: 2 - type: string - residential: - default: true - description: Indicates whether the delivery address is residential. - example: true - nullable: true - type: boolean - title: shipping_contact_address - customer_update_shipping_contacts_request: + example: Extra Plan3 + description: The name of the plan. + customer_update_shipping_contacts: + title: customer_update_shipping_contacts_request description: |- [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. properties: phone: - description: Phone contact - example: "+525511223344" type: string + example: '+525511223344' + description: Phone contact receiver: - description: Name of the person who will receive the order - example: Marvin Fuller type: string + example: Marvin Fuller + description: Name of the person who will receive the order between_streets: - description: The street names between which the order will be delivered. - Must contain at least two consecutive ASCII letters. - example: Ackerman Crescent - maxLength: 249 - pattern: "[A-Za-z]{2}" type: string + maxLength: 249 + pattern: '[A-Za-z]{2}' + example: Ackerman Crescent + description: The street names between which the order will be delivered. Must contain at least two consecutive ASCII letters. address: - $ref: "#/components/schemas/shipping_contact_address" + $ref: '#/components/schemas/shipping_contact_address' parent_id: type: string default: - nullable: true - type: boolean + type: + - boolean + - 'null' deleted: - nullable: true - type: boolean - title: customer_update_shipping_contacts_request - subscription_response_1: - description: subscription model - properties: - billing_cycle_start: - example: 1677626827 - format: int64 - nullable: true - type: integer - billing_cycle_end: - example: 1677626827 - format: int64 - nullable: true - type: integer - canceled_at: - example: 1678258162 - format: int64 - nullable: true - type: integer - canceled_reason: - description: Reason for cancellation. This field appears when the subscription - status is 'canceled'. - example: user_cancelation - type: string - card_id: - example: src_2tKcHxhTz7xU5SymL - type: string - charge_id: - example: 2tKcHxhTz7xU5SymL - nullable: true - type: string - created_at: - example: 1677626837 - format: int64 - type: integer - customer_custom_reference: - example: dotnet_123456 - type: string - customer_id: - example: cus_2tKcHxhTz7xU5SymF - type: string - id: - example: gold-plan - type: string - last_billing_cycle_order_id: - example: ord_2tSoMP7bZJbLiq4z8 - type: string - object: - example: subscription - type: string - paused_at: - example: 1678258162 - format: int64 - nullable: true - type: integer - plan_id: - example: plan_2tXx672QLQ68CkmMn - type: string - status: - example: past_due - type: string - subscription_start: - example: 1677626837 - type: integer - trial_start: - example: 1677626837 - format: int64 - nullable: true - type: integer - trial_end: - example: 1677626837 - format: int64 - nullable: true - type: integer - title: subscription_response - updates_a_subscription: - description: You can modify the subscription to change the plan used by your - customers. - properties: - plan_id: - example: f84gdgf5g48r15fd21g8w424fd1 - type: string - card_id: - example: src_2qUCNd5AyQqfPMBuV - type: string - trial_end: - example: 1484040996 - type: integer + type: + - boolean + - 'null' + subscription_update_request: title: updates a subscription - subscription_events_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/event_response" - type: array - default: null - title: subscription_events_response - subscription_details_card: - properties: - id: - example: src_2yw5zPrVahTy7xy7P - type: string - created_at: - example: 1761745218 - format: int64 - type: integer - active: - example: true - type: boolean - object: - example: card - type: string - exp_month: - example: "05" - type: string - exp_year: - example: "26" - type: string - brand: - example: mastercard - type: string - last4: - example: "1005" - type: string - name: - example: test - type: string - payment_source_status: - example: active - type: string - customer_id: - example: cus_2yDzKtEAD3khH8Sga - type: string - customer_custom_reference: - nullable: true - type: string - subscription_details_plan: + description: You can modify the subscription to change the plan used by your customers. + type: object properties: - id: - example: VG5 - type: string - object: - example: plan - type: string - name: - example: CLARO - type: string - amount: - example: 30000 - format: int32 - type: integer - currency: - example: USD + plan_id: type: string - interval: - example: month + example: f84gdgf5g48r15fd21g8w424fd1 + card_id: type: string - frequency: - example: 1 - format: int32 - type: integer - trial_period_days: - format: int32 - nullable: true - type: integer - expiry_count: - example: 1 - format: int32 - type: integer - created_at: - example: 1742087277 - format: int64 + example: src_2qUCNd5AyQqfPMBuV + trial_end: type: integer + example: 1484040996 subscription_details: + title: subscription_details description: Subscription details for customer portal + type: object properties: card: - $ref: "#/components/schemas/subscription_details_card" + type: object + properties: + id: + type: string + example: src_2yw5zPrVahTy7xy7P + created_at: + type: integer + format: int64 + example: 1761745218 + active: + type: boolean + example: true + object: + type: string + example: card + exp_month: + type: string + example: '05' + exp_year: + type: string + example: '26' + brand: + type: string + example: mastercard + last4: + type: string + example: '1005' + name: + type: string + example: test + payment_source_status: + type: string + example: active + customer_id: + type: string + example: cus_2yDzKtEAD3khH8Sga + customer_custom_reference: + type: + - string + - 'null' + example: null plan: - $ref: "#/components/schemas/subscription_details_plan" + type: object + properties: + id: + type: string + example: VG5 + object: + type: string + example: plan + name: + type: string + example: CLARO + amount: + type: integer + format: int32 + example: 30000 + currency: + type: string + example: USD + interval: + type: string + example: month + frequency: + type: integer + format: int32 + example: 1 + trial_period_days: + type: + - integer + - 'null' + format: int32 + example: null + expiry_count: + type: integer + format: int32 + example: 1 + created_at: + type: integer + format: int64 + example: 1742087277 id: - example: sub_2yYsQuYtXAbP1fdYu type: string + example: sub_2yYsQuYtXAbP1fdYu object: - example: subscription type: string + example: subscription status: - example: canceled type: string + example: canceled plan_id: - example: VG5 type: string + example: VG5 customer_id: - example: cus_2yDzKtEAD3khH8Sga type: string + example: cus_2yDzKtEAD3khH8Sga next_billing_cycle: - example: 1876833632 + type: + - integer + - 'null' format: int64 - nullable: true - type: integer + example: 1876833632 created_at: - example: 1755873642 - format: int64 type: integer - updated_at: - example: 1761745218 format: int64 + example: 1755873642 + updated_at: type: integer - title: subscription_details + format: int64 + example: 1761745218 customer_details: + title: customer_details description: Customer details for customer portal + type: object properties: id: - example: cus_2yDzKtEAD3khH8Sga type: string + example: cus_2yDzKtEAD3khH8Sga object: - example: customer type: string + example: customer name: - example: mao type: string + example: mao email: - example: maoarroya@gmail.com - format: email type: string - title: customer_details + format: email + example: maoarroya@gmail.com customer_portal_response: + title: customer_portal_response description: Customer portal model + type: object properties: slug: + type: string description: Unique slug identifier for the portal example: agIvD4QSBl4Nunq4TmuozMw2ThtyVC - type: string subscription_id: + type: string description: Associated subscription ID example: sub_2yYsQuYtXAbP1fdYu - type: string customer_id: + type: string description: Associated customer ID example: cus_2yDzKtEAD3khH8Sga - type: string livemode: + type: boolean description: Whether this is a live or test mode portal example: false - type: boolean subscription: - $ref: "#/components/schemas/subscription_details" + $ref: '#/components/schemas/subscription_details' customer: - $ref: "#/components/schemas/customer_details" + $ref: '#/components/schemas/customer_details' id: + type: string description: Customer portal ID example: scp_2ym7QbU9dTh7Froti - type: string company_id: + type: string description: Associated company ID example: 63dad459920de10001d177b3 - type: string object: - example: customer_portal type: string + example: customer_portal created_at: + type: integer + format: int64 description: Unix timestamp of creation example: 1759108828 - format: int64 - type: integer updated_at: + type: integer + format: int64 description: Unix timestamp of last update example: 1759108828 - format: int64 - type: integer portal_url: + type: string + format: uri description: URL to access the customer portal example: https://pay.stg.conekta.io/subscription/management/agIvD4QSBl4Nunq4TmuozMw2ThtyVC - format: uri - type: string - title: customer_portal_response - order_tax_response: - allOf: - - description: create new taxes for an existing order - properties: - amount: - description: The amount to be collected for tax in cents - example: 100 - format: int64 - minimum: 0 - type: integer - description: - description: description or tax's name - example: testing - minLength: 3 - type: string - metadata: - additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" - example: - key: value - maxProperties: 100 - required: - - amount - - description - title: order_tax_request - - properties: - id: - example: tax_lin_2tQ8dC5mg1UADmVPo - type: string - object: - example: tax_line - type: string - parent_id: - example: ord_2tPAmKCEJqh8RE6nY - type: string - description: create new taxes for an existing order response - required: - - id - title: order_tax_response - ordersUpdateTaxes_request: + update_order_tax_request: description: create new taxes for an existing order + type: object properties: amount: - description: The amount to be collected for tax in cents - example: 100 + type: integer + example: '100' format: int64 minimum: 0 - type: integer + description: The amount to be collected for tax in cents description: - description: description or tax's name + type: string example: testing minLength: 3 - type: string + description: description or tax's name metadata: + type: object additionalProperties: - $ref: "#/components/schemas/order_tax_request_metadata_value" + anyOf: + - type: string + maxLength: 249 + - type: integer + - type: number + - type: boolean maxProperties: 100 - token_request_card: - properties: - cvc: - description: It is a value that allows identifying the security code of - the card. - example: "123" - maxLength: 4 - type: string - x-encripted: true - device_fingerprint: - description: It is a value that allows identifying the device fingerprint. - example: zptcxk4p6w1ijwz85snf1l3bqe5g09ie - type: string - exp_month: - description: It is a value that allows identifying the expiration month - of the card. - example: "12" - maxLength: 2 - type: string - x-encripted: true - exp_year: - description: It is a value that allows identifying the expiration year of - the card. - example: "26" - maxLength: 2 - type: string - x-encripted: true - name: - description: It is a value that allows identifying the name of the cardholder. - example: Miguel - type: string - x-encripted: true - number: - description: It is a value that allows identifying the number of the card. - example: "4242424242424242" - type: string - x-encripted: true - required: - - cvc - - exp_month - - exp_year - - name - - number - token_request_checkout: - deprecated: true - properties: - returns_control_on: - description: It is a value that allows identifying the returns control on. - example: Token - type: string - token_request: + token: + title: token request description: a token + type: object properties: card: - $ref: "#/components/schemas/token_request_card" + type: + - object + - 'null' + required: + - exp_month + - exp_year + - number + - cvc + - name + properties: + cvc: + type: string + description: It is a value that allows identifying the security code of the card. + example: '123' + maxLength: 4 + x-encripted: true + device_fingerprint: + type: string + description: It is a value that allows identifying the device fingerprint. + example: zptcxk4p6w1ijwz85snf1l3bqe5g09ie + exp_month: + type: string + description: It is a value that allows identifying the expiration month of the card. + example: '12' + maxLength: 2 + x-encripted: true + exp_year: + type: string + description: It is a value that allows identifying the expiration year of the card. + example: '26' + maxLength: 2 + x-encripted: true + name: + type: string + description: It is a value that allows identifying the name of the cardholder. + example: Miguel + x-encripted: true + number: + type: string + description: It is a value that allows identifying the number of the card. + example: '4242424242424242' + x-encripted: true checkout: - $ref: "#/components/schemas/token_request_checkout" - title: token request - token_response_checkout: - deprecated: true - properties: - allowed_payment_methods: - items: - example: card - type: string - type: array - default: null - can_not_expire: - description: Indicates if the checkout can not expire. - example: false - type: boolean - emails_sent: - example: 0 - type: integer - exclude_card_networks: - items: - example: visa - type: string - title: token_response_exclude_card_networks - type: array - default: null - expires_at: - description: Date and time when the checkout expires. - example: 1675715413 - format: int64 - type: integer - failure_url: - description: URL to redirect the customer to if the payment process fails. - example: https://example.com/failure - type: string - force_3ds_flow: - description: Indicates if the checkout forces the 3DS flow. - example: false - type: boolean - id: - example: 524f9d2f-8c2e-4e64-a33d-6006711a91bd - type: string - livemode: - example: true - type: boolean - metadata: - additionalProperties: true - example: - key: value - type: object - monthly_installments_enabled: - description: Indicates if the checkout allows monthly installments. - example: false - type: boolean - monthly_installments_options: - description: List of monthly installments options. - items: - example: 3 - type: integer - type: array - default: null - name: - example: tok-2toNoPZpJgRU4PvgZ - type: string - needs_shipping_contact: - example: false - type: boolean - object: - description: "Indicates the type of object, in this case checkout." - example: checkout - type: string - on_demand_enabled: - description: Indicates if the checkout allows on demand payments. - example: false - type: boolean - paid_payments_count: - description: Number of payments that have been paid. - example: 0 - type: integer - recurrent: - description: Indicates if the checkout is recurrent. - example: false - type: boolean - sms_sent: - example: 0 - type: integer - starts_at: - description: Date and time when the checkout starts. - example: 1675715413 - format: int64 - type: integer - status: - description: Status of the checkout. - example: Issued - type: string - success_url: - description: URL to redirect the customer to after the payment process is - completed. - example: https://example.com/success - type: string - type: - description: Type of checkout. - example: Integration - type: string + deprecated: true + type: + - object + - 'null' + properties: + returns_control_on: + type: string + description: It is a value that allows identifying the returns control on. + example: Token token_response: + title: token_response description: token response + type: object + required: + - id + - livemode + - object + - used properties: checkout: - $ref: "#/components/schemas/token_response_checkout" + deprecated: true + type: + - object + - 'null' + properties: + allowed_payment_methods: + type: array + items: + type: string + example: card + can_not_expire: + type: boolean + example: false + description: Indicates if the checkout can not expire. + emails_sent: + type: integer + example: 0 + exclude_card_networks: + title: token_response_exclude_card_networks + type: array + items: + type: string + example: visa + expires_at: + type: integer + example: 1675715413 + description: Date and time when the checkout expires. + format: int64 + failure_url: + type: string + example: https://example.com/failure + description: URL to redirect the customer to if the payment process fails. + force_3ds_flow: + type: boolean + example: false + description: Indicates if the checkout forces the 3DS flow. + id: + type: string + example: 524f9d2f-8c2e-4e64-a33d-6006711a91bd + livemode: + type: boolean + example: true + metadata: + type: object + additionalProperties: true + example: + key: value + monthly_installments_enabled: + type: boolean + example: false + description: Indicates if the checkout allows monthly installments. + monthly_installments_options: + type: array + description: List of monthly installments options. + items: + type: integer + example: 3 + name: + type: string + example: tok-2toNoPZpJgRU4PvgZ + needs_shipping_contact: + type: boolean + example: false + object: + type: string + example: checkout + description: Indicates the type of object, in this case checkout. + on_demand_enabled: + type: boolean + example: false + description: Indicates if the checkout allows on demand payments. + paid_payments_count: + type: integer + example: 0 + description: Number of payments that have been paid. + recurrent: + type: boolean + example: false + description: Indicates if the checkout is recurrent. + sms_sent: + type: integer + example: 0 + starts_at: + type: integer + example: 1675715413 + description: Date and time when the checkout starts. + format: int64 + status: + type: string + example: Issued + description: Status of the checkout. + success_url: + type: string + example: https://example.com/success + description: URL to redirect the customer to after the payment process is completed. + type: + type: string + example: Integration + description: Type of checkout. id: - description: Unique identifier for the token generated by Conekta. - example: cus_2tHJfJ79KyUwpxTik type: string + example: cus_2tHJfJ79KyUwpxTik + description: Unique identifier for the token generated by Conekta. livemode: - description: Indicates whether the token is in live mode or test mode. - example: true type: boolean + example: true + description: Indicates whether the token is in live mode or test mode. object: - description: "Indicates the type of object, in this case token" - example: token type: string + example: token + description: Indicates the type of object, in this case token used: - description: Indicates if the token has been used - example: false type: boolean - required: - - id - - livemode - - object - - used - title: token_response + example: false + description: Indicates if the token has been used transaction_response: - description: "The Transaction object represents the actions or steps of an order.\ - \ Statuses can be: unprocessed, pending, available, owen, paid_out, voided,\ - \ capture, capture_reversal, liquidation, liquidation_reversal, payout, payout_reversal,\ - \ refund, refund_reversal, chargeback, chargeback_reversal, rounding_adjustment,\ - \ won_chargeback, transferred, and transferred." + title: transaction_response + description: 'The Transaction object represents the actions or steps of an order. Statuses can be: unprocessed, pending, available, owen, paid_out, voided, capture, capture_reversal, liquidation, liquidation_reversal, payout, payout_reversal, refund, refund_reversal, chargeback, chargeback_reversal, rounding_adjustment, won_chargeback, transferred, and transferred.' + type: object + required: + - id + - object + - amount + - fee + - net + - status + - type + - created_at + - currency + - charge + - livemode properties: amount: - description: The amount of the transaction. + type: integer example: 1000 format: int64 - type: integer + description: The amount of the transaction. charge: - description: Randomly assigned unique order identifier associated with the - charge. - example: 5ee7ec58885a45585e6d9f8m type: string + example: 5ee7ec58885a45585e6d9f8m + description: Randomly assigned unique order identifier associated with the charge. created_at: - description: Date and time of creation of the transaction in Unix format. + type: integer example: 1553273553 format: int64 - type: integer + description: Date and time of creation of the transaction in Unix format. currency: - description: "The currency of the transaction. It uses the 3-letter code\ - \ of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" + type: string example: MXN + description: The currency of the transaction. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) maxLength: 3 - type: string fee: - description: The amount to be deducted for taxes and commissions. + type: integer example: 560 format: int64 - type: integer + description: The amount to be deducted for taxes and commissions. id: - description: Unique identifier of the transaction. - example: 5ee7ec5b8dea41085erb7f9e type: string + example: 5ee7ec5b8dea41085erb7f9e + description: Unique identifier of the transaction. livemode: - description: Indicates whether the transaction was created in live mode - or test mode. - example: true type: boolean + example: true + description: Indicates whether the transaction was created in live mode or test mode. net: - description: The net amount after deducting commissions and taxes. + type: integer example: 440 format: int64 - type: integer + description: The net amount after deducting commissions and taxes. object: - description: "Object name, which is transaction." - example: transaction type: string + example: transaction + description: Object name, which is transaction. status: - description: Code indicating transaction status. - example: pending - type: string - type: - description: Transaction Type - example: capture - type: string - required: - - amount - - charge - - created_at - - currency - - fee - - id - - livemode - - net - - object - - status - - type - title: transaction_response - get_transactions_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - description: Transactions - items: - $ref: "#/components/schemas/transaction_response" - type: array - default: null - title: get_transactions_response - transfer_method_response: - description: Method used to make the transfer. - properties: - account_holder: - description: Name of the account holder. - example: John Doe - type: string - account_number: - description: Account number of the bank account. - example: "012180023547896764" - type: string - bank: - description: Name of the bank. - example: BBVA Bancomer - type: string - created_at: - description: Date and time of creation of the transfer. - example: 1553273553 - format: int64 - type: integer - id: - description: Unique identifier of the transfer. - example: pytmtd_2ide3qwTdDvNBosEC - type: string - object: - description: "Object name, which is bank_transfer_payout_method." - example: bank_transfer_payout_method - type: string - payee_id: - description: Unique identifier of the payee. - example: payee_2icdDewRxDENBos85 type: string + example: pending + description: Code indicating transaction status. type: - description: Type of the payee. - example: BankTransferPayoutMethod type: string - title: transfer_method_response + example: capture + description: Transaction Type transfers_response: - description: "A transfer represents the action of sending an amount to a business\ - \ bank account including the status, amount and method used to make the transfer." + title: transfers_response + description: A transfer represents the action of sending an amount to a business bank account including the status, amount and method used to make the transfer. + type: object properties: amount: - description: Amount in cents of the transfer. + type: integer example: 10000 format: int64 - type: integer + description: Amount in cents of the transfer. created_at: - description: Date and time of creation of the transfer. + type: integer example: 1553273553 format: int64 - type: integer + description: Date and time of creation of the transfer. currency: - description: "The currency of the transfer. It uses the 3-letter code of\ - \ the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" + type: string example: MXN + description: The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) maxLength: 3 - type: string id: - description: Unique identifier of the transfer. - example: 5b0337d4dD344ef954fe1X4b6 type: string + example: 5b0337d4dD344ef954fe1X4b6 + description: Unique identifier of the transfer. livemode: - description: Indicates whether the transfer was created in live mode or - test mode. - example: true type: boolean + example: true + description: Indicates whether the transfer was created in live mode or test mode. method: - $ref: "#/components/schemas/transfer_method_response" + type: object + description: Method used to make the transfer. + title: transfer_method_response + properties: + account_holder: + type: string + example: John Doe + description: Name of the account holder. + account_number: + type: string + example: '012180023547896764' + description: Account number of the bank account. + bank: + type: string + example: BBVA Bancomer + description: Name of the bank. + created_at: + type: integer + example: 1553273553 + format: int64 + description: Date and time of creation of the transfer. + id: + type: string + example: pytmtd_2ide3qwTdDvNBosEC + description: Unique identifier of the transfer. + object: + type: string + example: bank_transfer_payout_method + description: Object name, which is bank_transfer_payout_method. + payee_id: + type: string + example: payee_2icdDewRxDENBos85 + description: Unique identifier of the payee. + type: + type: string + example: BankTransferPayoutMethod + description: Type of the payee. object: - description: "Object name, which is transfer." - example: transfer type: string + example: transfer + description: Object name, which is transfer. statement_description: - description: Description of the transfer. - example: Conekta 4401234 type: string + example: Conekta 4401234 + description: Description of the transfer. statement_reference: - description: Reference number of the transfer. - example: "4401234" type: string + example: '4401234' + description: Reference number of the transfer. status: - description: Code indicating transfer status. - example: pending - type: string - title: transfers_response - get_transfers_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - description: Transfers - items: - $ref: "#/components/schemas/transfers_response" - type: array - default: null - title: get_transfers_response - transfer_destination_response: - description: Method used to make the transfer. - properties: - account_holder: - description: Name of the account holder. - example: John Doe type: string - account_number: - description: Account number of the bank account. - example: "012180023547896764" - type: string - bank: - description: Name of the bank. - example: BBVA Bancomer - type: string - created_at: - description: Date and time of creation of the transfer. - example: 1553273553 - format: int64 - type: integer - id: - description: Unique identifier of the transfer. - example: pytmtd_2ide3qwTdDvNBosEC - type: string - object: - description: "Object name, which is bank_transfer_payout_method." - example: bank_transfer_payout_method - type: string - payee_id: - description: Unique identifier of the payee. - example: payee_2icdDewRxDENBos85 - type: string - type: - description: Type of the payee. - example: BankTransferPayoutMethod - type: string - title: transfer_destination_response + example: pending + description: Code indicating transfer status. transfer_response: - description: "A transfer represents the action of sending an amount to a business\ - \ bank account including the status, amount and method used to make the transfer." + title: transfer_response + description: A transfer represents the action of sending an amount to a business bank account including the status, amount and method used to make the transfer. + type: object properties: amount: - description: Amount in cents of the transfer. + type: integer example: 10000 format: int64 - type: integer + description: Amount in cents of the transfer. created_at: - description: Date and time of creation of the transfer in Unix format. + type: integer example: 1553273553 format: int64 - type: integer + description: Date and time of creation of the transfer in Unix format. currency: - description: "The currency of the transfer. It uses the 3-letter code of\ - \ the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" + type: string example: MXN + description: The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) maxLength: 3 - type: string id: - description: Unique identifier of the transfer. - example: 5b0337d4dD344ef954fe1X4b6 type: string + example: 5b0337d4dD344ef954fe1X4b6 + description: Unique identifier of the transfer. livemode: - description: Indicates whether the transfer was created in live mode or - test mode. - example: true type: boolean + example: true + description: Indicates whether the transfer was created in live mode or test mode. destination: - $ref: "#/components/schemas/transfer_destination_response" + type: object + description: Method used to make the transfer. + title: transfer_destination_response + properties: + account_holder: + type: string + example: John Doe + description: Name of the account holder. + account_number: + type: string + example: '012180023547896764' + description: Account number of the bank account. + bank: + type: string + example: BBVA Bancomer + description: Name of the bank. + created_at: + type: integer + example: 1553273553 + format: int64 + description: Date and time of creation of the transfer. + id: + type: string + example: pytmtd_2ide3qwTdDvNBosEC + description: Unique identifier of the transfer. + object: + type: string + example: bank_transfer_payout_method + description: Object name, which is bank_transfer_payout_method. + payee_id: + type: string + example: payee_2icdDewRxDENBos85 + description: Unique identifier of the payee. + type: + type: string + example: BankTransferPayoutMethod + description: Type of the payee. object: - description: "Object name, which is transfer." - example: transfer type: string + example: transfer + description: Object name, which is transfer. statement_description: - description: Description of the transfer. - example: Conekta 4401234 type: string + example: Conekta 4401234 + description: Description of the transfer. statement_reference: - description: Reference number of the transfer. - example: "4401234" type: string + example: '4401234' + description: Reference number of the transfer. status: - description: Code indicating transfer status. - example: pending type: string - title: transfer_response - webhook_key_response: + example: pending + description: Code indicating transfer status. + webhook-key_response: + title: webhook_key_response description: webhook keys model + type: object properties: id: - description: Unique identifier of the webhook key - example: 62730ba6fb7dfd6a712f118e type: string + example: 62730ba6fb7dfd6a712f118e + description: Unique identifier of the webhook key active: - description: Indicates if the webhook key is active - example: true type: boolean + example: true + description: Indicates if the webhook key is active created_at: - description: Unix timestamp in seconds with the creation date of the webhook - key + type: integer example: 1577836800 format: int64 - type: integer + description: Unix timestamp in seconds with the creation date of the webhook key deactivated_at: - description: Unix timestamp in seconds with the deactivation date of the - webhook key + type: + - integer + - 'null' + example: null format: int64 - nullable: true - type: integer + description: Unix timestamp in seconds with the deactivation date of the webhook key public_key: - description: Public key to be used in the webhook - example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END - PUBLIC KEY-----\n' type: string + description: Public key to be used in the webhook + example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n' livemode: - description: Indicates if the webhook key is in live mode - example: false type: boolean + example: false + description: Indicates if the webhook key is in live mode object: - description: "Object name, value is webhook_key" - example: webhook_key type: string - title: webhook_key_response - get_webhook_keys_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/webhook_key_response" - type: array - default: null - title: get_webhook_keys_response - webhook_key_request: - properties: - active: - default: true - description: Indicates if the webhook key is active - example: true - type: boolean - title: webhook_key_request - webhook_key_create_response: + example: webhook_key + description: Object name, value is webhook_key + webhook-key_create_response: + title: webhook_key_create_response description: webhook keys model + type: object properties: active: - description: Indicates if the webhook key is active - example: true type: boolean + example: true + description: Indicates if the webhook key is active created_at: - description: Unix timestamp in seconds with the creation date of the webhook - key + type: integer example: 1577836800 format: int64 - type: integer + description: Unix timestamp in seconds with the creation date of the webhook key id: - description: Unique identifier of the webhook key - example: 62730ba6fb7dfd6a712f118e type: string + example: 62730ba6fb7dfd6a712f118e + description: Unique identifier of the webhook key livemode: - description: Indicates if the webhook key is in live mode - example: false type: boolean + example: false + description: Indicates if the webhook key is in live mode object: - description: "Object name, value is webhook_key" - example: webhook_key type: string + example: webhook_key + description: Object name, value is webhook_key public_key: - description: Public key to be used in the webhook - example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END - PUBLIC KEY-----\n' type: string - title: webhook_key_create_response - webhook_key_update_request: - properties: - active: - default: false - description: Indicates if the webhook key is active - example: false - type: boolean - title: webhook_key_update_request - webhook_key_delete_response: + description: Public key to be used in the webhook + example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n' + webhook-key_delete_response: + title: webhook_key_delete_response description: webhook keys model + type: object properties: active: - description: Indicates if the webhook key is active - example: true type: boolean + example: true + description: Indicates if the webhook key is active created_at: - description: Unix timestamp in seconds with the creation date of the webhook - key + type: integer example: 1577836800 format: int64 - type: integer + description: Unix timestamp in seconds with the creation date of the webhook key deleted: - description: Indicates if the webhook key is deleted - example: true type: boolean + example: true + description: Indicates if the webhook key is deleted id: - description: Unique identifier of the webhook key - example: 62730ba6fb7dfd6a712f118e type: string + example: 62730ba6fb7dfd6a712f118e + description: Unique identifier of the webhook key livemode: - description: Indicates if the webhook key is in live mode - example: false type: boolean + example: false + description: Indicates if the webhook key is in live mode object: - description: "Object name, value is webhook_key" - example: webhook_key type: string - title: webhook_key_delete_response + example: webhook_key + description: Object name, value is webhook_key webhook_response: + title: webhook_response description: webhooks model + type: object properties: id: description: id of the webhook - example: 6307a60c41de27127515a575 type: string + example: 6307a60c41de27127515a575 description: description: A name or brief explanation of what this webhook is used for - example: Server payments processor type: string + example: Server payments processor livemode: description: Indicates if the webhook is in production - example: true type: boolean + example: true active: description: Indicates if the webhook is actived or not - example: true type: boolean + example: true object: - description: "Object name, value is 'webhook'" - example: event + description: Object name, value is 'webhook' type: string + example: event status: description: Indicates if the webhook is ready to receive events or failing - example: listening type: string + example: listening subscribed_events: description: lists the events that will be sent to the webhook - example: - - charge.created - - charge.paid - - charge.under_fraud_review - - charge.fraudulent - - charge.refunded - - charge.preauthorized - - charge.declined - - charge.canceled - - charge.reversed - - charge.pending_confirmation + type: array items: type: string - type: array - default: null + example: + - charge.created + - charge.paid + - charge.under_fraud_review + - charge.fraudulent + - charge.refunded + - charge.preauthorized + - charge.declined + - charge.canceled + - charge.reversed + - charge.pending_confirmation url: description: url or endpoint of the webhook - example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval type: string - title: webhook_response - get_webhooks_response: - allOf: - - description: pagination metadata - properties: - has_more: - description: Indicates if there are more pages to be requested - example: false - type: boolean - object: - description: "Object type, in this case is list" - example: list - type: string - required: - - has_more - - object - title: pagination metadata - - description: page metadata - properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true - type: string - title: page metadata - - properties: - data: - items: - $ref: "#/components/schemas/webhook_response" - type: array - default: null - title: get_webhooks_response + example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval webhook_request: + title: webhook_request description: a webhook + type: object + required: + - url properties: url: - description: Here you must place the URL of your Webhook remember that you - must program what you will do with the events received. Also do not forget - to handle the HTTPS protocol for greater security. - example: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8 + type: string format: url + example: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8 pattern: ^(?!.*(localhost|127\.0\.0\.1)).*$ - type: string + description: Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. subscribed_events: - description: events that will be sent to the webhook - example: customer.created + type: array items: type: string - type: array - default: null - required: - - url - title: webhook_request - update_webhook: + example: customer.created + description: events that will be sent to the webhook + webhook_update_request: + title: update_webhook description: an updated webhook + type: object properties: url: - description: Here you must place the URL of your Webhook remember that you - must program what you will do with the events received. Also do not forget - to handle the HTTPS protocol for greater security. - example: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8 + type: string format: url + example: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8 pattern: ^(?!.*(localhost|127\.0\.0\.1)).*$ - type: string + description: Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. subscribed_events: description: events that will be sent to the webhook - example: customer.created + type: array items: type: string - type: array - default: null + example: customer.created active: description: whether the webhook is active or not - example: true type: boolean - title: update_webhook + example: true securitySchemes: bearerAuth: - scheme: bearer type: http + scheme: bearer + parameters: + accept_language: + in: header + name: Accept-Language + description: Use for knowing which language to use + required: false + schema: + default: es + type: string + enum: + - es + - en + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + id: + in: path + name: id + description: Identifier of the resource + required: true + schema: + type: string + example: 6307a60c41de27127515a575 + x_child_company_id: + in: header + name: X-Child-Company-Id + description: In the case of a holding company, the company id of the child company to which will process the request. + required: false + schema: + default: null + type: string + example: 6441b6376b60c3a638da80af + limit: + in: query + name: limit + description: The numbers of items to return, the maximum value is 250 + required: false + schema: + type: integer + format: int32 + default: 20 + minimum: 1 + maximum: 250 + next_page: + in: query + name: next + description: next page + required: false + schema: + type: string + previous_page: + in: query + name: previous + description: previous page + required: false + schema: + type: string + search: + in: query + name: search + description: General order search, e.g. by mail, reference etc. + required: false + schema: + type: string + fiscal_entities_id: + in: path + name: fiscal_entities_id + description: identifier + required: true + schema: + type: string + example: fis_ent_2tQ8HkkfbauaKP9Ho + discount_lines_id: + in: path + name: discount_lines_id + description: discount line id identifier + required: true + schema: + type: string + example: dis_lin_2tQ974hSHcsdeSZHG + event_id: + in: path + name: event_id + description: event identifier + required: true + schema: + type: string + example: 6463d6e35a4c3e001819e760 + payment_status: + in: query + name: payment_status + description: Filters by order status + required: false + schema: + type: string + example: paid + last_payment_info.status: + in: query + name: last_payment_info.status + description: Filters by last payment info status + required: false + schema: + type: string + example: pending_payment + created_at: + in: query + name: created_at + description: created equal to + required: false + schema: + type: integer + example: 1612137600 + format: int64 + created_at_gte: + in: query + name: created_at.gte + description: created at greater than or equal to + required: false + schema: + type: integer + example: 1612137600 + format: int64 + created_at_lte: + in: query + name: created_at.lte + description: created at less than or equal to + required: false + schema: + type: integer + example: 1612137600 + format: int64 + updated_at_gte: + in: query + name: updated_at.gte + description: updated at greater than or equal to + required: false + schema: + type: integer + example: 1612137600 + format: int64 + updated_at_lte: + in: query + name: updated_at.lte + description: updated at less than or equal to + required: false + schema: + type: integer + example: 1612137600 + format: int64 + line_items_id: + in: path + name: line_item_id + description: identifier + required: true + schema: + type: string + example: line_item_2tQ8HkkfbauaKP9Ho + refund_id: + in: path + name: refund_id + description: refund identifier + required: true + schema: + type: string + example: 6407b5bee1329a000175ba11 + payment_method_id: + in: path + name: payment_method_id + description: Identifier of the payment method + required: true + schema: + type: string + example: src_2tQ974hSHcsdeSZHG + shipping_id: + in: path + name: shipping_id + description: identifier + required: true + schema: + type: string + example: ship_lin_2tQ974hSHcsdeSZHG + shipping_contacts_id: + in: path + name: shipping_contacts_id + description: identifier + required: true + schema: + type: string + example: 6307a60c41de27127515a575 + customer_id: + in: path + name: customer_id + description: Identifier of the customer resource + required: true + schema: + type: string + example: cus_2tGzG1GxtDAZHEGPH + subscription_id: + in: path + name: id + description: Identifier of the subscription resource + required: true + schema: + type: string + example: sub_2tGzG1GxtDAZHEGPH + tax_id: + in: path + name: tax_id + description: identifier + required: true + schema: + type: string + example: tax_lin_2tQ974hSHcsdeSZHG + id_query: + in: query + name: id + description: id of the object to be retrieved + required: false + schema: + type: string + example: 65412a893cd69a0001c25892 + charge_id: + in: query + name: charge_id + description: id of the charge used for filtering + required: false + schema: + type: string + example: 65412a893cd69a0001c25892 + type: + in: query + name: type + description: type of the object to be retrieved + required: false + schema: + type: string + example: capture + currency: + in: query + name: currency + description: currency of the object to be retrieved + required: false + schema: + type: string + example: MXN + url: + in: query + name: url + description: url for webhook filter + required: false + schema: + type: string + responses: + '401': + description: authentication error + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - message: Please include your access key in your request. + param: null + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + '402': + description: payment required error + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + '403': + description: forbidden error + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - message: Unauthorized access service, please contact support team + code: conekta.errors.forbidden.authentication.invalid_whitelist_access + debug_message: Unauthorized access to whitelists service, please contact support team + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + '404': + description: not found entity + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - message: The resource was not found. + param: null + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + '422': + description: parameter validation error + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + '428': + description: Precondition Required + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - debug_message: The order cannot be modified because it has already a charge which is pending payment. + message: The order cannot be modified because it has already a charge which is pending payment. + param: null + code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge + log_id: 641b6e233cd9a50001515039 + object: error + type: precondition_required_error + '500': + description: internal server error + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - debug_message: There was a runtime error and Conekta engineers have been notified. + message: There was a runtime error and Conekta engineers have been notified. + param: null + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + 422_whitelist: + description: whitelist validation error + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: '#/components/schemas/error' + example: + details: + - debug_message: The "custom_field" parameter is not allowed + message: El parametro "custom_field" no está permitido + code: conekta.errors.parameter_validation.whitelist + object: error + type: parameter_validation_error + log_id: 6462aa7c90fef20001633546 + requestBodies: + api_keys_create: + description: requested field for a api keys + content: + application/json: + schema: + $ref: '#/components/schemas/api_key_request' + required: true + charge_update: + description: requested field for update a charge + content: + application/json: + schema: + $ref: '#/components/schemas/charge_update_request' + required: true + charge_create: + description: requested field for a charge + content: + application/json: + schema: + $ref: '#/components/schemas/charge_request' + examples: + bnpl: + $ref: '#/components/examples/charge_bnpl' + cash: + $ref: '#/components/examples/charge_cash' + pay_by_bank: + $ref: '#/components/examples/charge_pbb' + required: true + customer: + description: requested field for customer + content: + application/json: + schema: + $ref: '#/components/schemas/customer' + required: true + update_customer: + description: requested field for customer + content: + application/json: + schema: + $ref: '#/components/schemas/update_customer' + required: true + customer_fiscal_entities: + description: requested field for customer fiscal entities + content: + application/json: + schema: + $ref: '#/components/schemas/customer_fiscal_entities_request' + required: true + customer_update_fiscal_entities: + description: requested field for customer update fiscal entities + content: + application/json: + schema: + $ref: '#/components/schemas/customer_update_fiscal_entities_request' + required: true + discount_line_create: + description: requested field for a discount lines + content: + application/json: + schema: + $ref: '#/components/schemas/order_discount_lines_request' + required: true + discount_line_update: + description: requested field for a discount lines + content: + application/json: + schema: + $ref: '#/components/schemas/update_order_discount_lines_request' + required: true + order: + description: requested field for order + content: + application/json: + schema: + $ref: '#/components/schemas/order_request' + examples: + order_with_charges: + $ref: '#/components/examples/order_with_charges' + order_with_bnpl_charges: + $ref: '#/components/examples/order_with_charges_bnpl' + order_with_pbb_charges: + $ref: '#/components/examples/order_with_charges_pbb' + order_with_checkout: + $ref: '#/components/examples/order_with_checkout' + order_with_checkout_and_force_save_card: + $ref: '#/components/examples/order_with_checkout_and_force_save_card' + order_with_subscription: + $ref: '#/components/examples/order_with_subscription' + split_payment_with_2_card_charges: + $ref: '#/components/examples/split_payment_with_2_cards' + split_payment_with_3_cash_charges: + $ref: '#/components/examples/split_payment_with_cash' + split_payment_with_cash_card_charges: + $ref: '#/components/examples/split_payment_with_cash_card' + required: true + order_update: + description: requested field for an order + content: + application/json: + schema: + $ref: '#/components/schemas/order_update_request' + required: true + product_create: + description: requested field for a product + content: + application/json: + schema: + $ref: '#/components/schemas/product' + required: true + product_update: + description: requested field for products + content: + application/json: + schema: + $ref: '#/components/schemas/update_product' + required: true + order_refunds_request: + description: requested field for a refund + required: true + content: + application/json: + schema: + required: + - amount + - reason + properties: + amount: + type: integer + example: 500 + description: Amount to be refunded in cents + expires_at: + type: integer + example: 1553273553 + format: int64 + reason: + type: string + example: suspected_fraud + description: Reason for the refund + payout_order: + description: requested field for payout order + content: + application/json: + schema: + $ref: '#/components/schemas/payout_order' + required: true + checkout: + description: requested field for checkout + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/checkout' + examples: + create_checkout_with_plan_ids: + $ref: '#/components/examples/create_checkout_with_plan_ids' + checkout_email: + description: requested field for sms checkout + content: + application/json: + schema: + type: object + required: + - email + properties: + email: + type: string + example: example@conekta.com + format: email + required: true + checkout_sms: + description: requested field for sms checkout + content: + application/json: + schema: + type: object + required: + - phonenumber + properties: + phonenumber: + type: string + example: '5566982090' + required: true + customer_payment_methods: + description: requested field for customer payment methods + content: + application/json: + schema: + description: Contains details of the payment methods that the customer has active or has used in Conekta + oneOf: + - $ref: '#/components/schemas/payment_method_token_request' + - $ref: '#/components/schemas/payment_method_cash_request' + - $ref: '#/components/schemas/payment_method_spei_request' + examples: + card: + value: + type: card + token_id: tok_test_visa_4242 + cash: + value: + type: spei_recurrent + expires_at: 1553273553 + required: true + customer_update_payment_methods: + description: requested field for customer payment methods + content: + application/json: + schema: + $ref: '#/components/schemas/update_payment_methods' + required: true + plan: + description: requested field for plan + content: + application/json: + schema: + $ref: '#/components/schemas/plan_request' + required: true + plan_update: + description: requested field for plan + content: + application/json: + schema: + $ref: '#/components/schemas/plan_update_request' + required: true + shipping_create: + description: requested field for a shipping + content: + application/json: + schema: + $ref: '#/components/schemas/shipping_request' + required: true + customer_shipping_contacts: + description: requested field for customer shippings contacts + content: + application/json: + schema: + $ref: '#/components/schemas/customer_shipping_contacts' + required: true + customer_update_shipping_contacts: + description: requested field for customer update shippings contacts + content: + application/json: + schema: + $ref: '#/components/schemas/customer_update_shipping_contacts' + required: true + subscription: + description: requested field for subscriptions + content: + application/json: + schema: + $ref: '#/components/schemas/subscription_request' + required: true + subscription_update: + description: requested field for update a subscription + content: + application/json: + schema: + $ref: '#/components/schemas/subscription_update_request' + required: true + order_tax: + description: requested field for a taxes + content: + application/json: + schema: + $ref: '#/components/schemas/order_tax_request' + required: true + order_tax_update: + description: requested field for taxes + content: + application/json: + schema: + $ref: '#/components/schemas/update_order_tax_request' + required: true + token: + description: requested field for token + content: + application/json: + schema: + $ref: '#/components/schemas/token' + required: true + webhook: + description: requested field for webhook + content: + application/json: + schema: + $ref: '#/components/schemas/webhook_request' + required: true + webhook_update: + description: requested fields in order to update a webhook + content: + application/json: + schema: + $ref: '#/components/schemas/webhook_update_request' + required: true + examples: + charge_bnpl: + value: + payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure + product_type: aplazo_bnpl + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success + type: bnpl + charge_cash: + value: + payment_method: + type: cash + charge_pbb: + value: + payment_method: + expires_at: 1680397724 + product_type: bbva_pay_by_bank + type: pay_by_bank + order_with_charges: + summary: Create an order with charges + value: + charges: + - amount: 40000 + expires_at: 1677196303 + monthly_installments: 0 + payment_method: + type: card + token_id: tok_2897348234 + payment_source_id: src_2tLkkyfMPh6v7pFry + customer_ip_address: 0.0.0.0 + reference_id: string + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: '5522997233' + corporate: false + object: customer_info + fiscal_entity: + tax_id: '1234567890' + name: Conekta Inc + email: test@gmail.com + phone: '525511223344' + metadata: + test: true + company_id: '123' + address: + street1: Nuevo Leon 254 + street2: Departamento 404 + postal_code: '06100' + city: Ciudad de Mexico + state: Ciudad de Mexico + country: MX + external_number: '123' + discount_lines: + - amount: 500 + code: '123' + type: loyalty + line_items: + - antifraud_info: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 20000 + quantity: 1 + tags: + - string + brand: string + metadata: + additionalProp1: string + additionalProp2: string + additionalProp3: string + metadata: + test: true + company_id: '123' + pre_authorize: false + shipping_contact: + phone: '525511223344' + receiver: Marvin Fuller + between_streets: Ackerman Crescent + metadata: + test: true + company_id: '123' + address: + street1: Nuevo Leon 254 + street2: Departamento 404 + postal_code: '06100' + city: Ciudad de Mexico + state: Ciudad de Mexico + country: MX + residential: true + parent_id: string + default: true + deleted: true + shipping_lines: + - amount: 100 + carrier: FEDEX + tracking_number: TRACK123 + method: TRAING + metadata: + key: value + tax_lines: + - amount: 100 + description: testing + metadata: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + order_with_charges_bnpl: + summary: Create an order with a bnpl charge + value: + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_name: Test creditea + checkout_request_type: PaymentLink + charges: + - payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure + product_type: aplazo_bnpl + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success + type: bnpl + currency: MXN + customer_info: + customer_id: cus_2xZfwfjXxX9tZhVey + line_items: + - name: Test creditea + quantity: 1 + unit_price: 300000 + order_with_charges_pbb: + summary: Create an order with a pay by bank charge + value: + charges: + - payment_method: + product_type: bbva_pay_by_bank + type: pay_by_bank + currency: MXN + customer_info: + customer_id: cus_2xZfwfjXxX9tZhVey + line_items: + - name: Test pay by bank + quantity: 1 + unit_price: 300000 + order_with_checkout: + summary: Create an order with checkout + value: + checkout: + allowed_payment_methods: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + expires_at: 0 + failure_url: string + monthly_installments_enabled: false + monthly_installments_options: + - 0 + name: string + on_demand_enabled: true + success_url: string + type: Integration + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: '5522997233' + corporate: false + object: customer_info + discount_lines: + - amount: 500 + code: '123' + type: loyalty + line_items: + - antifraud_info: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 20000 + quantity: 1 + tags: + - string + brand: string + metadata: + additionalProp1: string + additionalProp2: string + additionalProp3: string + metadata: + additionalProp1: string + additionalProp2: string + additionalProp3: string + pre_authorize: false + 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 + parent_id: string + default: true + deleted: true + shipping_lines: + - amount: 100 + carrier: FEDEX + tracking_number: TRACK123 + method: TRAING + metadata: + key: value + tax_lines: + - amount: 100 + description: testing + metadata: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + order_with_checkout_and_force_save_card: + summary: Create an order with checkout and force save card + value: + checkout: + allowed_payment_methods: + - card + force_save_card: true + name: Compra + type: Integration + currency: MXN + customer_info: + customer_id: cus_2n9g6x7q1w5k8v3a + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 20000 + quantity: 1 + tags: + - string + brand: string + order_with_subscription: + summary: Create an order with subscription plans + value: + checkout: + allowed_payment_methods: + - card + plan_ids: + - nuevo-plan + expires_at: 1746015865 + failure_url: string + monthly_installments_enabled: false + name: Embebido Prueba + on_demand_enabled: true + success_url: string + type: Integration + max_failed_retries: 3 + is_redirect_on_failure: true + currency: MXN + customer_info: + name: Prueba + email: prueba@prueba.com + phone: '+5218181818181' + corporate: false + object: customer_info + shipping_lines: + - amount: 0 + metadata: + key: value + split_payment_with_2_cards: + summary: Create an order with 2 card charges + value: + charges: + - amount: 40000 + payment_method: + type: card + token_id: tok_2897348234 + - amount: 40000 + payment_method: + type: card + token_id: tok_2897348235 + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: '5522997233' + corporate: false + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 40000 + quantity: 2 + brand: string + split_payment_with_cash: + summary: Create an order with 3 cash charges + value: + charges: + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: '5522997233' + corporate: false + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 10000 + quantity: 3 + brand: string + split_payment_with_cash_card: + summary: Create an order with 3 cash and 2 card charges + value: + charges: + - amount: 10000 + payment_method: + type: card + token_id: tok_2897348234 + - amount: 10000 + payment_method: + type: card + token_id: tok_2897348235 + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: '5522997233' + corporate: false + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 50000 + quantity: 1 + brand: string + order_cash: + value: + livemode: true + amount: 1560 + currency: MXN + payment_status: pending_payment + amount_refunded: 0 + split_payment: false + customer_info: + email: franco.longhi@conekta.com + phone: 539-933-3810 + name: franco golden + corporate: null + customer_id: null + object: customer_info + shipping_contact: null + channel: null + fiscal_entity: null + object: order + id: ord_2xayxSvfWzQ2TLz7r + metadata: {} + is_refundable: false + processing_mode: null + created_at: 1741103510 + updated_at: 1741103510 + line_items: + object: list + has_more: false + total: 1 + data: + - name: APOYO URGENTE REFERENCIA + description: null + unit_price: 1560 + quantity: 1 + sku: COL094 + tags: null + brand: CHEDRAUI + type: null + object: line_item + id: line_item_2xayxSvfWzQ2TLz7p + parent_id: ord_2xayxSvfWzQ2TLz7r + metadata: {} + antifraud_info: {} + shipping_lines: null + tax_lines: null + discount_lines: null + charges: + object: list + has_more: false + total: 1 + data: + - id: 67c72196e777ac0001f2140c + livemode: true + created_at: 1741103510 + currency: MXN + failure_code: null + failure_message: null + monthly_installments: null + device_fingerprint: null + channel: null + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001140326893401915.png + store: null + auth_code: null + agreement: null + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + reference: 10001140326893402000 + cashier_id: null + product_type: cash_in + object: charge + description: Payment from order + is_refundable: false + reference_id: null + status: pending_payment + amount: 1560 + paid_at: null + customer_id: '' + order_id: ord_2xayxSvfWzQ2TLz7r + refunds: null + order_cash_multiple: + value: + livemode: true + amount: 156000 + currency: MXN + payment_status: pending_payment + amount_refunded: 0 + split_payment: false + customer_info: + email: franco.longhi@conekta.com + phone: 884-712-6894 + name: franco golden + corporate: null + customer_id: null + object: customer_info + shipping_contact: null + channel: null + fiscal_entity: null + object: order + id: ord_2xazGvtKYTjxTUZU3 + metadata: {} + is_refundable: false + processing_mode: null + created_at: 1741104962 + updated_at: 1741104963 + line_items: + object: list + has_more: false + total: 1 + data: + - name: APOYO URGENTE REFERENCIA + description: null + unit_price: 156000 + quantity: 1 + sku: COL094 + tags: null + brand: CHEDRAUI + type: null + object: line_item + id: line_item_2xazGvtKYTjxTUZU1 + parent_id: ord_2xazGvtKYTjxTUZU3 + metadata: {} + antifraud_info: {} + shipping_lines: null + tax_lines: null + discount_lines: null + charges: + object: list + has_more: false + total: 2 + data: + - id: 67c72742e777ac0001f21463 + livemode: true + created_at: 1741104962 + currency: MXN + failure_code: null + failure_message: null + monthly_installments: null + device_fingerprint: null + channel: null + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/bbva/10830309851141878231.png + store: null + auth_code: null + agreement: '2409992' + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - BBVA ATM + reference: 10830309851141878000 + cashier_id: null + product_type: bbva_cash_in + object: charge + description: Payment from order + is_refundable: false + reference_id: null + status: pending_payment + amount: 156000 + paid_at: null + customer_id: '' + order_id: ord_2xazGvtKYTjxTUZU3 + refunds: null + - id: 67c72742e777ac0001f2145b + livemode: true + created_at: 1741104962 + currency: MXN + failure_code: null + failure_message: null + monthly_installments: null + device_fingerprint: null + channel: null + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001244873740402013.png + store: null + auth_code: null + agreement: null + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + reference: 10001244873740403000 + cashier_id: null + product_type: cash_in + object: charge + description: Payment from order + is_refundable: false + reference_id: null + status: pending_payment + amount: 156000 + paid_at: null + customer_id: '' + order_id: ord_2xazGvtKYTjxTUZU3 + refunds: null + order_card: + value: + id: 63dab7d00558720001bb3c7d + livemode: true, + created_at: 1675278289, + currency: MXN + failure_code: suspected_fraud + failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso. + device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba + payment_method: + name: Fulanito Perez + exp_month: 2 + exp_year: 30 + object: card_payment + type: credit + last4: 4242 + brand: visa + issuer: BANAMEX + account_type: Credit + country: MX + fraud_indicators: + - description: El usuario está utilizando una tarjeta de crédito o débito de prueba en modo producción. + weight: null + value: null + object: charge + description: Payment from order + status: declined + amount: 20001, + fee: 116, + customer_id: null + order_id: ord_2tHuwPhgSwq6Gt7Rg + order_bnpl: + value: + amount: 300000 + amount_refunded: 0 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pWw + segment: Checkout + charges: + data: + - amount: 300000 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pXA + segment: Checkout + created_at: 1741015718 + currency: MXN + customer_id: '' + description: Payment from order + device_fingerprint: null + failure_code: null + failure_message: null + id: 67c5caa665f9b400015dec40 + is_refundable: false + livemode: true + monthly_installments: null + object: charge + order_id: ord_2xaegxs5s69VP4pWy + paid_at: null + payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + expires_at: 1743694118 + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + object: bnpl_payment + product_type: aplazo_bnpl + redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + type: bnpl + reference_id: null + refunds: null + status: pending_payment + has_more: false + object: list + total: 1 + checkout: null + created_at: 1741015718 + currency: MXN + customer_info: + corporate: false + customer_custom_reference: null + customer_id: cus_2xZfwfjXxX9tZhVey + email: alexis.ruiz@google.com + name: Pedro Ruiz + object: customer_info + phone: '+5215555555555' + discount_lines: null + fiscal_entity: null + id: ord_2xaegxs5s69VP4pWy + is_refundable: false + line_items: + data: + - antifraud_info: {} + brand: null + description: null + id: line_item_2xaegxs5s69VP4pWv + metadata: {} + name: Test creditea + object: line_item + parent_id: ord_2xaegxs5s69VP4pWy + quantity: 1 + sku: null + tags: null + type: null + unit_price: 300000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + payment_status: pending_payment + processing_mode: null + shipping_contact: null + shipping_lines: null + split_payment: false + tax_lines: null + updated_at: 1741015718 + order_pbb: + value: + amount: 300000 + amount_refunded: 0 + charges: + data: + - amount: 300000 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pXA + segment: Checkout + created_at: 1741015718 + currency: MXN + customer_id: '' + description: Payment from order + device_fingerprint: null + failure_code: null + failure_message: null + id: 67c5caa665f9b400015dec40 + is_refundable: false + livemode: true + monthly_installments: null + object: charge + order_id: ord_2xaegxs5s69VP4pWy + paid_at: null + payment_method: + expires_at: 1743694118 + object: pay_by_bank_payment + product_type: bbva_pay_by_bank + redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ + deep_link: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 + type: pay_by_bank + reference: '22277523174328893295' + reference_id: null + refunds: null + status: pending_payment + has_more: false + object: list + total: 1 + checkout: null + created_at: 1741015718 + currency: MXN + customer_info: + corporate: false + customer_custom_reference: null + customer_id: cus_2xZfwfjXxX9tZhVey + email: alexis.ruiz@google.com + name: Pedro Ruiz + object: customer_info + phone: '+5215555555555' + discount_lines: null + fiscal_entity: null + id: ord_2xaegxs5s69VP4pWy + is_refundable: false + line_items: + data: + - antifraud_info: {} + brand: null + description: null + id: line_item_2xaegxs5s69VP4pWv + metadata: {} + name: Test pay by bank + object: line_item + parent_id: ord_2xaegxs5s69VP4pWy + quantity: 1 + sku: null + tags: null + type: null + unit_price: 300000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + payment_status: pending_payment + processing_mode: null + shipping_contact: null + shipping_lines: null + split_payment: false + tax_lines: null + updated_at: 1741015718 + order_checkout: + value: + amount: 12000 + amount_refunded: 0 + charges: null + checkout: + allowed_payment_methods: + - card + - bnpl + - cash + - pay_by_bank + - bank_transfer + - apple + can_not_expire: false + emails_sent: 0 + exclude_card_networks: [] + expires_at: 1772171999 + failure_url: https://natalie.net + force_3ds_flow: false + id: 1263626c-53ae-4829-b092-2e7393f2d1b7 + is_redirect_on_failure: true + livemode: true + max_failed_retries: null + metadata: {} + monthly_installments_enabled: false + monthly_installments_options: [] + name: Pago de Servicio + needs_shipping_contact: false + object: checkout + paid_payments_count: 0 + payments_limit_count: null + plan_id: null + recurrent: false + redirection_time: null + slug: 1263626c53ae4829b0922e7393f2d1b7 + sms_sent: 0 + starts_at: 1771912800 + status: Issued + success_url: https://giovanna.info + three_ds_mode: null + type: HostedPayment + url: https://pay.conekta.com/checkout/1263626c53ae4829b0922e7393f2d1b7 + channel: + checkout_request_id: 1263626c-53ae-4829-b092-2e7393f2d1b7 + checkout_request_type: HostedPayment + id: channel_2zbhetCd6CmpJeFsY + original_checkout_request_id: null + original_checkout_request_type: null + segment: Checkout + created_at: 1771950546 + currency: MXN + customer_info: + corporate: null + customer_id: null + date_of_birth: null + email: xono.bernie@conekta.com + name: Juan Rosas + national_id: null + object: customer_info + phone: '5531431590' + discount_lines: null + fiscal_entity: null + id: ord_2zbhesToa1DAgNbP6 + is_refundable: false + line_items: + data: + - antifraud_info: {} + brand: addidas + description: null + id: line_item_2zbhesToa1DAgNbP3 + metadata: {} + name: Aretes Tres Círculos Numerales + object: line_item + parent_id: ord_2zbhesToa1DAgNbP6 + quantity: 1 + sku: COL094 + tags: null + type: null + unit_price: 10000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + payment_status: null + processing_mode: null + shipping_contact: null + shipping_lines: null + split_payment: null + tax_lines: + data: + - amount: 2000 + description: test + id: tax_lin_2zbhesToa1DAgNbP4 + metadata: null + object: tax_line + parent_id: ord_2zbhesToa1DAgNbP6 + has_more: false + object: list + total: 1 + updated_at: 1771950546 + create_checkout_with_plan_ids: + summary: Create Checkout with Plan IDs + value: + name: Payment Link con Plan + type: PaymentLink + recurrent: false + expires_at: 1745331574 + allowed_payment_methods: + - card + needs_shipping_contact: false + plan_ids: + - plan_ejemplo_1 + - plan_ejemplo_2 + order_template: + line_items: + - name: Producto de Ejemplo + unit_price: 15000 + quantity: 1 + currency: MXN + customer_info: + name: Cliente Ejemplo + email: ejemplo@conekta.com + phone: '5555555555' + metadata: + reference: mi_referencia_123 + more_info: datos_adicionales + customer_payment_source_cash_example: + value: + next_page_url: null, + previous_page_url: null, + has_more: false, + object: list, + data: + - id: off_ref_2xayPUpcxeTrotDHr + object: payment_source + provider: Cash + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + - BBVA ATM + type: cash_recurrent + reference: 10001189383263801812_caca + barcode: 10001189383263801000 + barcode_url: https://barcode.conekta.com/cash/cashin/10001189383263801812.png + expires_at: 0 + created_at: 1741100921 + parent_id: cus_2xayPFXsb4LBZ2GUL + agreements: + - provider: bbva_cash_in + agreement: 2409526 + shipping: + value: + amount: 0 + carrier: Fedex + method: Airplane + tracking_number: TRACK123 + object: shipping_line + id: ship_lin_2sLxi45ZFs1GHJmzx + parent_id: ord_2sLxi3MqYFJ1QfTmP + deleted: true From 321fafef7770b8210ebe6ecfc682f5e5be32ab8c Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Mon, 6 Jul 2026 10:41:39 -0400 Subject: [PATCH 08/10] chore: regenerate _build/api.yaml after rebase onto release/v2.3.0 Co-Authored-By: Claude Fable 5 --- _build/api.yaml | 85 +++++++++++++++++++++++++++++++++++++------------ 1 file changed, 65 insertions(+), 20 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index 87fcd85..1a8ec00 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -2889,6 +2889,8 @@ paths: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/next_page' - $ref: '#/components/parameters/previous_page' + - $ref: '#/components/parameters/currency' + - $ref: '#/components/parameters/frequency' post: tags: - Plans @@ -5681,8 +5683,7 @@ components: type: integer example: 1683053729 format: int64 - minimum: 0 - exclusiveMinimum: 7 + exclusiveMinimum: 0 description: Expiration date of the charge product_type: type: string @@ -10485,7 +10486,10 @@ components: required: false schema: type: string - example: paid + examples: + payment_status: + summary: Filters by order status + value: paid last_payment_info.status: in: query name: last_payment_info.status @@ -10493,7 +10497,10 @@ components: required: false schema: type: string - example: pending_payment + examples: + last_payment_info.status: + summary: Filters by last payment info status + value: pending_payment created_at: in: query name: created_at @@ -10501,8 +10508,11 @@ components: required: false schema: type: integer - example: 1612137600 format: int64 + examples: + created_at: + summary: created equal to + value: 1612137600 created_at_gte: in: query name: created_at.gte @@ -10510,8 +10520,11 @@ components: required: false schema: type: integer - example: 1612137600 format: int64 + examples: + created_at.gte: + summary: created at greater than or equal to + value: 1612137600 created_at_lte: in: query name: created_at.lte @@ -10519,8 +10532,11 @@ components: required: false schema: type: integer - example: 1612137600 format: int64 + examples: + created_at.lte: + summary: created at less than or equal to + value: 1612137600 updated_at_gte: in: query name: updated_at.gte @@ -10528,8 +10544,11 @@ components: required: false schema: type: integer - example: 1612137600 format: int64 + examples: + updated_at.gte: + summary: updated at greater than or equal to + value: 1612137600 updated_at_lte: in: query name: updated_at.lte @@ -10537,8 +10556,11 @@ components: required: false schema: type: integer - example: 1612137600 format: int64 + examples: + updated_at.lte: + summary: updated at less than or equal to + value: 1612137600 line_items_id: in: path name: line_item_id @@ -10563,6 +10585,28 @@ components: schema: type: string example: src_2tQ974hSHcsdeSZHG + currency: + in: query + name: currency + description: currency of the object to be retrieved + required: false + schema: + type: string + examples: + currency: + summary: currency of the object to be retrieved + value: MXN + frequency: + in: query + name: frequency + description: frequency of the object to be retrieved + required: false + schema: + type: integer + examples: + frequency: + summary: Frequency of the object to be retrieved + value: 1 shipping_id: in: path name: shipping_id @@ -10610,7 +10654,10 @@ components: required: false schema: type: string - example: 65412a893cd69a0001c25892 + examples: + id: + summary: id of the object to be retrieved + value: 65412a893cd69a0001c25892 charge_id: in: query name: charge_id @@ -10618,7 +10665,10 @@ components: required: false schema: type: string - example: 65412a893cd69a0001c25892 + examples: + charge_id: + summary: id of the charge used for filtering + value: 65412a893cd69a0001c25892 type: in: query name: type @@ -10626,15 +10676,10 @@ components: required: false schema: type: string - example: capture - currency: - in: query - name: currency - description: currency of the object to be retrieved - required: false - schema: - type: string - example: MXN + examples: + type: + summary: type of the object to be retrieved + value: capture url: in: query name: url From 48c60f8eea7a33d09b58f209bbc5e4e64c368360 Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Mon, 6 Jul 2026 10:44:59 -0400 Subject: [PATCH 09/10] fix: regenerate bundle with openapi-generator to match updated CI check The rebase brought in an updated check.yml that validates _build/api.yaml against openapi-generator v7.23.0 output (openapi-yaml-client layout), replacing the redocly-based check this branch had previously aligned to. Restore the original openapi-generator make merge target and regenerate the bundle with it. The new auto-generated-schema-names guard passes (no _allOf/_inner/_*_response names in the output). Co-Authored-By: Claude Fable 5 --- Makefile | 8 +- _build/api.yaml | 27890 ++++++++++++++++++++++++++++++++-------------- 2 files changed, 19299 insertions(+), 8599 deletions(-) diff --git a/Makefile b/Makefile index 64de214..138f3ac 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,10 @@ -# Must stay in sync with .github/workflows/ci.yml (Bundle OpenAPI document step), -# which diffs a fresh redocly bundle against the committed _build/api.yaml. merge: docker run --rm \ - -v ${PWD}:/spec redocly/cli:2.34.0 bundle api.yaml -o /spec/_build/api.yaml + -v ${PWD}:/local openapitools/openapi-generator-cli:v7.23.0 generate \ + -g openapi-yaml \ + -i /local/api.yaml \ + -p outputFile=local/_build/api.yaml \ + --skip-validate-spec update-readme: make merge && rdme openapi upload --key=${README_API_KEY} --branch=v2.3.0 --slug=conekta-api _build/api.yaml diff --git a/_build/api.yaml b/_build/api.yaml index 1a8ec00..7b0523a 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -1,837 +1,2111 @@ openapi: 3.1.0 info: - description: Conekta sdk - version: 2.3.0 contact: + email: engineering@conekta.com name: Engineering Conekta url: https://github.com/conekta/openapi/issues - email: engineering@conekta.com - title: Conekta API + description: Conekta sdk license: name: MIT-LICENSE url: https://www.apache.org/licenses/LICENSE-2.0.html + title: Conekta API + version: 2.3.0 servers: - - url: https://api.conekta.io - description: Conekta main server +- description: Conekta main server + url: https://api.conekta.io security: - - bearerAuth: [] +- bearerAuth: [] tags: - - name: Subscriptions - description: All subscription-related endpoints including creation, management, and events - - name: Subscriptions - Customer Portal - description: Customer portal endpoints for subscriptions +- description: "All subscription-related endpoints including creation, management,\ + \ and events" + name: Subscriptions +- description: Customer portal endpoints for subscriptions + name: Subscriptions - Customer Portal paths: /antifraud/whitelists: get: - tags: - - Antifraud - operationId: GetRuleWhitelist description: Return all rules - summary: Get a list of whitelisted rules + operationId: GetRuleWhitelist parameters: - - $ref: '#/components/parameters/accept_language' + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: All the rules + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/risk_rules_list' - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '500': - $ref: '#/components/responses/500' - post: + $ref: "#/components/schemas/risk_rules_list" + description: All the rules + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "403": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: "Unauthorized access service, please contact support team" + code: conekta.errors.forbidden.authentication.invalid_whitelist_access + debug_message: "Unauthorized access to whitelists service, please\ + \ contact support team" + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: forbidden error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + summary: Get a list of whitelisted rules tags: - - Antifraud + - Antifraud + post: operationId: CreateRuleWhitelist - summary: Create whitelisted rule parameters: - - $ref: '#/components/parameters/accept_language' - responses: - '200': - description: successfully registered rule - content: - application/vnd.conekta-v2.3.0+json: - schema: - title: whitelistlist_rule_response - properties: - id: - type: string - example: 2fw8EWJusiRrxdPzT - description: Whitelist rule id - field: - type: string - example: email - description: field used for whitelists rule - value: - type: string - example: email@example.com - description: value used for whitelists rule - description: - type: string - example: banned customer example@example.com - description: use an description for whitelisted rule - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '500': - $ref: '#/components/responses/500' + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_risk_rules_data' + $ref: "#/components/schemas/CreateRuleWhitelist_request" + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/whitelistlist_rule_response" + description: successfully registered rule + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "403": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: "Unauthorized access service, please contact support team" + code: conekta.errors.forbidden.authentication.invalid_whitelist_access + debug_message: "Unauthorized access to whitelists service, please\ + \ contact support team" + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: forbidden error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + summary: Create whitelisted rule + tags: + - Antifraud /antifraud/whitelists/{id}: delete: - tags: - - Antifraud operationId: DeleteRuleWhitelist parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - summary: Delete whitelisted rule + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successfully deleted rule + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: deleted_whitelist_rule_response - properties: - id: - type: string - example: 2fw8EWJusiRrxdPzT - description: Whitelist rule id - field: - type: string - example: email - description: field used for whitelists rule deleted - value: - type: string - example: email@example.com - description: value used for whitelists rule deleted - description: - type: string - example: secure customer example@example.com - description: use an description for whitelisted rule - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/deleted_whitelist_rule_response" + description: successfully deleted rule + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "403": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: "Unauthorized access service, please contact support team" + code: conekta.errors.forbidden.authentication.invalid_whitelist_access + debug_message: "Unauthorized access to whitelists service, please\ + \ contact support team" + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: forbidden error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + summary: Delete whitelisted rule + tags: + - Antifraud /antifraud/blacklists: get: - tags: - - Antifraud - operationId: GetRuleBlacklist description: Return all rules - summary: Get list of blacklisted rules + operationId: GetRuleBlacklist parameters: - - $ref: '#/components/parameters/accept_language' + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: All the rules + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/risk_rules_list' - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' - post: + $ref: "#/components/schemas/risk_rules_list" + description: All the rules + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + summary: Get list of blacklisted rules tags: - - Antifraud + - Antifraud + post: operationId: CreateRuleBlacklist - summary: Create blacklisted rule parameters: - - $ref: '#/components/parameters/accept_language' - responses: - '200': - description: successfully registered rule - content: - application/vnd.conekta-v2.3.0+json: - schema: - title: blacklist_rule_response - properties: - id: - type: string - example: 2fw8EWJusiRrxdPzT - description: Blacklist rule id - field: - type: string - example: email - description: field used for blacklists rule - value: - type: string - example: email@example.com - description: value used for blacklists rule - description: - type: string - example: secure customer example@example.com - description: use an description for blacklisted rule - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple requestBody: - description: requested field for blacklist rule content: application/json: schema: - $ref: '#/components/schemas/create_risk_rules_data' + $ref: "#/components/schemas/CreateRuleWhitelist_request" + description: requested field for blacklist rule required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/blacklist_rule_response" + description: successfully registered rule + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + summary: Create blacklisted rule + tags: + - Antifraud /antifraud/blacklists/{id}: delete: - summary: Delete blacklisted rule - tags: - - Antifraud operationId: DeleteRuleBlacklist parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successfully deleted rule + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: deleted_blacklist_rule_response - properties: - id: - type: string - example: 2fw8EWJusiRrxdPzT - description: Blacklist rule id - field: - type: string - example: email - description: field used for blacklists rule deleted - value: - type: string - example: email@example.com - description: value used for blacklists rule deleted - description: - type: string - example: banned customer example@example.com - description: use an description for blacklisted rule - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/deleted_blacklist_rule_response" + description: successfully deleted rule + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + summary: Delete blacklisted rule + tags: + - Antifraud /api_keys: get: - tags: - - Api Keys - operationId: getApiKeys - summary: Get list of Api Keys description: Consume the list of api keys you have + operationId: getApiKeys + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form + - description: "General search, e.g. by id, description, prefix" + explode: true + in: query + name: search + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_api_keys_response - allOf: - - $ref: '#/components/schemas/page' - - $ref: '#/components/schemas/pagination' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/api_key_response' + $ref: "#/components/schemas/get_api_keys_response" + description: successful headers: Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - - description: General search, e.g. by id, description, prefix - in: query - name: search - required: false - schema: - type: string - post: + - bearerAuth: [] + summary: Get list of Api Keys tags: - - Api Keys - operationId: createApiKey - summary: Create Api Key + - Api Keys + post: description: Create a api key + operationId: createApiKey + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/api_key_request" + description: requested field for a api keys + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: api_key_create_response - allOf: - - type: object - properties: - authentication_token: - type: string - example: key_rpHzxufNgjFCdprEEFZRTKi - description: It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place. - - $ref: '#/components/schemas/api_key_response' + $ref: "#/components/schemas/api_key_create_response" + description: successful operation headers: Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/api_keys_create' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /api_keys/{id}: - get: + - bearerAuth: [] + summary: Create Api Key tags: - - Api Keys - operationId: getApiKey - summary: Get Api Key - description: Gets a api key that corresponds to a api key ID + - Api Keys + /api_keys/{id}: + delete: + description: Deletes a api key that corresponds to a api key ID + operationId: deleteApiKey + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/api_key_response' + $ref: "#/components/schemas/delete_api_keys_response" + description: successful headers: Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - put: - tags: - - Api Keys - operationId: updateApiKey - summary: Update Api Key - description: Update an existing api key - responses: - '200': - description: successful operation + type: string + style: simple + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/api_key_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - content: - application/json: - schema: - type: object - title: api_key_update_request - properties: - active: - type: boolean - example: true - description: Indicates if the webhook key is active - description: - type: string - example: online store - description: A name or brief explanation of what this api key is used for - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - delete: - tags: - - Api Keys - operationId: deleteApiKey + - bearerAuth: [] summary: Delete Api Key - description: Deletes a api key that corresponds to a api key ID + tags: + - Api Keys + get: + description: Gets a api key that corresponds to a api key ID + operationId: getApiKey + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: delete_api_keys_response - allOf: - - $ref: '#/components/schemas/api_key_response_on_delete' - - type: object - properties: - deleted: - type: boolean - example: true + $ref: "#/components/schemas/api_key_response" + description: successful headers: Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Get Api Key + tags: + - Api Keys + put: + description: Update an existing api key + operationId: updateApiKey parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/api_key_update_request" + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/api_key_response" + description: successful operation + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Update Api Key + tags: + - Api Keys /balance: get: - tags: - - Balances - operationId: getBalance - summary: Get a company's balance description: Get a company's balance + operationId: getBalance + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/balance_response' + $ref: "#/components/schemas/balance_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' + - bearerAuth: [] + summary: Get a company's balance + tags: + - Balances /charges: get: - tags: - - Charges operationId: getCharges - summary: Get A List of Charges + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_charges_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/charge_response' + $ref: "#/components/schemas/get_charges_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '422': - $ref: '#/components/responses/422_whitelist' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: The "custom_field" parameter is not allowed + message: El parametro "custom_field" no está permitido + code: conekta.errors.parameter_validation.whitelist + object: error + type: parameter_validation_error + log_id: 6462aa7c90fef20001633546 + schema: + $ref: "#/components/schemas/error" + description: whitelist validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' + - bearerAuth: [] + summary: Get A List of Charges + tags: + - Charges /charges/{id}: put: - tags: - - Charges operationId: updateCharge - summary: Update a charge + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/charge_update_request" + description: requested field for update a charge + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/charge_response' + $ref: "#/components/schemas/charge_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422_whitelist' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: The "custom_field" parameter is not allowed + message: El parametro "custom_field" no está permitido + code: conekta.errors.parameter_validation.whitelist + object: error + type: parameter_validation_error + log_id: 6462aa7c90fef20001633546 + schema: + $ref: "#/components/schemas/error" + description: whitelist validation error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/charge_update' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Update a charge + tags: + - Charges /orders/{id}/charges: post: - tags: - - Charges - operationId: ordersCreateCharge - summary: Create charge description: Create charge for an existing orden + operationId: ordersCreateCharge + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + examples: + bnpl: + value: + payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure + product_type: aplazo_bnpl + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success + type: bnpl + cash: + value: + payment_method: + type: cash + pay_by_bank: + value: + payment_method: + expires_at: 1680397724 + product_type: bbva_pay_by_bank + type: pay_by_bank + schema: + $ref: "#/components/schemas/charge_request" + description: requested field for a charge + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/charge_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '428': - $ref: '#/components/responses/428' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/charge_order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "428": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: The order cannot be modified because it has already + a charge which is pending payment. + message: The order cannot be modified because it has already a charge + which is pending payment. + code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge + log_id: 641b6e233cd9a50001515039 + object: error + type: precondition_required_error + schema: + $ref: "#/components/schemas/error" + description: Precondition Required + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/charge_create' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Create charge + tags: + - Charges /orders/{id}/add_charges: post: - tags: - - Charges - operationId: ordersCreateCharges - summary: Create charges description: Create charges for an existing orden + operationId: ordersCreateCharges + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + examples: + bnpl: + value: + payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure + product_type: aplazo_bnpl + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success + type: bnpl + cash: + value: + payment_method: + type: cash + pay_by_bank: + value: + payment_method: + expires_at: 1680397724 + product_type: bbva_pay_by_bank + type: pay_by_bank + schema: + $ref: "#/components/schemas/charge_request" + description: requested field for a charge + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/charges_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '428': - $ref: '#/components/responses/428' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/charges_order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "428": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: The order cannot be modified because it has already + a charge which is pending payment. + message: The order cannot be modified because it has already a charge + which is pending payment. + code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge + log_id: 641b6e233cd9a50001515039 + object: error + type: precondition_required_error + schema: + $ref: "#/components/schemas/error" + description: Precondition Required + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/charge_create' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Create charges + tags: + - Charges /companies: get: - tags: - - Companies + description: Consume the list of child companies. This is used for holding + companies with several child entities. operationId: getCompanies - summary: Get List of Companies - description: Consume the list of child companies. This is used for holding companies with several child entities. + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_companies_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/company_response' + $ref: "#/components/schemas/get_companies_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - post: + - bearerAuth: [] + summary: Get List of Companies tags: - - Companies + - Companies + post: + description: Create a new company. operationId: createCompany - summary: Create Company - description: Create a new company. requestBody: - description: Company data - required: true content: application/json: schema: - $ref: '#/components/schemas/create_company_request' + $ref: "#/components/schemas/Create_Company_Request" + description: Company data + required: true responses: - '201': - description: Company created successfully + "201": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/company_response' + $ref: "#/components/schemas/company_response" + description: Company created successfully headers: Date: description: The date and time that the response was sent + explode: false schema: type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: type: string + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: type: string + style: simple Conekta-Media-Type: + explode: false schema: type: string - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Create Company + tags: + - Companies /companies/{id}: get: - tags: - - Companies operationId: getCompany - summary: Get Company + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/company_response' + $ref: "#/components/schemas/company_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - bearerAuth: [] + summary: Get Company + tags: + - Companies /companies/current: get: - tags: - - Companies + description: Retrieves information about the currently authenticated company. + This endpoint returns the same data as the standard company endpoint but automatically + uses the current company's context. operationId: getCurrentCompany - summary: Get Current Company - description: Retrieves information about the currently authenticated company. This endpoint returns the same data as the standard company endpoint but automatically uses the current company's context. + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/company_response' example: id: 2a1b3c4d5e6f7g8h9i0j1k2l name: Mi Empresa S.A. de C.V. - mcc: '5311' + mcc: "5311" active: true account_status: activated antifraud_vertical: physical_goods @@ -839,7 +2113,7 @@ paths: payment_link_enabled: true commercial_info: web_page: https://miempresa.mx - facebook: '' + facebook: "" category: Venta al menudeo average_sale: Range10KPlus monthly_sales: Range0To100K @@ -847,7 +2121,7 @@ paths: physical: false already_selling: true tos_page: https://miempresa.com/terminos - website_instructions: '' + website_instructions: "" object: commercial_info legal_info: name: MARIA GONZALEZ @@ -860,7 +2134,7 @@ paths: tax_id: EMP121008MU7 legal_entity_name: Mi Empresa S.A. de C.V. business_type: Persona moral - phone: '5563794965' + phone: "5563794965" address: street1: AVENIDA INSURGENTES street2: ROMA NORTE @@ -868,27 +2142,28 @@ paths: city: México state: CIUDAD DE MEXICO country: MEX - zip: '06700' - external_number: '123' - internal_number: '201' + zip: "06700" + external_number: "123" + internal_number: "201" object: address bank_account: - account_number: '123456789012345678' + account_number: "123456789012345678" account_holder_name: Mi Empresa S.A. de C.V. - bank: Sistema de Transferencias y Pagos STP, S.A. de C.V., SOFOM E.N.R. + bank: "Sistema de Transferencias y Pagos STP, S.A. de C.V., SOFOM\ + \ E.N.R." object: fiscal_info_bank_account files: - - id: 1239z8y7x6w5v4u3t2s1r0q9p8o - file_name: constancia_fiscal.pdf - file_type: fiscal_id - url: https://example.com/documents/constancia-fiscal.pdf - object: file + - id: 1239z8y7x6w5v4u3t2s1r0q9p8o + file_name: constancia_fiscal.pdf + file_type: fiscal_id + url: https://example.com/documents/constancia-fiscal.pdf + object: file object: fiscal_info user_accounts: - - role: owner - token: '1234567890' - livemode: true - object: user_account + - role: owner + token: "1234567890" + livemode: true + object: user_account capture_fees: oxxo_commission: 0.035 banorte_commission: 0.01 @@ -911,16 +2186,16 @@ paths: amex_nine_month_installments_commission: 0.079 amex_twelve_month_installments_commission: 0.099 webhooks: - - id: '1234567890' - url: https://miempresa.com/api/webhook - subscribed_events: - - charge.created - - charge.paid - - order.paid - status: listening - object: webhook - production_enabled: true - development_enabled: false + - id: "1234567890" + url: https://miempresa.com/api/webhook + subscribed_events: + - charge.created + - charge.paid + - order.paid + status: listening + object: webhook + production_enabled: true + development_enabled: false object: company oxxo_payments_enabled: true spei_payments_enabled: true @@ -931,5498 +2206,14900 @@ paths: card_max_limit: 10000000 voucher_card_categories: [] internal_scopes: - - orders + - orders retention: true three_ds_enabled: true three_ds_mode: strict + schema: + $ref: "#/components/schemas/company_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: - description: The version of the API used to process the request and the format of the response body + description: The version of the API used to process the request and + the format of the response body + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - /companies/{company_id}/document: - post: + - bearerAuth: [] + summary: Get Current Company tags: - - Companies - operationId: uploadCompanyDocument - summary: Upload Company Document - description: Uploads a document associated with a specific company. + - Companies + /companies/{company_id}/document: + patch: + description: Updates an existing document associated with a specific company. + operationId: updateCompanyDocument parameters: - - name: company_id - in: path - required: true - description: The unique identifier of the company. - schema: - type: string - example: 6827206b1ec60400015eb09a - - $ref: '#/components/parameters/accept_language' - requestBody: - description: Document information to upload. + - description: The unique identifier of the company. + explode: false + in: path + name: company_id required: true + schema: + example: 6827206b1ec60400015eb09a + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: content: application/json: schema: - $ref: '#/components/schemas/company_document_request' + $ref: "#/components/schemas/CompanyDocumentRequest" + description: Document information to update. + required: true responses: - '201': - description: Document uploaded successfully. + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/company_document_response' + $ref: "#/components/schemas/CompanyDocumentResponse" + description: Document updated successfully. headers: Date: description: The date and time that the response was sent + explode: false schema: type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: type: string + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: type: string + style: simple Conekta-Media-Type: + explode: false schema: type: string - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - patch: - tags: - - Companies - operationId: updateCompanyDocument + - bearerAuth: [] summary: Update Company Document - description: Updates an existing document associated with a specific company. + tags: + - Companies + post: + description: Uploads a document associated with a specific company. + operationId: uploadCompanyDocument parameters: - - name: company_id - in: path - required: true - description: The unique identifier of the company. - schema: - type: string - example: 6827206b1ec60400015eb09a - - $ref: '#/components/parameters/accept_language' - requestBody: - description: Document information to update. + - description: The unique identifier of the company. + explode: false + in: path + name: company_id required: true + schema: + example: 6827206b1ec60400015eb09a + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: content: application/json: schema: - $ref: '#/components/schemas/company_document_request' + $ref: "#/components/schemas/CompanyDocumentRequest" + description: Document information to upload. + required: true responses: - '200': - description: Document updated successfully. + "201": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/company_document_response' + $ref: "#/components/schemas/CompanyDocumentResponse" + description: Document uploaded successfully. headers: Date: description: The date and time that the response was sent + explode: false schema: type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: type: string + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: type: string + style: simple Conekta-Media-Type: + explode: false schema: type: string - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Upload Company Document + tags: + - Companies /companies/{company_id}/documents: get: - tags: - - Companies - operationId: getCompanyDocuments - summary: Get Company Documents description: Retrieve a list of documents associated with a specific company. + operationId: getCompanyDocuments parameters: - - name: company_id - in: path - required: true - description: The unique identifier of the company. - schema: - type: string - example: 6307a60c41de27127515a575 - - $ref: '#/components/parameters/accept_language' + - description: The unique identifier of the company. + explode: false + in: path + name: company_id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: A list of documents for the company. + "200": content: application/vnd.conekta-v2.3.0+json: schema: - type: array items: - $ref: '#/components/schemas/company_document_response' + $ref: "#/components/schemas/CompanyDocumentResponse" + type: array + default: null + description: A list of documents for the company. headers: Date: description: The date and time that the response was sent + explode: false schema: type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: type: string + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: type: string + style: simple Conekta-Media-Type: + explode: false schema: type: string - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - /customers: - post: + - bearerAuth: [] + summary: Get Company Documents tags: - - Customers - operationId: createCustomer - summary: Create customer - description: | - The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. - Remember the credit and debit card tokenization process: [https://developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer) + - Companies + /customers: + get: + description: "The purpose of business is to create and maintain a client, you\ + \ will learn what elements you need to obtain a list of clients, which can\ + \ be paged." + operationId: getCustomers + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_response' + $ref: "#/components/schemas/customers_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/customer' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: - tags: - - Customers - operationId: getCustomers + - bearerAuth: [] summary: Get a list of customers - description: The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged. + tags: + - Customers + post: + description: | + The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. + Remember the credit and debit card tokenization process: [https://developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer) + operationId: createCustomer + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/customer" + description: requested field for customer + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: customers_response - allOf: - - type: object - properties: - data: - title: customers_data_response - type: array - items: - $ref: '#/components/schemas/customer_response' - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' + $ref: "#/components/schemas/customer_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - /customers/{id}: - get: - tags: - - Customers - operationId: getCustomerById - summary: Get Customer - description: Gets a customer resource that corresponds to a customer ID. - responses: - '200': - description: successful operation + type: string + style: simple + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/customer_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: + - bearerAuth: [] + summary: Create customer tags: - - Customers - operationId: deleteCustomerById - summary: Delete Customer + - Customers + /customers/{id}: + delete: description: Deleted a customer resource that corresponds to a customer ID. + operationId: deleteCustomerById + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/customer_response" + description: successful operation + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Delete Customer + tags: + - Customers + get: + description: Gets a customer resource that corresponds to a customer ID. + operationId: getCustomerById parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - put: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/customer_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Get Customer tags: - - Customers - operationId: updateCustomer - summary: Update customer + - Customers + put: description: You can update customer-related data + operationId: updateCustomer + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update_customer" + description: requested field for customer + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_response' - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/customer_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/update_customer' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Update customer + tags: + - Customers /customers/{id}/fiscal_entities: post: - tags: - - Customers - operationId: CreateCustomerFiscalEntities - summary: Create Fiscal Entity description: Create Fiscal entity resource that corresponds to a customer ID. + operationId: CreateCustomerFiscalEntities + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/fiscal_entity_request" + description: requested field for customer fiscal entities + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: create_customer_fiscal_entities_response - allOf: - - $ref: '#/components/schemas/customer_fiscal_entities_request' - - type: object - required: - - id - - object - - created_at - properties: - id: - type: string - example: ship_cont_2tKZsTYcsryyu7Ah8 - object: - type: string - example: shipping_contact - created_at: - type: integer - format: int64 - example: 1675715413 - parent_id: - type: string - example: cus_2tKcHxhTz7xU5SymF - default: - type: boolean - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/create_customer_fiscal_entities_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/customer_fiscal_entities' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Create Fiscal Entity + tags: + - Customers /customers/{id}/fiscal_entities/{fiscal_entities_id}: put: - tags: - - Customers - operationId: UpdateCustomerFiscalEntities - summary: Update Fiscal Entity description: Update Fiscal Entity resource that corresponds to a customer ID. + operationId: UpdateCustomerFiscalEntities + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: fiscal_entities_id + required: true + schema: + example: fis_ent_2tQ8HkkfbauaKP9Ho + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update_fiscal_entity_request" + description: requested field for customer update fiscal entities + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: update_customer_fiscal_entities_response - allOf: - - $ref: '#/components/schemas/customer_fiscal_entities_request' - - type: object - required: - - id - - object - - created_at - properties: - id: - type: string - example: fis_ent_2tKZsTYcsryyu7Ah8 - object: - type: string - example: fiscal_entities - created_at: - type: integer - format: int64 - example: 1675715413 - parent_id: - type: string - example: cus_2tKcHxhTz7xU5SymF - default: - type: boolean - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/customer_update_fiscal_entities' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/fiscal_entities_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/discount_lines: - post: - tags: - - Discounts - operationId: ordersCreateDiscountLine - summary: Create Discount - description: Create discount lines for an existing orden - responses: - '200': - description: successful + $ref: "#/components/schemas/update_customer_fiscal_entities_response" + description: successful operation + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/discount_lines_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/discount_line_create' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: + - bearerAuth: [] + summary: Update Fiscal Entity tags: - - Discounts - operationId: ordersGetDiscountLines - summary: Get a List of Discount + - Customers + /orders/{id}/discount_lines: + get: description: Get discount lines for an existing orden + operationId: ordersGetDiscountLines + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_order_discount_lines_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/discount_lines_response' - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - /orders/{id}/discount_lines/{discount_lines_id}: - put: - tags: - - Discounts - operationId: ordersUpdateDiscountLines - summary: Update Discount - description: Update an existing discount lines for an existing orden - responses: - '200': + $ref: "#/components/schemas/get_order_discount_lines_response" description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/discount_lines_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/discount_line_update' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/discount_lines_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: + - bearerAuth: [] + summary: Get a List of Discount tags: - - Discounts - operationId: ordersDeleteDiscountLines - summary: Delete Discount - description: Delete an existing discount lines for an existing orden + - Discounts + post: + description: Create discount lines for an existing orden + operationId: ordersCreateDiscountLine + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/order_discount_lines_request" + description: requested field for a discount lines + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/discount_lines_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/discount_lines_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: - tags: - - Discounts - operationId: ordersGetDiscountLine - summary: Get Discount - description: Get an existing discount lines for an existing orden - responses: - '200': + $ref: "#/components/schemas/discount_lines_response" description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/discount_lines_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/discount_lines_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /events: - get: + - bearerAuth: [] + summary: Create Discount tags: - - Events - operationId: getEvents - summary: Get list of Events + - Discounts + /orders/{id}/discount_lines/{discount_lines_id}: + delete: + description: Delete an existing discount lines for an existing orden + operationId: ordersDeleteDiscountLines + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: discount line id identifier + explode: false + in: path + name: discount_lines_id + required: true + schema: + example: dis_lin_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_events_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/event_response' - headers: - Date: - description: The date and time that the response was sent - schema: - type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + $ref: "#/components/schemas/discount_lines_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Delete Discount + tags: + - Discounts + get: + description: Get an existing discount lines for an existing orden + operationId: ordersGetDiscountLine + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: discount line id identifier + explode: false + in: path + name: discount_lines_id + required: true + schema: + example: dis_lin_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/discount_lines_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Get Discount + tags: + - Discounts + put: + description: Update an existing discount lines for an existing orden + operationId: ordersUpdateDiscountLines + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: discount line id identifier + explode: false + in: path + name: discount_lines_id + required: true + schema: + example: dis_lin_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update_order_discount_lines_request" + description: requested field for a discount lines + required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/discount_lines_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Update Discount + tags: + - Discounts + /events: + get: + operationId: getEvents + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/get_events_response" + description: successful + headers: + Date: + description: The date and time that the response was sent + explode: false + schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" + type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' + - bearerAuth: [] + summary: Get list of Events + tags: + - Events /events/{id}: get: - tags: - - Events - operationId: getEvent - summary: Get Event description: Returns a single event + operationId: getEvent + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/event_response' + $ref: "#/components/schemas/event_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' + - bearerAuth: [] + summary: Get Event + tags: + - Events /events/{event_id}/resend: post: - tags: - - Events - operationId: resendEvent - summary: Resend Event description: Resend event to selected webhooks - responses: - '200': - description: successful operation - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/events_resend_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] + operationId: resendEvent parameters: - - $ref: '#/components/parameters/event_id' - - $ref: '#/components/parameters/accept_language' + - description: event identifier + explode: false + in: path + name: event_id + required: true + schema: + example: 6463d6e35a4c3e001819e760 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple requestBody: - description: requested fields for resend an event content: application/json: schema: - $ref: '#/components/schemas/resend_request' + $ref: "#/components/schemas/resendEvent_request" + description: requested fields for resend an event required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/events_resend_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Resend Event + tags: + - Events /logs: get: - tags: - - Logs - operationId: getLogs - summary: Get List Of Logs description: Get log details in the form of a list + operationId: getLogs + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/logs_response' + $ref: "#/components/schemas/logs_response_for_request" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' + - bearerAuth: [] + summary: Get List Of Logs + tags: + - Logs /logs/{id}: get: - tags: - - Logs - operationId: getLogById - summary: Get Log description: Get the details of a specific log + operationId: getLogById + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/log_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders: - post: - tags: - - Orders - operationId: createOrder - summary: Create order - description: Create a new order. - responses: - '200': - description: successful operation + $ref: "#/components/schemas/log_response_for_request" + description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/order_response' - examples: - cash: - $ref: '#/components/examples/order_cash' - multiples_cash_charges: - $ref: '#/components/examples/order_cash_multiple' - card: - $ref: '#/components/examples/order_card' - bnpl: - $ref: '#/components/examples/order_bnpl' - pay_by_bank: - $ref: '#/components/examples/order_pbb' - checkout: - $ref: '#/components/examples/order_checkout' - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/order' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: + - bearerAuth: [] + summary: Get Log tags: - - Orders - operationId: getOrders - summary: Get a list of Orders + - Logs + /orders: + get: description: Get order details in the form of a list + operationId: getOrders + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form + - description: Filters by order status + examples: + payment_status: + summary: Filters by order status + value: paid + explode: true + in: query + name: payment_status + required: false + schema: + type: string + style: form + - description: Filters by last payment info status + examples: + last_payment_info.status: + summary: Filters by last payment info status + value: pending_payment + explode: true + in: query + name: last_payment_info.status + required: false + schema: + type: string + style: form + - description: created equal to + examples: + created_at: + summary: created equal to + value: 1612137600 + explode: true + in: query + name: created_at + required: false + schema: + format: int64 + type: integer + style: form + - description: created at greater than or equal to + examples: + created_at.gte: + summary: created at greater than or equal to + value: 1612137600 + explode: true + in: query + name: created_at.gte + required: false + schema: + format: int64 + type: integer + style: form + - description: created at less than or equal to + examples: + created_at.lte: + summary: created at less than or equal to + value: 1612137600 + explode: true + in: query + name: created_at.lte + required: false + schema: + format: int64 + type: integer + style: form + - description: updated at greater than or equal to + examples: + updated_at.gte: + summary: updated at greater than or equal to + value: 1612137600 + explode: true + in: query + name: updated_at.gte + required: false + schema: + format: int64 + type: integer + style: form + - description: updated at less than or equal to + examples: + updated_at.lte: + summary: updated at less than or equal to + value: 1612137600 + explode: true + in: query + name: updated_at.lte + required: false + schema: + format: int64 + type: integer + style: form responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_orders_response - allOf: - - $ref: '#/components/schemas/orders_response' - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - - $ref: '#/components/parameters/payment_status' - - $ref: '#/components/parameters/last_payment_info.status' - - $ref: '#/components/parameters/created_at' - - $ref: '#/components/parameters/created_at_gte' - - $ref: '#/components/parameters/created_at_lte' - - $ref: '#/components/parameters/updated_at_gte' - - $ref: '#/components/parameters/updated_at_lte' - /orders/{id}: - get: - tags: - - Orders - operationId: getOrderById - description: Info for a specific order - summary: Get Order - responses: - '200': - description: successful + $ref: "#/components/schemas/get_orders_response" + description: successful operation + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - put: + - bearerAuth: [] + summary: Get a list of Orders tags: - - Orders - operationId: updateOrder - description: Update an existing Order. - summary: Update Order + - Orders + post: + description: Create a new order. + operationId: createOrder + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + examples: + order_with_charges: + summary: Create an order with charges + value: + charges: + - amount: 40000 + expires_at: 1677196303 + monthly_installments: 0 + payment_method: + type: card + token_id: tok_2897348234 + payment_source_id: src_2tLkkyfMPh6v7pFry + customer_ip_address: 0.0.0.0 + reference_id: string + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: "5522997233" + corporate: false + object: customer_info + fiscal_entity: + tax_id: "1234567890" + name: Conekta Inc + email: test@gmail.com + phone: "525511223344" + metadata: + test: true + company_id: "123" + address: + street1: Nuevo Leon 254 + street2: Departamento 404 + postal_code: "06100" + city: Ciudad de Mexico + state: Ciudad de Mexico + country: MX + external_number: "123" + discount_lines: + - amount: 500 + code: "123" + type: loyalty + line_items: + - antifraud_info: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 20000 + quantity: 1 + tags: + - string + brand: string + metadata: + additionalProp1: string + additionalProp2: string + additionalProp3: string + metadata: + test: true + company_id: "123" + pre_authorize: false + shipping_contact: + phone: "525511223344" + receiver: Marvin Fuller + between_streets: Ackerman Crescent + metadata: + test: true + company_id: "123" + address: + street1: Nuevo Leon 254 + street2: Departamento 404 + postal_code: "06100" + city: Ciudad de Mexico + state: Ciudad de Mexico + country: MX + residential: true + parent_id: string + default: true + deleted: true + shipping_lines: + - amount: 100 + carrier: FEDEX + tracking_number: TRACK123 + method: TRAING + metadata: + key: value + tax_lines: + - amount: 100 + description: testing + metadata: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + order_with_bnpl_charges: + summary: Create an order with a bnpl charge + value: + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_name: Test creditea + checkout_request_type: PaymentLink + charges: + - payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure + product_type: aplazo_bnpl + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success + type: bnpl + currency: MXN + customer_info: + customer_id: cus_2xZfwfjXxX9tZhVey + line_items: + - name: Test creditea + quantity: 1 + unit_price: 300000 + order_with_pbb_charges: + summary: Create an order with a pay by bank charge + value: + charges: + - payment_method: + product_type: bbva_pay_by_bank + type: pay_by_bank + currency: MXN + customer_info: + customer_id: cus_2xZfwfjXxX9tZhVey + line_items: + - name: Test pay by bank + quantity: 1 + unit_price: 300000 + order_with_checkout: + summary: Create an order with checkout + value: + checkout: + allowed_payment_methods: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + expires_at: 0 + failure_url: string + monthly_installments_enabled: false + monthly_installments_options: + - 0 + name: string + on_demand_enabled: true + success_url: string + type: Integration + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: "5522997233" + corporate: false + object: customer_info + discount_lines: + - amount: 500 + code: "123" + type: loyalty + line_items: + - antifraud_info: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 20000 + quantity: 1 + tags: + - string + brand: string + metadata: + additionalProp1: string + additionalProp2: string + additionalProp3: string + metadata: + additionalProp1: string + additionalProp2: string + additionalProp3: string + pre_authorize: false + 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 + parent_id: string + default: true + deleted: true + shipping_lines: + - amount: 100 + carrier: FEDEX + tracking_number: TRACK123 + method: TRAING + metadata: + key: value + tax_lines: + - amount: 100 + description: testing + metadata: + additionalProp1: {} + additionalProp2: {} + additionalProp3: {} + order_with_checkout_and_force_save_card: + summary: Create an order with checkout and force save card + value: + checkout: + allowed_payment_methods: + - card + force_save_card: true + name: Compra + type: Integration + currency: MXN + customer_info: + customer_id: cus_2n9g6x7q1w5k8v3a + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 20000 + quantity: 1 + tags: + - string + brand: string + order_with_subscription: + summary: Create an order with subscription plans + value: + checkout: + allowed_payment_methods: + - card + plan_ids: + - nuevo-plan + expires_at: 1746015865 + failure_url: string + monthly_installments_enabled: false + name: Embebido Prueba + on_demand_enabled: true + success_url: string + type: Integration + max_failed_retries: 3 + is_redirect_on_failure: true + currency: MXN + customer_info: + name: Prueba + email: prueba@prueba.com + phone: "+5218181818181" + corporate: false + object: customer_info + shipping_lines: + - amount: 0 + metadata: + key: value + split_payment_with_2_card_charges: + summary: Create an order with 2 card charges + value: + charges: + - amount: 40000 + payment_method: + type: card + token_id: tok_2897348234 + - amount: 40000 + payment_method: + type: card + token_id: tok_2897348235 + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: "5522997233" + corporate: false + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 40000 + quantity: 2 + brand: string + split_payment_with_3_cash_charges: + summary: Create an order with 3 cash charges + value: + charges: + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: "5522997233" + corporate: false + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 10000 + quantity: 3 + brand: string + split_payment_with_cash_card_charges: + summary: Create an order with 3 cash and 2 card charges + value: + charges: + - amount: 10000 + payment_method: + type: card + token_id: tok_2897348234 + - amount: 10000 + payment_method: + type: card + token_id: tok_2897348235 + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + - amount: 10000 + payment_method: + type: cash + currency: MXN + customer_info: + name: DevTest + email: test@conekta.com + phone: "5522997233" + corporate: false + line_items: + description: string + sku: string + name: Box of Cohiba S1s + unit_price: 50000 + quantity: 1 + brand: string + schema: + $ref: "#/components/schemas/order_request" + description: requested field for order + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + examples: + cash: + value: + livemode: true + amount: 1560 + currency: MXN + payment_status: pending_payment + amount_refunded: 0 + split_payment: false + customer_info: + email: franco.longhi@conekta.com + phone: 539-933-3810 + name: franco golden + object: customer_info + object: order + id: ord_2xayxSvfWzQ2TLz7r + metadata: {} + is_refundable: false + created_at: 1741103510 + updated_at: 1741103510 + line_items: + object: list + has_more: false + total: 1 + data: + - name: APOYO URGENTE REFERENCIA + unit_price: 1560 + quantity: 1 + sku: COL094 + brand: CHEDRAUI + object: line_item + id: line_item_2xayxSvfWzQ2TLz7p + parent_id: ord_2xayxSvfWzQ2TLz7r + metadata: {} + antifraud_info: {} + charges: + object: list + has_more: false + total: 1 + data: + - id: 67c72196e777ac0001f2140c + livemode: true + created_at: 1741103510 + currency: MXN + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001140326893401915.png + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + reference: 10001140326893401915 + product_type: cash_in + object: charge + description: Payment from order + is_refundable: false + status: pending_payment + amount: 1560 + customer_id: "" + order_id: ord_2xayxSvfWzQ2TLz7r + multiples_cash_charges: + value: + livemode: true + amount: 156000 + currency: MXN + payment_status: pending_payment + amount_refunded: 0 + split_payment: false + customer_info: + email: franco.longhi@conekta.com + phone: 884-712-6894 + name: franco golden + object: customer_info + object: order + id: ord_2xazGvtKYTjxTUZU3 + metadata: {} + is_refundable: false + created_at: 1741104962 + updated_at: 1741104963 + line_items: + object: list + has_more: false + total: 1 + data: + - name: APOYO URGENTE REFERENCIA + unit_price: 156000 + quantity: 1 + sku: COL094 + brand: CHEDRAUI + object: line_item + id: line_item_2xazGvtKYTjxTUZU1 + parent_id: ord_2xazGvtKYTjxTUZU3 + metadata: {} + antifraud_info: {} + charges: + object: list + has_more: false + total: 2 + data: + - id: 67c72742e777ac0001f21463 + livemode: true + created_at: 1741104962 + currency: MXN + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/bbva/10830309851141878231.png + agreement: "2409992" + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - BBVA ATM + reference: 10830309851141878231 + product_type: bbva_cash_in + object: charge + description: Payment from order + is_refundable: false + status: pending_payment + amount: 156000 + customer_id: "" + order_id: ord_2xazGvtKYTjxTUZU3 + - id: 67c72742e777ac0001f2145b + livemode: true + created_at: 1741104962 + currency: MXN + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001244873740402013.png + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + reference: 10001244873740402013 + product_type: cash_in + object: charge + description: Payment from order + is_refundable: false + status: pending_payment + amount: 156000 + customer_id: "" + order_id: ord_2xazGvtKYTjxTUZU3 + card: + value: + id: 63dab7d00558720001bb3c7d + livemode: "true," + created_at: "1675278289," + currency: MXN + failure_code: suspected_fraud + failure_message: Este cargo ha sido declinado porque el comportamiento + del comprador es sospechoso. + device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba + payment_method: + name: Fulanito Perez + exp_month: 2 + exp_year: 30 + object: card_payment + type: credit + last4: 4242 + brand: visa + issuer: BANAMEX + account_type: Credit + country: MX + fraud_indicators: + - description: El usuario está utilizando una tarjeta de crédito + o débito de prueba en modo producción. + object: charge + description: Payment from order + status: declined + amount: "20001," + fee: "116," + order_id: ord_2tHuwPhgSwq6Gt7Rg + bnpl: + value: + amount: 300000 + amount_refunded: 0 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pWw + segment: Checkout + charges: + data: + - amount: 300000 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pXA + segment: Checkout + created_at: 1741015718 + currency: MXN + customer_id: "" + description: Payment from order + id: 67c5caa665f9b400015dec40 + is_refundable: false + livemode: true + object: charge + order_id: ord_2xaegxs5s69VP4pWy + payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + expires_at: 1743694118 + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + object: bnpl_payment + product_type: aplazo_bnpl + redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + type: bnpl + status: pending_payment + has_more: false + object: list + total: 1 + created_at: 1741015718 + currency: MXN + customer_info: + corporate: false + customer_id: cus_2xZfwfjXxX9tZhVey + email: alexis.ruiz@google.com + name: Pedro Ruiz + object: customer_info + phone: "+5215555555555" + id: ord_2xaegxs5s69VP4pWy + is_refundable: false + line_items: + data: + - antifraud_info: {} + id: line_item_2xaegxs5s69VP4pWv + metadata: {} + name: Test creditea + object: line_item + parent_id: ord_2xaegxs5s69VP4pWy + quantity: 1 + unit_price: 300000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + payment_status: pending_payment + split_payment: false + updated_at: 1741015718 + pay_by_bank: + value: + amount: 300000 + amount_refunded: 0 + charges: + data: + - amount: 300000 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pXA + segment: Checkout + created_at: 1741015718 + currency: MXN + customer_id: "" + description: Payment from order + id: 67c5caa665f9b400015dec40 + is_refundable: false + livemode: true + object: charge + order_id: ord_2xaegxs5s69VP4pWy + payment_method: + expires_at: 1743694118 + object: pay_by_bank_payment + product_type: bbva_pay_by_bank + redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ + deep_link: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 + type: pay_by_bank + reference: "22277523174328893295" + status: pending_payment + has_more: false + object: list + total: 1 + created_at: 1741015718 + currency: MXN + customer_info: + corporate: false + customer_id: cus_2xZfwfjXxX9tZhVey + email: alexis.ruiz@google.com + name: Pedro Ruiz + object: customer_info + phone: "+5215555555555" + id: ord_2xaegxs5s69VP4pWy + is_refundable: false + line_items: + data: + - antifraud_info: {} + id: line_item_2xaegxs5s69VP4pWv + metadata: {} + name: Test pay by bank + object: line_item + parent_id: ord_2xaegxs5s69VP4pWy + quantity: 1 + unit_price: 300000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + payment_status: pending_payment + split_payment: false + updated_at: 1741015718 + checkout: + value: + amount: 12000 + amount_refunded: 0 + checkout: + allowed_payment_methods: + - card + - bnpl + - cash + - pay_by_bank + - bank_transfer + - apple + can_not_expire: false + emails_sent: 0 + exclude_card_networks: [] + expires_at: 1772171999 + failure_url: https://natalie.net + force_3ds_flow: false + id: 1263626c-53ae-4829-b092-2e7393f2d1b7 + is_redirect_on_failure: true + livemode: true + metadata: {} + monthly_installments_enabled: false + monthly_installments_options: [] + name: Pago de Servicio + needs_shipping_contact: false + object: checkout + paid_payments_count: 0 + recurrent: false + slug: 1263626c53ae4829b0922e7393f2d1b7 + sms_sent: 0 + starts_at: 1771912800 + status: Issued + success_url: https://giovanna.info + type: HostedPayment + url: https://pay.conekta.com/checkout/1263626c53ae4829b0922e7393f2d1b7 + channel: + checkout_request_id: 1263626c-53ae-4829-b092-2e7393f2d1b7 + checkout_request_type: HostedPayment + id: channel_2zbhetCd6CmpJeFsY + segment: Checkout + created_at: 1771950546 + currency: MXN + customer_info: + email: xono.bernie@conekta.com + name: Juan Rosas + object: customer_info + phone: "5531431590" + id: ord_2zbhesToa1DAgNbP6 + is_refundable: false + line_items: + data: + - antifraud_info: {} + brand: addidas + id: line_item_2zbhesToa1DAgNbP3 + metadata: {} + name: Aretes Tres Círculos Numerales + object: line_item + parent_id: ord_2zbhesToa1DAgNbP6 + quantity: 1 + sku: COL094 + unit_price: 10000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + tax_lines: + data: + - amount: 2000 + description: test + id: tax_lin_2zbhesToa1DAgNbP4 + object: tax_line + parent_id: ord_2zbhesToa1DAgNbP6 + has_more: false + object: list + total: 1 + updated_at: 1771950546 + schema: + $ref: "#/components/schemas/order_response" + description: successful operation + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/order_update' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - /orders/{id}/cancel: - post: + - bearerAuth: [] + summary: Create order tags: - - Orders - operationId: CancelOrder - description: Cancel an order that has been previously created. - summary: Cancel Order + - Orders + /orders/{id}: + get: + description: Info for a specific order + operationId: getOrderById + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/order_response' - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '428': - $ref: '#/components/responses/428' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/capture: - post: - tags: - - Orders - operationId: ordersCreateCapture - description: Processes an order that has been previously authorized. - summary: Capture Order - responses: - '200': + $ref: "#/components/schemas/order_response" description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '428': - $ref: '#/components/responses/428' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Get Order + tags: + - Orders + put: + description: Update an existing Order. + operationId: updateOrder + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple requestBody: - description: requested fields for capture order content: application/json: schema: - title: order_capture_request - required: - - amount - properties: - amount: - type: integer - format: int64 - example: 500 - description: Amount to capture - minimum: 1 - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/line_items: - post: - tags: - - Products - operationId: ordersCreateProduct - summary: Create Product - description: Create a new product for an existing order. + $ref: "#/components/schemas/order_update" + description: requested field for an order + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/product_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/product_create' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/line_items/{line_item_id}: - put: - tags: - - Products - operationId: ordersUpdateProduct - description: Update an existing product for an existing orden - summary: Update Product - responses: - '200': + $ref: "#/components/schemas/order_response" description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/product_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/product_update' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/line_items_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: - tags: - - Products - operationId: ordersDeleteProduct - description: Delete product for an existing orden - summary: Delete Product - responses: - '200': - description: successful + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/product_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/line_items_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/refunds: - post: - tags: - - Orders - operationId: orderRefund - description: A refunded order describes the items, amount, and reason an order is being refunded. - summary: Refund Order - responses: - '200': - description: successful + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/order_response' - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/order_refunds_request' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/refunds/{refund_id}: - delete: - tags: - - Orders - operationId: orderCancelRefund - description: A refunded order describes the items, amount, and reason an order is being refunded. - summary: Cancel Refund - responses: - '200': - description: successful + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/order_response' - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/refund_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /payout_orders: - post: + - bearerAuth: [] + summary: Update Order tags: - - Payout Orders - operationId: createPayoutOrder - summary: Create payout order - description: Create a new payout order. + - Orders + /orders/{id}/cancel: + post: + description: Cancel an order that has been previously created. + operationId: CancelOrder + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/payout_order_response' - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/payout_order' - parameters: - - $ref: '#/components/parameters/accept_language' - get: - tags: - - Payout Orders - operationId: getPayoutOrders - summary: Get a list of Payout Orders - description: Get Payout order details in the form of a list - responses: - '200': - description: successful operation + $ref: "#/components/schemas/order_response" + description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - title: payout_orders_response - allOf: - - type: object - properties: - data: - title: payout_orders_data_response - type: array - items: - $ref: '#/components/schemas/payout_order_response' - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - /payout_orders/{id}: - get: - tags: - - Payout Orders - operationId: getPayoutOrderById - summary: Get Payout Order - description: Gets a payout Order resource that corresponds to a payout order ID. - responses: - '200': - description: successful operation + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "428": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: The order cannot be modified because it has already + a charge which is pending payment. + message: The order cannot be modified because it has already a charge + which is pending payment. + code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge + log_id: 641b6e233cd9a50001515039 + object: error + type: precondition_required_error + schema: + $ref: "#/components/schemas/error" + description: Precondition Required + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Cancel Order + tags: + - Orders + /orders/{id}/capture: + post: + description: Processes an order that has been previously authorized. + operationId: ordersCreateCapture + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/order_capture_request" + description: requested fields for capture order + responses: + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/payout_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "428": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: The order cannot be modified because it has already + a charge which is pending payment. + message: The order cannot be modified because it has already a charge + which is pending payment. + code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge + log_id: 641b6e233cd9a50001515039 + object: error + type: precondition_required_error + schema: + $ref: "#/components/schemas/error" + description: Precondition Required + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Capture Order + tags: + - Orders + /orders/{id}/line_items: + post: + description: Create a new product for an existing order. + operationId: ordersCreateProduct parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - /payout_orders/{id}/cancel: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/product" + description: requested field for a product + required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/product_order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Create Product + tags: + - Products + /orders/{id}/line_items/{line_item_id}: + delete: + description: Delete product for an existing orden + operationId: ordersDeleteProduct + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: line_item_id + required: true + schema: + example: line_item_2tQ8HkkfbauaKP9Ho + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/product_order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Delete Product + tags: + - Products put: + description: Update an existing product for an existing orden + operationId: ordersUpdateProduct + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: line_item_id + required: true + schema: + example: line_item_2tQ8HkkfbauaKP9Ho + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update_product" + description: requested field for products + required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/product_order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Update Product tags: - - Payout Orders - operationId: cancelPayoutOrderById - summary: Cancel Payout Order - description: Cancel a payout Order resource that corresponds to a payout order ID. + - Products + /orders/{id}/refunds: + post: + description: "A refunded order describes the items, amount, and reason an order\ + \ is being refunded." + operationId: orderRefund + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/orderRefund_request" + description: requested field for a refund + required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Refund Order + tags: + - Orders + /orders/{id}/refunds/{refund_id}: + delete: + description: "A refunded order describes the items, amount, and reason an order\ + \ is being refunded." + operationId: orderCancelRefund + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: refund identifier + explode: false + in: path + name: refund_id + required: true + schema: + example: 6407b5bee1329a000175ba11 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Cancel Refund + tags: + - Orders + /payout_orders: + get: + description: Get Payout order details in the form of a list + operationId: getPayoutOrders + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/payout_orders_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Get a list of Payout Orders + tags: + - Payout Orders + post: + description: Create a new payout order. + operationId: createPayoutOrder + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/payout_order_request" + description: requested field for payout order + required: true responses: - '200': + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/payout_order_response" description: successful operation + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Create payout order + tags: + - Payout Orders + /payout_orders/{id}: + get: + description: Gets a payout Order resource that corresponds to a payout order + ID. + operationId: getPayoutOrderById + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + responses: + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/payout_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/payout_order_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Get Payout Order + tags: + - Payout Orders + /payout_orders/{id}/cancel: + put: + description: Cancel a payout Order resource that corresponds to a payout order + ID. + operationId: cancelPayoutOrderById parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/payout_order_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Cancel Payout Order + tags: + - Payout Orders /checkouts: get: - tags: - - Payment Link - operationId: getCheckouts - summary: Get a list of payment links description: Returns a list of links generated by the merchant + operationId: getCheckouts + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: checkouts_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/checkout_response' + $ref: "#/components/schemas/checkouts_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - post: + - bearerAuth: [] + summary: Get a list of payment links tags: - - Payment Link + - Payment Link + post: operationId: createCheckout - summary: Create Unique Payment Link + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + examples: + create_checkout_with_plan_ids: + summary: Create Checkout with Plan IDs + value: + name: Payment Link con Plan + type: PaymentLink + recurrent: false + expires_at: 1745331574 + allowed_payment_methods: + - card + needs_shipping_contact: false + plan_ids: + - plan_ejemplo_1 + - plan_ejemplo_2 + order_template: + line_items: + - name: Producto de Ejemplo + unit_price: 15000 + quantity: 1 + currency: MXN + customer_info: + name: Cliente Ejemplo + email: ejemplo@conekta.com + phone: "5555555555" + metadata: + reference: mi_referencia_123 + more_info: datos_adicionales + schema: + $ref: "#/components/schemas/checkout" + description: requested field for checkout + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/checkout_response' + $ref: "#/components/schemas/checkout_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: - description: The version of the API used to process the request and the format of the response body + description: The version of the API used to process the request and + the format of the response body + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/checkout' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Create Unique Payment Link + tags: + - Payment Link /checkouts/{id}: get: - tags: - - Payment Link operationId: getCheckout - summary: Get a payment link by ID + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/checkout_response' + $ref: "#/components/schemas/checkout_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' + - bearerAuth: [] + summary: Get a payment link by ID + tags: + - Payment Link /checkouts/{id}/cancel: put: - tags: - - Payment Link operationId: cancelCheckout - summary: Cancel Payment Link + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/checkout_response' + $ref: "#/components/schemas/checkout_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' + - bearerAuth: [] + summary: Cancel Payment Link + tags: + - Payment Link /checkouts/{id}/email: post: - tags: - - Payment Link operationId: emailCheckout - summary: Send an email + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/emailCheckout_request" + description: requested field for sms checkout + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/checkout_response' + $ref: "#/components/schemas/checkout_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/checkout_email' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' + - bearerAuth: [] + summary: Send an email + tags: + - Payment Link /checkouts/{id}/sms: post: - tags: - - Payment Link operationId: smsCheckout - summary: Send an sms + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/smsCheckout_request" + description: requested field for sms checkout + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/checkout_response' + $ref: "#/components/schemas/checkout_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/checkout_sms' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' - /customers/{id}/payment_sources: - post: - tags: - - Payment Methods - operationId: CreateCustomerPaymentMethods - summary: Create Payment Method - description: Create a payment method for a customer. - responses: - '200': - description: successful operation + type: string + style: simple + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - title: create_customer_payment_methods_response - discriminator: - propertyName: type - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - oneOf: - - $ref: '#/components/schemas/payment_method_cash_response' - - $ref: '#/components/schemas/payment_method_cash_recurrent_response' - - $ref: '#/components/schemas/payment_method_card_response' - - $ref: '#/components/schemas/payment_method_spei_recurrent_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/customer_payment_methods' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: + - bearerAuth: [] + summary: Send an sms tags: - - Payment Methods - operationId: GetCustomerPaymentMethods - summary: Get Payment Methods + - Payment Link + /customers/{id}/payment_sources: + get: description: Get a list of Payment Methods + operationId: GetCustomerPaymentMethods + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: - schema: - title: get_payment_method_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - title: get_customer_payment_method_data_response - discriminator: - propertyName: type - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - oneOf: - - $ref: '#/components/schemas/payment_method_cash_recurrent_response' - - $ref: '#/components/schemas/payment_method_cash_response' - - $ref: '#/components/schemas/payment_method_card_response' - - $ref: '#/components/schemas/payment_method_spei_recurrent_response' examples: cash: - $ref: '#/components/examples/customer_payment_source_cash_example' summary: Cash + value: + next_page_url: "null," + previous_page_url: "null," + has_more: "false," + object: "list," + data: + - id: off_ref_2xayPUpcxeTrotDHr + object: payment_source + provider: Cash + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + - BBVA ATM + type: cash_recurrent + reference: 10001189383263801812_caca + barcode: 10001189383263801812 + barcode_url: https://barcode.conekta.com/cash/cashin/10001189383263801812.png + expires_at: 0 + created_at: 1741100921 + parent_id: cus_2xayPFXsb4LBZ2GUL + agreements: + - provider: bbva_cash_in + agreement: 2409526 card: + summary: Card value: - next_page_url: null - previous_page_url: null has_more: false object: list data: - - id: src_2tbd5Bg327RL9oyas - object: payment_source - type: card - created_at: 1679958561 - last4: '0526' - bin: '41898989' - card_type: debit - exp_month: '01' - exp_year: '25' - brand: visa - issuer: santander - name: random name - parent_id: cus_2tUkvasdas1s4ihjs - default: false - payment_source_status: active - visible_on_checkout: false - summary: Card - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + - id: src_2tbd5Bg327RL9oyas + object: payment_source + type: card + created_at: 1679958561 + last4: "0526" + bin: "41898989" + card_type: debit + exp_month: "01" + exp_year: "25" + brand: visa + issuer: santander + name: random name + parent_id: cus_2tUkvasdas1s4ihjs + default: false + payment_source_status: active + visible_on_checkout: false + schema: + $ref: "#/components/schemas/get_payment_method_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - - $ref: '#/components/parameters/search' - /customers/{id}/payment_sources/{payment_method_id}: - put: + - bearerAuth: [] + summary: Get Payment Methods tags: - - Payment Methods - operationId: UpdateCustomerPaymentMethods - summary: Update Payment Method - description: Gets a payment Method that corresponds to a customer ID. + - Payment Methods + post: + description: Create a payment method for a customer. + operationId: CreateCustomerPaymentMethods + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + examples: + card: + value: + type: card + token_id: tok_test_visa_4242 + cash: + value: + type: spei_recurrent + expires_at: 1553273553 + schema: + $ref: "#/components/schemas/CreateCustomerPaymentMethods_request" + description: requested field for customer payment methods + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: update_customer_payment_methods_response - discriminator: - propertyName: type - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - oneOf: - - $ref: '#/components/schemas/payment_method_cash_response' - - $ref: '#/components/schemas/payment_method_cash_recurrent_response' - - $ref: '#/components/schemas/payment_method_card_response' - - $ref: '#/components/schemas/payment_method_spei_recurrent_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/create_customer_payment_methods_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/customer_update_payment_methods' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/payment_method_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: + - bearerAuth: [] + summary: Create Payment Method tags: - - Payment Methods - operationId: DeleteCustomerPaymentMethods - summary: Delete Payment Method + - Payment Methods + /customers/{id}/payment_sources/{payment_method_id}: + delete: description: Delete an existing payment method + operationId: DeleteCustomerPaymentMethods + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Identifier of the payment method + explode: false + in: path + name: payment_method_id + required: true + schema: + example: src_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: update_customer_payment_methods_response - discriminator: - propertyName: type - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - oneOf: - - $ref: '#/components/schemas/payment_method_cash_response' - - $ref: '#/components/schemas/payment_method_cash_recurrent_response' - - $ref: '#/components/schemas/payment_method_card_response' - - $ref: '#/components/schemas/payment_method_spei_recurrent_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/update_customer_payment_methods_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Delete Payment Method + tags: + - Payment Methods + put: + description: Gets a payment Method that corresponds to a customer ID. + operationId: UpdateCustomerPaymentMethods parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/payment_method_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Identifier of the payment method + explode: false + in: path + name: payment_method_id + required: true + schema: + example: src_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update_payment_methods_card" + description: requested field for customer payment methods + required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/update_customer_payment_methods_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Update Payment Method + tags: + - Payment Methods /plans: get: - tags: - - Plans operationId: getPlans - summary: Get A List of Plans + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form + - description: currency of the object to be retrieved + examples: + currency: + summary: currency of the object to be retrieved + value: MXN + explode: true + in: query + name: currency + required: false + schema: + type: string + style: form + - description: frequency of the object to be retrieved + examples: + frequency: + summary: Frequency of the object to be retrieved + value: 1 + explode: true + in: query + name: frequency + required: false + schema: + type: integer + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_plans_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/plan_response' + $ref: "#/components/schemas/get_plans_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - - $ref: '#/components/parameters/currency' - - $ref: '#/components/parameters/frequency' - post: + - bearerAuth: [] + summary: Get A List of Plans tags: - - Plans - operationId: createPlan - summary: Create Plan + - Plans + post: description: Create a new plan for an existing order + operationId: createPlan + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/plan_request" + description: requested field for plan + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/plan_response' + $ref: "#/components/schemas/plan_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/plan' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /plans/{id}: - get: + - bearerAuth: [] + summary: Create Plan tags: - - Plans - operationId: getPlan - summary: Get Plan + - Plans + /plans/{id}: + delete: + operationId: deletePlan + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/plan_response' + $ref: "#/components/schemas/plan_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - put: + - bearerAuth: [] + summary: Delete Plan tags: - - Plans - operationId: updatePlan - summary: Update Plan + - Plans + get: + operationId: getPlan + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/plan_response' + $ref: "#/components/schemas/plan_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/plan_update' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: + - bearerAuth: [] + summary: Get Plan tags: - - Plans - operationId: deletePlan - summary: Delete Plan + - Plans + put: + operationId: updatePlan + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update_plan" + description: requested field for plan + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/plan_response' + $ref: "#/components/schemas/plan_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - bearerAuth: [] + summary: Update Plan + tags: + - Plans /orders/{id}/shipping_lines: post: - tags: - - Shippings - operationId: ordersCreateShipping - summary: Create Shipping description: Create new shipping for an existing orden + operationId: ordersCreateShipping + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/shipping_request" + description: requested field for a shipping + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/shipping_order_response' examples: sucessfull: - $ref: '#/components/examples/shipping' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + value: + amount: 0 + carrier: Fedex + method: Airplane + tracking_number: TRACK123 + object: shipping_line + id: ship_lin_2sLxi45ZFs1GHJmzx + parent_id: ord_2sLxi3MqYFJ1QfTmP + deleted: true + schema: + $ref: "#/components/schemas/shipping_order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/shipping_create' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Create Shipping + tags: + - Shippings /orders/{id}/shipping_lines/{shipping_id}: - put: + delete: + description: Delete shipping + operationId: ordersDeleteShipping + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: shipping_id + required: true + schema: + example: ship_lin_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/shipping_order_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "428": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: The order cannot be modified because it has already + a charge which is pending payment. + message: The order cannot be modified because it has already a charge + which is pending payment. + code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge + log_id: 641b6e233cd9a50001515039 + object: error + type: precondition_required_error + schema: + $ref: "#/components/schemas/error" + description: Precondition Required + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Delete Shipping tags: - - Shippings - operationId: ordersUpdateShipping - summary: Update Shipping + - Shippings + put: description: Update existing shipping for an existing orden + operationId: ordersUpdateShipping + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: shipping_id + required: true + schema: + example: ship_lin_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/shipping_request" + description: requested field for a shipping + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/shipping_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/shipping_create' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/shipping_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: - tags: - - Shippings - operationId: ordersDeleteShipping - summary: Delete Shipping - description: Delete shipping - responses: - '200': + $ref: "#/components/schemas/shipping_order_response" description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/shipping_order_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '428': - $ref: '#/components/responses/428' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/shipping_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Update Shipping + tags: + - Shippings /customers/{id}/shipping_contacts: post: - tags: - - Shipping Contacts - operationId: CreateCustomerShippingContacts - summary: Create a shipping contacts description: Create a shipping contacts for a customer. + operationId: CreateCustomerShippingContacts + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/customer_shipping_contacts_request" + description: requested field for customer shippings contacts + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_shipping_contacts_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/customer_shipping_contacts_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/customer_shipping_contacts' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /customers/{id}/shipping_contacts/{shipping_contacts_id}: - put: + - bearerAuth: [] + summary: Create a shipping contacts tags: - - Shipping Contacts - operationId: UpdateCustomerShippingContacts - summary: Update shipping contacts - description: Update shipping contact that corresponds to a customer ID. + - Shipping Contacts + /customers/{id}/shipping_contacts/{shipping_contacts_id}: + delete: + description: Delete shipping contact that corresponds to a customer ID. + operationId: DeleteCustomerShippingContacts + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: shipping_contacts_id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_shipping_contacts_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/customer_shipping_contacts_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/customer_update_shipping_contacts' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/shipping_contacts_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: - tags: - - Shipping Contacts - operationId: DeleteCustomerShippingContacts + - bearerAuth: [] summary: Delete shipping contacts - description: Delete shipping contact that corresponds to a customer ID. + tags: + - Shipping Contacts + put: + description: Update shipping contact that corresponds to a customer ID. + operationId: UpdateCustomerShippingContacts + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: shipping_contacts_id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/customer_update_shipping_contacts_request" + description: requested field for customer update shippings contacts + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_shipping_contacts_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/customer_shipping_contacts_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/shipping_contacts_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Update shipping contacts + tags: + - Shipping Contacts /customers/{customer_id}/subscriptions: get: - tags: - - Subscriptions - operationId: subscriptionList - summary: List Subscriptions description: Get a list of subscriptions for a customer + operationId: subscriptionList + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - post: + - bearerAuth: [] + summary: List Subscriptions tags: - - Subscriptions + - Subscriptions + post: + description: Create a new subscription for a customer (keeps existing subscriptions + active) operationId: subscriptionCreate - summary: Create Subscription - description: Create a new subscription for a customer (keeps existing subscriptions active) + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/subscription_request" + description: requested field for subscriptions + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/subscription' - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /customers/{customer_id}/subscriptions/{id}: - put: + - bearerAuth: [] + summary: Create Subscription tags: - - Subscriptions - operationId: subscriptionUpdate - summary: Update Subscription - description: Update a specific subscription + - Subscriptions + /customers/{customer_id}/subscriptions/{id}: + get: + description: Retrieve a specific subscription + operationId: subscriptionsGet + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Identifier of the subscription resource + explode: false + in: path + name: id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Get Subscription + tags: + - Subscriptions + put: + description: Update a specific subscription + operationId: subscriptionUpdate + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Identifier of the subscription resource + explode: false + in: path + name: id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple requestBody: - $ref: '#/components/requestBodies/subscription_update' - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/subscription_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: - tags: - - Subscriptions - operationId: subscriptionsGet - summary: Get Subscription - description: Retrieve a specific subscription + content: + application/json: + schema: + $ref: "#/components/schemas/updates_a_subscription" + description: requested field for update a subscription + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/subscription_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Update Subscription + tags: + - Subscriptions /customers/{customer_id}/subscriptions/{id}/events: get: - tags: - - Subscriptions - operationId: subscriptionEvents - summary: Get Subscription Events description: Get events for a specific subscription + operationId: subscriptionEvents + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Identifier of the subscription resource + explode: false + in: path + name: id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: subscription_events_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/event_response' + $ref: "#/components/schemas/subscription_events_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/subscription_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' + - bearerAuth: [] + summary: Get Subscription Events + tags: + - Subscriptions /customers/{customer_id}/subscriptions/{id}/cancel: post: - tags: - - Subscriptions - operationId: subscriptionCancel - summary: Cancel Subscription description: Cancel a specific subscription + operationId: subscriptionCancel + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Identifier of the subscription resource + explode: false + in: path + name: id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/subscription_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Cancel Subscription + tags: + - Subscriptions /customers/{customer_id}/subscriptions/{id}/pause: post: - tags: - - Subscriptions - operationId: subscriptionPause - summary: Pause Subscription description: Pause a specific subscription + operationId: subscriptionPause + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Identifier of the subscription resource + explode: false + in: path + name: id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/subscription_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Pause Subscription + tags: + - Subscriptions /customers/{customer_id}/subscriptions/{id}/resume: post: - tags: - - Subscriptions - operationId: subscriptionResume - summary: Resume Subscription description: Resume a specific paused subscription + operationId: subscriptionResume + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Identifier of the subscription resource + explode: false + in: path + name: id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/subscription_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Resume Subscription + tags: + - Subscriptions /customers/{customer_id}/subscriptions/{id}/retry: post: - tags: - - Subscriptions - operationId: subscriptionsRetry - summary: Retry Failed Payment description: Retry a failed payment for a specific subscription + operationId: subscriptionsRetry + parameters: + - description: Identifier of the customer resource + explode: false + in: path + name: customer_id + required: true + schema: + example: cus_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Identifier of the subscription resource + explode: false + in: path + name: id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/customer_id' - - $ref: '#/components/parameters/subscription_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /subscriptions/{subscription_id}/customer_portal: - post: + - bearerAuth: [] + summary: Retry Failed Payment tags: - - Subscriptions - Customer Portal - operationId: createCustomerPortal - summary: Create customer portal - description: Creates a customer portal for a subscription. If a portal already exists, returns the existing one. + - Subscriptions + /subscriptions/{subscription_id}/customer_portal: + get: + description: Retrieves the customer portal for a subscription + operationId: getCustomerPortal + parameters: + - description: Identifier of the subscription resource + explode: false + in: path + name: subscription_id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '201': - description: Customer portal created successfully + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_portal_response' + $ref: "#/components/schemas/customer_portal_response" + description: Customer portal retrieved successfully headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' + type: string + style: simple + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error security: - - bearerAuth: [] - parameters: - - in: path - name: subscription_id - description: Identifier of the subscription resource - required: true - schema: - type: string - example: sub_2tGzG1GxtDAZHEGPH - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: - tags: - - Subscriptions - Customer Portal - operationId: getCustomerPortal + - bearerAuth: [] summary: Get customer portal - description: Retrieves the customer portal for a subscription + tags: + - Subscriptions - Customer Portal + post: + description: "Creates a customer portal for a subscription. If a portal already\ + \ exists, returns the existing one." + operationId: createCustomerPortal + parameters: + - description: Identifier of the subscription resource + explode: false + in: path + name: subscription_id + required: true + schema: + example: sub_2tGzG1GxtDAZHEGPH + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: Customer portal retrieved successfully + "201": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/customer_portal_response' + $ref: "#/components/schemas/customer_portal_response" + description: Customer portal created successfully headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' + type: string + style: simple + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error security: - - bearerAuth: [] - parameters: - - in: path - name: subscription_id - description: Identifier of the subscription resource - required: true - schema: - type: string - example: sub_2tGzG1GxtDAZHEGPH - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Create customer portal + tags: + - Subscriptions - Customer Portal /customers/{id}/subscription: - post: + get: deprecated: true - tags: - - Subscriptions - operationId: createSubscription - summary: Create Subscription [Deprecated] - description: 'DEPRECATED: This endpoint will be removed in version 2.3.0. You can create the subscription to include the plans that your customers consume' + description: "DEPRECATED: This endpoint will be removed in version 2.3.0." + operationId: getSubscription + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/subscription' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - put: - deprecated: true + - bearerAuth: [] + summary: "Get Subscription [Deprecated]" tags: - - Subscriptions - operationId: updateSubscription - summary: Update Subscription [Deprecated] - description: 'DEPRECATED: This endpoint will be removed in version 2.3.0. You can modify the subscription to change the plans that your customers consume' + - Subscriptions + post: + deprecated: true + description: "DEPRECATED: This endpoint will be removed in version 2.3.0. You\ + \ can create the subscription to include the plans that your customers consume" + operationId: createSubscription + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/subscription_request" + description: requested field for subscriptions + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/subscription_update' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - get: - deprecated: true + - bearerAuth: [] + summary: "Create Subscription [Deprecated]" tags: - - Subscriptions - operationId: getSubscription - summary: Get Subscription [Deprecated] - description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' + - Subscriptions + put: + deprecated: true + description: "DEPRECATED: This endpoint will be removed in version 2.3.0. You\ + \ can modify the subscription to change the plans that your customers consume" + operationId: updateSubscription + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/updates_a_subscription" + description: requested field for update a subscription + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - bearerAuth: [] + summary: "Update Subscription [Deprecated]" + tags: + - Subscriptions /customers/{id}/subscription/cancel: post: deprecated: true - tags: - - Subscriptions + description: "DEPRECATED: This endpoint will be removed in version 2.3.0." operationId: cancelSubscription - summary: Cancel Subscription [Deprecated] - description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: "Cancel Subscription [Deprecated]" + tags: + - Subscriptions /customers/{id}/subscription/events: get: deprecated: true - tags: - - Subscriptions + description: "DEPRECATED: This endpoint will be removed in version 2.3.0. You\ + \ can get the events of the subscription(s) of a client, with the customer\ + \ id" operationId: getSubscriptionEvents - summary: Get Subscription Events [Deprecated] - description: 'DEPRECATED: This endpoint will be removed in version 2.3.0. You can get the events of the subscription(s) of a client, with the customer id' + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: subscription_events_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/event_response' + $ref: "#/components/schemas/subscription_events_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: "Get Subscription Events [Deprecated]" + tags: + - Subscriptions /customers/{id}/subscription/pause: post: deprecated: true - tags: - - Subscriptions + description: "DEPRECATED: This endpoint will be removed in version 2.3.0." operationId: pauseSubscription - summary: Pause Subscription [Deprecated] - description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: "Pause Subscription [Deprecated]" + tags: + - Subscriptions /customers/{id}/subscription/resume: post: deprecated: true - tags: - - Subscriptions + description: "DEPRECATED: This endpoint will be removed in version 2.3.0." operationId: resumeSubscription - summary: Resume Subscription [Deprecated] - description: 'DEPRECATED: This endpoint will be removed in version 2.3.0.' + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false + schema: + example: conekta-v2.3.0; format=application/json + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "402": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The card could not be processed. + code: conekta.errors.processing.tokenization.used + debug_message: The token has already been used. + log_id: 641b6d073cd9a50001515007 + object: error + type: processing_error + schema: + $ref: "#/components/schemas/error" + description: payment required error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: "Resume Subscription [Deprecated]" + tags: + - Subscriptions + /orders/{id}/tax_lines: + post: + description: Create new taxes for an existing orden + operationId: ordersCreateTaxes + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/order_tax_request" + description: requested field for a taxes + required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: schema: - type: string - example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '402': - $ref: '#/components/responses/402' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/order_tax_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/tax_lines: - post: - tags: - - Taxes - operationId: ordersCreateTaxes - description: Create new taxes for an existing orden + - bearerAuth: [] summary: Create Tax + tags: + - Taxes + /orders/{id}/tax_lines/{tax_id}: + delete: + description: Delete taxes for an existing orden + operationId: ordersDeleteTaxes + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: tax_id + required: true + schema: + example: tax_lin_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/update_order_tax_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/order_tax_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/order_tax' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - /orders/{id}/tax_lines/{tax_id}: - put: + - bearerAuth: [] + summary: Delete Tax tags: - - Taxes - operationId: ordersUpdateTaxes - summary: Update Tax + - Taxes + put: description: Update taxes for an existing orden + operationId: ordersUpdateTaxes + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: identifier + explode: false + in: path + name: tax_id + required: true + schema: + example: tax_lin_2tQ974hSHcsdeSZHG + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ordersUpdateTaxes_request" + description: requested field for taxes + required: true responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/update_order_tax_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/order_tax_update' - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/tax_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - delete: - tags: - - Taxes - operationId: ordersDeleteTaxes - summary: Delete Tax - description: Delete taxes for an existing orden - responses: - '200': + $ref: "#/components/schemas/order_tax_response" description: successful + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/update_order_tax_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/tax_id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' + - bearerAuth: [] + summary: Update Tax + tags: + - Taxes /tokens: post: - tags: - - Tokens - operationId: createToken - summary: Create Token description: | Generate a payment token, to associate it with a card, Endpoint could be use directly only for PCI compliance account + operationId: createToken + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/token_request" + description: requested field for token + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/token_response' + $ref: "#/components/schemas/token_response" + description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '422': - $ref: '#/components/responses/422' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "422": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The token does not exist. + param: payment_method.token_id + code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token + debug_message: The token does not exist. + log_id: 641b6d813cd9a50001515017 + object: error + type: parameter_validation_error + schema: + $ref: "#/components/schemas/error" + description: parameter validation error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/token' - parameters: - - $ref: '#/components/parameters/accept_language' + - bearerAuth: [] + summary: Create Token + tags: + - Tokens /transactions: get: - tags: - - Transactions - operationId: getTransactions - summary: Get List transactions description: Get transaction details in the form of a list + operationId: getTransactions + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form + - description: id of the object to be retrieved + examples: + id: + summary: id of the object to be retrieved + value: 65412a893cd69a0001c25892 + explode: true + in: query + name: id + required: false + schema: + type: string + style: form + - description: id of the charge used for filtering + examples: + charge_id: + summary: id of the charge used for filtering + value: 65412a893cd69a0001c25892 + explode: true + in: query + name: charge_id + required: false + schema: + type: string + style: form + - description: type of the object to be retrieved + examples: + type: + summary: type of the object to be retrieved + value: capture + explode: true + in: query + name: type + required: false + schema: + type: string + style: form + - description: currency of the object to be retrieved + examples: + currency: + summary: currency of the object to be retrieved + value: MXN + explode: true + in: query + name: currency + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_transactions_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - description: Transactions - type: array - items: - $ref: '#/components/schemas/transaction_response' + $ref: "#/components/schemas/get_transactions_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - - $ref: '#/components/parameters/id_query' - - $ref: '#/components/parameters/charge_id' - - $ref: '#/components/parameters/type' - - $ref: '#/components/parameters/currency' + - bearerAuth: [] + summary: Get List transactions + tags: + - Transactions /transactions/{id}: get: - tags: - - Transactions - operationId: getTransaction - summary: Get transaction description: Get the details of a transaction + operationId: getTransaction + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/transaction_response' + $ref: "#/components/schemas/transaction_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' + - bearerAuth: [] + summary: Get transaction + tags: + - Transactions /transfers: get: - tags: - - Transfers - operationId: getTransfers - summary: Get a list of transfers description: Get transfers details in the form of a list + operationId: getTransfers + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_transfers_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - description: Transfers - type: array - items: - $ref: '#/components/schemas/transfers_response' + $ref: "#/components/schemas/get_transfers_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' + - bearerAuth: [] + summary: Get a list of transfers + tags: + - Transfers /transfers/{id}: get: - tags: - - Transfers - operationId: getTransfer - summary: Get Transfer description: Get the details of a Transfer + operationId: getTransfer + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/transfer_response' + $ref: "#/components/schemas/transfer_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' + - bearerAuth: [] + summary: Get Transfer + tags: + - Transfers /webhook_keys: get: - tags: - - Webhook keys - operationId: getWebhookKeys - summary: Get List of Webhook Keys description: Consume the list of webhook keys you have + operationId: getWebhookKeys + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_webhook_keys_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/webhook-key_response' + $ref: "#/components/schemas/get_webhook_keys_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - post: + - bearerAuth: [] + summary: Get List of Webhook Keys tags: - - Webhook keys - operationId: createWebhookKey - summary: Create Webhook Key + - Webhook keys + post: description: Create a webhook key + operationId: createWebhookKey + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/webhook_key_request" responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/webhook-key_create_response' - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/webhook_key_create_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - content: - application/json: - schema: - type: object - title: webhook_key_request - properties: - active: - type: boolean - example: true - description: Indicates if the webhook key is active - default: true - parameters: - - $ref: '#/components/parameters/accept_language' - /webhook_keys/{id}: - get: + - bearerAuth: [] + summary: Create Webhook Key tags: - - Webhook keys - operationId: getWebhookKey - summary: Get Webhook Key + - Webhook keys + /webhook_keys/{id}: + delete: + operationId: deleteWebhookKey + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/webhook-key_response' + $ref: "#/components/schemas/webhook_key_delete_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - put: - tags: - - Webhook keys - operationId: updateWebhookKey - summary: Update Webhook Key - description: updates an existing webhook key - responses: - '200': - description: successful operation + type: string + style: simple + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/webhook-key_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - content: - application/json: - schema: - type: object - title: webhook_key_update_request - properties: - active: - type: boolean - example: false - description: Indicates if the webhook key is active - default: false - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - delete: - tags: - - Webhook keys - operationId: deleteWebhookKey + - bearerAuth: [] summary: Delete Webhook key + tags: + - Webhook keys + get: + operationId: getWebhookKey + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/webhook-key_delete_response' + $ref: "#/components/schemas/webhook_key_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Get Webhook Key + tags: + - Webhook keys + put: + description: updates an existing webhook key + operationId: updateWebhookKey parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/webhook_key_update_request" + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/webhook_key_response" + description: successful operation + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Update Webhook Key + tags: + - Webhook keys /webhooks: get: - tags: - - Webhooks + description: "Consume the list of webhooks you have, each environment supports\ + \ 10 webhooks (For production and testing)" operationId: getWebhooks - summary: Get List of Webhooks - description: Consume the list of webhooks you have, each environment supports 10 webhooks (For production and testing) + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: "The numbers of items to return, the maximum value is 250" + explode: true + in: query + name: limit + required: false + schema: + default: 20 + format: int32 + maximum: 250 + minimum: 1 + type: integer + style: form + - description: "General order search, e.g. by mail, reference etc." + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + - description: url for webhook filter + explode: true + in: query + name: url + required: false + schema: + type: string + style: form + - description: next page + explode: true + in: query + name: next + required: false + schema: + type: string + style: form + - description: previous page + explode: true + in: query + name: previous + required: false + schema: + type: string + style: form responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - title: get_webhooks_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/webhook_response' + $ref: "#/components/schemas/get_webhooks_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/url' - - $ref: '#/components/parameters/next_page' - - $ref: '#/components/parameters/previous_page' - post: + - bearerAuth: [] + summary: Get List of Webhooks tags: - - Webhooks + - Webhooks + post: + description: "What we do at Conekta translates into events. For example, an\ + \ event of interest to us occurs at the time a payment is successfully processed.\ + \ At that moment we will be interested in doing several things: Send an email\ + \ to the buyer, generate an invoice, start the process of shipping the product,\ + \ etc." operationId: createWebhook - summary: Create Webhook - description: 'What we do at Conekta translates into events. For example, an event of interest to us occurs at the time a payment is successfully processed. At that moment we will be interested in doing several things: Send an email to the buyer, generate an invoice, start the process of shipping the product, etc.' + parameters: + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/webhook_request" + description: requested field for webhook + required: true responses: - '200': - description: successful operation + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/webhook_response' - '401': - $ref: '#/components/responses/401' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/webhook_response" + description: successful operation + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/webhook' - parameters: - - $ref: '#/components/parameters/accept_language' - /webhooks/{id}: - get: + - bearerAuth: [] + summary: Create Webhook tags: - - Webhooks - operationId: getWebhook - summary: Get Webhook + - Webhooks + /webhooks/{id}: + delete: + operationId: deleteWebhook + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/webhook_response' + $ref: "#/components/schemas/webhook_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive - Conekta-Media-Type: - schema: type: string - example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' - security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - put: - tags: - - Webhooks - operationId: updateWebhook - summary: Update Webhook - description: updates an existing webhook - responses: - '200': - description: successful operation + style: simple + Conekta-Media-Type: + explode: false + schema: + example: conekta-v2.3.0; format=application/json + type: string + style: simple + "401": content: application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/webhook_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - requestBody: - $ref: '#/components/requestBodies/webhook_update' - parameters: - - $ref: '#/components/parameters/accept_language' - - $ref: '#/components/parameters/x_child_company_id' - - $ref: '#/components/parameters/id' - delete: - tags: - - Webhooks - operationId: deleteWebhook + - bearerAuth: [] summary: Delete Webhook + tags: + - Webhooks + get: + operationId: getWebhook + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/webhook_response' + $ref: "#/components/schemas/webhook_response" + description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: + example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string - example: Fri, 03 Feb 2023 16:57:48 GMT + style: simple Content-Type: description: The format of the response body + explode: false schema: - type: string example: application/json; charset=utf-8 + type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: + example: "2737" type: string - example: '2737' + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: - type: string example: keep-alive + type: string + style: simple Conekta-Media-Type: + explode: false schema: - type: string example: conekta-v2.3.0; format=application/json - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + type: string + style: simple + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] + - bearerAuth: [] + summary: Get Webhook + tags: + - Webhooks + put: + description: updates an existing webhook + operationId: updateWebhook parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple + - description: "In the case of a holding company, the company id of the child\ + \ company to which will process the request." + example: 6441b6376b60c3a638da80af + explode: false + in: header + name: X-Child-Company-Id + required: false + schema: + type: string + style: simple + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update_webhook" + description: requested fields in order to update a webhook + required: true + responses: + "200": + content: + application/vnd.conekta-v2.3.0+json: + schema: + $ref: "#/components/schemas/webhook_response" + description: successful operation + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error + security: + - bearerAuth: [] + summary: Update Webhook + tags: + - Webhooks /webhooks/{id}/test: post: - tags: - - Webhooks - operationId: testWebhook - summary: Test Webhook description: Send a webhook.ping event + operationId: testWebhook + parameters: + - description: Identifier of the resource + explode: false + in: path + name: id + required: true + schema: + example: 6307a60c41de27127515a575 + type: string + style: simple + - description: Use for knowing which language to use + examples: + es: + summary: for spanish request/response + value: es + en: + summary: for english request/response + value: en + explode: false + in: header + name: Accept-Language + required: false + schema: + default: es + enum: + - es + - en + type: string + style: simple responses: - '200': - description: successful + "200": content: application/vnd.conekta-v2.3.0+json: schema: - $ref: '#/components/schemas/webhook_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/webhook_response" + description: successful + "401": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: Please include your access key in your request. + code: conekta.errors.authentication.missing_key + log_id: 507f1f77bcf86cd799439011 + object: error + type: authentication_error + schema: + $ref: "#/components/schemas/error" + description: authentication error + "404": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - message: The resource was not found. + code: conekta.errors.resource_not_found.entity + debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could + not be found. + log_id: 641b6c253cd9a50001514fae + object: error + type: resource_not_found_error + schema: + $ref: "#/components/schemas/error" + description: not found entity + "500": + content: + application/vnd.conekta-v2.3.0+json: + example: + details: + - debug_message: There was a runtime error and Conekta engineers have + been notified. + message: There was a runtime error and Conekta engineers have been + notified. + code: conekta.errors.api.system.general_failure + object: error + type: api_error + log_id: 641b6f2b3cd9a50001515098 + schema: + $ref: "#/components/schemas/error" + description: internal server error security: - - bearerAuth: [] - parameters: - - $ref: '#/components/parameters/id' - - $ref: '#/components/parameters/accept_language' + - bearerAuth: [] + summary: Test Webhook + tags: + - Webhooks components: schemas: event_types: + description: "It is a parameter that allows to identify in the response, the\ + \ type of event that is being generated." + enum: + - webhook_ping + - order.paid + - order.expired + - order.canceled + - order.pending_payment title: event_types type: string - description: It is a parameter that allows to identify in the response, the type of event that is being generated. - enum: - - webhook_ping - - order.paid - - order.expired - - order.canceled - - order.pending_payment - pagination: - title: pagination metadata - description: pagination metadata - type: object - required: - - object - - has_more + risk_rules_data: properties: - has_more: + id: + description: rule id + example: 618c3f2fdb8b8da9be376af9 + type: string + field: + description: field to be used for the rule + example: email + type: string + created_at: + description: rule creation date + example: 2021-11-10T21:52:47.339Z + type: string + value: + description: value to be used for the rule + example: email@example.com + type: string + is_global: + description: if the rule is global + example: false type: boolean + is_test: + description: if the rule is test example: false - description: Indicates if there are more pages to be requested - object: + type: boolean + description: + description: description of the rule + example: secure customer example@example.com type: string - example: list - description: Object type, in this case is list - page: - title: page metadata - description: page metadata - type: object - properties: - next_page_url: - description: URL of the next page. - type: - - string - - 'null' - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - previous_page_url: - description: Url of the previous page. - type: - - string - - 'null' - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + title: risk_rules_data risk_rules_list: - title: risk_rules_list allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - type: object - title: risk_rules_data - properties: - id: - type: string - example: 618c3f2fdb8b8da9be376af9 - description: rule id - field: - type: string - example: email - description: field to be used for the rule - created_at: - type: string - example: '2021-11-10T21:52:47.339Z' - description: rule creation date - value: - type: string - example: email@example.com - description: value to be used for the rule - is_global: - type: boolean - example: false - description: if the rule is global - is_test: - type: boolean - example: false - description: if the rule is test - description: - type: string - example: secure customer example@example.com - description: description of the rule - details: - type: object + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/risk_rules_data" + type: array + default: null + title: risk_rules_list + details_error: properties: - details: - type: array - items: - type: object - title: details_error - properties: - code: - type: string - example: conekta.errors.authentication.missing_key - param: - type: - - string - - 'null' - message: - type: string - example: Acceso no autorizado. - debug_message: - type: string - example: Please include your access key in your request. + code: + example: conekta.errors.authentication.missing_key + type: string + param: + nullable: true + type: string + message: + example: Acceso no autorizado. + type: string + debug_message: + example: Please include your access key in your request. + type: string + title: details_error error: - title: error - description: err model allOf: - - $ref: '#/components/schemas/details' - - type: object - properties: - log_id: - description: log id - type: - - string - - 'null' - example: 507f1f77bcf86cd799439011 - type: - type: string - example: authentication_error - object: - type: string - example: error - create_risk_rules_data: - type: object + - properties: + details: + items: + $ref: "#/components/schemas/details_error" + type: array + default: null + - properties: + log_id: + description: log id + example: 507f1f77bcf86cd799439011 + nullable: true + type: string + type: + example: authentication_error + type: string + object: + example: error + type: string + description: err model + title: error + CreateRuleWhitelist_request: + properties: + description: + description: Description of the rule + example: this client email was verified at 20/09/22 by internal process + type: string + field: + description: Field to be used for the rule + example: email | phone | card_token + type: string + value: + description: Value to be used for the rule + example: email@example.com | 818081808180 | src_2qUCNd5AyQqfPMBuV + type: string required: - - description - - field - - value + - description + - field + - value + whitelistlist_rule_response: properties: + id: + description: Whitelist rule id + example: 2fw8EWJusiRrxdPzT + type: string + field: + description: field used for whitelists rule + example: email + type: string + value: + description: value used for whitelists rule + example: email@example.com + type: string description: + description: use an description for whitelisted rule + example: banned customer example@example.com + type: string + title: whitelistlist_rule_response + deleted_whitelist_rule_response: + properties: + id: + description: Whitelist rule id + example: 2fw8EWJusiRrxdPzT type: string - example: this client email was verified at 20/09/22 by internal process - description: Description of the rule field: + description: field used for whitelists rule deleted + example: email type: string - example: email | phone | card_token - description: Field to be used for the rule value: + description: value used for whitelists rule deleted + example: email@example.com type: string - example: email@example.com | 818081808180 | src_2qUCNd5AyQqfPMBuV - description: Value to be used for the rule + description: + description: use an description for whitelisted rule + example: secure customer example@example.com + type: string + title: deleted_whitelist_rule_response + blacklist_rule_response: + properties: + id: + description: Blacklist rule id + example: 2fw8EWJusiRrxdPzT + type: string + field: + description: field used for blacklists rule + example: email + type: string + value: + description: value used for blacklists rule + example: email@example.com + type: string + description: + description: use an description for blacklisted rule + example: secure customer example@example.com + type: string + title: blacklist_rule_response + deleted_blacklist_rule_response: + properties: + id: + description: Blacklist rule id + example: 2fw8EWJusiRrxdPzT + type: string + field: + description: field used for blacklists rule deleted + example: email + type: string + value: + description: value used for blacklists rule deleted + example: email@example.com + type: string + description: + description: use an description for blacklisted rule + example: banned customer example@example.com + type: string + title: deleted_blacklist_rule_response api_key_response: - title: api_key_response description: api keys model - type: object properties: active: - type: boolean description: Indicates if the api key is active example: true + type: boolean created_at: - type: integer description: Unix timestamp in seconds of when the api key was created example: 1684167881 format: int64 - updated_at: type: integer + updated_at: description: Unix timestamp in seconds of when the api key was last updated example: 1684167923 format: int64 + type: integer deactivated_at: - type: - - integer - - 'null' description: Unix timestamp in seconds of when the api key was deleted - example: null format: int64 + nullable: true + type: integer last_used_at: - type: - - integer - - 'null' description: Unix timestamp in seconds with the api key was used - example: null format: int64 + nullable: true + type: integer description: - type: string description: A name or brief explanation of what this api key is used for example: online store - id: type: string - example: 64625cc9f3e02c00163f5e4d + id: description: Unique identifier of the api key + example: 64625cc9f3e02c00163f5e4d + type: string livemode: - type: boolean description: Indicates if the api key is in production example: false + type: boolean object: - type: string - description: Object name, value is 'api_key' + description: "Object name, value is 'api_key'" example: api_key - prefix: type: string + prefix: description: The first few characters of the authentication_token example: key_rp - role: type: string + role: description: Indicates if the api key is private or public example: private + type: string + title: api_key_response + get_api_keys_response: + allOf: + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - properties: + data: + items: + $ref: "#/components/schemas/api_key_response" + type: array + default: null + title: get_api_keys_response api_key_request: - title: api_key_request - name: api_key_request - required: - - role properties: description: - type: string description: A name or brief explanation of what this api key is used for example: online store - role: type: string + role: example: private + type: string descripción: Indicates if the api key is private or public - api_key_response_on_delete: - title: api_key_response_delete - description: api keys model - type: object + required: + - role + title: api_key_request + name: api_key_request + api_key_create_response: + allOf: + - properties: + authentication_token: + description: "It is occupied as a user when authenticated with basic authentication,\ + \ with a blank password. This value will only appear once, in the request\ + \ to create a new key. Copy and save it in a safe place." + example: key_rpHzxufNgjFCdprEEFZRTKi + type: string + - description: api keys model + properties: + active: + description: Indicates if the api key is active + example: true + type: boolean + created_at: + description: Unix timestamp in seconds of when the api key was created + example: 1684167881 + format: int64 + type: integer + updated_at: + description: Unix timestamp in seconds of when the api key was last updated + example: 1684167923 + format: int64 + type: integer + deactivated_at: + description: Unix timestamp in seconds of when the api key was deleted + format: int64 + nullable: true + type: integer + last_used_at: + description: Unix timestamp in seconds with the api key was used + format: int64 + nullable: true + type: integer + description: + description: A name or brief explanation of what this api key is used + for + example: online store + type: string + id: + description: Unique identifier of the api key + example: 64625cc9f3e02c00163f5e4d + type: string + livemode: + description: Indicates if the api key is in production + example: false + type: boolean + object: + description: "Object name, value is 'api_key'" + example: api_key + type: string + prefix: + description: The first few characters of the authentication_token + example: key_rp + type: string + role: + description: Indicates if the api key is private or public + example: private + type: string + title: api_key_response + title: api_key_create_response + api_key_update_request: properties: active: - type: boolean - description: Indicates if the api key is active + description: Indicates if the webhook key is active example: true - created_at: - type: integer - description: Unix timestamp in seconds of when the api key was created - example: 1684167881 - format: int64 + type: boolean description: - type: string description: A name or brief explanation of what this api key is used for example: online store - livemode: - type: boolean - description: Indicates if the api key is in production - example: false - prefix: - type: string - description: The first few characters of the authentication_token - example: key_rp - id: type: string - example: 64625cc9f3e02c00163f5e4d - description: Unique identifier of the api key - object: - type: string - description: Object name, value is 'api_key' - example: api_key - last_used_at: - type: - - integer - - 'null' - description: Unix timestamp in seconds with the api key was used - example: null - format: int64 - role: - type: string - description: Indicates if the api key is private or public - example: private - balance_common_field: - title: balance_common_fiels_response + title: api_key_update_request + delete_api_keys_response: + allOf: + - description: api keys model + properties: + active: + description: Indicates if the api key is active + example: true + type: boolean + created_at: + description: Unix timestamp in seconds of when the api key was created + example: 1684167881 + format: int64 + type: integer + description: + description: A name or brief explanation of what this api key is used + for + example: online store + type: string + livemode: + description: Indicates if the api key is in production + example: false + type: boolean + prefix: + description: The first few characters of the authentication_token + example: key_rp + type: string + id: + description: Unique identifier of the api key + example: 64625cc9f3e02c00163f5e4d + type: string + object: + description: "Object name, value is 'api_key'" + example: api_key + type: string + last_used_at: + description: Unix timestamp in seconds with the api key was used + format: int64 + nullable: true + type: integer + role: + description: Indicates if the api key is private or public + example: private + type: string + title: api_key_response_delete + - properties: + deleted: + example: true + type: boolean + title: delete_api_keys_response + balance_common_fiels_response: description: balance common fields model - type: object properties: amount: - type: integer - example: 100 description: The balance's amount + example: 100 format: int64 + type: integer currency: - type: string - example: MXN description: The balance's currency + example: MXN + type: string + title: balance_common_fiels_response balance_response: - title: balance_response description: balance model - type: object properties: available: - type: array description: The balance's available items: - $ref: '#/components/schemas/balance_common_field' - cashout_retention_amount: + $ref: "#/components/schemas/balance_common_fiels_response" type: array + default: null + cashout_retention_amount: description: The balance's cashout retention amount items: - $ref: '#/components/schemas/balance_common_field' - conekta_retention: + $ref: "#/components/schemas/balance_common_fiels_response" type: array + default: null + conekta_retention: description: The balance's conekta retention items: - $ref: '#/components/schemas/balance_common_field' - gateway: + $ref: "#/components/schemas/balance_common_fiels_response" type: array + default: null + gateway: description: The balance's gateway items: - $ref: '#/components/schemas/balance_common_field' - pending: + $ref: "#/components/schemas/balance_common_fiels_response" type: array + default: null + pending: description: The balance's pending items: - $ref: '#/components/schemas/balance_common_field' - retained: + $ref: "#/components/schemas/balance_common_fiels_response" type: array + default: null + retained: description: The balance's retained items: - $ref: '#/components/schemas/balance_common_field' - retention_amount: + $ref: "#/components/schemas/balance_common_fiels_response" type: array + default: null + retention_amount: description: The balance's retention amount items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" + type: array + default: null target_collateral_amount: - type: object description: The balance's target collateral amount + type: object target_retention_amount: - type: array description: The balance's target retention amount items: - $ref: '#/components/schemas/balance_common_field' - temporarily_retained: + $ref: "#/components/schemas/balance_common_fiels_response" type: array + default: null + temporarily_retained: description: The balance's temporarily retained items: - $ref: '#/components/schemas/balance_common_field' - payment_method: - type: object - required: - - object + $ref: "#/components/schemas/balance_common_fiels_response" + type: array + default: null + title: balance_response + charge_response_channel: properties: - type: + segment: + example: Checkout type: string - object: + checkout_request_id: + example: 6fca054a-8519-4c43-971e-cea35cc519bb + type: string + checkout_request_type: + example: HostedPayment + type: string + id: + example: channel_2tNDzhA4Akmzj11AU type: string - example: payment_source payment_method_cash: + allOf: + - properties: + type: + type: string + object: + example: payment_source + type: string + required: + - object + - description: use for cash responses + properties: + agreement: + description: Agreement ID + example: agreement_2tN73UdUSNrYRPD9r + type: string + auth_code: + example: 542563 + nullable: true + type: integer + cashier_id: + example: OINM01010 + nullable: true + type: string + reference: + example: "93000262276908" + type: string + barcode_url: + example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png + type: string + expires_at: + example: 0 + format: int64 + type: integer + product_type: + description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\ + \ etc." + example: bbva_cash_in + type: string + service_name: + example: store + type: string + store: + example: 10MON50EDI + nullable: true + type: string + store_name: + example: wallmart + type: string + customer_ip_address: + example: 0.0.0.0 + type: string + title: charge_data_payment_method_cash_response title: payment_method_cash x-discriminator-value: cash_payment - allOf: - - $ref: '#/components/schemas/payment_method' - - type: object - title: charge_data_payment_method_cash_response - description: use for cash responses - properties: - agreement: - type: string - example: agreement_2tN73UdUSNrYRPD9r - description: Agreement ID - auth_code: - type: - - integer - - 'null' - example: 542563 - cashier_id: - type: - - string - - 'null' - example: OINM01010 - reference: - type: string - example: '93000262276908' - barcode_url: - type: string - example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png - expires_at: - type: integer - format: int64 - example: 0 - product_type: - type: string - example: bbva_cash_in - description: Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. - service_name: - type: string - example: store - store: - type: - - string - - 'null' - example: 10MON50EDI - store_name: - type: string - example: wallmart - customer_ip_address: - type: string - example: 0.0.0.0 payment_method_card: + allOf: + - properties: + type: + type: string + object: + example: payment_source + type: string + required: + - object + - description: use for card responses + properties: + account_type: + description: Account type of the card + example: Credit + type: string + auth_code: + example: "867372" + type: string + brand: + description: Brand of the card + example: visa + type: string + contract_id: + description: Id sent for recurrent charges. + example: S781317595 + type: string + country: + description: Country of the card + example: MX + type: string + exp_month: + description: Expiration month of the card + example: "02" + type: string + exp_year: + description: Expiration year of the card + example: "2026" + type: string + fraud_indicators: + items: {} + type: array + default: null + issuer: + description: Issuer of the card + example: BANAMEX + type: string + last4: + description: Last 4 digits of the card + example: "4242" + type: string + name: + description: Name of the cardholder + example: Fulanito Perez + type: string + customer_ip_address: + description: Optional field used to capture the customer's IP address + for fraud prevention and security monitoring purposes + example: 0.0.0.0 + type: string + title: charge_data_payment_method_card_response title: payment_method_card x-discriminator-value: card_payment - allOf: - - $ref: '#/components/schemas/payment_method' - - type: object - title: charge_data_payment_method_card_response - description: use for card responses - properties: - account_type: - type: string - example: Credit - description: Account type of the card - auth_code: - type: string - example: '867372' - brand: - type: string - example: visa - description: Brand of the card - contract_id: - type: string - description: Id sent for recurrent charges. - example: S781317595 - country: - type: string - example: MX - description: Country of the card - exp_month: - type: string - example: '02' - description: Expiration month of the card - exp_year: - type: string - example: '2026' - description: Expiration year of the card - fraud_indicators: - type: array - items: {} - issuer: - type: string - example: BANAMEX - description: Issuer of the card - last4: - type: string - example: '4242' - description: Last 4 digits of the card - name: - type: string - example: Fulanito Perez - description: Name of the cardholder - customer_ip_address: - type: string - example: 0.0.0.0 - description: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes payment_method_bank_transfer: + allOf: + - properties: + type: + type: string + object: + example: payment_source + type: string + required: + - object + - description: use for bank transfer responses + properties: + bank: + example: STP + type: string + clabe: + example: "646180111805034237" + type: string + description: + nullable: true + type: string + executed_at: + nullable: true + type: string + expires_at: + example: 1683053729 + format: int64 + type: integer + issuing_account_bank: + nullable: true + type: string + issuing_account_number: + nullable: true + type: string + issuing_account_holder_name: + nullable: true + type: string + issuing_account_tax_id: + nullable: true + type: string + payment_attempts: + items: {} + type: array + default: null + receiving_account_holder_name: + nullable: true + type: string + receiving_account_number: + example: "646180111805034237" + type: string + receiving_account_bank: + example: STP + type: string + receiving_account_tax_id: + nullable: true + type: string + reference_number: + nullable: true + type: string + tracking_code: + nullable: true + type: string + customer_ip_address: + example: 0.0.0.0 + type: string + title: charge_data_payment_method_bank_transfer_response title: payment_method_bank_transfer x-discriminator-value: bank_transfer_payment - allOf: - - $ref: '#/components/schemas/payment_method' - - type: object - title: charge_data_payment_method_bank_transfer_response - description: use for bank transfer responses - properties: - bank: - type: string - example: STP - clabe: - type: string - example: '646180111805034237' - description: - type: - - string - - 'null' - executed_at: - type: - - string - - 'null' - expires_at: - type: integer - example: 1683053729 - format: int64 - issuing_account_bank: - type: - - string - - 'null' - issuing_account_number: - type: - - string - - 'null' - issuing_account_holder_name: - type: - - string - - 'null' - issuing_account_tax_id: - type: - - string - - 'null' - payment_attempts: - type: array - items: {} - receiving_account_holder_name: - type: - - string - - 'null' - receiving_account_number: - type: string - example: '646180111805034237' - receiving_account_bank: - type: string - example: STP - receiving_account_tax_id: - type: - - string - - 'null' - reference_number: - type: - - string - - 'null' - tracking_code: - type: - - string - - 'null' - customer_ip_address: - type: string - example: 0.0.0.0 payment_method_bnpl_payment: + allOf: + - properties: + type: + type: string + object: + example: payment_source + type: string + required: + - object + - description: use for bnpl payment responses + properties: + object: + enum: + - bnpl_payment + type: string + cancel_url: + description: URL to redirect the customer after a canceled payment + example: https://example.com/cancel + type: string + expires_at: + description: Expiration date of the charge + example: 1683053729 + format: int64 + type: integer + failure_url: + description: URL to redirect the customer after a failed payment + example: https://example.com/failure + type: string + product_type: + description: Product type of the charge + type: string + redirect_url: + description: URL to redirect the customer to complete the payment + example: https://example.com/redirect + type: string + success_url: + description: URL to redirect the customer after a successful payment + example: https://example.com/success + type: string + required: + - expires_at + - product_type + title: charge_data_payment_method_bnpl_payment_response title: payment_method_bnpl_payment x-discriminator-value: bnpl_payment - allOf: - - $ref: '#/components/schemas/payment_method' - - type: object - title: charge_data_payment_method_bnpl_payment_response - description: use for bnpl payment responses - required: - - product_type - - expires_at - properties: - object: - type: string - enum: - - bnpl_payment - cancel_url: - type: string - description: URL to redirect the customer after a canceled payment - example: https://example.com/cancel - expires_at: - type: integer - example: 1683053729 - format: int64 - description: Expiration date of the charge - failure_url: - type: string - description: URL to redirect the customer after a failed payment - example: https://example.com/failure - product_type: - type: string - description: Product type of the charge - examples: - - value: aplazo_bnpl - - value: azteca_bnpl - - value: coppel_bnpl - - value: creditea_bnpl - redirect_url: - type: string - description: URL to redirect the customer to complete the payment - example: https://example.com/redirect - success_url: - type: string - description: URL to redirect the customer after a successful payment - example: https://example.com/success payment_method_pbb_payment: + allOf: + - properties: + type: + type: string + object: + example: payment_source + type: string + required: + - object + - description: use for pbb payment responses + properties: + deep_link: + description: "Deep link for the payment, use for mobile apps/flows" + example: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 + type: string + expires_at: + description: Expiration date of the charge + example: 1683053729 + exclusiveMinimum: true + format: int64 + minimum: 0 + type: integer + product_type: + description: Product type of the charge + type: string + redirect_url: + description: URL to redirect the customer to complete the payment + example: https://example.com/redirect + type: string + reference: + description: Reference for the payment + example: "22277523174328893295" + type: string + required: + - deep_link + - expires_at + - product_type + - redirect_url + - reference + title: charge_data_payment_method_pbb_payment_response title: payment_method_pbb_payment x-discriminator-value: pay_by_bank_payment - allOf: - - $ref: '#/components/schemas/payment_method' - - type: object - title: charge_data_payment_method_pbb_payment_response - description: use for pbb payment responses - required: - - deep_link - - expires_at - - product_type - - redirect_url - - reference - properties: - deep_link: - type: string - description: Deep link for the payment, use for mobile apps/flows - example: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 - expires_at: - type: integer - example: 1683053729 - format: int64 - exclusiveMinimum: 0 - description: Expiration date of the charge - product_type: - type: string - description: Product type of the charge - examples: - - value: bbva_pay_by_bank - redirect_url: - type: string - description: URL to redirect the customer to complete the payment - example: https://example.com/redirect - reference: - type: string - description: Reference for the payment - example: '22277523174328893295' + charge_response_payment_method: + discriminator: + mapping: + cash_payment: payment_method_cash + card_payment: payment_method_card + bank_transfer_payment: payment_method_bank_transfer + bnpl_payment: payment_method_bnpl_payment + pay_by_bank_payment: payment_method_pbb_payment + propertyName: object + oneOf: + - $ref: "#/components/schemas/payment_method_cash" + - $ref: "#/components/schemas/payment_method_card" + - $ref: "#/components/schemas/payment_method_bank_transfer" + - $ref: "#/components/schemas/payment_method_bnpl_payment" + - $ref: "#/components/schemas/payment_method_pbb_payment" + title: charge_response_payment_method + propertyName: object + charge_response_refunds_data: + properties: + amount: + example: -15000 + format: int64 + type: integer + auth_code: + example: "867372" + type: string + created_at: + example: 1678226878 + format: int64 + type: integer + expires_at: + description: refund expiration date + example: 1678226878 + format: int64 + type: integer + id: + example: 6407b5bee1329a000175ba11 + type: string + object: + example: refund + type: string + status: + description: refund status + example: pending + type: string + required: + - amount + - created_at + - id + - object + title: charge_response_refunds_data + charge_response_refunds: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + description: refunds + items: + $ref: "#/components/schemas/charge_response_refunds_data" + type: array + default: null + title: charge_response_refunds chargeback_file_response: - title: chargeback_file_response - type: object description: A file associated with a chargeback (e.g. evidence document) properties: id: - type: string example: chbkf_2zPxWFUnGNLySoums - file_name: type: string + file_name: example: 20251221500000000000201.pdf + type: string url: - type: - - string - - 'null' + nullable: true + type: string created_at: - type: integer - format: int64 example: 1768846800 + format: int64 + type: integer + title: chargeback_file_response chargeback_response: - title: chargeback_response - type: object description: Chargeback object + nullable: true properties: id: - type: string example: chbk_2zPxWFUnGNLySoumn - status: type: string - example: lost + status: enum: - - won - - lost - - action_required - - pending_review - - under_review - - covered - - rt - - rt_sent - - represented - reason: + - won + - lost + - action_required + - pending_review + - under_review + - covered + - rt + - rt_sent + - represented + example: lost type: string - example: unrecognized + reason: enum: - - 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 + - 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 + example: unrecognized + type: string note: - type: - - string - - 'null' + nullable: true + type: string followup_status: - type: - - string - - 'null' enum: - - customer_uncontacted - - customer_contacted - - customer_unreachable + - customer_uncontacted + - customer_contacted + - customer_unreachable + nullable: true + type: string response_from_client: - type: - - string - - 'null' + nullable: true + type: string files: - type: array items: - $ref: '#/components/schemas/chargeback_file_response' + $ref: "#/components/schemas/chargeback_file_response" + type: array + default: null object: - type: string example: chargeback - charge_id: type: string + charge_id: example: 6966a06c044243000156c24d + type: string created_at: - type: integer - format: int64 example: 1768846800 - evidence_due_by: - type: integer format: int64 + type: integer + evidence_due_by: example: 1769126399 + format: int64 + type: integer + title: chargeback_response charge_response: - title: charge_response - type: object - required: - - amount - - created_at - - currency - - id - - livemode - - object - - status - - order_id properties: amount: - type: integer example: 4321 + type: integer channel: - type: object - properties: - segment: - type: string - example: Checkout - checkout_request_id: - type: string - example: 6fca054a-8519-4c43-971e-cea35cc519bb - checkout_request_type: - type: string - example: HostedPayment - id: - type: string - example: channel_2tNDzhA4Akmzj11AU + $ref: "#/components/schemas/charge_response_channel" created_at: - type: integer example: 1676386026 format: int64 + type: integer currency: - type: string example: MXN + type: string customer_id: type: string description: - type: string example: Payment from order - device_fingerprint: type: string + device_fingerprint: example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - failure_code: type: string + failure_code: example: suspected_fraud + type: string failure_message: + example: Este cargo ha sido declinado porque el comportamiento del comprador + es sospechoso. type: string - example: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso. id: - type: string - example: 63efa757cf65380001aec040 description: Charge ID + example: 63efa757cf65380001aec040 + type: string livemode: - type: boolean - example: false description: Whether the charge was made in live mode or not + example: false + type: boolean object: - type: string example: charge - order_id: type: string - example: ord_2tN73UdUSNrYRPD9r + order_id: description: Order ID + example: ord_2tN73UdUSNrYRPD9r + type: string paid_at: - type: - - integer - - 'null' - format: int64 - example: 1676390742 description: charge Payment date + example: 1676390742 + format: int64 + nullable: true + type: integer payment_method: - title: charge_response_payment_method - propertyName: object - oneOf: - - $ref: '#/components/schemas/payment_method_cash' - - $ref: '#/components/schemas/payment_method_card' - - $ref: '#/components/schemas/payment_method_bank_transfer' - - $ref: '#/components/schemas/payment_method_bnpl_payment' - - $ref: '#/components/schemas/payment_method_pbb_payment' - discriminator: - propertyName: object - mapping: - cash_payment: payment_method_cash - card_payment: payment_method_card - bank_transfer_payment: payment_method_bank_transfer - bnpl_payment: payment_method_bnpl_payment - pay_by_bank_payment: payment_method_pbb_payment + $ref: "#/components/schemas/charge_response_payment_method" reference_id: - type: - - string - - 'null' description: Reference ID of the charge example: ref_2tN73UdUSNrYRPD9r + nullable: true + type: string refunds: - type: - - object - - 'null' - title: charge_response_refunds - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - description: refunds - type: array - items: - title: charge_response_refunds_data - required: - - object - - id - - amount - - created_at - properties: - amount: - type: integer - format: int64 - example: -15000 - auth_code: - type: string - example: '867372' - created_at: - type: integer - example: 1678226878 - format: int64 - expires_at: - type: integer - example: 1678226878 - format: int64 - description: refund expiration date - id: - type: string - example: 6407b5bee1329a000175ba11 - object: - type: string - example: refund - status: - type: string - example: pending - description: refund status + $ref: "#/components/schemas/charge_response_refunds" chargeback: - description: Present only when the charge has a chargeback - oneOf: - - $ref: '#/components/schemas/chargeback_response' - - type: 'null' + $ref: "#/components/schemas/chargeback_response" status: - type: string - example: pending_payment description: Charge status + example: pending_payment + type: string + required: + - amount + - created_at + - currency + - id + - livemode + - object + - order_id + - status + title: charge_response + get_charges_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/charge_response" + type: array + default: null + title: get_charges_response charge_update_request: - title: charge_update_request description: requested field for update a charge properties: reference_id: - type: string - example: '278482642' description: custom reference id - customer_payment_method_request: - description: Contains details of the payment methods that the customer has active or has used in Conekta - title: customer_payment_method_request - required: - - type - properties: - type: + example: "278482642" type: string - example: card | cash | spei | bnpl | pay_by_bank - description: Type of payment method + title: charge_update_request payment_method_pbb_request: - title: payment_method_pbb_request allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - type: object - required: - - product_type - - type - properties: - expires_at: - type: integer - example: 1680397724 - format: int64 - description: Expiration date of the payment method, in Unix timestamp format - minimum: 0 - product_type: - type: string - example: bbva_pay_by_bank - description: Product type of the payment method, use for the payment method to know the product type - enum: - - bbva_pay_by_bank - type: - type: string - example: pay_by_bank - description: Type of the payment method + - description: Contains details of the payment methods that the customer has + active or has used in Conekta + properties: + type: + description: Type of payment method + example: card | cash | spei | bnpl | pay_by_bank + type: string + required: + - type + title: customer_payment_method_request + - properties: + expires_at: + description: "Expiration date of the payment method, in Unix timestamp\ + \ format" + example: 1680397724 + format: int64 + minimum: 0 + type: integer + product_type: + description: "Product type of the payment method, use for the payment\ + \ method to know the product type" + enum: + - bbva_pay_by_bank + example: bbva_pay_by_bank + type: string + type: + description: Type of the payment method + example: pay_by_bank + type: string + required: + - product_type + - type + title: payment_method_pbb_request payment_method_bnpl_request: - title: payment_method_bnpl_request allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - type: object - required: - - failure_url - - product_type - - success_url - - type - properties: - cancel_url: - type: string - description: Optional URL to redirect the customer after a canceled payment - example: https://example.com/cancel - expires_at: - type: integer - format: int64 - example: 1680397724 - description: Optional expiry for the BNPL order, expressed in seconds since the Unix epoch. Defaults to one month from creation when omitted. - failure_url: - type: string - description: URL to redirect the customer after a failed payment - example: https://example.com/failure - product_type: - type: string - example: aplazo_bnpl - description: Product type of the payment method, use for the payment method to know the product type - enum: - - aplazo_bnpl - - azteca_bnpl - - coppel_bnpl - - creditea_bnpl - success_url: - type: string - description: URL to redirect the customer after a successful payment - example: https://example.com/success - type: - type: string - example: bnpl - description: Type of the payment method + - description: Contains details of the payment methods that the customer has + active or has used in Conekta + properties: + type: + description: Type of payment method + example: card | cash | spei | bnpl | pay_by_bank + type: string + required: + - type + title: customer_payment_method_request + - properties: + cancel_url: + description: Optional URL to redirect the customer after a canceled payment + example: https://example.com/cancel + type: string + expires_at: + description: "Optional expiry for the BNPL order, expressed in seconds\ + \ since the Unix epoch. Defaults to one month from creation when omitted." + example: 1680397724 + format: int64 + type: integer + failure_url: + description: URL to redirect the customer after a failed payment + example: https://example.com/failure + type: string + product_type: + description: "Product type of the payment method, use for the payment\ + \ method to know the product type" + enum: + - aplazo_bnpl + - azteca_bnpl + - coppel_bnpl + - creditea_bnpl + example: aplazo_bnpl + type: string + success_url: + description: URL to redirect the customer after a successful payment + example: https://example.com/success + type: string + type: + description: Type of the payment method + example: bnpl + type: string + required: + - failure_url + - product_type + - success_url + - type + title: payment_method_bnpl_request payment_method_card_request: - title: payment_method_card_request allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - type: object - required: - - cvc - - name - - number - - exp_month - - exp_year - properties: - cvc: - type: string - example: '198' - description: Card security code - maxLength: 4 - minLength: 3 - exp_month: - type: string - example: '12' - description: Card expiration month - maxLength: 2 - minLength: 2 - exp_year: - type: string - example: '2025' - description: Card expiration year - maxLength: 4 - minLength: 4 - name: - type: string - maxLength: 249 - example: John Doe - description: Cardholder name. Must include first and last name separated by a space; single-word names are rejected. Letters (including accented Latin characters), spaces, and the characters , . ' - are accepted; digits and other symbols are rejected. - number: - type: string - example: '4242424242424242' - description: Card number - contract_id: - type: string - minLength: 10 - maxLength: 10 - example: '3456788363' - description: Optional merchant-supplied identifier (exactly 10 characters) that links a card transaction to a recurring/subscription contract at the acquiring bank. Forwarded to the bank gateway and stored on the resulting charge. Accepted on creation only; ignored on update. Do not place sensitive bank data here — the value is returned in charge responses. - customer_ip_address: - type: string - example: 0.0.0.0 - description: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes + - description: Contains details of the payment methods that the customer has + active or has used in Conekta + properties: + type: + description: Type of payment method + example: card | cash | spei | bnpl | pay_by_bank + type: string + required: + - type + title: customer_payment_method_request + - properties: + cvc: + description: Card security code + example: "198" + maxLength: 4 + minLength: 3 + type: string + exp_month: + description: Card expiration month + example: "12" + maxLength: 2 + minLength: 2 + type: string + exp_year: + description: Card expiration year + example: "2025" + maxLength: 4 + minLength: 4 + type: string + name: + description: "Cardholder name. Must include first and last name separated\ + \ by a space; single-word names are rejected. Letters (including accented\ + \ Latin characters), spaces, and the characters , . ' - are accepted;\ + \ digits and other symbols are rejected." + example: John Doe + maxLength: 249 + type: string + number: + description: Card number + example: "4242424242424242" + type: string + contract_id: + description: Optional merchant-supplied identifier (exactly 10 characters) + that links a card transaction to a recurring/subscription contract at + the acquiring bank. Forwarded to the bank gateway and stored on the + resulting charge. Accepted on creation only; ignored on update. Do not + place sensitive bank data here — the value is returned in charge responses. + example: "3456788363" + maxLength: 10 + minLength: 10 + type: string + customer_ip_address: + description: Optional field used to capture the customer's IP address + for fraud prevention and security monitoring purposes + example: 0.0.0.0 + type: string + required: + - cvc + - exp_month + - exp_year + - name + - number + title: payment_method_card_request + payment_method_general_request: + description: | + Payment method used in the charge. Go to the [payment methods](https://developers.conekta.com/reference/m%C3%A9todos-de-pago) section for more details + properties: + expires_at: + description: Method expiration date as unix timestamp + example: 1677196303 + format: int64 + type: integer + monthly_installments: + description: "How many months without interest to apply, it can be 3, 6,\ + \ 9, 12 or 18" + format: int8 + type: integer + type: + description: Type of payment method + example: card + type: string + token_id: + example: tok_2897348234 + type: string + payment_source_id: + example: src_2tLkkyfMPh6v7pFry + type: string + cvc: + description: "Optional, It is a value that allows identifying the security\ + \ code of the card. Only for PCI merchants" + example: "123" + type: string + contract_id: + description: Optional id sent to indicate the bank contract for recurrent + card charges. + example: S781317595 + type: string + customer_ip_address: + description: Optional field used to capture the customer's IP address for + fraud prevention and security monitoring purposes + example: 0.0.0.0 + type: string + required: + - type + title: payment_method_general_request + charge_request_payment_method: + oneOf: + - $ref: "#/components/schemas/payment_method_pbb_request" + - $ref: "#/components/schemas/payment_method_bnpl_request" + - $ref: "#/components/schemas/payment_method_card_request" + - $ref: "#/components/schemas/payment_method_general_request" + title: charge_request_payment_method charge_request: - title: charge_request description: The charges to be made - required: - - payment_method properties: amount: - type: integer + description: Amount to be charged in cents example: 40000 format: int64 - description: Amount to be charged in cents + type: integer payment_method: - title: charge_request_payment_method - oneOf: - - $ref: '#/components/schemas/payment_method_pbb_request' - - $ref: '#/components/schemas/payment_method_bnpl_request' - - $ref: '#/components/schemas/payment_method_card_request' - - required: - - type - type: object - title: payment_method_general_request - description: | - Payment method used in the charge. Go to the [payment methods](https://developers.conekta.com/reference/m%C3%A9todos-de-pago) section for more details - properties: - expires_at: - type: integer - format: int64 - description: Method expiration date as unix timestamp - example: 1677196303 - monthly_installments: - type: integer - format: int8 - description: How many months without interest to apply, it can be 3, 6, 9, 12 or 18 - type: - type: string - description: Type of payment method - example: card - token_id: - type: string - example: tok_2897348234 - payment_source_id: - type: string - example: src_2tLkkyfMPh6v7pFry - cvc: - type: string - example: '123' - description: Optional, It is a value that allows identifying the security code of the card. Only for PCI merchants - contract_id: - type: string - description: Optional id sent to indicate the bank contract for recurrent card charges. - example: S781317595 - customer_ip_address: - type: string - description: Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes - example: 0.0.0.0 + $ref: "#/components/schemas/charge_request_payment_method" reference_id: description: Custom reference to add to the charge type: string + required: + - payment_method + title: charge_request + charge_order_response_payment_method: + discriminator: + mapping: + cash_payment: payment_method_cash + card_payment: payment_method_card + bank_transfer_payment: payment_method_bank_transfer + bnpl_payment: payment_method_bnpl_payment + pay_by_bank_payment: payment_method_pbb_payment + propertyName: object + oneOf: + - $ref: "#/components/schemas/payment_method_cash" + - $ref: "#/components/schemas/payment_method_card" + - $ref: "#/components/schemas/payment_method_bank_transfer" + - $ref: "#/components/schemas/payment_method_bnpl_payment" + - $ref: "#/components/schemas/payment_method_pbb_payment" + title: charge_order_response_payment_method + propertyName: object charge_order_response: - title: charge_order_response - type: object properties: amount: - type: integer example: 4321 + type: integer channel: - type: object - properties: - segment: - type: string - example: Checkout - checkout_request_id: - type: string - example: 6fca054a-8519-4c43-971e-cea35cc519bb - checkout_request_type: - type: string - example: HostedPayment - id: - type: string - example: channel_2tNDzhA4Akmzj11AU + $ref: "#/components/schemas/charge_response_channel" created_at: - type: integer example: 1676386026 format: int64 + type: integer currency: - type: string example: MXN + type: string customer_id: type: string description: - type: string example: Payment from order + type: string device_fingerprint: - type: - - string - - 'null' example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - failure_code: + nullable: true type: string + failure_code: example: suspected_fraud + type: string failure_message: + example: Este cargo ha sido declinado porque el comportamiento del comprador + es sospechoso. type: string - example: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso. id: - type: string example: 63efa757cf65380001aec040 + type: string livemode: - type: boolean example: true + type: boolean monthly_installments: - type: - - integer - - 'null' + nullable: true + type: integer object: type: string order_id: - type: string example: ord_2tN73UdUSNrYRPD9r + type: string paid_at: - type: - - integer - - 'null' example: 1676390742 + nullable: true + type: integer payment_method: - title: charge_order_response_payment_method - propertyName: object - oneOf: - - $ref: '#/components/schemas/payment_method_cash' - - $ref: '#/components/schemas/payment_method_card' - - $ref: '#/components/schemas/payment_method_bank_transfer' - - $ref: '#/components/schemas/payment_method_bnpl_payment' - - $ref: '#/components/schemas/payment_method_pbb_payment' - discriminator: - propertyName: object - mapping: - cash_payment: payment_method_cash - card_payment: payment_method_card - bank_transfer_payment: payment_method_bank_transfer - bnpl_payment: payment_method_bnpl_payment - pay_by_bank_payment: payment_method_pbb_payment + $ref: "#/components/schemas/charge_order_response_payment_method" reference_id: - type: - - string - - 'null' description: Reference ID of the charge example: ref_2tN73UdUSNrYRPD9r + nullable: true + type: string refunds: - type: array items: {} + type: array + default: null status: - type: string example: pending_payment + type: string + title: charge_order_response charges_order_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/charge_response" + type: array + default: null description: The charges associated with the order title: charges_order_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/charge_response' + company_document_response: + properties: + file_classification: + description: | + Classification of the document. + + | Tipo de archivo | Descripción | + | :--------------------------- | :-------------------------------------------------------- | + | `id_legal_representative` | identificación oficial frente | + | `id_legal_representative_back` | identificación oficial atrás | + | `cfdi` | Prueba de situación fiscal | + | `constitutive_act_basic` | Acta constitutiva | + | `proof_of_address` | Comprobante de domicilio del negocio | + | `power_of_attonery` | Poderes de representación | + | `deposit_account_cover` | Carátula de la cuenta de depósito | + | `permit_casino` | Permiso ante SEGOB | + | `license_sanitation` | Licencia sanitaria de COFEPRIS | + | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | + enum: + - id_legal_representative + - id_legal_representative_back + - cfdi + - constitutive_act_basic + - proof_of_address + - power_of_attonery + - deposit_account_cover + - permit_casino + - license_sanitation + - registration_tourism + example: deposit_account_cover + type: string + status: + description: The status of the document. + example: pending + type: string + file_name: + description: The name of the file. + nullable: true + type: string + title: company_document_response company_response: - type: object - title: company_response properties: id: - type: string description: The unique identifier for the company. example: 6827305a1ec60400015eb116 - name: type: string + name: description: The name of the company. example: test + type: string active: - type: boolean description: Indicates if the company is active. example: false + type: boolean account_status: - type: string description: The current status of the company's account. example: signed_up + type: string parent_company_id: - type: - - string - - 'null' - description: The identifier of the parent company, if any. + description: "The identifier of the parent company, if any." example: 680bf1da38716d00013543bc - onboarding_status: + nullable: true type: string + onboarding_status: description: The current status of the company's onboarding process. example: pending + type: string documents: - type: array description: A list of documents related to the company. items: - title: company_document_response - type: object - properties: - file_classification: - type: string - description: | - Classification of the document. - - | Tipo de archivo | Descripción | - | :--------------------------- | :-------------------------------------------------------- | - | `id_legal_representative` | identificación oficial frente | - | `id_legal_representative_back` | identificación oficial atrás | - | `cfdi` | Prueba de situación fiscal | - | `constitutive_act_basic` | Acta constitutiva | - | `proof_of_address` | Comprobante de domicilio del negocio | - | `power_of_attonery` | Poderes de representación | - | `deposit_account_cover` | Carátula de la cuenta de depósito | - | `permit_casino` | Permiso ante SEGOB | - | `license_sanitation` | Licencia sanitaria de COFEPRIS | - | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | - example: deposit_account_cover - enum: - - id_legal_representative - - id_legal_representative_back - - cfdi - - constitutive_act_basic - - proof_of_address - - power_of_attonery - - deposit_account_cover - - permit_casino - - license_sanitation - - registration_tourism - status: - type: string - description: The status of the document. - example: pending - file_name: - type: - - string - - 'null' - description: The name of the file. - example: null + $ref: "#/components/schemas/company_document_response" + type: array + default: null created_at: - type: integer - format: int64 description: Timestamp of when the company was created. example: 1748968241 + format: int64 + type: integer object: - type: string - description: The type of object, typically "company". + description: "The type of object, typically \"company\"." example: company + type: string three_ds_enabled: - type: boolean description: Indicates if 3DS authentication is enabled for the company. example: true + type: boolean three_ds_mode: - type: - - string - - 'null' - description: The 3DS mode for the company, either 'smart' or 'strict'. This property is only applicable when three_ds_enabled is true. When three_ds_enabled is false, this field will be null. - example: strict + description: "The 3DS mode for the company, either 'smart' or 'strict'.\ + \ This property is only applicable when three_ds_enabled is true. When\ + \ three_ds_enabled is false, this field will be null." enum: - - smart - - strict + - smart + - strict + example: strict + nullable: true + type: string required: - - id - - name - - active - - account_status - - onboarding_status - - documents - - created_at + - account_status + - active + - created_at + - documents + - id + - name + - object + - onboarding_status + title: company_response + get_companies_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more - object - create_company_request: - title: Create Company Request - type: object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/company_response" + type: array + default: null + title: get_companies_response + Create_Company_Request_comercial_info: + description: Commercial information for the company. properties: - name: + website: + description: The company's website URL. + example: http://www.test.com + format: url + type: string + mcc: + description: The Merchant Category Code (MCC) for the company. + example: "5812" + type: string + merchant_support_email: + description: Email address for merchant support. + example: test@test.com + format: email + type: string + merchant_support_phone: + description: Phone number for merchant support. + example: "5300000000" + type: string + Create_Company_Request_fiscal_info: + description: Fiscal information for the company. + properties: + business_phone: + description: The business phone number for fiscal purposes. + example: "5300000000" + type: string + fiscal_type: + description: "The fiscal type of the company (e.g., 'moral', 'persona_fisica')." + example: moral + type: string + Create_Company_Request_bank_account_info: + description: Bank account information for the company. + properties: + clabe: + description: The 18-digit CLABE for the bank account. + example: "002010077777777771" type: string + Create_Company_Request: + properties: + name: description: The name of the company. example: test - type_company: type: string - description: The type of company, 'owner' + type_company: + description: "The type of company, 'owner'" example: owner + type: string comercial_info: - type: object - description: Commercial information for the company. - properties: - website: - type: string - format: url - description: The company's website URL. - example: http://www.test.com - mcc: - type: string - description: The Merchant Category Code (MCC) for the company. - example: '5812' - merchant_support_email: - type: string - format: email - description: Email address for merchant support. - example: test@test.com - merchant_support_phone: - type: string - description: Phone number for merchant support. - example: '5300000000' + $ref: "#/components/schemas/Create_Company_Request_comercial_info" fiscal_info: - type: object - description: Fiscal information for the company. - properties: - business_phone: - type: string - description: The business phone number for fiscal purposes. - example: '5300000000' - fiscal_type: - type: string - description: The fiscal type of the company (e.g., 'moral', 'persona_fisica'). - example: moral + $ref: "#/components/schemas/Create_Company_Request_fiscal_info" bank_account_info: - type: object - description: Bank account information for the company. - properties: - clabe: - type: string - description: The 18-digit CLABE for the bank account. - example: '002010077777777771' - company_document_request: - type: object - title: CompanyDocumentRequest + $ref: "#/components/schemas/Create_Company_Request_bank_account_info" + title: Create Company Request + CompanyDocumentRequest: description: Request body for uploading a company document. + example: + file_classification: id_legal_representative + content_type: application/pdf + international: false + file_name: example_document.pdf + file_data: VGhpcyBpcyBhIHRlc3QgZmlsZSBkYXRhIGluIGJhc2UgNjQu properties: file_classification: - type: string description: | Classification of the document. @@ -6438,51 +17115,50 @@ components: | `permit_casino` | Permiso ante SEGOB | | `license_sanitation` | Licencia sanitaria de COFEPRIS | | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | - example: id_legal_representative enum: - - id_legal_representative - - id_legal_representative_back - - cfdi - - constitutive_act_basic - - proof_of_address - - power_of_attonery - - deposit_account_cover - - permit_casino - - license_sanitation - - registration_tourism - content_type: + - id_legal_representative + - id_legal_representative_back + - cfdi + - constitutive_act_basic + - proof_of_address + - power_of_attonery + - deposit_account_cover + - permit_casino + - license_sanitation + - registration_tourism + example: id_legal_representative type: string + content_type: description: | MIME type of the file. Allowed values depend on the `file_classification`. - `image/jpeg` - `image/png` - `application/pdf` example: application/pdf + type: string international: - type: boolean description: Indicates if the document is international. Defaults to false. example: false + type: boolean file_name: - type: string description: Name of the file being uploaded. example: example_document.pdf - file_data: type: string - format: byte + file_data: description: Base64 encoded content of the file. example: VGhpcyBpcyBhIHRlc3QgZmlsZSBkYXRhIGluIGJhc2UgNjQu + format: byte + type: string required: - - file_classification - - content_type - - file_name - - file_data - company_document_response: - type: object - title: CompanyDocumentResponse + - content_type + - file_classification + - file_data + - file_name + title: CompanyDocumentRequest + CompanyDocumentResponse: description: Response body after uploading a company document. properties: file_classification: - type: string description: | Classification of the document. @@ -6498,772 +17174,1080 @@ components: | `permit_casino` | Permiso ante SEGOB | | `license_sanitation` | Licencia sanitaria de COFEPRIS | | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | - example: id_legal_representative enum: - - id_legal_representative - - id_legal_representative_back - - cfdi - - constitutive_act_basic - - proof_of_address - - power_of_attonery - - deposit_account_cover - - permit_casino - - license_sanitation - - registration_tourism - file_name: + - id_legal_representative + - id_legal_representative_back + - cfdi + - constitutive_act_basic + - proof_of_address + - power_of_attonery + - deposit_account_cover + - permit_casino + - license_sanitation + - registration_tourism + example: id_legal_representative type: string + file_name: description: Name of the file as stored or processed. example: prueba3.pdf - status: type: string + status: description: Current status of the document. example: uploaded + type: string required: - - file_classification - - file_name - - status - customer_address: - type: object - required: - - street1 + - file_classification + - file_name + - status + title: CompanyDocumentResponse + customer_antifraud_info_response: + properties: + first_paid_at: + example: 1485151007 + type: integer + account_created_at: + example: 1484040996 + format: int64 + type: integer + title: customer_antifraud_info_response + fiscal_entity_request_address: + allOf: + - properties: + street1: + example: Nuevo Leon 254 + type: string + street2: + example: Departamento 404 + type: string + postal_code: + example: "06100" + type: string + city: + example: Ciudad de Mexico + type: string + state: + example: Ciudad de Mexico + type: string + country: + description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" + example: MX + type: string + external_number: + type: string + required: - city - postal_code - properties: - street1: - type: string - example: Nuevo Leon 254 - street2: - type: string - example: Departamento 404 - postal_code: - type: string - example: '06100' - city: - type: string - example: Ciudad de Mexico - state: - type: string - example: Ciudad de Mexico - country: - type: string - example: MX - description: this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - external_number: - type: string - customer_fiscal_entities_request: - title: fiscal_entity_request - required: + - street1 + customer_fiscal_entities_data_response: + allOf: + - properties: + address: + $ref: "#/components/schemas/fiscal_entity_request_address" + tax_id: + type: string + email: + type: string + phone: + type: string + metadata: + additionalProperties: + type: object + company_name: + example: conekta + type: string + required: - address - properties: - address: - allOf: - - $ref: '#/components/schemas/customer_address' - tax_id: - type: string - email: - type: string - phone: - type: string - metadata: - type: object - additionalProperties: - type: object - company_name: - type: string - example: conekta - payment_method_response: - type: object - required: - - type + title: fiscal_entity_request + - properties: + id: + example: ship_cont_2tKZsTYcsryyu7Ah8 + type: string + object: + example: shipping_contact + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + parent_id: + example: cus_2tKcHxhTz7xU5SymF + type: string + default: + type: boolean + required: + - created_at - id - object - - created_at + title: customer_fiscal_entities_data_response + customer_fiscal_entities_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - properties: + data: + items: + $ref: "#/components/schemas/customer_fiscal_entities_data_response" + type: array + default: null + title: customer_fiscal_entities_response + cash_agreements_response: properties: - type: - type: string - id: - type: string - example: src_2s8K1B3PBKDontpi9 - object: + agreement: + description: "Agreement number, you can use this number to pay in the store/bbva" + example: "2409526" type: string - example: payment_source - created_at: - type: integer - format: int64 - example: 1675715413 - parent_id: + provider: + description: "Provider name, you can use this to know where to pay" + example: bbva_cash_in type: string - example: cus_2s8K1B3PBKDontpi8 + title: cash_agreements_response payment_method_cash_response: - x-discriminator-value: cash + allOf: + - properties: + type: + type: string + id: + example: src_2s8K1B3PBKDontpi9 + type: string + object: + example: payment_source + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + parent_id: + example: cus_2s8K1B3PBKDontpi8 + type: string + required: + - created_at + - id + - object + - type + - description: use for cash responses + properties: + agreements: + items: + $ref: "#/components/schemas/cash_agreements_response" + type: array + default: null + reference: + example: "93000262276908" + type: string + barcode: + example: "93000262276908" + type: string + barcode_url: + description: "URL to the barcode image, reference is the same as barcode" + example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png + type: string + expires_at: + example: 1742483424 + format: int64 + type: integer + provider: + example: Cash + type: string title: payment_method_cash_response + x-discriminator-value: cash + payment_method_cash_recurrent_response: allOf: - - $ref: '#/components/schemas/payment_method_response' - - type: object - description: use for cash responses + - allOf: + - properties: + type: + type: string + id: + example: src_2s8K1B3PBKDontpi9 + type: string + object: + example: payment_source + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + parent_id: + example: cus_2s8K1B3PBKDontpi8 + type: string + required: + - created_at + - id + - object + - type + - description: use for cash responses properties: agreements: - type: array items: - type: object - title: cash_agreements_response - properties: - agreement: - type: string - example: '2409526' - description: Agreement number, you can use this number to pay in the store/bbva - provider: - type: string - example: bbva_cash_in - description: Provider name, you can use this to know where to pay + $ref: "#/components/schemas/cash_agreements_response" + type: array + default: null reference: + example: "93000262276908" type: string - example: '93000262276908' barcode: + example: "93000262276908" type: string - example: '93000262276908' barcode_url: - type: string + description: "URL to the barcode image, reference is the same as barcode" example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png - description: URL to the barcode image, reference is the same as barcode + type: string expires_at: - type: integer - format: int64 example: 1742483424 + format: int64 + type: integer provider: - type: string example: Cash - payment_method_cash_recurrent_response: - title: payment_method_cash_recurrent_response - allOf: - - $ref: '#/components/schemas/payment_method_cash_response' + type: string + title: payment_method_cash_response + x-discriminator-value: cash description: Alias of cash response used when type=cash_recurrent + title: payment_method_cash_recurrent_response x-discriminator-value: cash_recurrent payment_method_card_response: - title: payment_method_card_response allOf: - - $ref: '#/components/schemas/payment_method_response' - - type: object - description: use for card responses - properties: - last4: - type: string - example: '6410' - bin: - type: string - example: '40276657' - card_type: - type: string - example: debit - exp_month: - type: string - example: '10' - exp_year: - type: string - example: '25' - brand: - type: string - example: visa - issuer: - type: string - example: santander - description: Name of the institution that issued the card - name: - type: string - example: Fulano Perez" - default: - type: boolean - visible_on_checkout: - type: boolean - payment_source_status: - type: string - example: active + - properties: + type: + type: string + id: + example: src_2s8K1B3PBKDontpi9 + type: string + object: + example: payment_source + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + parent_id: + example: cus_2s8K1B3PBKDontpi8 + type: string + required: + - created_at + - id + - object + - type + - description: use for card responses + properties: + last4: + example: "6410" + type: string + bin: + example: "40276657" + type: string + card_type: + example: debit + type: string + exp_month: + example: "10" + type: string + exp_year: + example: "25" + type: string + brand: + example: visa + type: string + issuer: + description: Name of the institution that issued the card + example: santander + type: string + name: + example: Fulano Perez" + type: string + default: + type: boolean + visible_on_checkout: + type: boolean + payment_source_status: + example: active + type: string + title: payment_method_card_response payment_method_spei_recurrent_response: + allOf: + - properties: + type: + type: string + id: + example: src_2s8K1B3PBKDontpi9 + type: string + object: + example: payment_source + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + parent_id: + example: cus_2s8K1B3PBKDontpi8 + type: string + required: + - created_at + - id + - object + - type + - description: use for spei responses + properties: + bank: + description: Bank name for the SPEI payment method + example: STP + type: string + reference: + example: "93000262276908" + type: string + expires_at: + example: none + type: string title: payment_method_spei_recurrent_response x-discriminator-value: spei_recurrent + customer_payment_methods_data: + discriminator: + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + propertyName: type + oneOf: + - $ref: "#/components/schemas/payment_method_cash_response" + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/payment_method_card_response" + - $ref: "#/components/schemas/payment_method_spei_recurrent_response" + title: customer_payment_methods_data + customer_payment_methods_response: allOf: - - $ref: '#/components/schemas/payment_method_response' - - type: object - description: use for spei responses - properties: - bank: - type: string - example: STP - description: Bank name for the SPEI payment method - reference: - type: string - example: '93000262276908' - expires_at: - type: string - example: none - shipping_contact_address: - title: shipping_contact_address - type: object - description: Address of the person who will receive the order - properties: - street1: - type: string - minLength: 2 - maxLength: 249 - example: Nuevo Leon 254 - description: Street and number of the delivery address. - street2: - type: string - maxLength: 249 - example: Departamento 404 - description: Apartment, suite or interior reference for the delivery address. - postal_code: - type: string - maxLength: 250 - example: '06100' - description: Postal code of the delivery address. For Mexican addresses (country MX) it must be a 5-digit postal code. - city: - type: string - maxLength: 249 - pattern: '[A-Za-z]{2}' - example: Ciudad de Mexico - description: City of the delivery address. Must contain at least two consecutive ASCII letters. - state: - type: string - maxLength: 249 - example: Ciudad de Mexico - description: State of the delivery address. - country: - type: string - minLength: 2 - maxLength: 249 - example: MX - description: Country of the delivery address. This field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - residential: - type: - - boolean - - 'null' - default: true - example: true - description: Indicates whether the delivery address is residential. - customer_shipping_contacts: - title: customer_shipping_contacts_request - description: |- - [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) - details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/customer_payment_methods_data" + title: customer_payment_methods_data + type: array + default: null + title: customerPaymentMethods + title: customer_payment_methods_response + customer_shipping_contacts_request_address: + allOf: + - description: Address of the person who will receive the order + properties: + street1: + description: Street and number of the delivery address. + example: Nuevo Leon 254 + maxLength: 249 + minLength: 2 + type: string + street2: + description: "Apartment, suite or interior reference for the delivery\ + \ address." + example: Departamento 404 + maxLength: 249 + type: string + postal_code: + description: Postal code of the delivery address. For Mexican addresses + (country MX) it must be a 5-digit postal code. + example: "06100" + maxLength: 250 + type: string + city: + description: City of the delivery address. Must contain at least two consecutive + ASCII letters. + example: Ciudad de Mexico + maxLength: 249 + pattern: "[A-Za-z]{2}" + type: string + state: + description: State of the delivery address. + example: Ciudad de Mexico + maxLength: 249 + type: string + country: + description: "Country of the delivery address. This field follows the\ + \ [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." + example: MX + maxLength: 249 + minLength: 2 + type: string + residential: + default: true + description: Indicates whether the delivery address is residential. + example: true + nullable: true + type: boolean + title: shipping_contact_address required: + - country + - postal_code + - street1 + customer_shipping_contacts_data_response: + allOf: + - description: |- + [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) + details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. + properties: + phone: + description: Phone contact + example: "+525511223344" + type: string + receiver: + description: Name of the person who will receive the order + example: Marvin Fuller + type: string + between_streets: + description: The street names between which the order will be delivered. + Must contain at least two consecutive ASCII letters. + example: Ackerman Crescent + maxLength: 249 + pattern: "[A-Za-z]{2}" + type: string + address: + $ref: "#/components/schemas/customer_shipping_contacts_request_address" + parent_id: + type: string + default: + nullable: true + type: boolean + deleted: + nullable: true + type: boolean + metadata: + additionalProperties: true + description: Metadata associated with the shipping contact + maxProperties: 100 + type: object + required: - address - properties: - phone: - type: string - example: '+525511223344' - description: Phone contact - receiver: - type: string - example: Marvin Fuller - description: Name of the person who will receive the order - between_streets: - type: string - maxLength: 249 - pattern: '[A-Za-z]{2}' - example: Ackerman Crescent - description: The street names between which the order will be delivered. Must contain at least two consecutive ASCII letters. - address: - allOf: - - $ref: '#/components/schemas/shipping_contact_address' - required: - - street1 - - postal_code - - country - parent_id: - type: string - default: - type: - - boolean - - 'null' - deleted: - type: - - boolean - - 'null' - metadata: - type: object - additionalProperties: true - maxProperties: 100 - description: Metadata associated with the shipping contact + title: customer_shipping_contacts_request + - properties: + id: + example: ship_cont_2tKZsTYcsryyu7Ah8 + type: string + object: + example: shipping_contact + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + required: + - created_at + - id + - object + title: customer_shipping_contacts_data_response + customer_response_shipping_contacts: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - properties: + data: + items: + $ref: "#/components/schemas/customer_shipping_contacts_data_response" + type: array + default: null subscription_response: - title: subscription_response description: subscription model - type: object + nullable: true properties: billing_cycle_start: - type: - - integer - - 'null' example: 1677626827 format: int64 + nullable: true + type: integer billing_cycle_end: - type: - - integer - - 'null' example: 1677626827 format: int64 + nullable: true + type: integer canceled_at: - type: - - integer - - 'null' example: 1678258162 format: int64 + nullable: true + type: integer canceled_reason: - type: string + description: Reason for cancellation. This field appears when the subscription + status is 'canceled'. example: user_cancelation - description: Reason for cancellation. This field appears when the subscription status is 'canceled'. - card_id: type: string + card_id: example: src_2tKcHxhTz7xU5SymL + type: string charge_id: - type: - - string - - 'null' example: 2tKcHxhTz7xU5SymL + nullable: true + type: string created_at: - type: integer example: 1677626837 format: int64 + type: integer customer_custom_reference: - type: string example: dotnet_123456 - customer_id: type: string + customer_id: example: cus_2tKcHxhTz7xU5SymF - id: type: string + id: example: gold-plan - last_billing_cycle_order_id: type: string + last_billing_cycle_order_id: example: ord_2tSoMP7bZJbLiq4z8 - object: type: string + object: example: subscription + type: string paused_at: - type: - - integer - - 'null' example: 1678258162 format: int64 + nullable: true + type: integer plan_id: - type: string example: plan_2tXx672QLQ68CkmMn - status: type: string + status: example: past_due + type: string subscription_start: - type: integer example: 1677626837 + type: integer trial_start: - type: - - integer - - 'null' example: 1677626837 format: int64 + nullable: true + type: integer trial_end: - type: - - integer - - 'null' example: 1677626837 format: int64 + nullable: true + type: integer + title: subscription_response customer_response: - title: customer response description: customer response - type: object - required: - - id - - livemode - - created_at - - object - - name properties: antifraud_info: - title: customer_antifraud_info_response - type: - - object - - 'null' - properties: - first_paid_at: - type: integer - example: 1485151007 - account_created_at: - type: integer - example: 1484040996 - format: int64 + $ref: "#/components/schemas/customer_antifraud_info_response" corporate: - type: boolean description: true if the customer is a company + type: boolean created_at: - type: integer - format: int64 - example: 1485151007 description: Creation date of the object + example: 1485151007 + format: int64 + type: integer custom_reference: - type: string - example: custom_reference description: Custom reference - date_of_birth: + example: custom_reference type: string - description: It is a parameter that allows to identify the date of birth of the client. + date_of_birth: + description: It is a parameter that allows to identify the date of birth + of the client. example: 24/07/1992 + type: string default_fiscal_entity_id: - type: - - string - - 'null' example: fis_ent_2tKqqAfqPi21oCmEJ - default_shipping_contact_id: + nullable: true type: string + default_shipping_contact_id: example: ship_cont_2tKZsTYcsryyu7Ah8 + type: string default_payment_source_id: - type: - - string - - 'null' example: src_2tHJfJ79KyUwpxTio - email: + nullable: true type: string + email: example: Felipe@gmail.com format: email + type: string fiscal_entities: - title: customer_fiscal_entities_response - allOf: - - $ref: '#/components/schemas/pagination' - - type: object - properties: - data: - type: array - items: - title: customer_fiscal_entities_data_response - allOf: - - $ref: '#/components/schemas/customer_fiscal_entities_request' - - type: object - required: - - id - - object - - created_at - properties: - id: - type: string - example: ship_cont_2tKZsTYcsryyu7Ah8 - object: - type: string - example: shipping_contact - created_at: - type: integer - format: int64 - example: 1675715413 - parent_id: - type: string - example: cus_2tKcHxhTz7xU5SymF - default: - type: boolean + $ref: "#/components/schemas/customer_fiscal_entities_response" id: - type: string - example: cus_2tHJfJ79KyUwpxTik description: Customer's ID + example: cus_2tHJfJ79KyUwpxTik + type: string livemode: - type: boolean + description: true if the object exists in live mode or the value false if + the object exists in test mode example: true - description: true if the object exists in live mode or the value false if the object exists in test mode + type: boolean name: - type: string - example: Felipe description: Customer's name - national_id: + example: Felipe type: string - description: It is a parameter that allows to identify the national identification number of the client. + national_id: + description: It is a parameter that allows to identify the national identification + number of the client. example: HEGG560427MVZRRL04 + type: string metadata: - type: object additionalProperties: true maxProperties: 100 + type: object object: - type: string example: customer + type: string payment_sources: - title: customer_payment_methods_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - title: customerPaymentMethods - properties: - data: - type: array - title: customer_payment_methods_data - items: - title: customer_payment_methods_data - discriminator: - propertyName: type - mapping: - cash: payment_method_cash_response - card: payment_method_card_response - cash_recurrent: payment_method_cash_recurrent_response - spei_recurrent: payment_method_spei_recurrent_response - oneOf: - - $ref: '#/components/schemas/payment_method_cash_response' - - $ref: '#/components/schemas/payment_method_cash_recurrent_response' - - $ref: '#/components/schemas/payment_method_card_response' - - $ref: '#/components/schemas/payment_method_spei_recurrent_response' + $ref: "#/components/schemas/customer_payment_methods_response" phone: - type: string - example: '+5215555555555' description: Customer's phone number + example: "+5215555555555" + type: string shipping_contacts: - allOf: - - $ref: '#/components/schemas/pagination' - - type: object - properties: - data: - type: array - items: - title: customer_shipping_contacts_data_response - allOf: - - $ref: '#/components/schemas/customer_shipping_contacts' - - type: object - required: - - id - - object - - created_at - properties: - id: - type: string - example: ship_cont_2tKZsTYcsryyu7Ah8 - object: - type: string - example: shipping_contact - created_at: - type: integer - format: int64 - example: 1675715413 + $ref: "#/components/schemas/customer_response_shipping_contacts" subscription: - title: customer_subscription_response - anyOf: - - $ref: '#/components/schemas/subscription_response' - - type: 'null' + $ref: "#/components/schemas/subscription_response" + required: + - created_at + - id + - livemode + - name + - object + title: customer response + customers_response: + allOf: + - properties: + data: + items: + $ref: "#/components/schemas/customer_response" + title: customers_data_response + type: array + default: null + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + title: customers_response + customer_antifraud_info: + properties: + account_created_at: + example: 1484040996 + format: int64 + type: integer + first_paid_at: + example: 1485151007 + format: int64 + type: integer + fiscal_entity_request: + properties: + address: + $ref: "#/components/schemas/fiscal_entity_request_address" + tax_id: + type: string + email: + type: string + phone: + type: string + metadata: + additionalProperties: + type: object + company_name: + example: conekta + type: string + required: + - address + title: fiscal_entity_request payment_method_token_request: - title: payment_method_token_request allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - type: object - required: - - token_id - properties: - token_id: - type: string - example: tok_32hj4g234as - description: Token id that will be used to create a "card" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.3.0/reference/createsubscription] tutorial for more information on how to tokenize cards. + - description: Contains details of the payment methods that the customer has + active or has used in Conekta + properties: + type: + description: Type of payment method + example: card | cash | spei | bnpl | pay_by_bank + type: string + required: + - type + title: customer_payment_method_request + - properties: + token_id: + description: "Token id that will be used to create a \"card\" type payment\ + \ method. See the (subscriptions)[https://developers.conekta.com/v2.3.0/reference/createsubscription]\ + \ tutorial for more information on how to tokenize cards." + example: tok_32hj4g234as + type: string + required: + - token_id + title: payment_method_token_request payment_method_cash_request: - title: payment_method_cash_request allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - type: object - properties: - expires_at: - type: integer - example: 1553273553 - format: int64 + - description: Contains details of the payment methods that the customer has + active or has used in Conekta + properties: + type: + description: Type of payment method + example: card | cash | spei | bnpl | pay_by_bank + type: string + required: + - type + title: customer_payment_method_request + - properties: + expires_at: + example: 1553273553 + format: int64 + type: integer + title: payment_method_cash_request payment_method_spei_request: - title: payment_method_spei_request allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - type: object - properties: - expires_at: - type: integer - example: 1553273553 - format: int64 - subscription_request: - title: subscription_request - description: It is a parameter that allows to identify in the response, the detailed content of the plans to which the client has subscribed - type: object + - description: Contains details of the payment methods that the customer has + active or has used in Conekta + properties: + type: + description: Type of payment method + example: card | cash | spei | bnpl | pay_by_bank + type: string + required: + - type + title: customer_payment_method_request + - properties: + expires_at: + example: 1553273553 + format: int64 + type: integer + title: payment_method_spei_request + customer_payment_methods_request: + oneOf: + - $ref: "#/components/schemas/payment_method_token_request" + - $ref: "#/components/schemas/payment_method_cash_request" + - $ref: "#/components/schemas/payment_method_spei_request" + title: customer_payment_methods_request + customer_shipping_contacts_request: + description: |- + [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) + details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. + properties: + phone: + description: Phone contact + example: "+525511223344" + type: string + receiver: + description: Name of the person who will receive the order + example: Marvin Fuller + type: string + between_streets: + description: The street names between which the order will be delivered. + Must contain at least two consecutive ASCII letters. + example: Ackerman Crescent + maxLength: 249 + pattern: "[A-Za-z]{2}" + type: string + address: + $ref: "#/components/schemas/customer_shipping_contacts_request_address" + parent_id: + type: string + default: + nullable: true + type: boolean + deleted: + nullable: true + type: boolean + metadata: + additionalProperties: true + description: Metadata associated with the shipping contact + maxProperties: 100 + type: object required: - - plan_id + - address + title: customer_shipping_contacts_request + subscription_request: + description: "It is a parameter that allows to identify in the response, the\ + \ detailed content of the plans to which the client has subscribed" properties: plan_id: - type: string example: f84gdgf5g48r15fd21g8w424fd1 - card_id: type: string + card_id: example: src_2qUCNd5AyQqfPMBuV + type: string trial_end: - type: integer example: 1484040996 + type: integer + required: + - plan_id + title: subscription_request customer: - title: customer description: a customer - type: object - required: - - name - - email - - phone properties: antifraud_info: - type: - - object - - 'null' - properties: - account_created_at: - type: integer - example: 1484040996 - format: int64 - first_paid_at: - type: integer - format: int64 - example: 1485151007 + $ref: "#/components/schemas/customer_antifraud_info" corporate: - type: boolean - description: It is a value that allows identifying if the email is corporate or not. - example: false default: false + description: It is a value that allows identifying if the email is corporate + or not. + example: false + type: boolean custom_reference: - type: string description: It is an undefined value. - date_of_birth: type: string - description: It is a parameter that allows to identify the date of birth of the client. + date_of_birth: + description: It is a parameter that allows to identify the date of birth + of the client. example: 24/07/1992 - email: type: string - description: An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). + email: + description: "An email address is a series of customizable characters followed\ + \ by a universal Internet symbol, the at symbol (@), the name of a host\ + \ server, and a web domain ending (.mx, .com, .org, . net, etc)." example: miguel@gmail.com format: email - default_payment_source_id: type: string - description: It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) + default_payment_source_id: + description: "It is a parameter that allows to identify in the response,\ + \ the Conekta ID of a payment method (payment_id)" example: src_1a2b3c4d5e6f7g8h - default_shipping_contact_id: type: string - description: It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) + default_shipping_contact_id: + description: "It is a parameter that allows to identify in the response,\ + \ the Conekta ID of the shipping address (shipping_contact)" example: ship_cont_1a2b3c4d5e6f7g8h + type: string fiscal_entities: - type: array items: - $ref: '#/components/schemas/customer_fiscal_entities_request' + $ref: "#/components/schemas/fiscal_entity_request" + type: array + default: null metadata: - type: object additionalProperties: true maxProperties: 100 + type: object name: - type: string description: Client's name example: miguel - national_id: type: string - description: It is a parameter that allows to identify the national identification number of the client. + national_id: + description: It is a parameter that allows to identify the national identification + number of the client. example: HEGG560427MVZRRL04 + type: string payment_sources: - description: Contains details of the payment methods that the customer has active or has used in Conekta - type: array + description: Contains details of the payment methods that the customer has + active or has used in Conekta items: - title: customer_payment_methods_request - oneOf: - - $ref: '#/components/schemas/payment_method_token_request' - - $ref: '#/components/schemas/payment_method_cash_request' - - $ref: '#/components/schemas/payment_method_spei_request' + $ref: "#/components/schemas/customer_payment_methods_request" + type: array + default: null phone: - type: string description: Is the customer's phone number - example: '+5215555555555' - plan_id: + example: "+5215555555555" type: string + plan_id: + description: "Contains the ID of a plan, which could together with name,\ + \ email and phone create a client directly to a subscription" example: plan_987234823 - description: Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription + type: string shipping_contacts: - description: Contains the detail of the shipping addresses that the client has active or has used in Conekta - type: array + description: Contains the detail of the shipping addresses that the client + has active or has used in Conekta items: - $ref: '#/components/schemas/customer_shipping_contacts' + $ref: "#/components/schemas/customer_shipping_contacts_request" + type: array + default: null subscription: - description: It is a parameter that allows to identify in the response, the detailed content of the plans to which the client has subscribed - $ref: '#/components/schemas/subscription_request' + $ref: "#/components/schemas/subscription_request" + required: + - email + - name + - phone + title: customer + update_customer_antifraud_info: + properties: + account_created_at: + example: 1484040996 + format: int64 + type: integer + first_paid_at: + example: 1485151007 + type: integer update_customer: - title: update_customer description: update customer - type: object properties: antifraud_info: - type: - - object - - 'null' - properties: - account_created_at: - type: integer - example: 1484040996 - format: int64 - first_paid_at: - type: integer - example: 1485151007 + $ref: "#/components/schemas/update_customer_antifraud_info" date_of_birth: - type: string - description: It is a parameter that allows to identify the date of birth of the client. + description: It is a parameter that allows to identify the date of birth + of the client. example: 24/07/1992 - default_payment_source_id: type: string - description: It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) + default_payment_source_id: + description: "It is a parameter that allows to identify in the response,\ + \ the Conekta ID of a payment method (payment_id)" example: src_1a2b3c4d5e6f7g8h - email: type: string - description: An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). + email: + description: "An email address is a series of customizable characters followed\ + \ by a universal Internet symbol, the at symbol (@), the name of a host\ + \ server, and a web domain ending (.mx, .com, .org, . net, etc)." example: miguel@gmail.com - name: type: string + name: description: Client's name example: miguel - phone: type: string + phone: description: Is the customer's phone number - example: '+5215555555555' - plan_id: + example: "+5215555555555" type: string + plan_id: + description: "Contains the ID of a plan, which could together with name,\ + \ email and phone create a client directly to a subscription" example: plan_987234823 - description: Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription - default_shipping_contact_id: type: string - description: It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) + default_shipping_contact_id: + description: "It is a parameter that allows to identify in the response,\ + \ the Conekta ID of the shipping address (shipping_contact)" example: ship_cont_1a2b3c4d5e6f7g8h + type: string corporate: - type: boolean - description: It is a value that allows identifying if the email is corporate or not. - example: false default: false + description: It is a value that allows identifying if the email is corporate + or not. + example: false + type: boolean custom_reference: - type: string description: It is an undefined value. + type: string fiscal_entities: - type: array items: - $ref: '#/components/schemas/customer_fiscal_entities_request' + $ref: "#/components/schemas/fiscal_entity_request" + type: array + default: null metadata: - type: object additionalProperties: true maxProperties: 100 + type: object national_id: - type: string - description: It is a parameter that allows to identify the national identification number of the client. + description: It is a parameter that allows to identify the national identification + number of the client. example: HEGG560427MVZRRL04 + type: string payment_sources: - description: Contains details of the payment methods that the customer has active or has used in Conekta - type: array + description: Contains details of the payment methods that the customer has + active or has used in Conekta items: - title: customer_payment_methods_request - oneOf: - - $ref: '#/components/schemas/payment_method_token_request' - - $ref: '#/components/schemas/payment_method_cash_request' - - $ref: '#/components/schemas/payment_method_spei_request' - shipping_contacts: - description: Contains the detail of the shipping addresses that the client has active or has used in Conekta + $ref: "#/components/schemas/customer_payment_methods_request" type: array + default: null + shipping_contacts: + description: Contains the detail of the shipping addresses that the client + has active or has used in Conekta items: - $ref: '#/components/schemas/customer_shipping_contacts' + $ref: "#/components/schemas/customer_shipping_contacts_request" + type: array + default: null subscription: - description: It is a parameter that allows to identify in the response, the detailed content of the plans to which the client has subscribed - $ref: '#/components/schemas/subscription_request' - customer_update_fiscal_entities_request: - title: update_fiscal_entity_request + $ref: "#/components/schemas/subscription_request" + title: update_customer + create_customer_fiscal_entities_response: + allOf: + - properties: + address: + $ref: "#/components/schemas/fiscal_entity_request_address" + tax_id: + type: string + email: + type: string + phone: + type: string + metadata: + additionalProperties: + type: object + company_name: + example: conekta + type: string + required: + - address + title: fiscal_entity_request + - properties: + id: + example: ship_cont_2tKZsTYcsryyu7Ah8 + type: string + object: + example: shipping_contact + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + parent_id: + example: cus_2tKcHxhTz7xU5SymF + type: string + default: + type: boolean + required: + - created_at + - id + - object + title: create_customer_fiscal_entities_response + update_fiscal_entity_request: properties: address: - allOf: - - $ref: '#/components/schemas/customer_address' + $ref: "#/components/schemas/fiscal_entity_request_address" tax_id: type: string email: @@ -7271,371 +18255,498 @@ components: phone: type: string metadata: - type: object additionalProperties: type: object company_name: - type: string example: conekta - order_discount_lines_request: - title: order_discount_lines_request - name: order_discount_lines_request - description: List of discounts that apply to the order. - required: + type: string + title: update_fiscal_entity_request + update_customer_fiscal_entities_response: + allOf: + - properties: + address: + $ref: "#/components/schemas/fiscal_entity_request_address" + tax_id: + type: string + email: + type: string + phone: + type: string + metadata: + additionalProperties: + type: object + company_name: + example: conekta + type: string + required: + - address + title: fiscal_entity_request + - properties: + id: + example: fis_ent_2tKZsTYcsryyu7Ah8 + type: string + object: + example: fiscal_entities + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + parent_id: + example: cus_2tKcHxhTz7xU5SymF + type: string + default: + type: boolean + required: + - created_at + - id + - object + title: update_customer_fiscal_entities_response + discount_lines_response: + allOf: + - description: List of discounts that apply to the order. + properties: + amount: + description: "The amount to be deducted from the total sum of all payments,\ + \ in cents." + example: 500 + format: int64 + minimum: 0 + type: integer + code: + description: Discount code. + example: "123" + type: string + type: + description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" + example: loyalty + type: string + required: - amount - code - type + title: order_discount_lines_request + name: order_discount_lines_request + - properties: + id: + description: The discount line id + example: dis_lin_2tQQ58HPgPw7StE8z + type: string + object: + description: The object name + example: discount_line + type: string + parent_id: + description: The order id + example: ord_2tPAmKCEJqh8RE6nY + type: string + required: + - id + - object + - parent_id + title: discount_lines_response + get_order_discount_lines_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/discount_lines_response" + type: array + default: null + title: get_order_discount_lines_response + order_discount_lines_request: + description: List of discounts that apply to the order. properties: amount: - type: integer - format: int64 + description: "The amount to be deducted from the total sum of all payments,\ + \ in cents." example: 500 + format: int64 minimum: 0 - description: The amount to be deducted from the total sum of all payments, in cents. + type: integer code: - type: string description: Discount code. - example: '123' - type: + example: "123" type: string + type: + description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" example: loyalty - description: It can be 'loyalty', 'campaign', 'coupon' o 'sign' - discount_lines_response: - title: discount_lines_response - allOf: - - $ref: '#/components/schemas/order_discount_lines_request' - - type: object - required: - - id - - object - - parent_id - properties: - id: - type: string - example: dis_lin_2tQQ58HPgPw7StE8z - description: The discount line id - object: - type: string - example: discount_line - description: The object name - parent_id: - type: string - example: ord_2tPAmKCEJqh8RE6nY - description: The order id + type: string + required: + - amount + - code + - type + title: order_discount_lines_request + name: order_discount_lines_request update_order_discount_lines_request: - title: update_order_discount_lines_request description: List of discounts that apply to the order. properties: amount: - type: integer - format: int64 example: 500 + format: int64 minimum: 0 + type: integer code: - type: string description: Discount code. - example: '123' - type: + example: "123" type: string + type: example: loyalty + type: string + title: update_order_discount_lines_request + WebhookLog: + properties: + failed_attempts: + example: 10 + type: integer + id: + example: webhl_2svd2sh6GbqzyWBNZ + type: string + last_attempted_at: + example: 1669651274 + type: integer + last_http_response_status: + example: 200 + format: int32 + type: integer + object: + example: webhook_log + type: string + response_data: + additionalProperties: true + example: + amount: 3000 + payable: true + maxProperties: 100 + type: object + url: + example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval + format: uri + type: string + title: WebhookLog event_response: - title: event_response description: event model - type: object properties: created_at: - type: integer - format: int64 example: 1661445644 + format: int64 + type: integer data: additionalProperties: true - maxProperties: 100 - type: object example: action: ping livemode: true + maxProperties: 100 + type: object id: - type: string example: 6307a60c41de27127515a575 + type: string livemode: - type: boolean example: true + type: boolean object: - type: string example: event - type: type: string + type: example: webhook_ping + type: string webhook_logs: - type: array items: - type: object - title: WebhookLog - properties: - failed_attempts: - type: integer - example: 10 - id: - type: string - example: webhl_2svd2sh6GbqzyWBNZ - last_attempted_at: - type: integer - example: 1669651274 - last_http_response_status: - type: integer - format: int32 - example: 200 - object: - type: string - example: webhook_log - response_data: - additionalProperties: true - maxProperties: 100 - type: object - example: - amount: 3000 - payable: true - url: - type: string - example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval - format: uri + $ref: "#/components/schemas/WebhookLog" + type: array + default: null webhook_status: - type: string example: successful - resend_request: - type: object - required: - - webhooks_ids + type: string + title: event_response + get_events_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/event_response" + type: array + default: null + title: get_events_response + resendEvent_request: properties: webhooks_ids: - type: array + description: webhooks ids to resend event + example: + - 6307a60c41de27127515a575 + - 6307a60c41de27127515a571 items: type: string - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - description: webhooks ids to resend event + type: array + default: null + required: + - webhooks_ids events_resend_response: - title: events_resend_response description: event model - type: object properties: failed_attempts: - type: integer example: 6 + type: integer id: - type: string example: webhl_2svd2sh6GbqzyWBNZ + type: string last_attempted_at: - type: integer example: 1684265970 - last_http_response_status: type: integer - format: int32 + last_http_response_status: example: 405 + format: int32 + type: integer response_data: additionalProperties: true + example: {} maxProperties: 100 type: object - example: {} url: - type: string example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval format: uri - logs_response: - title: logs_response_for_request + type: string + title: events_resend_response + logs_response_data: + properties: + created_at: + example: 1661445644 + format: int64 + type: integer + id: + example: 6307a60c41de27127515a575 + type: string + ip_address: + example: 54.235.131.48 + format: ipv4 + type: string + livemode: + example: true + type: boolean + loggable_id: + example: ord_87632467832 + nullable: true + type: string + loggable_type: + example: order + nullable: true + type: string + method: + example: POST + type: string + oauth_token_id: + nullable: true + type: string + query_string: + additionalProperties: true + example: + amount: 3000 + payable: true + type: object + related: + example: FilterResource + type: string + request_body: + example: + filters: + amount: + amount_from: 0 + amount_to: 0 + created_at: + date_from: 1653627600 + date_to: 1661489999 + filterName: Payments + sort_by: created_at + sort_direction: desc + status: [] + type: [] + id: 78e65162-0f37-4942-847c-9bf7081d54c2 + page: "0" + report_type: charges + testMode: false + type: object + request_headers: + additionalProperties: + type: string + example: + Accept: application/vnd.conekta-v2.3.0+json + Accept-Encoding: "gzip, deflate, br" + Accept-Language: "es-419, es; q=0.9, en; q=0.8" + Activitypermission: orders:read + Apiversion: 2.3.0 + response_body: + type: object + response_headers: + additionalProperties: + type: string + example: + Access-Control-Allow-Headers: "Content-Type, Depth, User-Agent, X-File-Size,\ + \ X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version,\ + \ Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection,\ + \ X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding,\ + \ Accept-Language, Referer, Origin, Activitypermission, Apiversion,\ + \ Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform,\ + \ Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id,\ + \ X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host,\ + \ X-Forwarded-Server, X-Real-Ip" + Access-Control-Allow-Methods: "POST, GET, PUT, OPTIONS" + Access-Control-Allow-Origin: '*' + Access-Control-Max-Age: "1728000" + Conekta-Media-Type: conekta-v2.3.0; format=application/json + Content-Type: application/json; charset=utf-8 + Referrer-Policy: strict-origin-when-cross-origin + Strict-Transport-Security: max-age=31536000; includeSubDomains + X-Content-Type-Options: nosniff + X-Download-Options: noopen + X-Frame-Options: SAMEORIGIN + X-Permitted-Cross-Domain-Policies: none + X-XSS-Protection: 1; mode=block + searchable_tags: + example: + - 6307a60c41de27127515a575 + - 6307a60c41de27127515a571 + items: + type: string + type: array + default: null + status: + example: 200 + type: string + updated_at: + example: 2022-08-25T16:40:44.887Z + type: string + url: + example: /filter_resource + type: string + user_account_id: + example: 5a0b7001edbb6e1725b0b2c6 + type: string + version: + example: 2.3.0 + type: string + title: logs_response_data + logs_response_for_request: description: logs model - type: object properties: has_more: - description: True, if there are more pages. - type: boolean + description: "True, if there are more pages." readOnly: true + type: boolean object: description: The object type - type: string readOnly: true + type: string next_page_url: description: URL of the next page. - type: - - string - - 'null' + nullable: true + type: string previous_page_url: description: Url of the previous page. - type: - - string - - 'null' + nullable: true + type: string data: description: set to page results. - type: - - array - - 'null' items: - title: logs_response_data - properties: - created_at: - type: integer - format: int64 - example: 1661445644 - id: - type: string - example: 6307a60c41de27127515a575 - ip_address: - type: string - format: ipv4 - example: 54.235.131.48 - livemode: - type: boolean - example: true - loggable_id: - type: - - string - - 'null' - example: ord_87632467832 - loggable_type: - type: - - string - - 'null' - example: order - method: - type: string - example: POST - oauth_token_id: - type: - - string - - 'null' - query_string: - type: object - additionalProperties: true - example: - amount: 3000 - payable: true - related: - type: string - example: FilterResource - request_body: - type: object - example: - filters: - amount: - amount_from: 0 - amount_to: 0 - created_at: - date_from: 1653627600 - date_to: 1661489999 - filterName: Payments - search_term: null - sort_by: created_at - sort_direction: desc - status: [] - type: [] - id: 78e65162-0f37-4942-847c-9bf7081d54c2 - page: '0' - report_type: charges - testMode: false - request_headers: - type: object - additionalProperties: - type: string - example: - Accept: application/vnd.conekta-v2.3.0+json - Accept-Encoding: gzip, deflate, br - Accept-Language: es-419, es; q=0.9, en; q=0.8 - Activitypermission: orders:read - Apiversion: 2.3.0 - response_body: - type: object - response_headers: - type: object - additionalProperties: - type: string - example: - Access-Control-Allow-Headers: Content-Type, Depth, User-Agent, X-File-Size, X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version, Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection, X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding, Accept-Language, Referer, Origin, Activitypermission, Apiversion, Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform, Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id, X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host, X-Forwarded-Server, X-Real-Ip - Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS - Access-Control-Allow-Origin: '*' - Access-Control-Max-Age: '1728000' - Conekta-Media-Type: conekta-v2.3.0; format=application/json - Content-Type: application/json; charset=utf-8 - Referrer-Policy: strict-origin-when-cross-origin - Strict-Transport-Security: max-age=31536000; includeSubDomains - X-Content-Type-Options: nosniff - X-Download-Options: noopen - X-Frame-Options: SAMEORIGIN - X-Permitted-Cross-Domain-Policies: none - X-XSS-Protection: 1; mode=block - searchable_tags: - type: array - items: - type: string - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - status: - type: string - example: 200 - updated_at: - type: string - example: '2022-08-25T16:40:44.887Z' - url: - type: string - example: /filter_resource - user_account_id: - type: string - example: 5a0b7001edbb6e1725b0b2c6 - version: - type: string - example: 2.3.0 - log_response: - title: log_response_for_request + $ref: "#/components/schemas/logs_response_data" + nullable: true + type: array + default: null + title: logs_response_for_request + log_response_for_request: description: log model - type: object - required: - - created_at - - id - - livemode properties: created_at: - type: integer - format: int64 example: 1661445644 + format: int64 + type: integer id: - type: string example: 6307a60c41de27127515a575 - ip_address: type: string - format: ipv4 + ip_address: example: 54.235.131.48 + format: ipv4 + type: string livemode: - type: boolean example: true + type: boolean loggable_id: - type: - - string - - 'null' example: ord_87632467832 + nullable: true + type: string loggable_type: - type: - - string - - 'null' example: order - method: + nullable: true type: string + method: example: POST + type: string oauth_token_id: - type: - - string - - 'null' + nullable: true + type: string query_string: - type: object additionalProperties: true example: amount: 3000 payable: true + type: object related: - type: string example: FilterResource + type: string request_body: - type: object example: filters: amount: @@ -7645,36 +18756,42 @@ components: date_from: 1653627600 date_to: 1661489999 filterName: Payments - search_term: null sort_by: created_at sort_direction: desc status: [] type: [] id: 78e65162-0f37-4942-847c-9bf7081d54c2 - page: '0' + page: "0" report_type: charges testMode: false - request_headers: type: object + request_headers: additionalProperties: type: string example: Accept: application/vnd.conekta-v2.3.0+json - Accept-Encoding: gzip, deflate, br - Accept-Language: es-419, es; q=0.9, en; q=0.8 + Accept-Encoding: "gzip, deflate, br" + Accept-Language: "es-419, es; q=0.9, en; q=0.8" Activitypermission: orders:read Apiversion: 2.3.0 response_body: type: object response_headers: - type: object additionalProperties: type: string example: - Access-Control-Allow-Headers: Content-Type, Depth, User-Agent, X-File-Size, X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version, Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection, X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding, Accept-Language, Referer, Origin, Activitypermission, Apiversion, Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform, Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id, X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host, X-Forwarded-Server, X-Real-Ip - Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS + Access-Control-Allow-Headers: "Content-Type, Depth, User-Agent, X-File-Size,\ + \ X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, X-Prototype-Version,\ + \ Authorization, Accept, Date, Version, X-Forwarded-For, Host, Connection,\ + \ X-Forwarded-Proto, X-Forwarded-Port, X-Amzn-Trace-Id, Accept-Encoding,\ + \ Accept-Language, Referer, Origin, Activitypermission, Apiversion,\ + \ Entityid, Livemode, Sec-Ch-Ua, Sec-Ch-Ua-Mobile, Sec-Ch-Ua-Platform,\ + \ Sec-Fetch-Dest, Sec-Fetch-Mode, Sec-Fetch-Site, X-Datadog-Parent-Id,\ + \ X-Datadog-Sampling-Priority, X-Datadog-Trace-Id, X-Forwarded-Host,\ + \ X-Forwarded-Server, X-Real-Ip" + Access-Control-Allow-Methods: "POST, GET, PUT, OPTIONS" Access-Control-Allow-Origin: '*' - Access-Control-Max-Age: '1728000' + Access-Control-Max-Age: "1728000" Conekta-Media-Type: conekta-v2.3.0; format=application/json Content-Type: application/json; charset=utf-8 Referrer-Policy: strict-origin-when-cross-origin @@ -7685,786 +18802,1065 @@ components: X-Permitted-Cross-Domain-Policies: none X-XSS-Protection: 1; mode=block searchable_tags: - type: array + example: + - 6307a60c41de27127515a575 + - 6307a60c41de27127515a571 items: type: string - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 + type: array + default: null status: - type: string example: 200 + type: string updated_at: + example: 2022-08-25T16:40:44.887Z type: string - example: '2022-08-25T16:40:44.887Z' url: - type: string example: /filter_resource - user_account_id: type: string + user_account_id: example: 5a0b7001edbb6e1725b0b2c6 - version: type: string + version: example: 2.3.0 - order_customer_info_response: - title: order_customer_info_response - type: object - properties: - customer_custom_reference: - type: - - string - - 'null' - example: custom_reference - description: Custom reference - name: type: string - example: DevTest - email: + required: + - created_at + - id + - livemode + title: log_response_for_request + order_channel_response: + properties: + segment: + example: Checkout type: string - format: email - example: test@conekta.com - phone: + checkout_request_id: + example: 6fca054a-8519-4c43-971e-cea35cc519bb type: string - example: '5522997233' - corporate: - default: false - type: boolean - object: + checkout_request_type: + example: HostedPayment type: string - example: customer_info - customer_info_just_customer_id_response: - title: customer_info_response - type: object - properties: - customer_id: + id: + example: channel_2tNDzhA4Akmzj11AU type: string - example: cus_23874283647 - order_tax_request: - title: order_tax_request - description: create new taxes for an existing order - type: object - required: + title: order_channel_response + charges_data_response: + allOf: + - properties: + amount: + example: 4321 + type: integer + channel: + $ref: "#/components/schemas/charge_response_channel" + created_at: + example: 1676386026 + format: int64 + type: integer + currency: + example: MXN + type: string + customer_id: + type: string + description: + example: Payment from order + type: string + device_fingerprint: + example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba + type: string + failure_code: + example: suspected_fraud + type: string + failure_message: + example: Este cargo ha sido declinado porque el comportamiento del comprador + es sospechoso. + type: string + id: + description: Charge ID + example: 63efa757cf65380001aec040 + type: string + livemode: + description: Whether the charge was made in live mode or not + example: false + type: boolean + object: + example: charge + type: string + order_id: + description: Order ID + example: ord_2tN73UdUSNrYRPD9r + type: string + paid_at: + description: charge Payment date + example: 1676390742 + format: int64 + nullable: true + type: integer + payment_method: + $ref: "#/components/schemas/charge_response_payment_method" + reference_id: + description: Reference ID of the charge + example: ref_2tN73UdUSNrYRPD9r + nullable: true + type: string + refunds: + $ref: "#/components/schemas/charge_response_refunds" + chargeback: + $ref: "#/components/schemas/chargeback_response" + status: + description: Charge status + example: pending_payment + type: string + required: - amount - - description + - created_at + - currency + - id + - livemode + - object + - order_id + - status + title: charge_response + title: charges_data_response + order_charges_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/charges_data_response" + type: array + default: null + description: The charges associated with the order + title: order_charges_response + order_response_checkout: properties: - amount: + allowed_payment_methods: + description: Are the payment methods available for this link + example: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + - apple + - google + items: + type: string + type: array + default: null + excluded_payment_methods: + description: Payment methods excluded from the checkout. This field is only + returned when excluded_payment_methods is provided in the request. + example: + - cash + - bank_transfer + items: + enum: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + type: string + title: order_response_excluded_payment_methods + type: array + default: null + can_not_expire: + example: false + type: boolean + emails_sent: + example: 0 type: integer - example: '100' + exclude_card_networks: + example: + - visa + - amex + items: + enum: + - visa + - mastercard + - amex + type: string + title: order_response_exclude_card_networks + type: array + default: null + expires_at: + example: 1676613599 format: int64 - minimum: 0 - description: The amount to be collected for tax in cents - description: + type: integer + failure_url: + example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx type: string - example: testing - minLength: 3 - description: description or tax's name + force_3ds_flow: + example: false + type: boolean + force_save_card: + description: Indicates whether the card used for the payment should be saved + for future purchases. This field is only applicable for card payments. + example: false + nullable: true + type: boolean + id: + example: 6fca054a-8519-4c43-971e-cea35cc519bb + type: string + is_redirect_on_failure: + example: false + type: boolean + livemode: + example: false + type: boolean + max_failed_retries: + description: Number of retries allowed before the checkout is marked as + failed + example: 3 + format: int8 + nullable: true + type: integer metadata: - type: object - additionalProperties: - anyOf: - - type: string - maxLength: 249 - - type: integer - - type: number - - type: boolean - example: - key: value + additionalProperties: true maxProperties: 100 - update_order_tax_response: - title: order_tax_response - description: create new taxes for an existing order response + type: object + monthly_installments_enabled: + example: false + type: boolean + monthly_installments_options: + items: + format: int8 + type: integer + type: array + default: null + name: + example: ord-2tNDzhA4Akmzj11AS + type: string + needs_shipping_contact: + example: false + type: boolean + object: + example: checkout + type: string + on_demand_enabled: + example: true + nullable: true + type: boolean + paid_payments_count: + example: 0 + type: integer + recurrent: + example: false + type: boolean + redirection_time: + description: number of seconds to wait before redirecting to the success_url + example: 2 + format: int8 + nullable: true + type: integer + slug: + example: 6fca054a85194c43971ecea35cc519bb + type: string + sms_sent: + example: 0 + type: integer + success_url: + description: "Redirection url back to the site in case of successful payment,\ + \ applies only to HostedPayment" + example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx + format: uri + type: string + starts_at: + example: 1676354400 + type: integer + status: + example: Issued + type: string + type: + description: "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." + example: HostedPayment + type: string + url: + description: "Indicate the url of the Conekta component to complete the\ + \ payment. For HostedPayment, this will be a Conekta-hosted page" + example: https://pay.conekta.io/checkout/6fca054a85194c43971ecea35cc519bb + format: uri + type: string required: - - id + - id + - livemode + - name + - object + - type + order_response_customer_info: + allOf: + - properties: + object: + example: customer_info + type: string + - properties: + customer_custom_reference: + description: Custom reference + example: custom_reference + nullable: true + type: string + name: + example: DevTest + type: string + email: + example: test@conekta.com + format: email + type: string + phone: + example: "5522997233" + type: string + corporate: + default: false + type: boolean + object: + example: customer_info + type: string + title: order_customer_info_response + - properties: + customer_id: + example: cus_23874283647 + type: string + title: customer_info_response + discount_lines_data_response: + allOf: + - allOf: + - description: List of discounts that apply to the order. + properties: + amount: + description: "The amount to be deducted from the total sum of all payments,\ + \ in cents." + example: 500 + format: int64 + minimum: 0 + type: integer + code: + description: Discount code. + example: "123" + type: string + type: + description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" + example: loyalty + type: string + required: + - amount + - code + - type + title: order_discount_lines_request + name: order_discount_lines_request + - properties: + id: + description: The discount line id + example: dis_lin_2tQQ58HPgPw7StE8z + type: string + object: + description: The object name + example: discount_line + type: string + parent_id: + description: The order id + example: ord_2tPAmKCEJqh8RE6nY + type: string + required: + - id + - object + - parent_id + title: discount_lines_response + title: discount_lines_data_response + order_response_discount_lines: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/discount_lines_data_response" + type: array + default: null + description: List of discounts that are applied to the order + nullable: true + order_tax_request_metadata_value: + anyOf: + - maxLength: 249 + type: string + - type: integer + - type: number + - type: boolean + tax_lines_data_response: allOf: - - $ref: '#/components/schemas/order_tax_request' - - type: object + - allOf: + - description: create new taxes for an existing order properties: + amount: + description: The amount to be collected for tax in cents + example: 100 + format: int64 + minimum: 0 + type: integer + description: + description: description or tax's name + example: testing + minLength: 3 + type: string + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + example: + key: value + maxProperties: 100 + required: + - amount + - description + title: order_tax_request + - properties: id: + example: tax_lin_2tQ8dC5mg1UADmVPo + type: string + object: + example: tax_line + type: string + parent_id: + example: ord_2tPAmKCEJqh8RE6nY + type: string + description: create new taxes for an existing order response + required: + - id + title: order_tax_response + title: tax_lines_data_response + order_response_tax_lines: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/tax_lines_data_response" + type: array + default: null + description: List of taxes that are applied to the order + nullable: true + shipping_lines_data_response: + allOf: + - allOf: + - properties: + amount: + description: Shipping amount in cents + example: 100 + format: int64 + minimum: 0 + type: integer + carrier: + description: Carrier name for the shipment + example: FEDEX + maxLength: 249 + minLength: 3 type: string - example: tax_lin_2tQ8dC5mg1UADmVPo - object: + tracking_number: + description: Tracking number can be used to track the shipment + example: TRACK123 + maxLength: 249 + minLength: 3 type: string - example: tax_line - parent_id: + method: + description: Method of shipment + example: Same day + maxLength: 249 + minLength: 3 type: string - example: ord_2tPAmKCEJqh8RE6nY - shipping_request: - title: shipping_request - required: - - amount - properties: - amount: - type: integer - format: int64 - example: 100 - minimum: 0 - description: Shipping amount in cents - carrier: - type: string - minLength: 3 - maxLength: 249 - example: FEDEX - description: Carrier name for the shipment - tracking_number: - type: string - minLength: 3 - maxLength: 249 - example: TRACK123 - description: Tracking number can be used to track the shipment - method: - type: string - minLength: 3 - maxLength: 249 - example: Same day - description: Method of shipment - metadata: - description: 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. - type: object - additionalProperties: - anyOf: - - type: string - maxLength: 249 - - type: integer - - type: number - - type: boolean - example: - key: value - maxProperties: 100 - shipping_order_response: - title: shipping_order_response - allOf: - - $ref: '#/components/schemas/shipping_request' - - type: object - properties: + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "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." + example: + key: value + maxProperties: 100 + required: + - amount + title: shipping_request + - properties: id: type: string object: type: string parent_id: type: string - fiscal_entity_address: - title: fiscal_entity_address - required: - - street1 + title: shipping_order_response + title: shipping_lines_data_response + order_response_shipping_lines: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/shipping_lines_data_response" + type: array + default: null + description: List of shipping costs applied to the order + nullable: true + order_fiscal_entity_address_response: + allOf: + - description: Address of the fiscal entity + properties: + street1: + description: Street name and number + example: Nuevo Leon 254 + type: string + street2: + description: Street name and number + example: Departamento 404 + nullable: true + type: string + postal_code: + description: Postal code + example: "06100" + type: string + city: + description: City + example: Ciudad de Mexico + type: string + state: + description: State + example: Ciudad de Mexico + type: string + country: + description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" + example: MX + type: string + external_number: + description: External number + example: "123" + type: string + required: - city - country - - postal_code - external_number - type: object + - postal_code + - street1 + title: fiscal_entity_address + - properties: + object: + example: fiscal_entity_address + type: string description: Address of the fiscal entity + title: order_fiscal_entity_address_response + order_fiscal_entity_response: + description: "Fiscal entity of the order, Currently it is a purely informative\ + \ field" properties: - street1: + address: + $ref: "#/components/schemas/order_fiscal_entity_address_response" + email: + description: Email of the fiscal entity + example: test@gmail.com + nullable: true type: string - example: Nuevo Leon 254 - description: Street name and number - street2: - type: - - string - - 'null' - example: Departamento 404 - description: Street name and number - postal_code: + metadata: + additionalProperties: true + description: Metadata associated with the fiscal entity + maxProperties: 100 + type: object + name: + description: Name of the fiscal entity + example: Conekta Inc + nullable: true type: string - example: '06100' - description: Postal code - city: + tax_id: + description: Tax ID of the fiscal entity + example: "324234234" + nullable: true type: string - example: Ciudad de Mexico - description: City - state: + id: + description: ID of the fiscal entity + example: fis_ent_2tN85VYaSMyDvjB3M type: string - example: Ciudad de Mexico - description: State - country: + created_at: + description: The time at which the object was created in seconds since the + Unix epoch + example: 1676328434 + format: int64 + type: integer + object: + example: fiscal_entity type: string - example: MX - description: this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - external_number: + phone: + description: Phone of the fiscal entity + example: "+525511223344" + nullable: true type: string - example: '123' - description: External number - product: - type: object - title: product required: + - address + - created_at + - id + - object + title: order_fiscal_entity_response + product_data_response: + allOf: + - properties: + antifraud_info: + additionalProperties: true + example: + key: value + type: object + brand: + description: The brand of the item. + example: Cohiba + maxLength: 249 + minLength: 2 + type: string + description: + description: Short description of the item + example: Imported From Mex. + maxLength: 249 + minLength: 3 + type: string + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + default: {} + description: "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." + example: + key: value + maxProperties: 100 + name: + description: The name of the item. It will be displayed in the order. + example: Box of Cohiba S1s + maxLength: 249 + minLength: 3 + type: string + quantity: + description: The quantity of the item in the order. + example: 1 + format: int32 + minimum: 1 + type: integer + sku: + description: The stock keeping unit for the item. It is used to identify + the item in the order. + example: XYZ12345 + maxLength: 249 + minLength: 1 + type: string + tags: + description: List of tags for the item. It is used to identify the item + in the order. + example: + - food + - mexican food + items: + maxLength: 249 + minLength: 2 + type: string + minItems: 1 + type: array + default: null + unit_price: + description: The price of the item in cents. + example: 20000 + format: int32 + minimum: 0 + type: integer + required: - name - - unit_price - quantity + - unit_price + title: product + - properties: + id: + type: string + object: + type: string + parent_id: + type: string + title: product_data_response + order_response_products: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/product_data_response" + type: array + default: null + title: order_response_products + order_next_action_response_redirect_to_url: + description: contains the following attributes that will guide to continue the + flow properties: - antifraud_info: - type: object - additionalProperties: true - example: - key: value - brand: - type: string - minLength: 2 - maxLength: 249 - example: Cohiba - description: The brand of the item. - description: + url: + description: "pay.conekta.com/{id} Indicates the url of the Conekta component\ + \ to authenticate the flow through 3DS2." + example: https://pay.conekta.com/6fca054a85194c43971ecea35cc519bb + format: uri type: string - example: Imported From Mex. - minLength: 3 - maxLength: 249 - description: Short description of the item - metadata: - type: object - maxProperties: 100 - description: 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. - additionalProperties: - anyOf: - - type: string - maxLength: 249 - - type: integer - - type: number - - type: boolean - example: - key: value - default: {} - name: + return_url: + description: "Indicates the url to which the 3DS2 flow returns at the end,\ + \ when the integration is redirected." + example: https://my-website.com" + format: uri type: string - minLength: 3 - maxLength: 249 - example: Box of Cohiba S1s - description: The name of the item. It will be displayed in the order. - quantity: - type: integer - format: int32 - example: 1 - minimum: 1 - description: The quantity of the item in the order. - sku: + order_next_action_response: + description: contains the following attributes that will guide to continue the + flow + properties: + redirect_to_url: + $ref: "#/components/schemas/order_next_action_response_redirect_to_url" + type: + description: Indicates the type of action to be taken + example: redirect_to_url type: string - minLength: 1 - maxLength: 249 - example: XYZ12345 - description: The stock keeping unit for the item. It is used to identify the item in the order. - tags: - type: array - minItems: 1 - items: - type: string - minLength: 2 - maxLength: 249 - example: - - food - - mexican food - description: List of tags for the item. It is used to identify the item in the order. - unit_price: - type: integer - format: int32 - example: 20000 - minimum: 0 - description: The price of the item in cents. - customer_shipping_contacts_response: - title: customer_shipping_contacts_response - description: Contains the detail of the shipping addresses that the client has active or has used in Conekta + title: order_next_action_response + customer_shipping_contacts_address: properties: - phone: + object: + example: shipping_address type: string - example: '+525511223344' - receiver: + street1: + example: Nuevo Leon 254 type: string - example: Marvin Fuller - between_streets: - type: - - string - - 'null' - example: Ackerman Crescent - address: - title: customer_shipping_contacts_address - type: object - properties: - object: - type: string - example: shipping_address - street1: - type: string - example: Nuevo Leon 254 - street2: - type: string - example: Departamento 404 - postal_code: - type: string - example: '06100' - city: - type: string - example: Ciudad de Mexico - state: - type: string - example: Ciudad de Mexico - country: - type: string - example: MX - residential: - type: - - boolean - - 'null' - example: true - parent_id: + street2: + example: Departamento 404 type: string - default: - type: boolean - example: false - id: + postal_code: + example: "06100" type: string - example: adr_1234567890 - created_at: - type: integer - format: int64 - example: 1675715413 - metadata: - type: object - additionalProperties: true - maxProperties: 100 - description: Metadata associated with the shipping contact - object: + city: + example: Ciudad de Mexico + type: string + state: + example: Ciudad de Mexico type: string - example: shipping_contact - deleted: + country: + example: MX + type: string + residential: + example: true + nullable: true type: boolean - example: false + title: customer_shipping_contacts_address + order_response_shipping_contact: + allOf: + - properties: + created_at: + format: int64 + type: integer + id: + type: string + object: + type: string + - description: Contains the detail of the shipping addresses that the client + has active or has used in Conekta + properties: + phone: + example: "+525511223344" + type: string + receiver: + example: Marvin Fuller + type: string + between_streets: + example: Ackerman Crescent + nullable: true + type: string + address: + $ref: "#/components/schemas/customer_shipping_contacts_address" + parent_id: + type: string + default: + example: false + type: boolean + id: + example: adr_1234567890 + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + metadata: + additionalProperties: true + description: Metadata associated with the shipping contact + maxProperties: 100 + type: object + object: + example: shipping_contact + type: string + deleted: + example: false + type: boolean + title: customer_shipping_contacts_response order_response: - title: order_response description: order response properties: amount: - type: integer - example: 21605 description: The total amount to be collected in cents - amount_refunded: + example: 21605 type: integer - example: 0 + amount_refunded: description: The total amount refunded in cents + example: 0 + type: integer channel: - type: object - title: order_channel_response - properties: - segment: - type: string - example: Checkout - checkout_request_id: - type: string - example: 6fca054a-8519-4c43-971e-cea35cc519bb - checkout_request_type: - type: string - example: HostedPayment - id: - type: string - example: channel_2tNDzhA4Akmzj11AU + $ref: "#/components/schemas/order_channel_response" charges: - description: The charges associated with the order - title: order_charges_response - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - title: charges_data_response - allOf: - - $ref: '#/components/schemas/charge_response' + $ref: "#/components/schemas/order_charges_response" checkout: - type: object - required: - - id - - livemode - - name - - object - - type - properties: - allowed_payment_methods: - type: array - example: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - - apple - - google - description: Are the payment methods available for this link - items: - type: string - excluded_payment_methods: - title: order_response_excluded_payment_methods - type: array - items: - type: string - enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - example: - - cash - - bank_transfer - description: Payment methods excluded from the checkout. This field is only returned when excluded_payment_methods is provided in the request. - can_not_expire: - type: boolean - example: false - emails_sent: - type: integer - example: 0 - exclude_card_networks: - title: order_response_exclude_card_networks - type: array - items: - type: string - enum: - - visa - - mastercard - - amex - example: - - visa - - amex - expires_at: - type: integer - example: 1676613599 - format: int64 - failure_url: - type: string - example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx - force_3ds_flow: - type: boolean - example: false - force_save_card: - type: - - boolean - - 'null' - example: false - description: Indicates whether the card used for the payment should be saved for future purchases. This field is only applicable for card payments. - id: - type: string - example: 6fca054a-8519-4c43-971e-cea35cc519bb - is_redirect_on_failure: - type: boolean - example: false - livemode: - type: boolean - example: false - max_failed_retries: - type: - - integer - - 'null' - example: 3 - format: int8 - description: Number of retries allowed before the checkout is marked as failed - metadata: - additionalProperties: true - maxProperties: 100 - type: object - monthly_installments_enabled: - type: boolean - example: false - monthly_installments_options: - type: array - items: - type: integer - format: int8 - name: - type: string - example: ord-2tNDzhA4Akmzj11AS - needs_shipping_contact: - type: boolean - example: false - object: - type: string - example: checkout - on_demand_enabled: - type: - - boolean - - 'null' - example: true - paid_payments_count: - type: integer - example: 0 - recurrent: - type: boolean - example: false - redirection_time: - type: - - integer - - 'null' - example: 2 - format: int8 - description: number of seconds to wait before redirecting to the success_url - slug: - type: string - example: 6fca054a85194c43971ecea35cc519bb - sms_sent: - type: integer - example: 0 - success_url: - type: string - description: Redirection url back to the site in case of successful payment, applies only to HostedPayment - example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx - format: uri - starts_at: - type: integer - example: 1676354400 - status: - type: string - example: Issued - type: - type: string - description: 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. - example: HostedPayment - url: - type: string - description: Indicate the url of the Conekta component to complete the payment. For HostedPayment, this will be a Conekta-hosted page - example: https://pay.conekta.io/checkout/6fca054a85194c43971ecea35cc519bb - format: uri + $ref: "#/components/schemas/order_response_checkout" created_at: - type: integer + description: The time at which the object was created in seconds since the + Unix epoch example: 1676328434 format: int64 - description: The time at which the object was created in seconds since the Unix epoch + type: integer currency: - type: string + description: The three-letter ISO 4217 currency code. The currency of the + order. example: MXN - description: The three-letter ISO 4217 currency code. The currency of the order. + type: string customer_info: - allOf: - - type: object - properties: - object: - type: string - example: customer_info - - $ref: '#/components/schemas/order_customer_info_response' - - $ref: '#/components/schemas/customer_info_just_customer_id_response' + $ref: "#/components/schemas/order_response_customer_info" discount_lines: - description: List of discounts that are applied to the order - title: order_discount_lines_response - anyOf: - - type: 'null' - - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - title: discount_lines_data_response - allOf: - - $ref: '#/components/schemas/discount_lines_response' + $ref: "#/components/schemas/order_response_discount_lines" tax_lines: - description: List of taxes that are applied to the order - title: order_tax_lines_response - anyOf: - - type: 'null' - - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - title: tax_lines_data_response - allOf: - - $ref: '#/components/schemas/update_order_tax_response' + $ref: "#/components/schemas/order_response_tax_lines" shipping_lines: - description: List of shipping costs applied to the order - title: order_shipping_lines_response - anyOf: - - type: 'null' - - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - title: shipping_lines_data_response - allOf: - - $ref: '#/components/schemas/shipping_order_response' + $ref: "#/components/schemas/order_response_shipping_lines" fiscal_entity: - type: - - object - - 'null' - title: order_fiscal_entity_response - description: Fiscal entity of the order, Currently it is a purely informative field - required: - - address - - id - - object - - created_at - properties: - address: - title: order_fiscal_entity_address_response - description: Address of the fiscal entity - allOf: - - $ref: '#/components/schemas/fiscal_entity_address' - - type: object - properties: - object: - type: string - example: fiscal_entity_address - email: - type: - - string - - 'null' - example: test@gmail.com - description: Email of the fiscal entity - metadata: - type: object - additionalProperties: true - maxProperties: 100 - description: Metadata associated with the fiscal entity - name: - type: - - string - - 'null' - example: Conekta Inc - description: Name of the fiscal entity - tax_id: - type: - - string - - 'null' - example: '324234234' - description: Tax ID of the fiscal entity - id: - type: string - example: fis_ent_2tN85VYaSMyDvjB3M - description: ID of the fiscal entity - created_at: - type: integer - format: int64 - example: 1676328434 - description: The time at which the object was created in seconds since the Unix epoch - object: - type: string - example: fiscal_entity - phone: - type: - - string - - 'null' - example: '+525511223344' - description: Phone of the fiscal entity + $ref: "#/components/schemas/order_fiscal_entity_response" id: - type: string example: ord_2tMtQQpDvfnNjiuFG + type: string is_refundable: - type: boolean example: false + type: boolean line_items: - title: order_response_products - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - type: object - properties: - data: - type: array - items: - title: product_data_response - allOf: - - $ref: '#/components/schemas/product' - - type: object - properties: - id: - type: string - object: - type: string - parent_id: - type: string + $ref: "#/components/schemas/order_response_products" livemode: - type: boolean - example: false description: Whether the object exists in live mode or test mode + example: false + type: boolean metadata: additionalProperties: true + description: 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. maxProperties: 100 type: object - description: 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: - title: order_next_action_response - type: object - description: contains the following attributes that will guide to continue the flow - properties: - redirect_to_url: - type: object - description: contains the following attributes that will guide to continue the flow - properties: - url: - type: string - format: uri - description: pay.conekta.com/{id} Indicates the url of the Conekta component to authenticate the flow through 3DS2. - example: https://pay.conekta.com/6fca054a85194c43971ecea35cc519bb - return_url: - type: string - format: uri - description: Indicates the url to which the 3DS2 flow returns at the end, when the integration is redirected. - example: https://my-website.com" - type: - type: string - example: redirect_to_url - description: Indicates the type of action to be taken + $ref: "#/components/schemas/order_next_action_response" object: - type: string + description: String representing the object’s type. Objects of the same + type share the same value. example: order - description: String representing the object’s type. Objects of the same type share the same value. - payment_status: type: string - example: paid + payment_status: description: The payment status of the order. - processing_mode: + example: paid type: string - description: Indicates the processing mode for the order, either ecommerce, recurrent or validation. + processing_mode: + description: "Indicates the processing mode for the order, either ecommerce,\ + \ recurrent or validation." example: ecommerce + type: string shipping_contact: - allOf: - - type: object - properties: - created_at: - type: integer - format: int64 - id: - type: string - object: - type: string - - $ref: '#/components/schemas/customer_shipping_contacts_response' + $ref: "#/components/schemas/order_response_shipping_contact" updated_at: - type: integer + description: The time at which the object was last updated in seconds since + the Unix epoch example: 1676328434 format: int64 - description: The time at which the object was last updated in seconds since the Unix epoch - orders_response: - title: orders_response - type: object - required: + type: integer + title: order_response + get_orders_response: + allOf: + - properties: + data: + items: + $ref: "#/components/schemas/order_response" + type: array + default: null + required: - data - properties: - data: - type: array - items: - $ref: '#/components/schemas/order_response' - checkout_request: - title: order_checkout_request + title: orders_response + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + title: get_orders_response + order_checkout_request: description: | [Checkout](https://developers.conekta.com/v2.3.0/reference/payment-link) details properties: allowed_payment_methods: - type: array - description: Are the payment methods available for this link. For subscriptions, only 'card' is allowed due to the recurring nature of the payments. This field is mutually exclusive with excluded_payment_methods. + description: "Are the payment methods available for this link. For subscriptions,\ + \ only 'card' is allowed due to the recurring nature of the payments.\ + \ This field is mutually exclusive with excluded_payment_methods." + example: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank + - apple + - google items: - type: string enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - - apple - - google - example: - cash - card - bank_transfer @@ -8472,3623 +19868,2925 @@ components: - pay_by_bank - apple - google - excluded_payment_methods: - title: checkout_request_excluded_payment_methods + type: string type: array - description: Payment methods to be excluded from the checkout. This field is mutually exclusive with allowed_payment_methods. + default: null + excluded_payment_methods: + description: Payment methods to be excluded from the checkout. This field + is mutually exclusive with allowed_payment_methods. + example: + - cash + - bank_transfer items: - type: string enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - example: - cash + - card - bank_transfer - exclude_card_networks: - title: checkout_request_exclude_card_networks + - bnpl + - pay_by_bank + type: string + title: checkout_request_excluded_payment_methods type: array - description: 'List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: ''visa_master_card'' (a single token excluding both Visa and Mastercard) and ''amex''.' + default: null + exclude_card_networks: + description: "List of card networks to exclude from the checkout. This field\ + \ is only applicable for card payments. Accepted values: 'visa_master_card'\ + \ (a single token excluding both Visa and Mastercard) and 'amex'." + example: + - visa_master_card items: - type: string enum: - - visa_master_card - - amex - example: - visa_master_card - plan_ids: + - amex + type: string + title: checkout_request_exclude_card_networks type: array - description: List of plan IDs that will be available for subscription. This field is required for subscription payments. + default: null + plan_ids: + description: List of plan IDs that will be available for subscription. This + field is required for subscription payments. + example: + - plan_123 + - plan_456 items: type: string - example: - - plan_123 - - plan_456 + type: array + default: null expires_at: - type: integer - minimum: 1 + description: "It is the time when the link will expire. \nIt is expressed\ + \ in seconds since the Unix epoch. The valid range is from 5 minutes to\ + \ 365 days from the creation date.\n" format: int64 - description: | - It is the time when the link will expire. - It is expressed in seconds since the Unix epoch. The valid range is from 5 minutes to 365 days from the creation date. + minimum: 1 + type: integer failure_url: + description: "Redirection url back to the site in case of failed payment,\ + \ applies only to HostedPayment." + example: https://www.mysite.com/failure + format: uri + type: string + force_save_card: + description: Indicates whether the card used for the payment should be saved + for future purchases. This field is only applicable for card payments. + example: false + type: boolean + monthly_installments_enabled: + example: false + type: boolean + monthly_installments_options: + example: + - 3 + - 6 + - 12 + items: + format: int8 + type: integer + type: array + default: null + max_failed_retries: + description: Number of retries allowed before the checkout is marked as + failed + example: 3 + format: int8 + type: integer + name: + description: Reason for payment + type: string + on_demand_enabled: + example: true + type: boolean + redirection_time: + description: number of seconds to wait before redirecting to the success_url + example: 10 + format: int8 + type: integer + success_url: + description: "Redirection url back to the site in case of successful payment,\ + \ applies only to HostedPayment" + example: https://www.mysite.com/success + format: uri + type: string + type: + description: "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." + enum: + - Integration + - HostedPayment + type: string + title: order_checkout_request + customer_info: + properties: + name: + example: DevTest + type: string + email: + example: test@conekta.com + format: email + type: string + phone: + example: "5522997233" + type: string + corporate: + type: boolean + object: + example: customer_info + type: string + required: + - email + - name + - phone + title: customer_info + customer_info_customer_id: + properties: + customer_id: + example: cus_23874283647 + type: string + required: + - customer_id + title: customer_info_customer_id + order_request_customer_info: + description: Customer information + oneOf: + - $ref: "#/components/schemas/customer_info" + - $ref: "#/components/schemas/customer_info_customer_id" + fiscal_entity_address: + description: Address of the fiscal entity + properties: + street1: + description: Street name and number + example: Nuevo Leon 254 + type: string + street2: + description: Street name and number + example: Departamento 404 + nullable: true + type: string + postal_code: + description: Postal code + example: "06100" + type: string + city: + description: City + example: Ciudad de Mexico + type: string + state: + description: State + example: Ciudad de Mexico + type: string + country: + description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" + example: MX type: string - format: uri - description: Redirection url back to the site in case of failed payment, applies only to HostedPayment. - example: https://www.mysite.com/failure - force_save_card: - type: boolean - example: false - description: Indicates whether the card used for the payment should be saved for future purchases. This field is only applicable for card payments. - monthly_installments_enabled: - type: boolean - example: false - monthly_installments_options: - type: array - items: - type: integer - format: int8 - example: - - 3 - - 6 - - 12 - max_failed_retries: - type: integer - format: int8 - description: Number of retries allowed before the checkout is marked as failed - example: 3 + external_number: + description: External number + example: "123" + type: string + required: + - city + - country + - external_number + - postal_code + - street1 + title: fiscal_entity_address + order_fiscal_entity_request: + description: "Fiscal entity of the order, Currently it is a purely informative\ + \ field" + properties: + address: + $ref: "#/components/schemas/fiscal_entity_address" + email: + description: Email of the fiscal entity + example: test@gmail.com + type: string + metadata: + additionalProperties: true + description: Metadata associated with the fiscal entity + maxProperties: 100 + type: object name: + description: Name of the fiscal entity + example: Conekta Inc + nullable: true type: string - description: Reason for payment - on_demand_enabled: - type: boolean - example: true - redirection_time: - type: integer - format: int8 - description: number of seconds to wait before redirecting to the success_url - example: 10 - success_url: + phone: + description: Phone of the fiscal entity + example: "+525511223344" type: string - format: uri - description: Redirection url back to the site in case of successful payment, applies only to HostedPayment - example: https://www.mysite.com/success - type: + tax_id: + description: Tax ID of the fiscal entity + example: AAA010101AAA + nullable: true type: string - description: 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. - enum: - - Integration - - HostedPayment - customer_info: - title: customer_info - type: object required: - - name - - phone - - email + - address + title: order_fiscal_entity_request + product: properties: + antifraud_info: + additionalProperties: true + example: + key: value + type: object + brand: + description: The brand of the item. + example: Cohiba + maxLength: 249 + minLength: 2 + type: string + description: + description: Short description of the item + example: Imported From Mex. + maxLength: 249 + minLength: 3 + type: string + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + default: {} + description: "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." + example: + key: value + maxProperties: 100 name: + description: The name of the item. It will be displayed in the order. + example: Box of Cohiba S1s + maxLength: 249 + minLength: 3 type: string - example: DevTest - email: + quantity: + description: The quantity of the item in the order. + example: 1 + format: int32 + minimum: 1 + type: integer + sku: + description: The stock keeping unit for the item. It is used to identify + the item in the order. + example: XYZ12345 + maxLength: 249 + minLength: 1 type: string - format: email - example: test@conekta.com - phone: + tags: + description: List of tags for the item. It is used to identify the item + in the order. + example: + - food + - mexican food + items: + maxLength: 249 + minLength: 2 + type: string + minItems: 1 + type: array + default: null + unit_price: + description: The price of the item in cents. + example: 20000 + format: int32 + minimum: 0 + type: integer + required: + - name + - quantity + - unit_price + title: product + shipping_request: + properties: + amount: + description: Shipping amount in cents + example: 100 + format: int64 + minimum: 0 + type: integer + carrier: + description: Carrier name for the shipment + example: FEDEX + maxLength: 249 + minLength: 3 type: string - example: '5522997233' - corporate: - type: boolean - object: + tracking_number: + description: Tracking number can be used to track the shipment + example: TRACK123 + maxLength: 249 + minLength: 3 type: string - example: customer_info - customer_info_just_customer_id: - title: customer_info_customer_id - type: object + method: + description: Method of shipment + example: Same day + maxLength: 249 + minLength: 3 + type: string + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "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." + example: + key: value + maxProperties: 100 required: - - customer_id + - amount + title: shipping_request + order_tax_request: + description: create new taxes for an existing order properties: - customer_id: + amount: + description: The amount to be collected for tax in cents + example: 100 + format: int64 + minimum: 0 + type: integer + description: + description: description or tax's name + example: testing + minLength: 3 type: string - example: cus_23874283647 + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + example: + key: value + maxProperties: 100 + required: + - amount + - description + title: order_tax_request order_request: - title: order_request description: a order - type: object - required: - - currency - - customer_info - - line_items properties: charges: - description: List of [charges](https://developers.conekta.com/v2.3.0/reference/orderscreatecharge) that are applied to the order - type: array + description: "List of [charges](https://developers.conekta.com/v2.3.0/reference/orderscreatecharge)\ + \ that are applied to the order" items: - $ref: '#/components/schemas/charge_request' + $ref: "#/components/schemas/charge_request" + type: array + default: null checkout: - $ref: '#/components/schemas/checkout_request' + $ref: "#/components/schemas/order_checkout_request" currency: - type: string - description: Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) + description: "Currency with which the payment will be made. It uses the\ + \ 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" example: MXN maxLength: 3 + type: string customer_info: - description: Customer information - oneOf: - - $ref: '#/components/schemas/customer_info' - - $ref: '#/components/schemas/customer_info_just_customer_id' + $ref: "#/components/schemas/order_request_customer_info" discount_lines: - description: List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline) that are applied to the order. - type: array + description: "List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline)\ + \ that are applied to the order." items: - $ref: '#/components/schemas/order_discount_lines_request' + $ref: "#/components/schemas/order_discount_lines_request" + type: array + default: null fiscal_entity: - title: order_fiscal_entity_request - type: object - description: Fiscal entity of the order, Currently it is a purely informative field - required: - - address - properties: - address: - $ref: '#/components/schemas/fiscal_entity_address' - email: - type: string - example: test@gmail.com - description: Email of the fiscal entity - metadata: - type: object - additionalProperties: true - maxProperties: 100 - description: Metadata associated with the fiscal entity - name: - type: - - string - - 'null' - example: Conekta Inc - description: Name of the fiscal entity - phone: - type: string - example: '+525511223344' - description: Phone of the fiscal entity - tax_id: - type: - - string - - 'null' - example: AAA010101AAA - description: Tax ID of the fiscal entity + $ref: "#/components/schemas/order_fiscal_entity_request" line_items: - description: List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product. - type: array + description: "List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct)\ + \ that are sold in the order. You must have at least one product." items: - $ref: '#/components/schemas/product' + $ref: "#/components/schemas/product" + type: array + default: null metadata: - type: object additionalProperties: - anyOf: - - type: string - maxLength: 249 - - type: integer - - type: number - - type: boolean + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "Metadata associated with the order. Values must be scalar\ + \ (string of at most 249 characters, integer, number or boolean); nested\ + \ objects and arrays are not supported." maxProperties: 100 - description: Metadata associated with the order. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are not supported. needs_shipping_contact: - type: boolean - example: false description: Allows you to fill out the shipping information at checkout - pre_authorize: + example: false type: boolean + pre_authorize: description: Indicates whether the order charges must be preauthorized + type: boolean processing_mode: - type: string - description: Indicates the processing mode for the order, either ecommerce, recurrent or validation. + description: "Indicates the processing mode for the order, either ecommerce,\ + \ recurrent or validation." example: ecommerce - return_url: type: string - format: uri - description: Indicates the redirection callback upon completion of the 3DS2 flow. Do not use this parameter if your order has a checkout parameter + return_url: + description: Indicates the redirection callback upon completion of the 3DS2 + flow. Do not use this parameter if your order has a checkout parameter example: https://my-website.com + format: uri + type: string shipping_contact: - $ref: '#/components/schemas/customer_shipping_contacts' + $ref: "#/components/schemas/customer_shipping_contacts_request" shipping_lines: - description: List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping). If the online store offers digital products. - type: array + description: "List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping).\ + \ If the online store offers digital products." items: - $ref: '#/components/schemas/shipping_request' - tax_lines: - description: List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes) that are applied to the order. + $ref: "#/components/schemas/shipping_request" type: array + default: null + tax_lines: + description: "List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes)\ + \ that are applied to the order." items: - $ref: '#/components/schemas/order_tax_request' + $ref: "#/components/schemas/order_tax_request" + type: array + default: null three_ds_mode: - type: string + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ + \ The value is validated against the allowed set on creation; sending\ + \ an explicit null is rejected. Omit the field to create the order without\ + \ requesting 3DS through the API (company-level 3DS applies only to orders\ + \ paid through Checkout or when antifraud forces 3DS)." enum: - - strict - - not_strict - - smart - description: 'Indicates the 3DS2 mode: ''strict'', ''not_strict'' or ''smart''. The value is validated against the allowed set on creation; sending an explicit null is rejected. Omit the field to create the order without requesting 3DS through the API (company-level 3DS applies only to orders paid through Checkout or when antifraud forces 3DS).' - examples: - - value: smart - summary: 'Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication.' - - value: strict - summary: All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2. - - value: not_strict - summary: The 3DS2 flow is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode. - order_update_request: - title: order_update + - strict + - not_strict + - smart + type: string + required: + - currency + - customer_info + - line_items + title: order_request + order_update_customer_info: + oneOf: + - $ref: "#/components/schemas/customer_info" + - $ref: "#/components/schemas/customer_info_customer_id" + title: order_update_customer_info + order_update_fiscal_entity_request: + description: "Fiscal entity of the order, Currently it is a purely informative\ + \ field" + properties: + address: + $ref: "#/components/schemas/fiscal_entity_address" + email: + description: Email of the fiscal entity + example: test@gmail.com + type: string + name: + description: Name of the fiscal entity + example: Conekta Inc + nullable: true + type: string + metadata: + additionalProperties: true + description: Metadata associated with the fiscal entity + maxProperties: 100 + type: object + phone: + description: Phone of the fiscal entity + example: "+525511223344" + type: string + tax_id: + description: Tax ID of the fiscal entity + example: AAA010101AAA + nullable: true + type: string + required: + - address + title: order_update_fiscal_entity_request + order_update: description: a order - type: object properties: charges: - type: array items: - $ref: '#/components/schemas/charge_request' + $ref: "#/components/schemas/charge_request" + type: array + default: null checkout: - $ref: '#/components/schemas/checkout_request' + $ref: "#/components/schemas/order_checkout_request" currency: - type: string - description: Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) + description: "Currency with which the payment will be made. It uses the\ + \ 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" example: MXN maxLength: 3 + type: string customer_info: - title: order_update_customer_info - oneOf: - - $ref: '#/components/schemas/customer_info' - - $ref: '#/components/schemas/customer_info_just_customer_id' + $ref: "#/components/schemas/order_update_customer_info" discount_lines: - description: List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline) that are applied to the order. - type: array + description: "List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline)\ + \ that are applied to the order." items: - $ref: '#/components/schemas/order_discount_lines_request' + $ref: "#/components/schemas/order_discount_lines_request" + type: array + default: null fiscal_entity: - title: order_update_fiscal_entity_request - type: object - description: Fiscal entity of the order, Currently it is a purely informative field - required: - - address - properties: - address: - $ref: '#/components/schemas/fiscal_entity_address' - email: - type: string - example: test@gmail.com - description: Email of the fiscal entity - name: - type: - - string - - 'null' - example: Conekta Inc - description: Name of the fiscal entity - metadata: - type: object - additionalProperties: true - maxProperties: 100 - description: Metadata associated with the fiscal entity - phone: - type: string - example: '+525511223344' - description: Phone of the fiscal entity - tax_id: - type: - - string - - 'null' - example: AAA010101AAA - description: Tax ID of the fiscal entity + $ref: "#/components/schemas/order_update_fiscal_entity_request" line_items: - description: List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product. - type: array + description: "List of [products](https://developers.conekta.com/v2.3.0/reference/orderscreateproduct)\ + \ that are sold in the order. You must have at least one product." items: - $ref: '#/components/schemas/product' + $ref: "#/components/schemas/product" + type: array + default: null metadata: - type: object - maxProperties: 100 additionalProperties: - anyOf: - - type: string - maxLength: 249 - - type: integer - - type: number - - type: boolean + $ref: "#/components/schemas/order_tax_request_metadata_value" + maxProperties: 100 pre_authorize: - type: boolean description: Indicates whether the order charges must be preauthorized + type: boolean shipping_contact: - $ref: '#/components/schemas/customer_shipping_contacts' + $ref: "#/components/schemas/customer_shipping_contacts_request" shipping_lines: - type: array - description: List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping). If the online store offers digital products. + description: "List of [shipping costs](https://developers.conekta.com/v2.3.0/reference/orderscreateshipping).\ + \ If the online store offers digital products." items: - $ref: '#/components/schemas/shipping_request' - tax_lines: + $ref: "#/components/schemas/shipping_request" type: array + default: null + tax_lines: items: - $ref: '#/components/schemas/order_tax_request' + $ref: "#/components/schemas/order_tax_request" + type: array + default: null + title: order_update + order_capture_request: + properties: + amount: + description: Amount to capture + example: 500 + format: int64 + minimum: 1 + type: integer + required: + - amount + title: order_capture_request product_order_response: - title: product order response allOf: - - $ref: '#/components/schemas/product' - - type: object - properties: - id: - type: string - object: - type: string - parent_id: + - properties: + antifraud_info: + additionalProperties: true + example: + key: value + type: object + brand: + description: The brand of the item. + example: Cohiba + maxLength: 249 + minLength: 2 + type: string + description: + description: Short description of the item + example: Imported From Mex. + maxLength: 249 + minLength: 3 + type: string + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + default: {} + description: "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." + example: + key: value + maxProperties: 100 + name: + description: The name of the item. It will be displayed in the order. + example: Box of Cohiba S1s + maxLength: 249 + minLength: 3 + type: string + quantity: + description: The quantity of the item in the order. + example: 1 + format: int32 + minimum: 1 + type: integer + sku: + description: The stock keeping unit for the item. It is used to identify + the item in the order. + example: XYZ12345 + maxLength: 249 + minLength: 1 + type: string + tags: + description: List of tags for the item. It is used to identify the item + in the order. + example: + - food + - mexican food + items: + maxLength: 249 + minLength: 2 type: string + minItems: 1 + type: array + default: null + unit_price: + description: The price of the item in cents. + example: 20000 + format: int32 + minimum: 0 + type: integer + required: + - name + - quantity + - unit_price + title: product + - properties: + id: + type: string + object: + type: string + parent_id: + type: string + title: product order response update_product: - type: object - title: update_product properties: antifraud_info: - type: object additionalProperties: type: object description: - type: string - minLength: 3 maxLength: 249 - sku: + minLength: 3 type: string - minLength: 1 + sku: maxLength: 249 - name: + minLength: 1 type: string - minLength: 3 - maxLength: 249 + name: example: Box of Cohiba S1s + maxLength: 249 + minLength: 3 + type: string unit_price: - type: integer - format: int64 example: 20000 + format: int64 minimum: 0 - quantity: type: integer - format: int32 + quantity: example: 1 + format: int32 minimum: 1 + type: integer tags: - type: array - minItems: 1 items: - type: string - minLength: 2 maxLength: 249 + minLength: 2 + type: string + minItems: 1 + type: array + default: null brand: - type: string - minLength: 2 maxLength: 249 + minLength: 2 + type: string metadata: - type: object - maxProperties: 100 additionalProperties: - anyOf: - - type: string - maxLength: 249 - - type: integer - - type: number - - type: boolean - payout_order_response: - title: payout_order_response - description: payout order model response - type: object + $ref: "#/components/schemas/order_tax_request_metadata_value" + maxProperties: 100 + title: update_product + orderRefund_request: + properties: + amount: + description: Amount to be refunded in cents + example: 500 + type: integer + expires_at: + example: 1553273553 + format: int64 + type: integer + reason: + description: Reason for the refund + example: suspected_fraud + type: string required: - - allowed_payout_methods - - amount - - created_at - - currency - - customer_info + - amount + - reason + payout_order_response_customer_info: + allOf: + - properties: + id: + description: The id of the customer. + example: cus_23874283647 + type: string + required: - id - - livemode - - object - - payouts - - reason - - updated_at - - expires_at - - status + - properties: + customer_custom_reference: + description: Custom reference + example: custom_reference + nullable: true + type: string + name: + example: DevTest + type: string + email: + example: test@conekta.com + format: email + type: string + phone: + example: "5522997233" + type: string + corporate: + default: false + type: boolean + object: + example: customer_info + type: string + title: order_customer_info_response + description: The customer information of the payout order. + payout_order_payouts_item: + properties: + amount: + description: The amount of the payout. + example: 3000 + type: integer + currency: + description: The currency in which the payout is made. + example: MXN + type: string + expires_at: + description: The expiration date of the payout. + example: 1677626837 + format: int64 + type: integer + id: + description: The id of the payout. + example: payout_2vZwsRAhhGp2dFDJx + type: string + livemode: + description: The live mode of the payout. + example: true + type: boolean + object: + description: The object of the payout. + example: payout + type: string + payout_order_id: + description: The id of the payout order. + example: f2654d66-d740-457a-9a8c-f96b5196f44e + type: string + status: + description: The status of the payout. + example: open + type: string + required: + - amount + - currency + - id + - livemode + - object + title: payout_order_payouts_item + payout_order_response: + description: payout order model response properties: allowed_payout_methods: - type: array description: The payout methods that are allowed for the payout order. + example: + - cashout items: type: string - example: - - cashout minItems: 1 + type: array + default: null amount: - type: integer description: The amount of the payout order. - format: int64 example: 100 - created_at: + format: int64 type: integer + created_at: description: The creation date of the payout order. example: 1677626837 format: int64 + type: integer currency: - type: string + default: MXN description: The currency in which the payout order is made. example: MXN - default: MXN + type: string customer_info: - description: The customer information of the payout order. - allOf: - - type: object - required: - - id - properties: - id: - type: string - example: cus_23874283647 - description: The id of the customer. - - $ref: '#/components/schemas/order_customer_info_response' + $ref: "#/components/schemas/payout_order_response_customer_info" expires_at: - type: integer description: The expiration date of the payout order. - format: int64 example: 1677626837 + format: int64 + type: integer id: - type: string description: The id of the payout order. example: f2654d66-d740-457a-9a8c-f96b5196f44e + type: string livemode: - type: boolean description: The live mode of the payout order. example: true + type: boolean object: - type: string description: The object of the payout order. example: payout_order + type: string metadata: - type: object - description: The metadata of the payout order. additionalProperties: true - maxProperties: 100 + description: The metadata of the payout order. example: - custom_client_id: '12345' + custom_client_id: "12345" + maxProperties: 100 + type: object payouts: - type: array description: The payout information of the payout order. - title: payout_order_payouts items: - type: object - title: payout_order_payouts_item - required: - - id - - amount - - currency - - livemode - - object - properties: - amount: - type: integer - description: The amount of the payout. - example: 3000 - currency: - type: string - description: The currency in which the payout is made. - example: MXN - expires_at: - format: int64 - type: integer - description: The expiration date of the payout. - example: 1677626837 - id: - type: string - description: The id of the payout. - example: payout_2vZwsRAhhGp2dFDJx - livemode: - type: boolean - description: The live mode of the payout. - example: true - object: - type: string - description: The object of the payout. - example: payout - payout_order_id: - type: string - description: The id of the payout order. - example: f2654d66-d740-457a-9a8c-f96b5196f44e - status: - type: string - description: The status of the payout. - example: open + $ref: "#/components/schemas/payout_order_payouts_item" + title: payout_order_payouts + type: array + default: null reason: - type: string description: The reason for the payout order. example: Payout order for the customer - status: type: string + status: description: The status of the payout order. example: open + type: string updated_at: - type: integer description: The update date of the payout order. example: 1677626837 format: int64 - payout_order: - title: payout_order_request - description: a payout order - type: object + type: integer required: - - allowed_payout_methods - - amount - - currency - - customer_info - - payout - - reason - - expires_at + - allowed_payout_methods + - amount + - created_at + - currency + - customer_info + - expires_at + - id + - livemode + - object + - payouts + - reason + - status + - updated_at + title: payout_order_response + payout_orders_response: + allOf: + - properties: + data: + items: + $ref: "#/components/schemas/payout_order_response" + title: payout_orders_data_response + type: array + default: null + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + title: payout_orders_response + payout_order_request_customer_info: + allOf: + - properties: + customer_id: + example: cus_23874283647 + type: string + required: + - customer_id + title: customer_info_customer_id + description: The customer information to whom the payout order is made. + payout_method: + description: The payout method of the payout order. + properties: + type: + description: The type of the payout method. + example: cashout + type: string + required: + - type + title: payout_method + payout: + description: The payout information of the payout order. + properties: + payout_method: + $ref: "#/components/schemas/payout_method" + required: + - payout_method + title: payout + payout_order_request: + description: a payout order properties: allowed_payout_methods: - type: array description: The payout methods that are allowed for the payout order. + example: + - cashout items: type: string - example: - - cashout + type: array + default: null amount: - type: integer description: The amount of the payout order. example: 100 format: int64 + type: integer currency: - type: string + default: MXN description: The currency in which the payout order is made. example: MXN - default: MXN + type: string customer_info: - allOf: - - $ref: '#/components/schemas/customer_info_just_customer_id' - description: The customer information to whom the payout order is made. + $ref: "#/components/schemas/payout_order_request_customer_info" expires_at: - type: integer description: The expiration time of the payout order in Unix timestamp. example: 1700000000 format: int64 + type: integer metadata: - type: object - description: The metadata of the payout order. additionalProperties: true - maxProperties: 100 + description: The metadata of the payout order. example: - custom_client_id: '12345' - payout: - title: payout - required: - - payout_method + custom_client_id: "12345" + maxProperties: 100 type: object - description: The payout information of the payout order. - properties: - payout_method: - title: payout_method - required: - - type - type: object - description: The payout method of the payout order. - properties: - type: - type: string - description: The type of the payout method. - example: cashout + payout: + $ref: "#/components/schemas/payout" reason: - type: string description: The reason for the payout order. example: Payout order for the customer + type: string + required: + - allowed_payout_methods + - amount + - currency + - customer_info + - expires_at + - payout + - reason + title: payout_order_request checkout_response: - title: checkout_response description: checkout response - type: object - required: - - id - - livemode - - object - - name properties: allowed_payment_methods: - type: array + description: Are the payment methods available for this link + example: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank items: type: string + type: array + default: null + excluded_payment_methods: + description: Payment methods excluded from the checkout. This field is only + returned when excluded_payment_methods is provided in the request. example: + - cash + - bank_transfer + items: + enum: - cash - card - bank_transfer - bnpl - pay_by_bank - description: Are the payment methods available for this link - excluded_payment_methods: + type: string title: checkout_response_excluded_payment_methods type: array - items: - type: string - enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - example: - - cash - - bank_transfer - description: Payment methods excluded from the checkout. This field is only returned when excluded_payment_methods is provided in the request. + default: null plan_ids: - type: array description: List of plan IDs that are available for subscription + example: + - plan_123 + - plan_456 items: type: string - example: - - plan_123 - - plan_456 + type: array + default: null can_not_expire: - type: boolean example: false + type: boolean emails_sent: - type: integer example: 0 + type: integer exclude_card_networks: - title: checkout_response_exclude_card_networks - type: array + example: + - visa + - amex items: - type: string enum: - - visa - - mastercard - - amex - example: - visa + - mastercard - amex + type: string + title: checkout_response_exclude_card_networks + type: array + default: null expires_at: - type: integer example: 1680397724 format: int64 + type: integer failure_url: - type: string example: https://pay.conekta.com/failure + type: string force_3ds_flow: - type: boolean example: false + type: boolean id: - type: string example: b0bf16c4-18b9-445e-ba24-01604f329dbf + type: string livemode: - type: boolean example: true + type: boolean metadata: - type: object additionalProperties: true example: key: value + type: object monthly_installments_enabled: - type: boolean example: false + type: boolean monthly_installments_options: - type: array + example: + - 3 + - 6 + - 12 items: - type: integer format: int8 - example: - - 3 - - 6 - - 12 + type: integer + type: array + default: null name: - type: string description: Reason for charge example: Payment Link Name 1594138857 + type: string needs_shipping_contact: - type: boolean example: false + type: boolean object: - type: string example: checkout + type: string paid_payments_count: - type: integer example: 0 + type: integer payments_limit_count: - type: - - integer - - 'null' - format: int8 example: 5 + format: int8 + nullable: true + type: integer recurrent: - type: boolean example: false + type: boolean slug: - type: string example: b0bf16c418b9445eba2401604f329dbf + type: string sms_sent: - type: integer example: 0 - starts_at: type: integer + starts_at: example: 1677650400 + type: integer status: - type: string example: Issued - success_url: type: string - example: https://pay.conekta.com/success + success_url: description: The URL to redirect to after a successful payment. - type: + example: https://pay.conekta.com/success type: string + type: example: PaymentLink - url: type: string - format: uri + url: example: https://pay.conekta.com/link/b0bf16c418b9445eba2401604f329dbf - checkout: - title: checkout - description: It is a sub-resource of the Order model that can be stipulated in order to configure its corresponding checkout - type: object + format: uri + type: string required: - - name - - type - - order_template - - recurrent - - expires_at + - id + - livemode + - name + - object + title: checkout_response + checkouts_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/checkout_response" + type: array + default: null + title: checkouts_response + checkout_order_template: + description: It maintains the attributes with which the order will be created + when receiving a new payment. properties: - allowed_payment_methods: + currency: + description: It is the currency in which the order will be created. It must + be a valid ISO 4217 currency code. + example: MXN + maxLength: 3 + type: string + customer_info: + $ref: "#/components/schemas/order_request_customer_info" + line_items: + description: They are the products to buy. Each contains the "unit price" + and "quantity" parameters that are used to calculate the total amount + of the order. + items: + $ref: "#/components/schemas/product" + type: array + default: null + metadata: + additionalProperties: true + description: It is a set of key-value pairs that you can attach to the order. + It can be used to store additional information about the order in a structured + format. + example: + key: value + maxProperties: 100 + type: object + tax_lines: + description: "List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes)\ + \ that are applied to the order." + items: + $ref: "#/components/schemas/order_tax_request" + type: array + default: null + discount_lines: + description: "List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline)\ + \ that are applied to the order." + items: + $ref: "#/components/schemas/order_discount_lines_request" type: array + default: null + required: + - currency + - line_items + checkout: + description: It is a sub-resource of the Order model that can be stipulated + in order to configure its corresponding checkout + properties: + allowed_payment_methods: + description: Those are the payment methods that will be available for the + link. This field is mutually exclusive with excluded_payment_methods. + example: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank items: type: string + type: array + default: null + excluded_payment_methods: + description: Payment methods to be excluded from the checkout. This field + is mutually exclusive with allowed_payment_methods. example: + - cash + - bank_transfer + items: + enum: - cash - card - bank_transfer - bnpl - pay_by_bank - description: Those are the payment methods that will be available for the link. This field is mutually exclusive with excluded_payment_methods. - excluded_payment_methods: + type: string title: checkout_excluded_payment_methods type: array - description: Payment methods to be excluded from the checkout. This field is mutually exclusive with allowed_payment_methods. - items: - type: string - enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - example: - - cash - - bank_transfer + default: null exclude_card_networks: - title: checkout_exclude_card_networks - type: array - description: 'List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: ''visa_master_card'' (a single token excluding both Visa and Mastercard) and ''amex''.' + description: "List of card networks to exclude from the checkout. This field\ + \ is only applicable for card payments. Accepted values: 'visa_master_card'\ + \ (a single token excluding both Visa and Mastercard) and 'amex'." + example: + - visa_master_card items: - type: string enum: - - visa_master_card - - amex - example: - visa_master_card + - amex + type: string + title: checkout_exclude_card_networks + type: array + default: null expires_at: - type: integer + description: "It is the time when the link will expire. \nIt is expressed\ + \ in seconds since the Unix epoch. The valid range is from 5 minutes to\ + \ 365 days from the creation date.\n" example: 1680397724 format: int64 minimum: 1 - description: | - It is the time when the link will expire. - It is expressed in seconds since the Unix epoch. The valid range is from 5 minutes to 365 days from the creation date. + type: integer monthly_installments_enabled: - type: boolean + description: This flag allows you to specify if months without interest + will be active. example: true - description: This flag allows you to specify if months without interest will be active. + type: boolean monthly_installments_options: - description: This field allows you to specify the number of months without interest. - type: array + description: This field allows you to specify the number of months without + interest. + example: + - 3 + - 6 + - 12 items: - type: integer format: int8 - example: - - 3 - - 6 - - 12 + type: integer + type: array + default: null three_ds_mode: - type: - - string - - 'null' + description: "Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'.\ + \ Accepted on creation only. Null appears in responses when no mode is\ + \ configured; to defer to the company-level 3DS configuration, omit the\ + \ field on creation (an explicit null is rejected)." enum: - - strict - - not_strict - - smart - - null - description: 'Indicates the 3DS2 mode: ''strict'', ''not_strict'' or ''smart''. Accepted on creation only. Null appears in responses when no mode is configured; to defer to the company-level 3DS configuration, omit the field on creation (an explicit null is rejected).' - examples: - - value: smart - summary: 'Risk-based 3DS: transactions that Conekta considers risky go through the 3DS2 verification flow (provided the issuing bank supports it); low-risk transactions continue without 3DS2 authentication.' - - value: strict - summary: All transactions require 3DS2 authentication as a complementary security measure, except those rejected by our Anti-Fraud. The issuing bank must support 3DS2. - - value: not_strict - summary: The 3DS2 flow is also always initiated, behaving like 'strict'. Acceptance of authentication attempts is governed by the company-level 3DS configuration, not by this mode. - name: + - strict + - not_strict + - smart + - null + nullable: true type: string + name: description: Reason for charge example: Payment Link Name 1594138857 + type: string needs_shipping_contact: - type: boolean + description: This flag allows you to fill in the shipping information at + checkout. example: false - description: This flag allows you to fill in the shipping information at checkout. + type: boolean on_demand_enabled: - type: - - boolean - - 'null' - example: true description: This flag allows you to specify if the link will be on demand. + example: true + nullable: true + type: boolean plan_ids: description: It is a list of plan IDs that will be associated with the order. - type: array + example: + - plan_123 + - plan_456 items: type: string - example: - - plan_123 - - plan_456 + type: array + default: null order_template: - description: It maintains the attributes with which the order will be created when receiving a new payment. - type: object - required: - - currency - - line_items - properties: - currency: - type: string - example: MXN - maxLength: 3 - description: It is the currency in which the order will be created. It must be a valid ISO 4217 currency code. - customer_info: - description: It is the information of the customer who will be created when receiving a new payment. - oneOf: - - $ref: '#/components/schemas/customer_info' - - $ref: '#/components/schemas/customer_info_just_customer_id' - line_items: - description: They are the products to buy. Each contains the "unit price" and "quantity" parameters that are used to calculate the total amount of the order. - type: array - items: - $ref: '#/components/schemas/product' - metadata: - type: object - additionalProperties: true - example: - key: value - maxProperties: 100 - description: It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format. - tax_lines: - description: List of [taxes](https://developers.conekta.com/v2.3.0/reference/orderscreatetaxes) that are applied to the order. - type: array - items: - $ref: '#/components/schemas/order_tax_request' - discount_lines: - description: List of [discounts](https://developers.conekta.com/v2.3.0/reference/orderscreatediscountline) that are applied to the order. - type: array - items: - $ref: '#/components/schemas/order_discount_lines_request' + $ref: "#/components/schemas/checkout_order_template" payments_limit_count: - type: integer - format: int8 + description: It is the number of payments that can be made through the link. example: 5 + format: int8 minimum: 1 - description: It is the number of payments that can be made through the link. + type: integer success_url: - type: string - example: https://www.conekta.com/success description: The URL to redirect to after a successful payment. + example: https://www.conekta.com/success + type: string recurrent: - type: boolean + description: "false: single use. true: multiple payments" example: false - description: 'false: single use. true: multiple payments' + type: boolean type: - type: string + description: It is the type of link that will be created. It must be a valid + type. example: PaymentLink - description: It is the type of link that will be created. It must be a valid type. - update_payment_methods: - title: update_payment_methods_card - type: object + type: string + required: + - expires_at + - name + - order_template + - recurrent + - type + title: checkout + emailCheckout_request: properties: - name: + email: + example: example@conekta.com + format: email type: string - example: Payment recurrent + required: + - email + smsCheckout_request: + properties: + phonenumber: + example: "5566982090" + type: string + required: + - phonenumber + get_customer_payment_method_data_response: + discriminator: + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + propertyName: type + oneOf: + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/payment_method_cash_response" + - $ref: "#/components/schemas/payment_method_card_response" + - $ref: "#/components/schemas/payment_method_spei_recurrent_response" + title: get_customer_payment_method_data_response + get_payment_method_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/get_customer_payment_method_data_response" + type: array + default: null + title: get_payment_method_response + CreateCustomerPaymentMethods_request: + description: Contains details of the payment methods that the customer has active + or has used in Conekta + oneOf: + - $ref: "#/components/schemas/payment_method_token_request" + - $ref: "#/components/schemas/payment_method_cash_request" + - $ref: "#/components/schemas/payment_method_spei_request" + create_customer_payment_methods_response: + discriminator: + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + propertyName: type + oneOf: + - $ref: "#/components/schemas/payment_method_cash_response" + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/payment_method_card_response" + - $ref: "#/components/schemas/payment_method_spei_recurrent_response" + title: create_customer_payment_methods_response + update_payment_methods_card: + properties: + name: description: The name of the payment method holder + example: Payment recurrent + type: string expires_at: - type: integer - description: The expiration date of the payment method in Unix timestamp format + description: The expiration date of the payment method in Unix timestamp + format example: 1760457350 format: int64 minimum: 1 + type: integer + title: update_payment_methods_card + update_customer_payment_methods_response: + discriminator: + mapping: + cash: payment_method_cash_response + card: payment_method_card_response + cash_recurrent: payment_method_cash_recurrent_response + spei_recurrent: payment_method_spei_recurrent_response + propertyName: type + oneOf: + - $ref: "#/components/schemas/payment_method_cash_response" + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/payment_method_card_response" + - $ref: "#/components/schemas/payment_method_spei_recurrent_response" + title: update_customer_payment_methods_response plan_response: - title: plan_response description: plans model - type: object properties: amount: - type: integer example: 10000 - created_at: type: integer + created_at: example: 1666900846 format: int64 + type: integer currency: - type: string example: MXN maxLength: 3 + type: string expiry_count: - type: - - integer - - 'null' example: 12 - frequency: + nullable: true type: integer + frequency: example: 1 + type: integer id: - type: string example: gold-plan - interval: type: string + interval: example: month + type: string livemode: - type: boolean example: true + type: boolean name: - type: string example: Extra Plan3 - object: type: string + object: example: plan + type: string trial_period_days: - type: - - integer - - 'null' example: 0 - max_retries: + nullable: true type: integer + max_retries: example: 3 - retry_delay_hours: type: integer + retry_delay_hours: example: 48 + type: integer + title: plan_response + get_plans_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/plan_response" + type: array + default: null + title: get_plans_response plan_request: - title: plan_request description: a plan - type: object - required: - - amount - - frequency - - interval - - name properties: amount: - type: integer + description: The amount in cents that will be charged on the interval specified. example: 10000 minimum: 1 - description: The amount in cents that will be charged on the interval specified. + type: integer currency: - type: string + description: "ISO 4217 for currencies, for the Mexican peso it is MXN/USD" example: MXN maxLength: 3 - description: ISO 4217 for currencies, for the Mexican peso it is MXN/USD + type: string expiry_count: - type: integer + description: "Number of repetitions of the frequency NUMBER OF CHARGES TO\ + \ BE MADE, considering the interval and frequency, this evolves over time,\ + \ but is subject to the expiration count." example: 12 - description: Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. - frequency: type: integer + frequency: + description: "Frequency of the charge, which together with the interval,\ + \ can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights" example: 1 minimum: 1 - description: Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights + type: integer id: - type: string - example: plan_24234 description: internal reference id - interval: + example: plan_24234 type: string - enum: - - week - - half_month - - month - - year + interval: description: The interval of time between each charge. - name: + enum: + - week + - half_month + - month + - year type: string - example: Extra Plan3 + name: description: The name of the plan. + example: Extra Plan3 + type: string trial_period_days: - type: integer - example: 0 description: The number of days the customer will have a free trial. - max_retries: + example: 0 type: integer - minimum: 3 + max_retries: + description: (optional) Specifies the maximum number of retry attempts for + a subscription payment before it is canceled. example: 3 - description: (optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled. - retry_delay_hours: + minimum: 3 type: integer - minimum: 48 + retry_delay_hours: + description: (optional) Defines the number of hours between subscription + payment retry attempts. example: 50 - description: (optional) Defines the number of hours between subscription payment retry attempts. - plan_update_request: - title: update_plan + minimum: 48 + type: integer + required: + - amount + - frequency + - interval + - name + title: plan_request + update_plan: description: a plan - type: object properties: amount: - type: integer + description: The amount in cents that will be charged on the interval specified. example: 10000 minimum: 1 - description: The amount in cents that will be charged on the interval specified. + type: integer currency: - type: string + description: "ISO 4217 for currencies, for the Mexican peso it is MXN/USD" example: MXN maxLength: 3 - description: ISO 4217 for currencies, for the Mexican peso it is MXN/USD + type: string expiry_count: - type: integer + description: "Number of repetitions of the frequency NUMBER OF CHARGES TO\ + \ BE MADE, considering the interval and frequency, this evolves over time,\ + \ but is subject to the expiration count." example: 12 - description: Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. + type: integer name: - type: string - example: Extra Plan3 description: The name of the plan. - customer_update_shipping_contacts: - title: customer_update_shipping_contacts_request + example: Extra Plan3 + type: string + title: update_plan + shipping_order_response: + allOf: + - properties: + amount: + description: Shipping amount in cents + example: 100 + format: int64 + minimum: 0 + type: integer + carrier: + description: Carrier name for the shipment + example: FEDEX + maxLength: 249 + minLength: 3 + type: string + tracking_number: + description: Tracking number can be used to track the shipment + example: TRACK123 + maxLength: 249 + minLength: 3 + type: string + method: + description: Method of shipment + example: Same day + maxLength: 249 + minLength: 3 + type: string + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + description: "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." + example: + key: value + maxProperties: 100 + required: + - amount + title: shipping_request + - properties: + id: + type: string + object: + type: string + parent_id: + type: string + title: shipping_order_response + customer_shipping_contacts_response: + description: Contains the detail of the shipping addresses that the client has + active or has used in Conekta + properties: + phone: + example: "+525511223344" + type: string + receiver: + example: Marvin Fuller + type: string + between_streets: + example: Ackerman Crescent + nullable: true + type: string + address: + $ref: "#/components/schemas/customer_shipping_contacts_address" + parent_id: + type: string + default: + example: false + type: boolean + id: + example: adr_1234567890 + type: string + created_at: + example: 1675715413 + format: int64 + type: integer + metadata: + additionalProperties: true + description: Metadata associated with the shipping contact + maxProperties: 100 + type: object + object: + example: shipping_contact + type: string + deleted: + example: false + type: boolean + title: customer_shipping_contacts_response + shipping_contact_address: + description: Address of the person who will receive the order + properties: + street1: + description: Street and number of the delivery address. + example: Nuevo Leon 254 + maxLength: 249 + minLength: 2 + type: string + street2: + description: "Apartment, suite or interior reference for the delivery address." + example: Departamento 404 + maxLength: 249 + type: string + postal_code: + description: Postal code of the delivery address. For Mexican addresses + (country MX) it must be a 5-digit postal code. + example: "06100" + maxLength: 250 + type: string + city: + description: City of the delivery address. Must contain at least two consecutive + ASCII letters. + example: Ciudad de Mexico + maxLength: 249 + pattern: "[A-Za-z]{2}" + type: string + state: + description: State of the delivery address. + example: Ciudad de Mexico + maxLength: 249 + type: string + country: + description: "Country of the delivery address. This field follows the [ISO\ + \ 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." + example: MX + maxLength: 249 + minLength: 2 + type: string + residential: + default: true + description: Indicates whether the delivery address is residential. + example: true + nullable: true + type: boolean + title: shipping_contact_address + customer_update_shipping_contacts_request: description: |- [Shipping](https://developers.conekta.com/v2.3.0/reference/createcustomershippingcontacts) details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used. properties: phone: - type: string - example: '+525511223344' description: Phone contact - receiver: + example: "+525511223344" type: string - example: Marvin Fuller + receiver: description: Name of the person who will receive the order - between_streets: + example: Marvin Fuller type: string - maxLength: 249 - pattern: '[A-Za-z]{2}' + between_streets: + description: The street names between which the order will be delivered. + Must contain at least two consecutive ASCII letters. example: Ackerman Crescent - description: The street names between which the order will be delivered. Must contain at least two consecutive ASCII letters. + maxLength: 249 + pattern: "[A-Za-z]{2}" + type: string address: - $ref: '#/components/schemas/shipping_contact_address' + $ref: "#/components/schemas/shipping_contact_address" parent_id: type: string default: - type: - - boolean - - 'null' + nullable: true + type: boolean deleted: - type: - - boolean - - 'null' - subscription_update_request: - title: updates a subscription - description: You can modify the subscription to change the plan used by your customers. - type: object + nullable: true + type: boolean + title: customer_update_shipping_contacts_request + subscription_response_1: + description: subscription model properties: + billing_cycle_start: + example: 1677626827 + format: int64 + nullable: true + type: integer + billing_cycle_end: + example: 1677626827 + format: int64 + nullable: true + type: integer + canceled_at: + example: 1678258162 + format: int64 + nullable: true + type: integer + canceled_reason: + description: Reason for cancellation. This field appears when the subscription + status is 'canceled'. + example: user_cancelation + type: string + card_id: + example: src_2tKcHxhTz7xU5SymL + type: string + charge_id: + example: 2tKcHxhTz7xU5SymL + nullable: true + type: string + created_at: + example: 1677626837 + format: int64 + type: integer + customer_custom_reference: + example: dotnet_123456 + type: string + customer_id: + example: cus_2tKcHxhTz7xU5SymF + type: string + id: + example: gold-plan + type: string + last_billing_cycle_order_id: + example: ord_2tSoMP7bZJbLiq4z8 + type: string + object: + example: subscription + type: string + paused_at: + example: 1678258162 + format: int64 + nullable: true + type: integer plan_id: + example: plan_2tXx672QLQ68CkmMn + type: string + status: + example: past_due type: string + subscription_start: + example: 1677626837 + type: integer + trial_start: + example: 1677626837 + format: int64 + nullable: true + type: integer + trial_end: + example: 1677626837 + format: int64 + nullable: true + type: integer + title: subscription_response + updates_a_subscription: + description: You can modify the subscription to change the plan used by your + customers. + properties: + plan_id: example: f84gdgf5g48r15fd21g8w424fd1 - card_id: type: string + card_id: example: src_2qUCNd5AyQqfPMBuV + type: string trial_end: + example: 1484040996 + type: integer + title: updates a subscription + subscription_events_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/event_response" + type: array + default: null + title: subscription_events_response + subscription_details_card: + properties: + id: + example: src_2yw5zPrVahTy7xy7P + type: string + created_at: + example: 1761745218 + format: int64 + type: integer + active: + example: true + type: boolean + object: + example: card + type: string + exp_month: + example: "05" + type: string + exp_year: + example: "26" + type: string + brand: + example: mastercard + type: string + last4: + example: "1005" + type: string + name: + example: test + type: string + payment_source_status: + example: active + type: string + customer_id: + example: cus_2yDzKtEAD3khH8Sga + type: string + customer_custom_reference: + nullable: true + type: string + subscription_details_plan: + properties: + id: + example: VG5 + type: string + object: + example: plan + type: string + name: + example: CLARO + type: string + amount: + example: 30000 + format: int32 + type: integer + currency: + example: USD + type: string + interval: + example: month + type: string + frequency: + example: 1 + format: int32 + type: integer + trial_period_days: + format: int32 + nullable: true + type: integer + expiry_count: + example: 1 + format: int32 + type: integer + created_at: + example: 1742087277 + format: int64 type: integer - example: 1484040996 subscription_details: - title: subscription_details description: Subscription details for customer portal - type: object properties: card: - type: object - properties: - id: - type: string - example: src_2yw5zPrVahTy7xy7P - created_at: - type: integer - format: int64 - example: 1761745218 - active: - type: boolean - example: true - object: - type: string - example: card - exp_month: - type: string - example: '05' - exp_year: - type: string - example: '26' - brand: - type: string - example: mastercard - last4: - type: string - example: '1005' - name: - type: string - example: test - payment_source_status: - type: string - example: active - customer_id: - type: string - example: cus_2yDzKtEAD3khH8Sga - customer_custom_reference: - type: - - string - - 'null' - example: null + $ref: "#/components/schemas/subscription_details_card" plan: - type: object - properties: - id: - type: string - example: VG5 - object: - type: string - example: plan - name: - type: string - example: CLARO - amount: - type: integer - format: int32 - example: 30000 - currency: - type: string - example: USD - interval: - type: string - example: month - frequency: - type: integer - format: int32 - example: 1 - trial_period_days: - type: - - integer - - 'null' - format: int32 - example: null - expiry_count: - type: integer - format: int32 - example: 1 - created_at: - type: integer - format: int64 - example: 1742087277 + $ref: "#/components/schemas/subscription_details_plan" id: - type: string example: sub_2yYsQuYtXAbP1fdYu - object: type: string + object: example: subscription - status: type: string + status: example: canceled - plan_id: type: string + plan_id: example: VG5 - customer_id: type: string + customer_id: example: cus_2yDzKtEAD3khH8Sga + type: string next_billing_cycle: - type: - - integer - - 'null' - format: int64 example: 1876833632 - created_at: - type: integer format: int64 - example: 1755873642 - updated_at: + nullable: true type: integer + created_at: + example: 1755873642 format: int64 + type: integer + updated_at: example: 1761745218 + format: int64 + type: integer + title: subscription_details customer_details: - title: customer_details description: Customer details for customer portal - type: object properties: id: - type: string example: cus_2yDzKtEAD3khH8Sga - object: type: string + object: example: customer - name: type: string + name: example: mao - email: type: string - format: email + email: example: maoarroya@gmail.com + format: email + type: string + title: customer_details customer_portal_response: - title: customer_portal_response description: Customer portal model - type: object properties: slug: - type: string description: Unique slug identifier for the portal example: agIvD4QSBl4Nunq4TmuozMw2ThtyVC - subscription_id: type: string + subscription_id: description: Associated subscription ID example: sub_2yYsQuYtXAbP1fdYu - customer_id: type: string + customer_id: description: Associated customer ID example: cus_2yDzKtEAD3khH8Sga + type: string livemode: - type: boolean description: Whether this is a live or test mode portal example: false + type: boolean subscription: - $ref: '#/components/schemas/subscription_details' + $ref: "#/components/schemas/subscription_details" customer: - $ref: '#/components/schemas/customer_details' + $ref: "#/components/schemas/customer_details" id: - type: string description: Customer portal ID example: scp_2ym7QbU9dTh7Froti - company_id: type: string + company_id: description: Associated company ID example: 63dad459920de10001d177b3 - object: type: string + object: example: customer_portal + type: string created_at: - type: integer - format: int64 description: Unix timestamp of creation example: 1759108828 - updated_at: - type: integer format: int64 + type: integer + updated_at: description: Unix timestamp of last update example: 1759108828 + format: int64 + type: integer portal_url: - type: string - format: uri description: URL to access the customer portal example: https://pay.stg.conekta.io/subscription/management/agIvD4QSBl4Nunq4TmuozMw2ThtyVC - update_order_tax_request: + format: uri + type: string + title: customer_portal_response + order_tax_response: + allOf: + - description: create new taxes for an existing order + properties: + amount: + description: The amount to be collected for tax in cents + example: 100 + format: int64 + minimum: 0 + type: integer + description: + description: description or tax's name + example: testing + minLength: 3 + type: string + metadata: + additionalProperties: + $ref: "#/components/schemas/order_tax_request_metadata_value" + example: + key: value + maxProperties: 100 + required: + - amount + - description + title: order_tax_request + - properties: + id: + example: tax_lin_2tQ8dC5mg1UADmVPo + type: string + object: + example: tax_line + type: string + parent_id: + example: ord_2tPAmKCEJqh8RE6nY + type: string + description: create new taxes for an existing order response + required: + - id + title: order_tax_response + ordersUpdateTaxes_request: description: create new taxes for an existing order - type: object properties: amount: - type: integer - example: '100' + description: The amount to be collected for tax in cents + example: 100 format: int64 minimum: 0 - description: The amount to be collected for tax in cents + type: integer description: - type: string + description: description or tax's name example: testing minLength: 3 - description: description or tax's name + type: string metadata: - type: object additionalProperties: - anyOf: - - type: string - maxLength: 249 - - type: integer - - type: number - - type: boolean + $ref: "#/components/schemas/order_tax_request_metadata_value" maxProperties: 100 - token: - title: token request + token_request_card: + properties: + cvc: + description: It is a value that allows identifying the security code of + the card. + example: "123" + maxLength: 4 + type: string + x-encripted: true + device_fingerprint: + description: It is a value that allows identifying the device fingerprint. + example: zptcxk4p6w1ijwz85snf1l3bqe5g09ie + type: string + exp_month: + description: It is a value that allows identifying the expiration month + of the card. + example: "12" + maxLength: 2 + type: string + x-encripted: true + exp_year: + description: It is a value that allows identifying the expiration year of + the card. + example: "26" + maxLength: 2 + type: string + x-encripted: true + name: + description: It is a value that allows identifying the name of the cardholder. + example: Miguel + type: string + x-encripted: true + number: + description: It is a value that allows identifying the number of the card. + example: "4242424242424242" + type: string + x-encripted: true + required: + - cvc + - exp_month + - exp_year + - name + - number + token_request_checkout: + deprecated: true + properties: + returns_control_on: + description: It is a value that allows identifying the returns control on. + example: Token + type: string + token_request: description: a token - type: object properties: card: - type: - - object - - 'null' - required: - - exp_month - - exp_year - - number - - cvc - - name - properties: - cvc: - type: string - description: It is a value that allows identifying the security code of the card. - example: '123' - maxLength: 4 - x-encripted: true - device_fingerprint: - type: string - description: It is a value that allows identifying the device fingerprint. - example: zptcxk4p6w1ijwz85snf1l3bqe5g09ie - exp_month: - type: string - description: It is a value that allows identifying the expiration month of the card. - example: '12' - maxLength: 2 - x-encripted: true - exp_year: - type: string - description: It is a value that allows identifying the expiration year of the card. - example: '26' - maxLength: 2 - x-encripted: true - name: - type: string - description: It is a value that allows identifying the name of the cardholder. - example: Miguel - x-encripted: true - number: - type: string - description: It is a value that allows identifying the number of the card. - example: '4242424242424242' - x-encripted: true + $ref: "#/components/schemas/token_request_card" checkout: - deprecated: true - type: - - object - - 'null' - properties: - returns_control_on: - type: string - description: It is a value that allows identifying the returns control on. - example: Token - token_response: - title: token_response - description: token response - type: object - required: - - id - - livemode - - object - - used + $ref: "#/components/schemas/token_request_checkout" + title: token request + token_response_checkout: + deprecated: true properties: - checkout: - deprecated: true - type: - - object - - 'null' - properties: - allowed_payment_methods: - type: array - items: - type: string - example: card - can_not_expire: - type: boolean - example: false - description: Indicates if the checkout can not expire. - emails_sent: - type: integer - example: 0 - exclude_card_networks: - title: token_response_exclude_card_networks - type: array - items: - type: string - example: visa - expires_at: - type: integer - example: 1675715413 - description: Date and time when the checkout expires. - format: int64 - failure_url: - type: string - example: https://example.com/failure - description: URL to redirect the customer to if the payment process fails. - force_3ds_flow: - type: boolean - example: false - description: Indicates if the checkout forces the 3DS flow. - id: - type: string - example: 524f9d2f-8c2e-4e64-a33d-6006711a91bd - livemode: - type: boolean - example: true - metadata: - type: object - additionalProperties: true - example: - key: value - monthly_installments_enabled: - type: boolean - example: false - description: Indicates if the checkout allows monthly installments. - monthly_installments_options: - type: array - description: List of monthly installments options. - items: - type: integer - example: 3 - name: - type: string - example: tok-2toNoPZpJgRU4PvgZ - needs_shipping_contact: - type: boolean - example: false - object: - type: string - example: checkout - description: Indicates the type of object, in this case checkout. - on_demand_enabled: - type: boolean - example: false - description: Indicates if the checkout allows on demand payments. - paid_payments_count: - type: integer - example: 0 - description: Number of payments that have been paid. - recurrent: - type: boolean - example: false - description: Indicates if the checkout is recurrent. - sms_sent: - type: integer - example: 0 - starts_at: - type: integer - example: 1675715413 - description: Date and time when the checkout starts. - format: int64 - status: - type: string - example: Issued - description: Status of the checkout. - success_url: - type: string - example: https://example.com/success - description: URL to redirect the customer to after the payment process is completed. - type: - type: string - example: Integration - description: Type of checkout. + allowed_payment_methods: + items: + example: card + type: string + type: array + default: null + can_not_expire: + description: Indicates if the checkout can not expire. + example: false + type: boolean + emails_sent: + example: 0 + type: integer + exclude_card_networks: + items: + example: visa + type: string + title: token_response_exclude_card_networks + type: array + default: null + expires_at: + description: Date and time when the checkout expires. + example: 1675715413 + format: int64 + type: integer + failure_url: + description: URL to redirect the customer to if the payment process fails. + example: https://example.com/failure + type: string + force_3ds_flow: + description: Indicates if the checkout forces the 3DS flow. + example: false + type: boolean id: + example: 524f9d2f-8c2e-4e64-a33d-6006711a91bd + type: string + livemode: + example: true + type: boolean + metadata: + additionalProperties: true + example: + key: value + type: object + monthly_installments_enabled: + description: Indicates if the checkout allows monthly installments. + example: false + type: boolean + monthly_installments_options: + description: List of monthly installments options. + items: + example: 3 + type: integer + type: array + default: null + name: + example: tok-2toNoPZpJgRU4PvgZ + type: string + needs_shipping_contact: + example: false + type: boolean + object: + description: "Indicates the type of object, in this case checkout." + example: checkout + type: string + on_demand_enabled: + description: Indicates if the checkout allows on demand payments. + example: false + type: boolean + paid_payments_count: + description: Number of payments that have been paid. + example: 0 + type: integer + recurrent: + description: Indicates if the checkout is recurrent. + example: false + type: boolean + sms_sent: + example: 0 + type: integer + starts_at: + description: Date and time when the checkout starts. + example: 1675715413 + format: int64 + type: integer + status: + description: Status of the checkout. + example: Issued type: string - example: cus_2tHJfJ79KyUwpxTik + success_url: + description: URL to redirect the customer to after the payment process is + completed. + example: https://example.com/success + type: string + type: + description: Type of checkout. + example: Integration + type: string + token_response: + description: token response + properties: + checkout: + $ref: "#/components/schemas/token_response_checkout" + id: description: Unique identifier for the token generated by Conekta. + example: cus_2tHJfJ79KyUwpxTik + type: string livemode: - type: boolean - example: true description: Indicates whether the token is in live mode or test mode. + example: true + type: boolean object: - type: string + description: "Indicates the type of object, in this case token" example: token - description: Indicates the type of object, in this case token + type: string used: - type: boolean - example: false description: Indicates if the token has been used - transaction_response: - title: transaction_response - description: 'The Transaction object represents the actions or steps of an order. Statuses can be: unprocessed, pending, available, owen, paid_out, voided, capture, capture_reversal, liquidation, liquidation_reversal, payout, payout_reversal, refund, refund_reversal, chargeback, chargeback_reversal, rounding_adjustment, won_chargeback, transferred, and transferred.' - type: object + example: false + type: boolean required: - - id - - object - - amount - - fee - - net - - status - - type - - created_at - - currency - - charge - - livemode + - id + - livemode + - object + - used + title: token_response + transaction_response: + description: "The Transaction object represents the actions or steps of an order.\ + \ Statuses can be: unprocessed, pending, available, owen, paid_out, voided,\ + \ capture, capture_reversal, liquidation, liquidation_reversal, payout, payout_reversal,\ + \ refund, refund_reversal, chargeback, chargeback_reversal, rounding_adjustment,\ + \ won_chargeback, transferred, and transferred." properties: amount: - type: integer + description: The amount of the transaction. example: 1000 format: int64 - description: The amount of the transaction. + type: integer charge: - type: string + description: Randomly assigned unique order identifier associated with the + charge. example: 5ee7ec58885a45585e6d9f8m - description: Randomly assigned unique order identifier associated with the charge. + type: string created_at: - type: integer + description: Date and time of creation of the transaction in Unix format. example: 1553273553 format: int64 - description: Date and time of creation of the transaction in Unix format. + type: integer currency: - type: string + description: "The currency of the transaction. It uses the 3-letter code\ + \ of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" example: MXN - description: The currency of the transaction. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) maxLength: 3 + type: string fee: - type: integer + description: The amount to be deducted for taxes and commissions. example: 560 format: int64 - description: The amount to be deducted for taxes and commissions. + type: integer id: - type: string - example: 5ee7ec5b8dea41085erb7f9e description: Unique identifier of the transaction. + example: 5ee7ec5b8dea41085erb7f9e + type: string livemode: - type: boolean + description: Indicates whether the transaction was created in live mode + or test mode. example: true - description: Indicates whether the transaction was created in live mode or test mode. + type: boolean net: - type: integer + description: The net amount after deducting commissions and taxes. example: 440 format: int64 - description: The net amount after deducting commissions and taxes. + type: integer object: - type: string + description: "Object name, which is transaction." example: transaction - description: Object name, which is transaction. - status: type: string - example: pending + status: description: Code indicating transaction status. - type: + example: pending type: string - example: capture + type: description: Transaction Type + example: capture + type: string + required: + - amount + - charge + - created_at + - currency + - fee + - id + - livemode + - net + - object + - status + - type + title: transaction_response + get_transactions_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + description: Transactions + items: + $ref: "#/components/schemas/transaction_response" + type: array + default: null + title: get_transactions_response + transfer_method_response: + description: Method used to make the transfer. + properties: + account_holder: + description: Name of the account holder. + example: John Doe + type: string + account_number: + description: Account number of the bank account. + example: "012180023547896764" + type: string + bank: + description: Name of the bank. + example: BBVA Bancomer + type: string + created_at: + description: Date and time of creation of the transfer. + example: 1553273553 + format: int64 + type: integer + id: + description: Unique identifier of the transfer. + example: pytmtd_2ide3qwTdDvNBosEC + type: string + object: + description: "Object name, which is bank_transfer_payout_method." + example: bank_transfer_payout_method + type: string + payee_id: + description: Unique identifier of the payee. + example: payee_2icdDewRxDENBos85 + type: string + type: + description: Type of the payee. + example: BankTransferPayoutMethod + type: string + title: transfer_method_response transfers_response: - title: transfers_response - description: A transfer represents the action of sending an amount to a business bank account including the status, amount and method used to make the transfer. - type: object + description: "A transfer represents the action of sending an amount to a business\ + \ bank account including the status, amount and method used to make the transfer." properties: amount: - type: integer + description: Amount in cents of the transfer. example: 10000 format: int64 - description: Amount in cents of the transfer. - created_at: type: integer + created_at: + description: Date and time of creation of the transfer. example: 1553273553 format: int64 - description: Date and time of creation of the transfer. + type: integer currency: - type: string + description: "The currency of the transfer. It uses the 3-letter code of\ + \ the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" example: MXN - description: The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) maxLength: 3 - id: type: string - example: 5b0337d4dD344ef954fe1X4b6 + id: description: Unique identifier of the transfer. + example: 5b0337d4dD344ef954fe1X4b6 + type: string livemode: - type: boolean + description: Indicates whether the transfer was created in live mode or + test mode. example: true - description: Indicates whether the transfer was created in live mode or test mode. + type: boolean method: - type: object - description: Method used to make the transfer. - title: transfer_method_response - properties: - account_holder: - type: string - example: John Doe - description: Name of the account holder. - account_number: - type: string - example: '012180023547896764' - description: Account number of the bank account. - bank: - type: string - example: BBVA Bancomer - description: Name of the bank. - created_at: - type: integer - example: 1553273553 - format: int64 - description: Date and time of creation of the transfer. - id: - type: string - example: pytmtd_2ide3qwTdDvNBosEC - description: Unique identifier of the transfer. - object: - type: string - example: bank_transfer_payout_method - description: Object name, which is bank_transfer_payout_method. - payee_id: - type: string - example: payee_2icdDewRxDENBos85 - description: Unique identifier of the payee. - type: - type: string - example: BankTransferPayoutMethod - description: Type of the payee. + $ref: "#/components/schemas/transfer_method_response" object: - type: string + description: "Object name, which is transfer." example: transfer - description: Object name, which is transfer. - statement_description: type: string - example: Conekta 4401234 + statement_description: description: Description of the transfer. - statement_reference: + example: Conekta 4401234 type: string - example: '4401234' + statement_reference: description: Reference number of the transfer. - status: + example: "4401234" type: string - example: pending + status: description: Code indicating transfer status. + example: pending + type: string + title: transfers_response + get_transfers_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + description: Transfers + items: + $ref: "#/components/schemas/transfers_response" + type: array + default: null + title: get_transfers_response + transfer_destination_response: + description: Method used to make the transfer. + properties: + account_holder: + description: Name of the account holder. + example: John Doe + type: string + account_number: + description: Account number of the bank account. + example: "012180023547896764" + type: string + bank: + description: Name of the bank. + example: BBVA Bancomer + type: string + created_at: + description: Date and time of creation of the transfer. + example: 1553273553 + format: int64 + type: integer + id: + description: Unique identifier of the transfer. + example: pytmtd_2ide3qwTdDvNBosEC + type: string + object: + description: "Object name, which is bank_transfer_payout_method." + example: bank_transfer_payout_method + type: string + payee_id: + description: Unique identifier of the payee. + example: payee_2icdDewRxDENBos85 + type: string + type: + description: Type of the payee. + example: BankTransferPayoutMethod + type: string + title: transfer_destination_response transfer_response: - title: transfer_response - description: A transfer represents the action of sending an amount to a business bank account including the status, amount and method used to make the transfer. - type: object + description: "A transfer represents the action of sending an amount to a business\ + \ bank account including the status, amount and method used to make the transfer." properties: amount: - type: integer + description: Amount in cents of the transfer. example: 10000 format: int64 - description: Amount in cents of the transfer. - created_at: type: integer + created_at: + description: Date and time of creation of the transfer in Unix format. example: 1553273553 format: int64 - description: Date and time of creation of the transfer in Unix format. + type: integer currency: - type: string + description: "The currency of the transfer. It uses the 3-letter code of\ + \ the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" example: MXN - description: The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) maxLength: 3 - id: type: string - example: 5b0337d4dD344ef954fe1X4b6 + id: description: Unique identifier of the transfer. + example: 5b0337d4dD344ef954fe1X4b6 + type: string livemode: - type: boolean + description: Indicates whether the transfer was created in live mode or + test mode. example: true - description: Indicates whether the transfer was created in live mode or test mode. + type: boolean destination: - type: object - description: Method used to make the transfer. - title: transfer_destination_response - properties: - account_holder: - type: string - example: John Doe - description: Name of the account holder. - account_number: - type: string - example: '012180023547896764' - description: Account number of the bank account. - bank: - type: string - example: BBVA Bancomer - description: Name of the bank. - created_at: - type: integer - example: 1553273553 - format: int64 - description: Date and time of creation of the transfer. - id: - type: string - example: pytmtd_2ide3qwTdDvNBosEC - description: Unique identifier of the transfer. - object: - type: string - example: bank_transfer_payout_method - description: Object name, which is bank_transfer_payout_method. - payee_id: - type: string - example: payee_2icdDewRxDENBos85 - description: Unique identifier of the payee. - type: - type: string - example: BankTransferPayoutMethod - description: Type of the payee. + $ref: "#/components/schemas/transfer_destination_response" object: - type: string + description: "Object name, which is transfer." example: transfer - description: Object name, which is transfer. - statement_description: type: string - example: Conekta 4401234 + statement_description: description: Description of the transfer. - statement_reference: + example: Conekta 4401234 type: string - example: '4401234' + statement_reference: description: Reference number of the transfer. - status: + example: "4401234" type: string - example: pending + status: description: Code indicating transfer status. - webhook-key_response: - title: webhook_key_response + example: pending + type: string + title: transfer_response + webhook_key_response: description: webhook keys model - type: object properties: id: - type: string - example: 62730ba6fb7dfd6a712f118e description: Unique identifier of the webhook key + example: 62730ba6fb7dfd6a712f118e + type: string active: - type: boolean - example: true description: Indicates if the webhook key is active + example: true + type: boolean created_at: - type: integer + description: Unix timestamp in seconds with the creation date of the webhook + key example: 1577836800 format: int64 - description: Unix timestamp in seconds with the creation date of the webhook key + type: integer deactivated_at: - type: - - integer - - 'null' - example: null + description: Unix timestamp in seconds with the deactivation date of the + webhook key format: int64 - description: Unix timestamp in seconds with the deactivation date of the webhook key + nullable: true + type: integer public_key: - type: string description: Public key to be used in the webhook - example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n' + example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END + PUBLIC KEY-----\n' + type: string livemode: - type: boolean - example: false description: Indicates if the webhook key is in live mode + example: false + type: boolean object: - type: string + description: "Object name, value is webhook_key" example: webhook_key - description: Object name, value is webhook_key - webhook-key_create_response: - title: webhook_key_create_response - description: webhook keys model - type: object + type: string + title: webhook_key_response + get_webhook_keys_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/webhook_key_response" + type: array + default: null + title: get_webhook_keys_response + webhook_key_request: properties: active: - type: boolean + default: true + description: Indicates if the webhook key is active example: true + type: boolean + title: webhook_key_request + webhook_key_create_response: + description: webhook keys model + properties: + active: description: Indicates if the webhook key is active + example: true + type: boolean created_at: - type: integer + description: Unix timestamp in seconds with the creation date of the webhook + key example: 1577836800 format: int64 - description: Unix timestamp in seconds with the creation date of the webhook key + type: integer id: - type: string - example: 62730ba6fb7dfd6a712f118e description: Unique identifier of the webhook key + example: 62730ba6fb7dfd6a712f118e + type: string livemode: - type: boolean - example: false description: Indicates if the webhook key is in live mode + example: false + type: boolean object: - type: string + description: "Object name, value is webhook_key" example: webhook_key - description: Object name, value is webhook_key - public_key: type: string + public_key: description: Public key to be used in the webhook - example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n' - webhook-key_delete_response: - title: webhook_key_delete_response - description: webhook keys model - type: object + example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END + PUBLIC KEY-----\n' + type: string + title: webhook_key_create_response + webhook_key_update_request: properties: active: + default: false + description: Indicates if the webhook key is active + example: false type: boolean - example: true + title: webhook_key_update_request + webhook_key_delete_response: + description: webhook keys model + properties: + active: description: Indicates if the webhook key is active + example: true + type: boolean created_at: - type: integer + description: Unix timestamp in seconds with the creation date of the webhook + key example: 1577836800 format: int64 - description: Unix timestamp in seconds with the creation date of the webhook key + type: integer deleted: - type: boolean - example: true description: Indicates if the webhook key is deleted + example: true + type: boolean id: - type: string - example: 62730ba6fb7dfd6a712f118e description: Unique identifier of the webhook key + example: 62730ba6fb7dfd6a712f118e + type: string livemode: - type: boolean - example: false description: Indicates if the webhook key is in live mode + example: false + type: boolean object: - type: string + description: "Object name, value is webhook_key" example: webhook_key - description: Object name, value is webhook_key + type: string + title: webhook_key_delete_response webhook_response: - title: webhook_response description: webhooks model - type: object properties: id: description: id of the webhook - type: string example: 6307a60c41de27127515a575 + type: string description: description: A name or brief explanation of what this webhook is used for - type: string example: Server payments processor + type: string livemode: description: Indicates if the webhook is in production - type: boolean example: true + type: boolean active: description: Indicates if the webhook is actived or not - type: boolean example: true + type: boolean object: - description: Object name, value is 'webhook' - type: string + description: "Object name, value is 'webhook'" example: event + type: string status: description: Indicates if the webhook is ready to receive events or failing - type: string example: listening + type: string subscribed_events: description: lists the events that will be sent to the webhook - type: array + example: + - charge.created + - charge.paid + - charge.under_fraud_review + - charge.fraudulent + - charge.refunded + - charge.preauthorized + - charge.declined + - charge.canceled + - charge.reversed + - charge.pending_confirmation items: type: string - example: - - charge.created - - charge.paid - - charge.under_fraud_review - - charge.fraudulent - - charge.refunded - - charge.preauthorized - - charge.declined - - charge.canceled - - charge.reversed - - charge.pending_confirmation + type: array + default: null url: description: url or endpoint of the webhook - type: string example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval + type: string + title: webhook_response + get_webhooks_response: + allOf: + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean + object: + description: "Object type, in this case is list" + example: list + type: string + required: + - has_more + - object + title: pagination metadata + - description: page metadata + properties: + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 + nullable: true + type: string + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 + nullable: true + type: string + title: page metadata + - properties: + data: + items: + $ref: "#/components/schemas/webhook_response" + type: array + default: null + title: get_webhooks_response webhook_request: - title: webhook_request description: a webhook - type: object - required: - - url properties: url: - type: string - format: url + description: Here you must place the URL of your Webhook remember that you + must program what you will do with the events received. Also do not forget + to handle the HTTPS protocol for greater security. example: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8 + format: url pattern: ^(?!.*(localhost|127\.0\.0\.1)).*$ - description: Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. + type: string subscribed_events: - type: array + description: events that will be sent to the webhook + example: customer.created items: type: string - example: customer.created - description: events that will be sent to the webhook - webhook_update_request: - title: update_webhook + type: array + default: null + required: + - url + title: webhook_request + update_webhook: description: an updated webhook - type: object properties: url: - type: string - format: url + description: Here you must place the URL of your Webhook remember that you + must program what you will do with the events received. Also do not forget + to handle the HTTPS protocol for greater security. example: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8 + format: url pattern: ^(?!.*(localhost|127\.0\.0\.1)).*$ - description: Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. + type: string subscribed_events: description: events that will be sent to the webhook - type: array + example: customer.created items: type: string - example: customer.created + type: array + default: null active: description: whether the webhook is active or not - type: boolean example: true + type: boolean + title: update_webhook securitySchemes: bearerAuth: - type: http scheme: bearer - parameters: - accept_language: - in: header - name: Accept-Language - description: Use for knowing which language to use - required: false - schema: - default: es - type: string - enum: - - es - - en - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - id: - in: path - name: id - description: Identifier of the resource - required: true - schema: - type: string - example: 6307a60c41de27127515a575 - x_child_company_id: - in: header - name: X-Child-Company-Id - description: In the case of a holding company, the company id of the child company to which will process the request. - required: false - schema: - default: null - type: string - example: 6441b6376b60c3a638da80af - limit: - in: query - name: limit - description: The numbers of items to return, the maximum value is 250 - required: false - schema: - type: integer - format: int32 - default: 20 - minimum: 1 - maximum: 250 - next_page: - in: query - name: next - description: next page - required: false - schema: - type: string - previous_page: - in: query - name: previous - description: previous page - required: false - schema: - type: string - search: - in: query - name: search - description: General order search, e.g. by mail, reference etc. - required: false - schema: - type: string - fiscal_entities_id: - in: path - name: fiscal_entities_id - description: identifier - required: true - schema: - type: string - example: fis_ent_2tQ8HkkfbauaKP9Ho - discount_lines_id: - in: path - name: discount_lines_id - description: discount line id identifier - required: true - schema: - type: string - example: dis_lin_2tQ974hSHcsdeSZHG - event_id: - in: path - name: event_id - description: event identifier - required: true - schema: - type: string - example: 6463d6e35a4c3e001819e760 - payment_status: - in: query - name: payment_status - description: Filters by order status - required: false - schema: - type: string - examples: - payment_status: - summary: Filters by order status - value: paid - last_payment_info.status: - in: query - name: last_payment_info.status - description: Filters by last payment info status - required: false - schema: - type: string - examples: - last_payment_info.status: - summary: Filters by last payment info status - value: pending_payment - created_at: - in: query - name: created_at - description: created equal to - required: false - schema: - type: integer - format: int64 - examples: - created_at: - summary: created equal to - value: 1612137600 - created_at_gte: - in: query - name: created_at.gte - description: created at greater than or equal to - required: false - schema: - type: integer - format: int64 - examples: - created_at.gte: - summary: created at greater than or equal to - value: 1612137600 - created_at_lte: - in: query - name: created_at.lte - description: created at less than or equal to - required: false - schema: - type: integer - format: int64 - examples: - created_at.lte: - summary: created at less than or equal to - value: 1612137600 - updated_at_gte: - in: query - name: updated_at.gte - description: updated at greater than or equal to - required: false - schema: - type: integer - format: int64 - examples: - updated_at.gte: - summary: updated at greater than or equal to - value: 1612137600 - updated_at_lte: - in: query - name: updated_at.lte - description: updated at less than or equal to - required: false - schema: - type: integer - format: int64 - examples: - updated_at.lte: - summary: updated at less than or equal to - value: 1612137600 - line_items_id: - in: path - name: line_item_id - description: identifier - required: true - schema: - type: string - example: line_item_2tQ8HkkfbauaKP9Ho - refund_id: - in: path - name: refund_id - description: refund identifier - required: true - schema: - type: string - example: 6407b5bee1329a000175ba11 - payment_method_id: - in: path - name: payment_method_id - description: Identifier of the payment method - required: true - schema: - type: string - example: src_2tQ974hSHcsdeSZHG - currency: - in: query - name: currency - description: currency of the object to be retrieved - required: false - schema: - type: string - examples: - currency: - summary: currency of the object to be retrieved - value: MXN - frequency: - in: query - name: frequency - description: frequency of the object to be retrieved - required: false - schema: - type: integer - examples: - frequency: - summary: Frequency of the object to be retrieved - value: 1 - shipping_id: - in: path - name: shipping_id - description: identifier - required: true - schema: - type: string - example: ship_lin_2tQ974hSHcsdeSZHG - shipping_contacts_id: - in: path - name: shipping_contacts_id - description: identifier - required: true - schema: - type: string - example: 6307a60c41de27127515a575 - customer_id: - in: path - name: customer_id - description: Identifier of the customer resource - required: true - schema: - type: string - example: cus_2tGzG1GxtDAZHEGPH - subscription_id: - in: path - name: id - description: Identifier of the subscription resource - required: true - schema: - type: string - example: sub_2tGzG1GxtDAZHEGPH - tax_id: - in: path - name: tax_id - description: identifier - required: true - schema: - type: string - example: tax_lin_2tQ974hSHcsdeSZHG - id_query: - in: query - name: id - description: id of the object to be retrieved - required: false - schema: - type: string - examples: - id: - summary: id of the object to be retrieved - value: 65412a893cd69a0001c25892 - charge_id: - in: query - name: charge_id - description: id of the charge used for filtering - required: false - schema: - type: string - examples: - charge_id: - summary: id of the charge used for filtering - value: 65412a893cd69a0001c25892 - type: - in: query - name: type - description: type of the object to be retrieved - required: false - schema: - type: string - examples: - type: - summary: type of the object to be retrieved - value: capture - url: - in: query - name: url - description: url for webhook filter - required: false - schema: - type: string - responses: - '401': - description: authentication error - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - message: Please include your access key in your request. - param: null - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - '402': - description: payment required error - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - message: The card could not be processed. - code: conekta.errors.processing.tokenization.used - debug_message: The token has already been used. - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - '403': - description: forbidden error - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - message: Unauthorized access service, please contact support team - code: conekta.errors.forbidden.authentication.invalid_whitelist_access - debug_message: Unauthorized access to whitelists service, please contact support team - log_id: 641b6d073cd9a50001515007 - object: error - type: processing_error - '404': - description: not found entity - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - message: The resource was not found. - param: null - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could not be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - '422': - description: parameter validation error - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - message: The token does not exist. - param: payment_method.token_id - code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token - debug_message: The token does not exist. - log_id: 641b6d813cd9a50001515017 - object: error - type: parameter_validation_error - '428': - description: Precondition Required - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - debug_message: The order cannot be modified because it has already a charge which is pending payment. - message: The order cannot be modified because it has already a charge which is pending payment. - param: null - code: conekta.errors.precondition_required.combo.order.cannot_be_updated_because_has_charge - log_id: 641b6e233cd9a50001515039 - object: error - type: precondition_required_error - '500': - description: internal server error - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - debug_message: There was a runtime error and Conekta engineers have been notified. - message: There was a runtime error and Conekta engineers have been notified. - param: null - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - 422_whitelist: - description: whitelist validation error - content: - application/vnd.conekta-v2.3.0+json: - schema: - $ref: '#/components/schemas/error' - example: - details: - - debug_message: The "custom_field" parameter is not allowed - message: El parametro "custom_field" no está permitido - code: conekta.errors.parameter_validation.whitelist - object: error - type: parameter_validation_error - log_id: 6462aa7c90fef20001633546 - requestBodies: - api_keys_create: - description: requested field for a api keys - content: - application/json: - schema: - $ref: '#/components/schemas/api_key_request' - required: true - charge_update: - description: requested field for update a charge - content: - application/json: - schema: - $ref: '#/components/schemas/charge_update_request' - required: true - charge_create: - description: requested field for a charge - content: - application/json: - schema: - $ref: '#/components/schemas/charge_request' - examples: - bnpl: - $ref: '#/components/examples/charge_bnpl' - cash: - $ref: '#/components/examples/charge_cash' - pay_by_bank: - $ref: '#/components/examples/charge_pbb' - required: true - customer: - description: requested field for customer - content: - application/json: - schema: - $ref: '#/components/schemas/customer' - required: true - update_customer: - description: requested field for customer - content: - application/json: - schema: - $ref: '#/components/schemas/update_customer' - required: true - customer_fiscal_entities: - description: requested field for customer fiscal entities - content: - application/json: - schema: - $ref: '#/components/schemas/customer_fiscal_entities_request' - required: true - customer_update_fiscal_entities: - description: requested field for customer update fiscal entities - content: - application/json: - schema: - $ref: '#/components/schemas/customer_update_fiscal_entities_request' - required: true - discount_line_create: - description: requested field for a discount lines - content: - application/json: - schema: - $ref: '#/components/schemas/order_discount_lines_request' - required: true - discount_line_update: - description: requested field for a discount lines - content: - application/json: - schema: - $ref: '#/components/schemas/update_order_discount_lines_request' - required: true - order: - description: requested field for order - content: - application/json: - schema: - $ref: '#/components/schemas/order_request' - examples: - order_with_charges: - $ref: '#/components/examples/order_with_charges' - order_with_bnpl_charges: - $ref: '#/components/examples/order_with_charges_bnpl' - order_with_pbb_charges: - $ref: '#/components/examples/order_with_charges_pbb' - order_with_checkout: - $ref: '#/components/examples/order_with_checkout' - order_with_checkout_and_force_save_card: - $ref: '#/components/examples/order_with_checkout_and_force_save_card' - order_with_subscription: - $ref: '#/components/examples/order_with_subscription' - split_payment_with_2_card_charges: - $ref: '#/components/examples/split_payment_with_2_cards' - split_payment_with_3_cash_charges: - $ref: '#/components/examples/split_payment_with_cash' - split_payment_with_cash_card_charges: - $ref: '#/components/examples/split_payment_with_cash_card' - required: true - order_update: - description: requested field for an order - content: - application/json: - schema: - $ref: '#/components/schemas/order_update_request' - required: true - product_create: - description: requested field for a product - content: - application/json: - schema: - $ref: '#/components/schemas/product' - required: true - product_update: - description: requested field for products - content: - application/json: - schema: - $ref: '#/components/schemas/update_product' - required: true - order_refunds_request: - description: requested field for a refund - required: true - content: - application/json: - schema: - required: - - amount - - reason - properties: - amount: - type: integer - example: 500 - description: Amount to be refunded in cents - expires_at: - type: integer - example: 1553273553 - format: int64 - reason: - type: string - example: suspected_fraud - description: Reason for the refund - payout_order: - description: requested field for payout order - content: - application/json: - schema: - $ref: '#/components/schemas/payout_order' - required: true - checkout: - description: requested field for checkout - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/checkout' - examples: - create_checkout_with_plan_ids: - $ref: '#/components/examples/create_checkout_with_plan_ids' - checkout_email: - description: requested field for sms checkout - content: - application/json: - schema: - type: object - required: - - email - properties: - email: - type: string - example: example@conekta.com - format: email - required: true - checkout_sms: - description: requested field for sms checkout - content: - application/json: - schema: - type: object - required: - - phonenumber - properties: - phonenumber: - type: string - example: '5566982090' - required: true - customer_payment_methods: - description: requested field for customer payment methods - content: - application/json: - schema: - description: Contains details of the payment methods that the customer has active or has used in Conekta - oneOf: - - $ref: '#/components/schemas/payment_method_token_request' - - $ref: '#/components/schemas/payment_method_cash_request' - - $ref: '#/components/schemas/payment_method_spei_request' - examples: - card: - value: - type: card - token_id: tok_test_visa_4242 - cash: - value: - type: spei_recurrent - expires_at: 1553273553 - required: true - customer_update_payment_methods: - description: requested field for customer payment methods - content: - application/json: - schema: - $ref: '#/components/schemas/update_payment_methods' - required: true - plan: - description: requested field for plan - content: - application/json: - schema: - $ref: '#/components/schemas/plan_request' - required: true - plan_update: - description: requested field for plan - content: - application/json: - schema: - $ref: '#/components/schemas/plan_update_request' - required: true - shipping_create: - description: requested field for a shipping - content: - application/json: - schema: - $ref: '#/components/schemas/shipping_request' - required: true - customer_shipping_contacts: - description: requested field for customer shippings contacts - content: - application/json: - schema: - $ref: '#/components/schemas/customer_shipping_contacts' - required: true - customer_update_shipping_contacts: - description: requested field for customer update shippings contacts - content: - application/json: - schema: - $ref: '#/components/schemas/customer_update_shipping_contacts' - required: true - subscription: - description: requested field for subscriptions - content: - application/json: - schema: - $ref: '#/components/schemas/subscription_request' - required: true - subscription_update: - description: requested field for update a subscription - content: - application/json: - schema: - $ref: '#/components/schemas/subscription_update_request' - required: true - order_tax: - description: requested field for a taxes - content: - application/json: - schema: - $ref: '#/components/schemas/order_tax_request' - required: true - order_tax_update: - description: requested field for taxes - content: - application/json: - schema: - $ref: '#/components/schemas/update_order_tax_request' - required: true - token: - description: requested field for token - content: - application/json: - schema: - $ref: '#/components/schemas/token' - required: true - webhook: - description: requested field for webhook - content: - application/json: - schema: - $ref: '#/components/schemas/webhook_request' - required: true - webhook_update: - description: requested fields in order to update a webhook - content: - application/json: - schema: - $ref: '#/components/schemas/webhook_update_request' - required: true - examples: - charge_bnpl: - value: - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure - product_type: aplazo_bnpl - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success - type: bnpl - charge_cash: - value: - payment_method: - type: cash - charge_pbb: - value: - payment_method: - expires_at: 1680397724 - product_type: bbva_pay_by_bank - type: pay_by_bank - order_with_charges: - summary: Create an order with charges - value: - charges: - - amount: 40000 - expires_at: 1677196303 - monthly_installments: 0 - payment_method: - type: card - token_id: tok_2897348234 - payment_source_id: src_2tLkkyfMPh6v7pFry - customer_ip_address: 0.0.0.0 - reference_id: string - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: '5522997233' - corporate: false - object: customer_info - fiscal_entity: - tax_id: '1234567890' - name: Conekta Inc - email: test@gmail.com - phone: '525511223344' - metadata: - test: true - company_id: '123' - address: - street1: Nuevo Leon 254 - street2: Departamento 404 - postal_code: '06100' - city: Ciudad de Mexico - state: Ciudad de Mexico - country: MX - external_number: '123' - discount_lines: - - amount: 500 - code: '123' - type: loyalty - line_items: - - antifraud_info: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - metadata: - test: true - company_id: '123' - pre_authorize: false - shipping_contact: - phone: '525511223344' - receiver: Marvin Fuller - between_streets: Ackerman Crescent - metadata: - test: true - company_id: '123' - address: - street1: Nuevo Leon 254 - street2: Departamento 404 - postal_code: '06100' - city: Ciudad de Mexico - state: Ciudad de Mexico - country: MX - residential: true - parent_id: string - default: true - deleted: true - shipping_lines: - - amount: 100 - carrier: FEDEX - tracking_number: TRACK123 - method: TRAING - metadata: - key: value - tax_lines: - - amount: 100 - description: testing - metadata: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - order_with_charges_bnpl: - summary: Create an order with a bnpl charge - value: - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_name: Test creditea - checkout_request_type: PaymentLink - charges: - - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure - product_type: aplazo_bnpl - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success - type: bnpl - currency: MXN - customer_info: - customer_id: cus_2xZfwfjXxX9tZhVey - line_items: - - name: Test creditea - quantity: 1 - unit_price: 300000 - order_with_charges_pbb: - summary: Create an order with a pay by bank charge - value: - charges: - - payment_method: - product_type: bbva_pay_by_bank - type: pay_by_bank - currency: MXN - customer_info: - customer_id: cus_2xZfwfjXxX9tZhVey - line_items: - - name: Test pay by bank - quantity: 1 - unit_price: 300000 - order_with_checkout: - summary: Create an order with checkout - value: - checkout: - allowed_payment_methods: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - expires_at: 0 - failure_url: string - monthly_installments_enabled: false - monthly_installments_options: - - 0 - name: string - on_demand_enabled: true - success_url: string - type: Integration - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: '5522997233' - corporate: false - object: customer_info - discount_lines: - - amount: 500 - code: '123' - type: loyalty - line_items: - - antifraud_info: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - pre_authorize: false - 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 - parent_id: string - default: true - deleted: true - shipping_lines: - - amount: 100 - carrier: FEDEX - tracking_number: TRACK123 - method: TRAING - metadata: - key: value - tax_lines: - - amount: 100 - description: testing - metadata: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - order_with_checkout_and_force_save_card: - summary: Create an order with checkout and force save card - value: - checkout: - allowed_payment_methods: - - card - force_save_card: true - name: Compra - type: Integration - currency: MXN - customer_info: - customer_id: cus_2n9g6x7q1w5k8v3a - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - order_with_subscription: - summary: Create an order with subscription plans - value: - checkout: - allowed_payment_methods: - - card - plan_ids: - - nuevo-plan - expires_at: 1746015865 - failure_url: string - monthly_installments_enabled: false - name: Embebido Prueba - on_demand_enabled: true - success_url: string - type: Integration - max_failed_retries: 3 - is_redirect_on_failure: true - currency: MXN - customer_info: - name: Prueba - email: prueba@prueba.com - phone: '+5218181818181' - corporate: false - object: customer_info - shipping_lines: - - amount: 0 - metadata: - key: value - split_payment_with_2_cards: - summary: Create an order with 2 card charges - value: - charges: - - amount: 40000 - payment_method: - type: card - token_id: tok_2897348234 - - amount: 40000 - payment_method: - type: card - token_id: tok_2897348235 - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: '5522997233' - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 40000 - quantity: 2 - brand: string - split_payment_with_cash: - summary: Create an order with 3 cash charges - value: - charges: - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: '5522997233' - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 10000 - quantity: 3 - brand: string - split_payment_with_cash_card: - summary: Create an order with 3 cash and 2 card charges - value: - charges: - - amount: 10000 - payment_method: - type: card - token_id: tok_2897348234 - - amount: 10000 - payment_method: - type: card - token_id: tok_2897348235 - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: '5522997233' - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 50000 - quantity: 1 - brand: string - order_cash: - value: - livemode: true - amount: 1560 - currency: MXN - payment_status: pending_payment - amount_refunded: 0 - split_payment: false - customer_info: - email: franco.longhi@conekta.com - phone: 539-933-3810 - name: franco golden - corporate: null - customer_id: null - object: customer_info - shipping_contact: null - channel: null - fiscal_entity: null - object: order - id: ord_2xayxSvfWzQ2TLz7r - metadata: {} - is_refundable: false - processing_mode: null - created_at: 1741103510 - updated_at: 1741103510 - line_items: - object: list - has_more: false - total: 1 - data: - - name: APOYO URGENTE REFERENCIA - description: null - unit_price: 1560 - quantity: 1 - sku: COL094 - tags: null - brand: CHEDRAUI - type: null - object: line_item - id: line_item_2xayxSvfWzQ2TLz7p - parent_id: ord_2xayxSvfWzQ2TLz7r - metadata: {} - antifraud_info: {} - shipping_lines: null - tax_lines: null - discount_lines: null - charges: - object: list - has_more: false - total: 1 - data: - - id: 67c72196e777ac0001f2140c - livemode: true - created_at: 1741103510 - currency: MXN - failure_code: null - failure_message: null - monthly_installments: null - device_fingerprint: null - channel: null - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001140326893401915.png - store: null - auth_code: null - agreement: null - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - reference: 10001140326893402000 - cashier_id: null - product_type: cash_in - object: charge - description: Payment from order - is_refundable: false - reference_id: null - status: pending_payment - amount: 1560 - paid_at: null - customer_id: '' - order_id: ord_2xayxSvfWzQ2TLz7r - refunds: null - order_cash_multiple: - value: - livemode: true - amount: 156000 - currency: MXN - payment_status: pending_payment - amount_refunded: 0 - split_payment: false - customer_info: - email: franco.longhi@conekta.com - phone: 884-712-6894 - name: franco golden - corporate: null - customer_id: null - object: customer_info - shipping_contact: null - channel: null - fiscal_entity: null - object: order - id: ord_2xazGvtKYTjxTUZU3 - metadata: {} - is_refundable: false - processing_mode: null - created_at: 1741104962 - updated_at: 1741104963 - line_items: - object: list - has_more: false - total: 1 - data: - - name: APOYO URGENTE REFERENCIA - description: null - unit_price: 156000 - quantity: 1 - sku: COL094 - tags: null - brand: CHEDRAUI - type: null - object: line_item - id: line_item_2xazGvtKYTjxTUZU1 - parent_id: ord_2xazGvtKYTjxTUZU3 - metadata: {} - antifraud_info: {} - shipping_lines: null - tax_lines: null - discount_lines: null - charges: - object: list - has_more: false - total: 2 - data: - - id: 67c72742e777ac0001f21463 - livemode: true - created_at: 1741104962 - currency: MXN - failure_code: null - failure_message: null - monthly_installments: null - device_fingerprint: null - channel: null - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/bbva/10830309851141878231.png - store: null - auth_code: null - agreement: '2409992' - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - BBVA ATM - reference: 10830309851141878000 - cashier_id: null - product_type: bbva_cash_in - object: charge - description: Payment from order - is_refundable: false - reference_id: null - status: pending_payment - amount: 156000 - paid_at: null - customer_id: '' - order_id: ord_2xazGvtKYTjxTUZU3 - refunds: null - - id: 67c72742e777ac0001f2145b - livemode: true - created_at: 1741104962 - currency: MXN - failure_code: null - failure_message: null - monthly_installments: null - device_fingerprint: null - channel: null - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001244873740402013.png - store: null - auth_code: null - agreement: null - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - reference: 10001244873740403000 - cashier_id: null - product_type: cash_in - object: charge - description: Payment from order - is_refundable: false - reference_id: null - status: pending_payment - amount: 156000 - paid_at: null - customer_id: '' - order_id: ord_2xazGvtKYTjxTUZU3 - refunds: null - order_card: - value: - id: 63dab7d00558720001bb3c7d - livemode: true, - created_at: 1675278289, - currency: MXN - failure_code: suspected_fraud - failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso. - device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - payment_method: - name: Fulanito Perez - exp_month: 2 - exp_year: 30 - object: card_payment - type: credit - last4: 4242 - brand: visa - issuer: BANAMEX - account_type: Credit - country: MX - fraud_indicators: - - description: El usuario está utilizando una tarjeta de crédito o débito de prueba en modo producción. - weight: null - value: null - object: charge - description: Payment from order - status: declined - amount: 20001, - fee: 116, - customer_id: null - order_id: ord_2tHuwPhgSwq6Gt7Rg - order_bnpl: - value: - amount: 300000 - amount_refunded: 0 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pWw - segment: Checkout - charges: - data: - - amount: 300000 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pXA - segment: Checkout - created_at: 1741015718 - currency: MXN - customer_id: '' - description: Payment from order - device_fingerprint: null - failure_code: null - failure_message: null - id: 67c5caa665f9b400015dec40 - is_refundable: false - livemode: true - monthly_installments: null - object: charge - order_id: ord_2xaegxs5s69VP4pWy - paid_at: null - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - expires_at: 1743694118 - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - object: bnpl_payment - product_type: aplazo_bnpl - redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - type: bnpl - reference_id: null - refunds: null - status: pending_payment - has_more: false - object: list - total: 1 - checkout: null - created_at: 1741015718 - currency: MXN - customer_info: - corporate: false - customer_custom_reference: null - customer_id: cus_2xZfwfjXxX9tZhVey - email: alexis.ruiz@google.com - name: Pedro Ruiz - object: customer_info - phone: '+5215555555555' - discount_lines: null - fiscal_entity: null - id: ord_2xaegxs5s69VP4pWy - is_refundable: false - line_items: - data: - - antifraud_info: {} - brand: null - description: null - id: line_item_2xaegxs5s69VP4pWv - metadata: {} - name: Test creditea - object: line_item - parent_id: ord_2xaegxs5s69VP4pWy - quantity: 1 - sku: null - tags: null - type: null - unit_price: 300000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - payment_status: pending_payment - processing_mode: null - shipping_contact: null - shipping_lines: null - split_payment: false - tax_lines: null - updated_at: 1741015718 - order_pbb: - value: - amount: 300000 - amount_refunded: 0 - charges: - data: - - amount: 300000 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pXA - segment: Checkout - created_at: 1741015718 - currency: MXN - customer_id: '' - description: Payment from order - device_fingerprint: null - failure_code: null - failure_message: null - id: 67c5caa665f9b400015dec40 - is_refundable: false - livemode: true - monthly_installments: null - object: charge - order_id: ord_2xaegxs5s69VP4pWy - paid_at: null - payment_method: - expires_at: 1743694118 - object: pay_by_bank_payment - product_type: bbva_pay_by_bank - redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ - deep_link: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 - type: pay_by_bank - reference: '22277523174328893295' - reference_id: null - refunds: null - status: pending_payment - has_more: false - object: list - total: 1 - checkout: null - created_at: 1741015718 - currency: MXN - customer_info: - corporate: false - customer_custom_reference: null - customer_id: cus_2xZfwfjXxX9tZhVey - email: alexis.ruiz@google.com - name: Pedro Ruiz - object: customer_info - phone: '+5215555555555' - discount_lines: null - fiscal_entity: null - id: ord_2xaegxs5s69VP4pWy - is_refundable: false - line_items: - data: - - antifraud_info: {} - brand: null - description: null - id: line_item_2xaegxs5s69VP4pWv - metadata: {} - name: Test pay by bank - object: line_item - parent_id: ord_2xaegxs5s69VP4pWy - quantity: 1 - sku: null - tags: null - type: null - unit_price: 300000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - payment_status: pending_payment - processing_mode: null - shipping_contact: null - shipping_lines: null - split_payment: false - tax_lines: null - updated_at: 1741015718 - order_checkout: - value: - amount: 12000 - amount_refunded: 0 - charges: null - checkout: - allowed_payment_methods: - - card - - bnpl - - cash - - pay_by_bank - - bank_transfer - - apple - can_not_expire: false - emails_sent: 0 - exclude_card_networks: [] - expires_at: 1772171999 - failure_url: https://natalie.net - force_3ds_flow: false - id: 1263626c-53ae-4829-b092-2e7393f2d1b7 - is_redirect_on_failure: true - livemode: true - max_failed_retries: null - metadata: {} - monthly_installments_enabled: false - monthly_installments_options: [] - name: Pago de Servicio - needs_shipping_contact: false - object: checkout - paid_payments_count: 0 - payments_limit_count: null - plan_id: null - recurrent: false - redirection_time: null - slug: 1263626c53ae4829b0922e7393f2d1b7 - sms_sent: 0 - starts_at: 1771912800 - status: Issued - success_url: https://giovanna.info - three_ds_mode: null - type: HostedPayment - url: https://pay.conekta.com/checkout/1263626c53ae4829b0922e7393f2d1b7 - channel: - checkout_request_id: 1263626c-53ae-4829-b092-2e7393f2d1b7 - checkout_request_type: HostedPayment - id: channel_2zbhetCd6CmpJeFsY - original_checkout_request_id: null - original_checkout_request_type: null - segment: Checkout - created_at: 1771950546 - currency: MXN - customer_info: - corporate: null - customer_id: null - date_of_birth: null - email: xono.bernie@conekta.com - name: Juan Rosas - national_id: null - object: customer_info - phone: '5531431590' - discount_lines: null - fiscal_entity: null - id: ord_2zbhesToa1DAgNbP6 - is_refundable: false - line_items: - data: - - antifraud_info: {} - brand: addidas - description: null - id: line_item_2zbhesToa1DAgNbP3 - metadata: {} - name: Aretes Tres Círculos Numerales - object: line_item - parent_id: ord_2zbhesToa1DAgNbP6 - quantity: 1 - sku: COL094 - tags: null - type: null - unit_price: 10000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - payment_status: null - processing_mode: null - shipping_contact: null - shipping_lines: null - split_payment: null - tax_lines: - data: - - amount: 2000 - description: test - id: tax_lin_2zbhesToa1DAgNbP4 - metadata: null - object: tax_line - parent_id: ord_2zbhesToa1DAgNbP6 - has_more: false - object: list - total: 1 - updated_at: 1771950546 - create_checkout_with_plan_ids: - summary: Create Checkout with Plan IDs - value: - name: Payment Link con Plan - type: PaymentLink - recurrent: false - expires_at: 1745331574 - allowed_payment_methods: - - card - needs_shipping_contact: false - plan_ids: - - plan_ejemplo_1 - - plan_ejemplo_2 - order_template: - line_items: - - name: Producto de Ejemplo - unit_price: 15000 - quantity: 1 - currency: MXN - customer_info: - name: Cliente Ejemplo - email: ejemplo@conekta.com - phone: '5555555555' - metadata: - reference: mi_referencia_123 - more_info: datos_adicionales - customer_payment_source_cash_example: - value: - next_page_url: null, - previous_page_url: null, - has_more: false, - object: list, - data: - - id: off_ref_2xayPUpcxeTrotDHr - object: payment_source - provider: Cash - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - - BBVA ATM - type: cash_recurrent - reference: 10001189383263801812_caca - barcode: 10001189383263801000 - barcode_url: https://barcode.conekta.com/cash/cashin/10001189383263801812.png - expires_at: 0 - created_at: 1741100921 - parent_id: cus_2xayPFXsb4LBZ2GUL - agreements: - - provider: bbva_cash_in - agreement: 2409526 - shipping: - value: - amount: 0 - carrier: Fedex - method: Airplane - tracking_number: TRACK123 - object: shipping_line - id: ship_lin_2sLxi45ZFs1GHJmzx - parent_id: ord_2sLxi3MqYFJ1QfTmP - deleted: true + type: http From 60544bdaeb1c288f459830a72c8ab562171b19ea Mon Sep 17 00:00:00 2001 From: Leo Fischer Date: Mon, 6 Jul 2026 11:32:45 -0400 Subject: [PATCH 10/10] fix(bnpl): cancel_url and expires_at are nullable payments-api validates both as [String, Null] / [Integer, Null] (conekta/payments-api#6466): wrong types are rejected, explicit null and absence are accepted. Co-Authored-By: Claude Fable 5 --- _build/api.yaml | 2 ++ schemas/customers/payment_method_bnpl_request.yml | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index 7b0523a..9ad79a4 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -16610,12 +16610,14 @@ components: cancel_url: description: Optional URL to redirect the customer after a canceled payment example: https://example.com/cancel + nullable: true type: string expires_at: description: "Optional expiry for the BNPL order, expressed in seconds\ \ since the Unix epoch. Defaults to one month from creation when omitted." example: 1680397724 format: int64 + nullable: true type: integer failure_url: description: URL to redirect the customer after a failed payment diff --git a/schemas/customers/payment_method_bnpl_request.yml b/schemas/customers/payment_method_bnpl_request.yml index 20249a5..68042ed 100644 --- a/schemas/customers/payment_method_bnpl_request.yml +++ b/schemas/customers/payment_method_bnpl_request.yml @@ -9,11 +9,11 @@ allOf: - type properties: cancel_url: - type: string + type: [string, "null"] description: "Optional URL to redirect the customer after a canceled payment" example: "https://example.com/cancel" expires_at: - type: integer + type: [integer, "null"] format: int64 example: 1680397724 description: "Optional expiry for the BNPL order, expressed in seconds since the Unix epoch. Defaults to one month from creation when omitted."