openapi: 3.1.0
info:
  contact:
    email: engineering@conekta.com
    name: Engineering Conekta
    url: https://github.com/conekta/openapi/issues
  description: Conekta sdk
  license:
    name: MIT-LICENSE
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Conekta API
  version: 2.2.0
servers:
- description: Conekta main server
  url: https://api.conekta.io
security:
- bearerAuth: []
tags:
- 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:
      description: Return all rules
      operationId: GetRuleWhitelist
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/risk_rules_list"
          description: All the rules
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
    post:
      operationId: CreateRuleWhitelist
      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"
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/whitelistlist_rule_response"
          description: successfully registered rule
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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:
      operationId: DeleteRuleWhitelist
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/deleted_whitelist_rule_response"
          description: successfully deleted rule
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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:
      description: Return all rules
      operationId: GetRuleBlacklist
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/risk_rules_list"
          description: All the rules
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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
    post:
      operationId: CreateRuleBlacklist
      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"
        description: requested field for blacklist rule
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/blacklist_rule_response"
          description: successfully registered rule
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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:
      operationId: DeleteRuleBlacklist
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/deleted_blacklist_rule_response"
          description: successfully deleted rule
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/get_api_keys_response"
          description: successful
          headers:
            Content-Type:
              description: The format of the response body
              explode: false
              schema:
                example: application/json; charset=utf-8
                type: string
              style: simple
            Conekta-Media-Type:
              explode: false
              schema:
                example: conekta-v2.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Api Keys
      tags:
      - 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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/api_key_create_response"
          description: successful operation
          headers:
            Content-Type:
              description: The format of the response body
              explode: false
              schema:
                example: application/json; charset=utf-8
                type: string
              style: simple
            Conekta-Media-Type:
              explode: false
              schema:
                example: conekta-v2.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Api Key
      tags:
      - 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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/delete_api_keys_response"
          description: successful
          headers:
            Content-Type:
              description: The format of the response body
              explode: false
              schema:
                example: application/json; charset=utf-8
                type: string
              style: simple
            Conekta-Media-Type:
              explode: false
              schema:
                example: conekta-v2.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Api Key
      tags:
      - Api Keys
    get:
      description: Gets a api key that corresponds to a api key ID
      operationId: getApiKey
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/api_key_response"
          description: successful
          headers:
            Content-Type:
              description: The format of the response body
              explode: false
              schema:
                example: application/json; charset=utf-8
                type: string
              style: simple
            Conekta-Media-Type:
              explode: false
              schema:
                example: conekta-v2.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Api Key
      tags:
      - Api Keys
    put:
      description: Update an existing api key
      operationId: updateApiKey
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/api_key_response"
          description: successful operation
        "404":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 company's balance
      tags:
      - Balances
  /charges:
    get:
      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
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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 Charges
      tags:
      - Charges
  /charges/{id}:
    put:
      operationId: updateCharge
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 a charge
      tags:
      - Charges
  /orders/{id}/charges:
    post:
      description: Create charge for an existing orden
      operationId: ordersCreateCharge
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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:
                    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
                    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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/charge_order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 charge
      tags:
      - Charges
  /orders/{id}/add_charges:
    post:
      description: Create charges for an existing orden
      operationId: ordersCreateCharges
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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:
                    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
                    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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/charges_order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 charges
      tags:
      - Charges
  /companies:
    get:
      description: Consume the list of child companies.  This is used for holding
        companies with several child entities.
      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
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Companies
      tags:
      - Companies
    post:
      description: Create a new company.
      operationId: createCompany
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Create_Company_Request"
        description: Company data
        required: true
      responses:
        "201":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Company
      tags:
      - Companies
  /companies/{id}:
    get:
      operationId: getCompany
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              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
            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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Company
      tags:
      - Companies
  /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.
      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
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              example:
                id: 2a1b3c4d5e6f7g8h9i0j1k2l
                name: Mi Empresa S.A. de C.V.
                mcc: "5311"
                active: true
                account_status: activated
                antifraud_vertical: physical_goods
                created_at: 1510699009
                payment_link_enabled: true
                commercial_info:
                  web_page: https://miempresa.mx
                  facebook: ""
                  category: Venta al menudeo
                  average_sale: Range10KPlus
                  monthly_sales: Range0To100K
                  shipping: false
                  physical: false
                  already_selling: true
                  tos_page: https://miempresa.com/terminos
                  website_instructions: ""
                  object: commercial_info
                legal_info:
                  name: MARIA GONZALEZ
                  email: maria.gonzalez@miempresa.com
                  identification_type: ife
                  signed_contract_uploaded: false
                  curp: GOMA930207MSLNZR00
                  object: legal_info
                fiscal_info:
                  tax_id: EMP121008MU7
                  legal_entity_name: Mi Empresa S.A. de C.V.
                  business_type: Persona moral
                  phone: "5563794965"
                  address:
                    street1: AVENIDA INSURGENTES
                    street2: ROMA NORTE
                    street3: Cuauhtémoc
                    city: México
                    state: CIUDAD DE MEXICO
                    country: MEX
                    zip: "06700"
                    external_number: "123"
                    internal_number: "201"
                    object: address
                  bank_account:
                    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."
                    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
                  object: fiscal_info
                user_accounts:
                - role: owner
                  token: "1234567890"
                  livemode: true
                  object: user_account
                capture_fees:
                  oxxo_commission: 0.035
                  banorte_commission: 0.01
                  spei_commission: 0.01
                  amex_commission: 0.029
                  credit_commission: 0.029
                  debit_commission: 0.029
                  oxxo_fixed_cost: 0
                  banorte_fixed_cost: 1200
                  spei_fixed_cost: 800
                  amex_fixed_cost: 250
                  credit_fixed_cost: 250
                  debit_fixed_cost: 250
                  credit_three_month_installments_commission: 0.049
                  credit_six_month_installments_commission: 0.079
                  credit_nine_month_installments_commission: 0.109
                  credit_twelve_month_installments_commission: 0.139
                  amex_three_month_installments_commission: 0.039
                  amex_six_month_installments_commission: 0.059
                  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
                object: company
                oxxo_payments_enabled: true
                spei_payments_enabled: true
                card_payments_enabled: true
                bnpl_payments_enabled: true
                direct_debit_payments_enabled: true
                voucher_card_enabled: false
                card_max_limit: 10000000
                voucher_card_categories: []
                internal_scopes:
                - 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
            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:
              description: The version of the API used to process the request and
                the format of the response body
              explode: false
              schema:
                example: conekta-v2.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Current Company
      tags:
      - Companies
  /companies/{company_id}/document:
    patch:
      description: Updates an existing document associated with a specific company.
      operationId: updateCompanyDocument
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CompanyDocumentRequest"
        description: Document information to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Company Document
      tags:
      - Companies
    post:
      description: Uploads a document associated with a specific company.
      operationId: uploadCompanyDocument
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CompanyDocumentRequest"
        description: Document information to upload.
        required: true
      responses:
        "201":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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: Upload Company Document
      tags:
      - Companies
  /companies/{company_id}/documents:
    get:
      description: Retrieve a list of documents associated with a specific company.
      operationId: getCompanyDocuments
      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
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                items:
                  $ref: "#/components/schemas/CompanyDocumentResponse"
                type: array
          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
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Company Documents
      tags:
      - 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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 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
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/customer"
        description: requested field for customer
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 customer
      tags:
      - Customers
  /customers/{id}:
    delete:
      description: Deleted a customer resource that corresponds to a customer ID.
      operationId: deleteCustomerById
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/customer_response"
          description: successful operation
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Customer
      tags:
      - Customers
    get:
      description: Gets a customer resource that corresponds to a customer ID.
      operationId: getCustomerById
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/customer_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
    put:
      description: You can update customer-related data
      operationId: updateCustomer
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/customer_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 customer
      tags:
      - Customers
  /customers/{id}/fiscal_entities:
    post:
      description: Create Fiscal entity resource that corresponds to a customer ID.
      operationId: CreateCustomerFiscalEntities
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/create_customer_fiscal_entities_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Fiscal Entity
      tags:
      - Customers
  /customers/{id}/fiscal_entities/{fiscal_entities_id}:
    put:
      description: Update Fiscal Entity resource that corresponds to a customer ID.
      operationId: UpdateCustomerFiscalEntities
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: fis_ent_2tQ8HkkfbauaKP9Ho
        explode: false
        in: path
        name: fiscal_entities_id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/update_customer_fiscal_entities_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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  Fiscal Entity
      tags:
      - Customers
  /orders/{id}/discount_lines:
    get:
      description: Get discount lines for an existing orden
      operationId: ordersGetDiscountLines
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/get_order_discount_lines_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Discount
      tags:
      - Discounts
    post:
      description: Create discount lines for an existing orden
      operationId: ordersCreateDiscountLine
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/discount_lines_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Discount
      tags:
      - 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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: discount line id identifier
        example: dis_lin_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: discount_lines_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/discount_lines_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: discount line id identifier
        example: dis_lin_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: discount_lines_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/discount_lines_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: discount line id identifier
        example: dis_lin_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: discount_lines_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/discount_lines_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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:
                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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Events
      tags:
      - Events
  /events/{id}:
    get:
      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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Event
      tags:
      - Events
  /events/{event_id}/resend:
    post:
      description: Resend event to selected webhooks
      operationId: resendEvent
      parameters:
      - description: event identifier
        example: 6463d6e35a4c3e001819e760
        explode: false
        in: path
        name: event_id
        required: true
        schema:
          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/resendEvent_request"
        description: requested fields for resend an event
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/events_resend_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Logs
      tags:
      - Logs
  /logs/{id}:
    get:
      description: Get the details of a specific log
      operationId: getLogById
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/log_response_for_request"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Log
      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
        explode: true
        in: query
        name: payment_status
        required: false
        schema:
          example: paid
          type: string
        style: form
      - description: Filters by last payment info status
        explode: true
        in: query
        name: last_payment_info.status
        required: false
        schema:
          example: pending_payment
          type: string
        style: form
      - description: created equal to
        explode: true
        in: query
        name: created_at
        required: false
        schema:
          example: 1612137600
          format: int64
          type: integer
        style: form
      - description: created at greater than or equal to
        explode: true
        in: query
        name: created_at.gte
        required: false
        schema:
          example: 1612137600
          format: int64
          type: integer
        style: form
      - description: created at less than or equal to
        explode: true
        in: query
        name: created_at.lte
        required: false
        schema:
          example: 1612137600
          format: int64
          type: integer
        style: form
      - description: updated at greater than or equal to
        explode: true
        in: query
        name: updated_at.gte
        required: false
        schema:
          example: 1612137600
          format: int64
          type: integer
        style: form
      - description: updated at less than or equal to
        explode: true
        in: query
        name: updated_at.lte
        required: false
        schema:
          example: 1612137600
          format: int64
          type: integer
        style: form
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/get_orders_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Orders
      tags:
      - 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:
                      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
                      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_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":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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 order
      tags:
      - Orders
  /orders/{id}:
    get:
      description: Info for a specific order
      operationId: getOrderById
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Order
      tags:
      - Orders
    put:
      description: Update an existing Order.
      operationId: updateOrder
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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/order_update"
        description: requested field for an order
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Order
      tags:
      - Orders
  /orders/{id}/cancel:
    post:
      description: Cancel an order that has been previously created.
      operationId: CancelOrder
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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: Capture Order
      tags:
      - Orders
  /orders/{id}/line_items:
    post:
      description: Create a new product for an existing order.
      operationId: ordersCreateProduct
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/product_order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: line_item_2tQ8HkkfbauaKP9Ho
        explode: false
        in: path
        name: line_item_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/product_order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: line_item_2tQ8HkkfbauaKP9Ho
        explode: false
        in: path
        name: line_item_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/product_order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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:
      - 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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: refund identifier
        example: 6407b5bee1329a000175ba11
        explode: false
        in: path
        name: refund_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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.2.0+json:
              schema:
                $ref: "#/components/schemas/payout_orders_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.0+json:
              schema:
                $ref: "#/components/schemas/payout_order_response"
          description: successful operation
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/payout_order_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/payout_order_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 payment links
      tags:
      - Payment Link
    post:
      operationId: createCheckout
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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:
              description: The version of the API used to process the request and
                the format of the response body
              explode: false
              schema:
                example: conekta-v2.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Unique Payment Link
      tags:
      - Payment Link
  /checkouts/{id}:
    get:
      operationId: getCheckout
      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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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 payment link by ID
      tags:
      - Payment Link
  /checkouts/{id}/cancel:
    put:
      operationId: cancelCheckout
      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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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 Payment Link
      tags:
      - Payment Link
  /checkouts/{id}/email:
    post:
      operationId: emailCheckout
      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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/emailCheckout_request"
        description: requested field for sms checkout
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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: 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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/smsCheckout_request"
        description: requested field for sms checkout
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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: Send an sms
      tags:
      - Payment Link
  /customers/{id}/payment_sources:
    get:
      description: Get a list of Payment Methods
      operationId: GetCustomerPaymentMethods
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.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.2.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.2.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.2.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
      tags:
      - Payment Methods
    post:
      description: Create a payment method for a customer.
      operationId: CreateCustomerPaymentMethods
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/create_customer_payment_methods_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: Identifier of the payment method
        example: src_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: payment_method_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/update_customer_payment_methods_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: Identifier of the payment method
        example: src_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: payment_method_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/update_customer_payment_methods_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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:
      operationId: getPlans
      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.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Plans
      tags:
      - 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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Plan
      tags:
      - Plans
  /plans/{id}:
    delete:
      operationId: deletePlan
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Plan
      tags:
      - Plans
    get:
      operationId: getPlan
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Plan
      tags:
      - Plans
    put:
      operationId: updatePlan
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Plan
      tags:
      - Plans
  /orders/{id}/shipping_lines:
    post:
      description: Create new shipping for an existing orden
      operationId: ordersCreateShipping
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.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"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Shipping
      tags:
      - Shippings
  /orders/{id}/shipping_lines/{shipping_id}:
    delete:
      description: Delete shipping
      operationId: ordersDeleteShipping
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: ship_lin_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: shipping_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/shipping_order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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
    put:
      description: Update existing shipping for an existing orden
      operationId: ordersUpdateShipping
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: ship_lin_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: shipping_id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/shipping_order_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/customer_shipping_contacts_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: shipping_contacts_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/customer_shipping_contacts_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: shipping_contacts_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/customer_shipping_contacts_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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: List Subscriptions
      tags:
      - Subscriptions
    post:
      description: Create a new subscription for a customer (keeps existing subscriptions
        active)
      operationId: subscriptionCreate
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Subscription
      tags:
      - 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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 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:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/updates_a_subscription"
        description: requested field for update a subscription
        required: true
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Subscription
      tags:
      - Subscriptions
  /customers/{customer_id}/subscriptions/{id}/events:
    get:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Subscription Events
      tags:
      - Subscriptions
  /customers/{customer_id}/subscriptions/{id}/cancel:
    post:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Subscription
      tags:
      - Subscriptions
  /customers/{customer_id}/subscriptions/{id}/pause:
    post:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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: Pause Subscription
      tags:
      - Subscriptions
  /customers/{customer_id}/subscriptions/{id}/resume:
    post:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
      tags:
      - Subscriptions
  /customers/{customer_id}/subscriptions/{id}/retry:
    post:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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: Retry Failed Payment
      tags:
      - 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:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "404":
          content:
            application/vnd.conekta-v2.2.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.2.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: []
      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
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "404":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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: []
      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
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 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
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "422":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 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
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 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
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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 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
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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: "Pause Subscription [Deprecated]"
      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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/subscription_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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/order_tax_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
      tags:
      - Taxes
  /orders/{id}/tax_lines/{tax_id}:
    delete:
      description: Delete taxes for an existing orden
      operationId: ordersDeleteTaxes
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: tax_lin_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: tax_id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/order_tax_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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 Tax
      tags:
      - Taxes
    put:
      description: Update taxes for an existing orden
      operationId: ordersUpdateTaxes
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: identifier
        example: tax_lin_2tQ974hSHcsdeSZHG
        explode: false
        in: path
        name: tax_id
        required: true
        schema:
          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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/order_tax_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Token
      tags:
      - Tokens
  /transactions:
    get:
      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
        explode: true
        in: query
        name: id
        required: false
        schema:
          example: 65412a893cd69a0001c25892
          type: string
        style: form
      - description: id of the charge used for filtering
        explode: true
        in: query
        name: charge_id
        required: false
        schema:
          example: 65412a893cd69a0001c25892
          type: string
        style: form
      - description: type of the object to be retrieved
        explode: true
        in: query
        name: type
        required: false
        schema:
          example: capture
          type: string
        style: form
      - description: currency of the object to be retrieved
        explode: true
        in: query
        name: currency
        required: false
        schema:
          example: MXN
          type: string
        style: form
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 transactions
      tags:
      - Transactions
  /transactions/{id}:
    get:
      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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 transaction
      tags:
      - Transactions
  /transfers:
    get:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 transfers
      tags:
      - Transfers
  /transfers/{id}:
    get:
      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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/vnd.conekta-v2.2.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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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 Transfer
      tags:
      - Transfers
  /webhook_keys:
    get:
      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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $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
              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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Webhook Keys
      tags:
      - 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":
          content:
            application/vnd.conekta-v2.2.0+json:
              schema:
                $ref: "#/components/schemas/webhook_key_create_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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 Key
      tags:
      - Webhook keys
  /webhook_keys/{id}:
    delete:
      operationId: deleteWebhookKey
      parameters:
      - description: Identifier of the resource
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.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"
                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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/webhook_key_response"
          description: successful operation
        "404":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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.2.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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.0+json:
              schema:
                $ref: "#/components/schemas/webhook_response"
          description: successful operation
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.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.2.0; format=application/json
                type: string
              style: simple
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/webhook_response"
          description: successful operation
        "404":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
        example: 6307a60c41de27127515a575
        explode: false
        in: path
        name: id
        required: true
        schema:
          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.2.0+json:
              schema:
                $ref: "#/components/schemas/webhook_response"
          description: successful
        "401":
          content:
            application/vnd.conekta-v2.2.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.2.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.2.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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/risk_rules_data"
            type: array
      title: risk_rules_list
    details_error:
      properties:
        code:
          example: conekta.errors.authentication.missing_key
          type: string
        param:
          type: string
          nullable: true
        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
      - properties:
          log_id:
            description: log id
            example: 507f1f77bcf86cd799439011
            type: string
            nullable: true
          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
          type: integer
          nullable: true
        last_used_at:
          description: Unix timestamp in seconds with the api key was used
          format: int64
          type: integer
          nullable: true
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        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
      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
            type: integer
            nullable: true
          last_used_at:
            description: Unix timestamp in seconds with the api key was used
            format: int64
            type: integer
            nullable: true
          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
            type: integer
            nullable: true
          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
        cashout_retention_amount:
          description: The balance's cashout retention amount
          items:
            $ref: "#/components/schemas/balance_common_fiels_response"
          type: array
        conekta_retention:
          description: The balance's conekta retention
          items:
            $ref: "#/components/schemas/balance_common_fiels_response"
          type: array
        gateway:
          description: The balance's gateway
          items:
            $ref: "#/components/schemas/balance_common_fiels_response"
          type: array
        pending:
          description: The balance's pending
          items:
            $ref: "#/components/schemas/balance_common_fiels_response"
          type: array
        retained:
          description: The balance's retained
          items:
            $ref: "#/components/schemas/balance_common_fiels_response"
          type: array
        retention_amount:
          description: The balance's retention amount
          items:
            $ref: "#/components/schemas/balance_common_fiels_response"
          type: array
        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
        temporarily_retained:
          description: The balance's temporarily retained
          items:
            $ref: "#/components/schemas/balance_common_fiels_response"
          type: array
      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
            type: integer
            nullable: true
          cashier_id:
            example: OINM01010
            type: string
            nullable: true
          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
            type: string
            nullable: true
          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
          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:
            type: string
            nullable: true
          executed_at:
            type: string
            nullable: true
          expires_at:
            example: 1683053729
            format: int64
            type: integer
          issuing_account_bank:
            type: string
            nullable: true
          issuing_account_number:
            type: string
            nullable: true
          issuing_account_holder_name:
            type: string
            nullable: true
          issuing_account_tax_id:
            type: string
            nullable: true
          payment_attempts:
            items: {}
            type: array
          receiving_account_holder_name:
            type: string
            nullable: true
          receiving_account_number:
            example: "646180111805034237"
            type: string
          receiving_account_bank:
            example: STP
            type: string
          receiving_account_tax_id:
            type: string
            nullable: true
          reference_number:
            type: string
            nullable: true
          tracking_code:
            type: string
            nullable: true
          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
            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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            description: refunds
            items:
              $ref: "#/components/schemas/charge_response_refunds_data"
            type: array
      title: charge_response_refunds
      nullable: true
    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
        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
          type: string
          nullable: true
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/charge_response"
            type: array
      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: 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
          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:
        - can_not_expire
        - cancel_url
        - 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
            example: John Doe
            type: string
          number:
            description: Card number
            example: "4242424242424242"
            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
          type: string
          nullable: true
        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:
          type: integer
          nullable: true
        object:
          type: string
        order_id:
          example: ord_2tN73UdUSNrYRPD9r
          type: string
        paid_at:
          example: 1676390742
          type: integer
          nullable: true
        payment_method:
          $ref: "#/components/schemas/charge_order_response_payment_method"
        reference_id:
          description: Reference ID of the charge
          example: ref_2tN73UdUSNrYRPD9r
          type: string
          nullable: true
        refunds:
          items: {}
          type: array
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/charge_response"
            type: array
      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.
          type: string
          nullable: true
      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
          type: string
          nullable: true
        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
        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
          type: string
          nullable: true
      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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/company_response"
            type: array
      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"
          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: string
        type_company:
          description: "The type of company, 'owner'"
          example: owner
          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:
        content_type: application/pdf
        file_name: example_document.pdf
        file_classification: id_legal_representative
        international: false
        file_data: VGhpcyBpcyBhIHRlc3QgZmlsZSBkYXRhIGluIGJhc2UgNjQu
      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
          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:
          description: Indicates if the document is international. Defaults to false.
          example: false
          type: boolean
        file_name:
          description: Name of the file being uploaded.
          example: example_document.pdf
          type: string
        file_data:
          description: Base64 encoded content of the file.
          example: VGhpcyBpcyBhIHRlc3QgZmlsZSBkYXRhIGluIGJhc2UgNjQu
          format: byte
          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
          type: string
        file_name:
          description: Name of the file as stored or processed.
          example: prueba3.pdf
          type: string
        status:
          description: Current status of the document.
          example: uploaded
          type: string
      required:
      - 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
      nullable: true
    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
          residential:
            default: false
            example: true
            type: boolean
          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
        - object
        title: pagination metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/customer_fiscal_entities_data_response"
            type: array
      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: string
        provider:
          description: "Provider name, you can use this to know where to pay"
          example: bbva_cash_in
          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
          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:
      - 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
            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
      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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/customer_payment_methods_data"
            title: customer_payment_methods_data
            type: array
        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
          type: boolean
          nullable: true
    customer_shipping_contacts_data_response:
      allOf:
      - description: |-
          [Shipping](https://developers.conekta.com/v2.2.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.
            example: Ackerman Crescent
            type: string
          address:
            $ref: "#/components/schemas/customer_shipping_contacts_request_address"
          parent_id:
            type: string
          default:
            type: boolean
            nullable: true
          deleted:
            type: boolean
            nullable: true
          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:
      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
    customer_subscription_response:
      description: subscription model
      properties:
        billing_cycle_start:
          example: 1677626827
          format: int64
          type: integer
          nullable: true
        billing_cycle_end:
          example: 1677626827
          format: int64
          type: integer
          nullable: true
        canceled_at:
          example: 1678258162
          format: int64
          type: integer
          nullable: true
        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
          type: string
          nullable: true
        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
          type: integer
          nullable: true
        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
          type: integer
          nullable: true
        trial_end:
          example: 1677626837
          format: int64
          type: integer
          nullable: true
      title: customer_subscription_response
      nullable: true
    customer_response:
      description: customer response
      properties:
        antifraud_info:
          $ref: "#/components/schemas/customer_antifraud_info_response"
        corporate:
          description: true if the customer is a company
          type: boolean
        created_at:
          description: Creation date of the object
          example: 1485151007
          format: int64
          type: integer
        custom_reference:
          description: Custom reference
          example: custom_reference
          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
          type: string
        default_fiscal_entity_id:
          example: fis_ent_2tKqqAfqPi21oCmEJ
          type: string
          nullable: true
        default_shipping_contact_id:
          example: ship_cont_2tKZsTYcsryyu7Ah8
          type: string
        default_payment_source_id:
          example: src_2tHJfJ79KyUwpxTio
          type: string
          nullable: true
        email:
          example: Felipe@gmail.com
          format: email
          type: string
        fiscal_entities:
          $ref: "#/components/schemas/customer_fiscal_entities_response"
        id:
          description: Customer's ID
          example: cus_2tHJfJ79KyUwpxTik
          type: string
        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
        object:
          example: customer
          type: string
        payment_sources:
          $ref: "#/components/schemas/customer_payment_methods_response"
        phone:
          description: Customer's phone number
          example: "+5215555555555"
          type: string
        shipping_contacts:
          $ref: "#/components/schemas/customer_response_shipping_contacts"
        subscription:
          $ref: "#/components/schemas/customer_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
      - 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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        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
      nullable: true
    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:
      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.2.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:
      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:
      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.2.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.
          example: Ackerman Crescent
          type: string
        address:
          $ref: "#/components/schemas/customer_shipping_contacts_request_address"
        parent_id:
          type: string
        default:
          type: boolean
          nullable: true
        deleted:
          type: boolean
          nullable: true
        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
          type: string
        card_id:
          example: src_2qUCNd5AyQqfPMBuV
          type: string
        trial_end:
          example: 1484040996
          type: integer
      required:
      - plan_id
      title: subscription_request
    customer:
      description: a customer
      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
          type: boolean
        custom_reference:
          description: It is an undefined value.
          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
          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
          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
          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
          type: string
        fiscal_entities:
          items:
            $ref: "#/components/schemas/fiscal_entity_request"
          type: array
        metadata:
          additionalProperties: true
          maxProperties: 100
          type: object
        name:
          description: Client's name
          example: miguel
          type: string
        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
          items:
            $ref: "#/components/schemas/customer_payment_methods_request"
          type: array
        phone:
          description: Is the customer's phone number
          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
          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
        subscription:
          $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
      nullable: true
    update_customer:
      description: update customer
      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
          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
          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
          type: string
        name:
          description: Client's name
          example: miguel
          type: string
        phone:
          description: Is the customer's phone number
          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
          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
          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.
          type: string
        fiscal_entities:
          items:
            $ref: "#/components/schemas/fiscal_entity_request"
          type: array
        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
          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
        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
        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:
        - 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"
        tax_id:
          type: string
        email:
          type: string
        phone:
          type: string
        metadata:
          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
        - 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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/discount_lines_response"
            type: array
      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.
      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
        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:
        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
        webhook_status:
          example: successful
          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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/event_response"
            type: array
      title: get_events_response
    resendEvent_request:
      properties:
        webhooks_ids:
          description: webhooks ids to resend event
          example:
          - 6307a60c41de27127515a575
          - 6307a60c41de27127515a571
          items:
            type: string
          type: array
      required:
      - webhooks_ids
    events_resend_response:
      description: event model
      properties:
        failed_attempts:
          example: 6
          type: integer
        id:
          example: webhl_2svd2sh6GbqzyWBNZ
          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
          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
          type: string
          nullable: true
        loggable_type:
          example: order
          type: string
          nullable: true
        method:
          example: POST
          type: string
        oauth_token_id:
          type: string
          nullable: true
        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.2.0+json
            Accept-Encoding: "gzip, deflate, br"
            Accept-Language: "es-419, es; q=0.9, en; q=0.8"
            Activitypermission: orders:read
            Apiversion: 2.2.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.2.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
        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.2.0
          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
        object:
          description: The object type
          readOnly: true
          type: string
        next_page_url:
          description: URL of the next page.
          type: string
          nullable: true
        previous_page_url:
          description: Url of the previous page.
          type: string
          nullable: true
        data:
          description: set to page results.
          items:
            $ref: "#/components/schemas/logs_response_data"
          type: array
          nullable: true
      title: logs_response_for_request
    log_response_for_request:
      description: log model
      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
          type: string
          nullable: true
        loggable_type:
          example: order
          type: string
          nullable: true
        method:
          example: POST
          type: string
        oauth_token_id:
          type: string
          nullable: true
        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.2.0+json
            Accept-Encoding: "gzip, deflate, br"
            Accept-Language: "es-419, es; q=0.9, en; q=0.8"
            Activitypermission: orders:read
            Apiversion: 2.2.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.2.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
        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.2.0
          type: string
      required:
      - created_at
      - id
      - livemode
      title: log_response_for_request
    order_channel_response:
      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
      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
            type: string
            nullable: true
          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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/charges_data_response"
            type: array
      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
          items:
            type: string
          type: array
        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
          type: array
        expires_at:
          example: 1676613599
          format: int64
          type: integer
        failure_url:
          example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx
          type: string
        force_3ds_flow:
          example: false
          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
          type: integer
          nullable: true
        metadata:
          additionalProperties: true
          maxProperties: 100
          type: object
        monthly_installments_enabled:
          example: false
          type: boolean
        monthly_installments_options:
          items:
            format: int8
            type: integer
          type: array
        name:
          example: ord-2tNDzhA4Akmzj11AS
          type: string
        needs_shipping_contact:
          example: false
          type: boolean
        object:
          example: checkout
          type: string
        on_demand_enabled:
          example: true
          type: boolean
          nullable: true
        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
          type: integer
          nullable: true
        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
          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
          type: string
      required:
      - allowed_payment_methods
      - id
      - 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
            type: string
            nullable: true
          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_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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/discount_lines_data_response"
            type: array
      description: List of discounts that are applied to the order
      title: order_discount_lines_response
      nullable: true
    tax_lines_data_response:
      allOf:
      - 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: 2
              type: string
            metadata:
              additionalProperties: true
              example:
                key: value
              maxProperties: 100
              type: object
          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_tax_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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/tax_lines_data_response"
            type: array
      description: List of taxes that are applied to the order
      title: order_tax_lines_response
      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
              type: string
            tracking_number:
              description: Tracking number can be used to track the shipment
              example: TRACK123
              type: string
            method:
              description: Method of shipment
              example: Same day
              type: string
            metadata:
              additionalProperties: true
              description: Hash where the user can send additional information for
                each 'shipping'.
              example:
                key: value
              maxProperties: 100
              type: object
          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_shipping_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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/shipping_lines_data_response"
            type: array
      description: List of shipping costs applied to the order
      title: order_shipping_lines_response
      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
            type: string
            nullable: true
          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"
      properties:
        address:
          $ref: "#/components/schemas/order_fiscal_entity_address_response"
        email:
          description: Email of the fiscal entity
          example: test@gmail.com
          type: string
          nullable: true
        metadata:
          additionalProperties: true
          description: Metadata associated with the fiscal entity
          maxProperties: 100
          type: object
        name:
          description: Name of the fiscal entity
          example: Conekta Inc
          type: string
          nullable: true
        tax_id:
          description: Tax ID of the fiscal entity
          example: "324234234"
          type: string
          nullable: 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
        object:
          example: fiscal_entity
          type: string
        phone:
          description: Phone of the fiscal entity
          example: "+525511223344"
          type: string
          nullable: true
      required:
      - address
      - created_at
      - id
      - object
      title: order_fiscal_entity_response
      nullable: true
    product_data_response:
      allOf:
      - properties:
          antifraud_info:
            additionalProperties: true
            example:
              key: value
            type: object
          brand:
            description: The brand of the item.
            example: Cohiba
            type: string
          description:
            description: Short description of the item
            example: Imported From Mex.
            maxLength: 250
            type: string
          metadata:
            additionalProperties: true
            default: {}
            description: It is a key/value hash that can hold custom fields. Maximum
              100 elements and allows special characters.
            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
            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
            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:
              type: string
            type: array
          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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/product_data_response"
            type: array
      title: order_response_products
    order_next_action_response_redirect_to_url:
      description: contains the following attributes that will guide to continue the
        flow
      properties:
        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"
          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:
      properties:
        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
          type: string
        residential:
          example: true
          type: boolean
          nullable: true
      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
            type: string
            nullable: true
          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
      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_discount_lines_response"
        tax_lines:
          $ref: "#/components/schemas/order_tax_lines_response"
        shipping_lines:
          $ref: "#/components/schemas/order_shipping_lines_response"
        fiscal_entity:
          $ref: "#/components/schemas/order_fiscal_entity_response"
        id:
          example: ord_2tMtQQpDvfnNjiuFG
          type: string
        is_refundable:
          example: false
          type: boolean
        line_items:
          $ref: "#/components/schemas/order_response_products"
        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: order
          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
          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
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      title: get_orders_response
    order_checkout_request:
      description: |
        [Checkout](https://developers.conekta.com/v2.2.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."
          example:
          - cash
          - card
          - bank_transfer
          - bnpl
          - pay_by_bank
          items:
            enum:
            - cash
            - card
            - bank_transfer
            - bnpl
            - pay_by_bank
            type: string
          type: array
        exclude_card_networks:
          description: List of card networks to exclude from the checkout. This field
            is only applicable for card payments.
          example:
          - visa
          - amex
          items:
            enum:
            - visa
            - mastercard
            - amex
            type: string
          title: checkout_request_exclude_card_networks
          type: array
        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
        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
        monthly_installments_enabled:
          example: false
          type: boolean
        monthly_installments_options:
          example:
          - 3
          - 6
          - 12
          items:
            format: int8
            type: integer
          type: array
        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
      required:
      - allowed_payment_methods
      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
          type: string
          nullable: true
        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
    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
          type: string
          nullable: true
        phone:
          description: Phone of the fiscal entity
          example: "+525511223344"
          type: string
        tax_id:
          description: Tax ID of the fiscal entity
          example: AAA010101AAA
          type: string
          nullable: true
      required:
      - 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
          type: string
        description:
          description: Short description of the item
          example: Imported From Mex.
          maxLength: 250
          type: string
        metadata:
          additionalProperties: true
          default: {}
          description: It is a key/value hash that can hold custom fields. Maximum
            100 elements and allows special characters.
          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
          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
          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:
            type: string
          type: array
        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
          type: string
        tracking_number:
          description: Tracking number can be used to track the shipment
          example: TRACK123
          type: string
        method:
          description: Method of shipment
          example: Same day
          type: string
        metadata:
          additionalProperties: true
          description: Hash where the user can send additional information for each
            'shipping'.
          example:
            key: value
          maxProperties: 100
          type: object
      required:
      - amount
      title: shipping_request
    order_tax_request:
      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: 2
          type: string
        metadata:
          additionalProperties: true
          example:
            key: value
          maxProperties: 100
          type: object
      required:
      - amount
      - description
      title: order_tax_request
    order_request:
      description: a order
      properties:
        charges:
          description: "List of [charges](https://developers.conekta.com/v2.2.0/reference/orderscreatecharge)\
            \ that are applied to the order"
          items:
            $ref: "#/components/schemas/charge_request"
          type: array
        checkout:
          $ref: "#/components/schemas/order_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)"
          example: MXN
          maxLength: 3
          type: string
        customer_info:
          $ref: "#/components/schemas/order_request_customer_info"
        discount_lines:
          description: "List of [discounts](https://developers.conekta.com/v2.2.0/reference/orderscreatediscountline)\
            \ that are applied to the order."
          items:
            $ref: "#/components/schemas/order_discount_lines_request"
          type: array
        fiscal_entity:
          $ref: "#/components/schemas/order_fiscal_entity_request"
        line_items:
          description: "List of [products](https://developers.conekta.com/v2.2.0/reference/orderscreateproduct)\
            \ that are sold in the order. You must have at least one product."
          items:
            $ref: "#/components/schemas/product"
          type: array
        metadata:
          additionalProperties: true
          description: Metadata associated with the order
          maxProperties: 100
          type: object
        needs_shipping_contact:
          description: Allows you to fill out the shipping information at checkout
          example: false
          type: boolean
        pre_authorize:
          description: Indicates whether the order charges must be preauthorized
          type: boolean
        processing_mode:
          description: "Indicates the processing mode for the order, either ecommerce,\
            \ recurrent or validation."
          example: ecommerce
          type: string
        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_request"
        shipping_lines:
          description: "List of [shipping costs](https://developers.conekta.com/v2.2.0/reference/orderscreateshipping).\
            \ If the online store offers digital products."
          items:
            $ref: "#/components/schemas/shipping_request"
          type: array
        tax_lines:
          description: "List of [taxes](https://developers.conekta.com/v2.2.0/reference/orderscreatetaxes)\
            \ that are applied to the order."
          items:
            $ref: "#/components/schemas/order_tax_request"
          type: array
        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."
          type: string
          nullable: true
      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"
    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
          type: string
          nullable: true
        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
          type: string
          nullable: true
      required:
      - address
      title: order_update_fiscal_entity_request
    order_update:
      description: a order
      properties:
        charges:
          items:
            $ref: "#/components/schemas/charge_request"
          type: array
        checkout:
          $ref: "#/components/schemas/order_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)"
          example: MXN
          maxLength: 3
          type: string
        customer_info:
          $ref: "#/components/schemas/order_update_customer_info"
        discount_lines:
          description: "List of [discounts](https://developers.conekta.com/v2.2.0/reference/orderscreatediscountline)\
            \ that are applied to the order."
          items:
            $ref: "#/components/schemas/order_discount_lines_request"
          type: array
        fiscal_entity:
          $ref: "#/components/schemas/order_update_fiscal_entity_request"
        line_items:
          description: "List of [products](https://developers.conekta.com/v2.2.0/reference/orderscreateproduct)\
            \ that are sold in the order. You must have at least one product."
          items:
            $ref: "#/components/schemas/product"
          type: array
        metadata:
          additionalProperties:
            type: string
        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.2.0/reference/orderscreateshipping).\
            \ If the online store offers digital products."
          items:
            $ref: "#/components/schemas/shipping_request"
          type: array
        tax_lines:
          items:
            $ref: "#/components/schemas/order_tax_request"
          type: array
      title: order_update
    order_capture_request:
      properties:
        amount:
          description: Amount to capture
          example: 500
          format: int64
          minimum: 1
          type: integer
          nullable: false
      required:
      - amount
      title: order_capture_request
    product_order_response:
      allOf:
      - properties:
          antifraud_info:
            additionalProperties: true
            example:
              key: value
            type: object
          brand:
            description: The brand of the item.
            example: Cohiba
            type: string
          description:
            description: Short description of the item
            example: Imported From Mex.
            maxLength: 250
            type: string
          metadata:
            additionalProperties: true
            default: {}
            description: It is a key/value hash that can hold custom fields. Maximum
              100 elements and allows special characters.
            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
            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
            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:
              type: string
            type: array
          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:
      properties:
        antifraud_info:
          additionalProperties:
            type: object
        description:
          maxLength: 250
          type: string
        sku:
          type: string
        name:
          example: Box of Cohiba S1s
          type: string
        unit_price:
          example: 20000
          format: int64
          minimum: 0
          type: integer
        quantity:
          example: 1
          format: int32
          minimum: 1
          type: integer
        tags:
          items:
            type: string
          type: array
        brand:
          type: string
        metadata:
          additionalProperties:
            type: string
      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
            type: string
            nullable: true
          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:
          description: The payout methods that are allowed for the payout order.
          example:
          - cashout
          items:
            type: string
          minItems: 1
          type: array
        amount:
          description: The amount of the payout order.
          example: 100
          format: int64
          type: integer
        created_at:
          description: The creation date of the payout order.
          example: 1677626837
          format: int64
          type: integer
        currency:
          default: MXN
          description: The currency in which the payout order is made.
          example: MXN
          type: string
        customer_info:
          $ref: "#/components/schemas/payout_order_response_customer_info"
        expires_at:
          description: The expiration date of the payout order.
          example: 1677626837
          format: int64
          type: integer
        id:
          description: The id of the payout order.
          example: f2654d66-d740-457a-9a8c-f96b5196f44e
          type: string
        livemode:
          description: The live mode of the payout order.
          example: true
          type: boolean
        object:
          description: The object of the payout order.
          example: payout_order
          type: string
        metadata:
          additionalProperties: true
          description: The metadata of the payout order.
          example:
            custom_client_id: "12345"
          maxProperties: 100
          type: object
        payouts:
          description: The payout information of the payout order.
          items:
            $ref: "#/components/schemas/payout_order_payouts_item"
          title: payout_order_payouts
          type: array
        reason:
          description: The reason for the payout order.
          example: Payout order for the customer
          type: string
        status:
          description: The status of the payout order.
          example: open
          type: string
        updated_at:
          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
      - 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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        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:
          description: The payout methods that are allowed for the payout order.
          example:
          - cashout
          items:
            type: string
          type: array
        amount:
          description: The amount of the payout order.
          example: 100
          format: int64
          type: integer
        currency:
          default: MXN
          description: The currency in which the payout order is made.
          example: MXN
          type: string
        customer_info:
          $ref: "#/components/schemas/payout_order_request_customer_info"
        expires_at:
          description: The expiration time of the payout order in Unix timestamp.
          example: 1700000000
          format: int64
          type: integer
        metadata:
          additionalProperties: true
          description: The metadata of the payout order.
          example:
            custom_client_id: "12345"
          maxProperties: 100
          type: object
        payout:
          $ref: "#/components/schemas/payout"
        reason:
          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:
      description: checkout response
      properties:
        allowed_payment_methods:
          description: Are the payment methods available for this link
          example:
          - cash
          - card
          - bank_transfer
          - bnpl
          - pay_by_bank
          items:
            type: string
          type: array
        plan_ids:
          description: List of plan IDs that are available for subscription
          example:
          - plan_123
          - plan_456
          items:
            type: string
          type: array
        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: checkout_response_exclude_card_networks
          type: array
        expires_at:
          example: 1680397724
          format: int64
          type: integer
        failure_url:
          example: https://pay.conekta.com/failure
          type: string
        force_3ds_flow:
          example: false
          type: boolean
        id:
          example: b0bf16c4-18b9-445e-ba24-01604f329dbf
          type: string
        livemode:
          example: true
          type: boolean
        metadata:
          additionalProperties: true
          example:
            key: value
          type: object
        monthly_installments_enabled:
          example: false
          type: boolean
        monthly_installments_options:
          example:
          - 3
          - 6
          - 12
          items:
            format: int8
            type: integer
          type: array
        name:
          description: Reason for charge
          example: Payment Link Name 1594138857
          type: string
        needs_shipping_contact:
          example: false
          type: boolean
        object:
          example: checkout
          type: string
        paid_payments_count:
          example: 0
          type: integer
        payments_limit_count:
          example: 5
          format: int8
          type: integer
          nullable: true
        recurrent:
          example: false
          type: boolean
        slug:
          example: b0bf16c418b9445eba2401604f329dbf
          type: string
        sms_sent:
          example: 0
          type: integer
        starts_at:
          example: 1677650400
          type: integer
        status:
          example: Issued
          type: string
        success_url:
          description: The URL to redirect to after a successful payment.
          example: https://pay.conekta.com/success
          type: string
        type:
          example: PaymentLink
          type: string
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/checkout_response"
            type: array
      title: checkouts_response
    checkout_order_template_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_customer_id"
    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/checkout_order_template_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
        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.2.0/reference/orderscreatetaxes)\
            \ that are applied to the order."
          items:
            $ref: "#/components/schemas/order_tax_request"
          type: array
        discount_lines:
          description: "List of [discounts](https://developers.conekta.com/v2.2.0/reference/orderscreatediscountline)\
            \ that are applied to the order."
          items:
            $ref: "#/components/schemas/order_discount_lines_request"
          type: array
      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
          example:
          - cash
          - card
          - bank_transfer
          - bnpl
          - pay_by_bank
          items:
            type: string
          type: array
        exclude_card_networks:
          description: List of card networks to exclude from the checkout. This field
            is only applicable for card payments.
          example:
          - visa
          - amex
          items:
            enum:
            - visa
            - mastercard
            - amex
            type: string
          title: checkout_exclude_card_networks
          type: array
        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"
          example: 1680397724
          format: int64
          minimum: 1
          type: integer
        monthly_installments_enabled:
          description: This flag allows you to specify if months without interest
            will be active.
          example: true
          type: boolean
        monthly_installments_options:
          description: This field allows you to specify the number of months without
            interest.
          example:
          - 3
          - 6
          - 12
          items:
            format: int8
            type: integer
          type: array
        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."
          type: string
          nullable: true
        name:
          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
        on_demand_enabled:
          description: This flag allows you to specify if the link will be on demand.
          example: true
          type: boolean
          nullable: true
        plan_ids:
          description: It is a list of plan IDs that will be associated with the order.
          example:
          - plan_123
          - plan_456
          items:
            type: string
          type: array
        order_template:
          $ref: "#/components/schemas/checkout_order_template"
        payments_limit_count:
          description: It is the number of payments that can be made through the link.
          example: 5
          format: int8
          minimum: 1
          type: integer
        success_url:
          description: The URL to redirect to after a successful payment.
          example: https://www.conekta.com/success
          type: string
        recurrent:
          description: "false: single use. true: multiple payments"
          example: false
          type: boolean
        type:
          description: It is the type of link that will be created. It must be a valid
            type.
          example: PaymentLink
          type: string
      required:
      - allowed_payment_methods
      - 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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/get_customer_payment_method_data_response"
            type: array
      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:
          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:
      description: plans model
      properties:
        amount:
          example: 10000
          type: integer
        created_at:
          example: 1666900846
          format: int64
          type: integer
        currency:
          example: MXN
          maxLength: 3
          type: string
        expiry_count:
          example: 12
          type: integer
          nullable: true
        frequency:
          example: 1
          type: integer
        id:
          example: gold-plan
          type: string
        interval:
          example: month
          type: string
        livemode:
          example: true
          type: boolean
        name:
          example: Extra Plan3
          type: string
        object:
          example: plan
          type: string
        trial_period_days:
          example: 0
          type: integer
          nullable: true
        max_retries:
          example: 3
          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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/plan_response"
            type: array
      title: get_plans_response
    plan_request:
      description: a plan
      properties:
        amount:
          description: The amount in cents that will be charged on the interval specified.
          example: 10000
          minimum: 1
          type: integer
        currency:
          description: "ISO 4217 for currencies, for the Mexican peso it is MXN/USD"
          example: MXN
          maxLength: 3
          type: string
        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
        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
          type: integer
        id:
          description: internal reference id
          example: plan_24234
          type: string
        interval:
          description: The interval of time between each charge.
          enum:
          - week
          - half_month
          - month
          - year
          type: string
          nullable: false
        name:
          description: The name of the plan.
          example: Extra Plan3
          type: string
        trial_period_days:
          description: The number of days the customer will have a free trial.
          example: 0
          type: integer
        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
        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:
      description: a plan
      properties:
        amount:
          description: The amount in cents that will be charged on the interval specified.
          example: 10000
          minimum: 1
          type: integer
        currency:
          description: "ISO 4217 for currencies, for the Mexican peso it is MXN/USD"
          example: MXN
          maxLength: 3
          type: string
        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
        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
            type: string
          tracking_number:
            description: Tracking number can be used to track the shipment
            example: TRACK123
            type: string
          method:
            description: Method of shipment
            example: Same day
            type: string
          metadata:
            additionalProperties: true
            description: Hash where the user can send additional information for each
              'shipping'.
            example:
              key: value
            maxProperties: 100
            type: object
        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
          type: string
          nullable: true
        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
    customer_update_shipping_contacts_request:
      description: |-
        [Shipping](https://developers.conekta.com/v2.2.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.
          example: Ackerman Crescent
          type: string
        address:
          $ref: "#/components/schemas/customer_shipping_contacts_request_address"
        parent_id:
          type: string
        default:
          type: boolean
          nullable: true
        deleted:
          type: boolean
          nullable: true
      title: customer_update_shipping_contacts_request
    subscription_response:
      description: subscription model
      properties:
        billing_cycle_start:
          example: 1677626827
          format: int64
          type: integer
          nullable: true
        billing_cycle_end:
          example: 1677626827
          format: int64
          type: integer
          nullable: true
        canceled_at:
          example: 1678258162
          format: int64
          type: integer
          nullable: true
        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
          type: string
          nullable: true
        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
          type: integer
          nullable: true
        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
          type: integer
          nullable: true
        trial_end:
          example: 1677626837
          format: int64
          type: integer
          nullable: true
      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
      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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/event_response"
            type: array
      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:
          type: string
          nullable: true
    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
          type: integer
          nullable: true
        expiry_count:
          example: 1
          format: int32
          type: integer
        created_at:
          example: 1742087277
          format: int64
          type: integer
    subscription_details:
      description: Subscription details for customer portal
      properties:
        card:
          $ref: "#/components/schemas/subscription_details_card"
        plan:
          $ref: "#/components/schemas/subscription_details_plan"
        id:
          example: sub_2yYsQuYtXAbP1fdYu
          type: string
        object:
          example: subscription
          type: string
        status:
          example: canceled
          type: string
        plan_id:
          example: VG5
          type: string
        customer_id:
          example: cus_2yDzKtEAD3khH8Sga
          type: string
        next_billing_cycle:
          example: 1876833632
          format: int64
          type: integer
          nullable: true
        created_at:
          example: 1755873642
          format: int64
          type: integer
        updated_at:
          example: 1761745218
          format: int64
          type: integer
      title: subscription_details
    customer_details:
      description: Customer details for customer portal
      properties:
        id:
          example: cus_2yDzKtEAD3khH8Sga
          type: string
        object:
          example: customer
          type: string
        name:
          example: mao
          type: string
        email:
          example: maoarroya@gmail.com
          format: email
          type: string
      title: customer_details
    customer_portal_response:
      description: Customer portal model
      properties:
        slug:
          description: Unique slug identifier for the portal
          example: agIvD4QSBl4Nunq4TmuozMw2ThtyVC
          type: string
        subscription_id:
          description: Associated subscription ID
          example: sub_2yYsQuYtXAbP1fdYu
          type: string
        customer_id:
          description: Associated customer ID
          example: cus_2yDzKtEAD3khH8Sga
          type: string
        livemode:
          description: Whether this is a live or test mode portal
          example: false
          type: boolean
        subscription:
          $ref: "#/components/schemas/subscription_details"
        customer:
          $ref: "#/components/schemas/customer_details"
        id:
          description: Customer portal ID
          example: scp_2ym7QbU9dTh7Froti
          type: string
        company_id:
          description: Associated company ID
          example: 63dad459920de10001d177b3
          type: string
        object:
          example: customer_portal
          type: string
        created_at:
          description: Unix timestamp of creation
          example: 1759108828
          format: int64
          type: integer
        updated_at:
          description: Unix timestamp of last update
          example: 1759108828
          format: int64
          type: integer
        portal_url:
          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: 2
            type: string
          metadata:
            additionalProperties: true
            example:
              key: value
            maxProperties: 100
            type: object
        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
      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: 2
          type: string
        metadata:
          additionalProperties:
            type: object
          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
      nullable: true
    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
      nullable: true
    token_request:
      description: a token
      properties:
        card:
          $ref: "#/components/schemas/token_request_card"
        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
        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
        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
        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
      nullable: true
    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:
          description: Indicates whether the token is in live mode or test mode.
          example: true
          type: boolean
        object:
          description: "Indicates the type of object, in this case token"
          example: token
          type: string
        used:
          description: Indicates if the token has been used
          example: false
          type: boolean
      required:
      - 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:
          description: The amount of the transaction.
          example: 1000
          format: int64
          type: integer
        charge:
          description: Randomly assigned unique order identifier associated with the
            charge.
          example: 5ee7ec58885a45585e6d9f8m
          type: string
        created_at:
          description: Date and time of creation of the transaction in Unix format.
          example: 1553273553
          format: int64
          type: integer
        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)"
          example: MXN
          maxLength: 3
          type: string
        fee:
          description: The amount to be deducted for taxes and commissions.
          example: 560
          format: int64
          type: integer
        id:
          description: Unique identifier of the transaction.
          example: 5ee7ec5b8dea41085erb7f9e
          type: string
        livemode:
          description: Indicates whether the transaction was created in live mode
            or test mode.
          example: true
          type: boolean
        net:
          description: The net amount after deducting commissions and taxes.
          example: 440
          format: int64
          type: integer
        object:
          description: "Object name, which is transaction."
          example: transaction
          type: string
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            description: Transactions
            items:
              $ref: "#/components/schemas/transaction_response"
            type: array
      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:
      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:
          description: Amount in cents of the transfer.
          example: 10000
          format: int64
          type: integer
        created_at:
          description: Date and time of creation of the transfer.
          example: 1553273553
          format: int64
          type: integer
        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)"
          example: MXN
          maxLength: 3
          type: string
        id:
          description: Unique identifier of the transfer.
          example: 5b0337d4dD344ef954fe1X4b6
          type: string
        livemode:
          description: Indicates whether the transfer was created in live mode or
            test mode.
          example: true
          type: boolean
        method:
          $ref: "#/components/schemas/transfer_method_response"
        object:
          description: "Object name, which is transfer."
          example: transfer
          type: string
        statement_description:
          description: Description of the transfer.
          example: Conekta 4401234
          type: string
        statement_reference:
          description: Reference number of the transfer.
          example: "4401234"
          type: string
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            description: Transfers
            items:
              $ref: "#/components/schemas/transfers_response"
            type: array
      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:
      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:
          description: Amount in cents of the transfer.
          example: 10000
          format: int64
          type: integer
        created_at:
          description: Date and time of creation of the transfer in Unix format.
          example: 1553273553
          format: int64
          type: integer
        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)"
          example: MXN
          maxLength: 3
          type: string
        id:
          description: Unique identifier of the transfer.
          example: 5b0337d4dD344ef954fe1X4b6
          type: string
        livemode:
          description: Indicates whether the transfer was created in live mode or
            test mode.
          example: true
          type: boolean
        destination:
          $ref: "#/components/schemas/transfer_destination_response"
        object:
          description: "Object name, which is transfer."
          example: transfer
          type: string
        statement_description:
          description: Description of the transfer.
          example: Conekta 4401234
          type: string
        statement_reference:
          description: Reference number of the transfer.
          example: "4401234"
          type: string
        status:
          description: Code indicating transfer status.
          example: pending
          type: string
      title: transfer_response
    webhook_key_response:
      description: webhook keys model
      properties:
        id:
          description: Unique identifier of the webhook key
          example: 62730ba6fb7dfd6a712f118e
          type: string
        active:
          description: Indicates if the webhook key is active
          example: true
          type: boolean
        created_at:
          description: Unix timestamp in seconds with the creation date of the webhook
            key
          example: 1577836800
          format: int64
          type: integer
        deactivated_at:
          description: Unix timestamp in seconds with the deactivation date of the
            webhook key
          format: int64
          type: integer
          nullable: true
        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
        livemode:
          description: Indicates if the webhook key is in live mode
          example: false
          type: boolean
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/webhook_key_response"
            type: array
      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:
      description: webhook keys model
      properties:
        active:
          description: Indicates if the webhook key is active
          example: true
          type: boolean
        created_at:
          description: Unix timestamp in seconds with the creation date of the webhook
            key
          example: 1577836800
          format: int64
          type: integer
        id:
          description: Unique identifier of the webhook key
          example: 62730ba6fb7dfd6a712f118e
          type: string
        livemode:
          description: Indicates if the webhook key is in live mode
          example: false
          type: boolean
        object:
          description: "Object name, value is webhook_key"
          example: webhook_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'
          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: webhook keys model
      properties:
        active:
          description: Indicates if the webhook key is active
          example: true
          type: boolean
        created_at:
          description: Unix timestamp in seconds with the creation date of the webhook
            key
          example: 1577836800
          format: int64
          type: integer
        deleted:
          description: Indicates if the webhook key is deleted
          example: true
          type: boolean
        id:
          description: Unique identifier of the webhook key
          example: 62730ba6fb7dfd6a712f118e
          type: string
        livemode:
          description: Indicates if the webhook key is in live mode
          example: false
          type: boolean
        object:
          description: "Object name, value is webhook_key"
          example: webhook_key
          type: string
      title: webhook_key_delete_response
    webhook_response:
      description: webhooks model
      properties:
        id:
          description: id of the webhook
          example: 6307a60c41de27127515a575
          type: string
        description:
          description: A name or brief explanation of what this webhook is used for
          example: Server payments processor
          type: string
        livemode:
          description: Indicates if the webhook is in production
          example: true
          type: boolean
        active:
          description: Indicates if the webhook is actived or not
          example: true
          type: boolean
        object:
          description: "Object name, value is 'webhook'"
          example: event
          type: string
        status:
          description: Indicates if the webhook is ready to receive events or failing
          example: listening
          type: string
        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
          items:
            type: string
          type: array
        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
            type: string
            nullable: true
          previous_page_url:
            description: Url of the previous page.
            example: https://api.conekta.io/resources?limit=10&previous=chrg_1
            type: string
            nullable: true
        title: page metadata
      - properties:
          data:
            items:
              $ref: "#/components/schemas/webhook_response"
            type: array
      title: get_webhooks_response
    webhook_request:
      description: a webhook
      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
          format: url
          pattern: ^(?!.*(localhost|127\.0\.0\.1)).*$
          type: string
        subscribed_events:
          description: events that will be sent to the webhook
          example: customer.created
          items:
            type: string
          type: array
      required:
      - url
      title: webhook_request
    update_webhook:
      description: an updated webhook
      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
          format: url
          pattern: ^(?!.*(localhost|127\.0\.0\.1)).*$
          type: string
        subscribed_events:
          description: events that will be sent to the webhook
          example: customer.created
          items:
            type: string
          type: array
        active:
          description: whether the webhook is active or not
          example: true
          type: boolean
      title: update_webhook
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http