From bf8b8893329c5cac6a4a6b7d2aefb434ed33c0a2 Mon Sep 17 00:00:00 2001 From: Franklin Date: Fri, 26 Dec 2025 10:13:50 -0500 Subject: [PATCH 1/2] update version --- .github/workflows/check.yml | 6 +- Dockerfile | 2 +- Makefile | 2 +- _build/api.yaml | 14748 +++++++++++++++++++--------------- api.yaml | 2 +- 5 files changed, 8455 insertions(+), 6305 deletions(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index cdb99a3..3d4c2a8 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -13,7 +13,7 @@ jobs: # Checkout your code - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v6 # Generate your OpenAPI document (if you don't write it manually) @@ -24,7 +24,7 @@ jobs: with: generator: openapi-yaml openapi-file: api.yaml - generator-tag: v7.13.0 + generator-tag: v7.18.0 - name: check if api.yaml are equals run: | if diff -q _build/api.yaml openapi-yaml-client/openapi/openapi.yaml >/dev/null; then @@ -32,4 +32,4 @@ jobs: else echo "exists differences between files _build/api.yaml" exit 1 - fi \ No newline at end of file + fi diff --git a/Dockerfile b/Dockerfile index 71b8712..584cc63 100644 --- a/Dockerfile +++ b/Dockerfile @@ -6,7 +6,7 @@ RUN apt-get update && \ apt-get clean; RUN npm install @openapitools/openapi-generator-cli -g -RUN openapi-generator-cli version-manager set 7.13.0 +RUN openapi-generator-cli version-manager set 7.18.0 WORKDIR /app COPY parameters/ parameters/ diff --git a/Makefile b/Makefile index e2e884f..5680f8e 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ merge: docker run --rm \ - -v ${PWD}:/local openapitools/openapi-generator-cli:v7.13.0 generate \ + -v ${PWD}:/local openapitools/openapi-generator-cli:v7.18.0 generate \ -g openapi-yaml \ -i /local/api.yaml \ -p outputFile=local/_build/api.yaml \ diff --git a/_build/api.yaml b/_build/api.yaml index 960d900..f58d7f9 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.0 info: contact: email: engineering@conekta.com @@ -35,6 +35,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -44,12 +45,13 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/risk_rules_list' + $ref: "#/components/schemas/GetRuleWhitelist_200_response" description: All the rules "401": content: @@ -63,7 +65,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "403": content: @@ -78,7 +80,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: forbidden error "500": content: @@ -95,7 +97,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error summary: Get a list of whitelisted rules tags: @@ -111,6 +113,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -120,17 +123,18 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_risk_rules_data' + $ref: "#/components/schemas/CreateRuleWhitelist_request" responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/whitelistlist_rule_response' + $ref: "#/components/schemas/whitelistlist_rule_response" description: successfully registered rule "401": content: @@ -144,7 +148,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "403": content: @@ -159,7 +163,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: forbidden error "500": content: @@ -176,7 +180,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error summary: Create whitelisted rule tags: @@ -187,11 +191,13 @@ paths: 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: @@ -200,6 +206,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -209,20 +216,23 @@ paths: - 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' + $ref: "#/components/schemas/deleted_whitelist_rule_response" description: successfully deleted rule "401": content: @@ -236,7 +246,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "403": content: @@ -251,7 +261,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: forbidden error "404": content: @@ -267,7 +277,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -284,7 +294,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error summary: Delete whitelisted rule tags: @@ -302,6 +312,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -311,12 +322,13 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/risk_rules_list' + $ref: "#/components/schemas/GetRuleWhitelist_200_response" description: All the rules "401": content: @@ -330,7 +342,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -347,7 +359,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error summary: Get list of blacklisted rules tags: @@ -363,6 +375,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -372,11 +385,12 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_risk_rules_data' + $ref: "#/components/schemas/CreateRuleWhitelist_request" description: requested field for blacklist rule required: true responses: @@ -384,7 +398,7 @@ paths: content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/blacklist_rule_response' + $ref: "#/components/schemas/blacklist_rule_response" description: successfully registered rule "401": content: @@ -398,7 +412,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -415,7 +429,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error summary: Create blacklisted rule tags: @@ -426,11 +440,13 @@ paths: 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: @@ -439,6 +455,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -448,20 +465,23 @@ paths: - 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' + $ref: "#/components/schemas/deleted_blacklist_rule_response" description: successfully deleted rule "401": content: @@ -475,7 +495,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -491,7 +511,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -508,7 +528,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error summary: Delete blacklisted rule tags: @@ -526,6 +546,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -535,15 +556,19 @@ paths: - 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 @@ -553,41 +578,52 @@ paths: 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' + $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: @@ -600,7 +636,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -617,7 +653,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -636,6 +672,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -645,33 +682,45 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/api_keys_create' + content: + application/json: + schema: + $ref: "#/components/schemas/api_keys_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' + $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: @@ -684,7 +733,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "422": content: @@ -699,7 +748,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -716,7 +765,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -730,11 +779,13 @@ paths: 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: @@ -743,6 +794,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -752,23 +804,28 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/delete_api_keys_response' + $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: @@ -781,7 +838,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -797,7 +854,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -814,7 +871,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -827,11 +884,13 @@ paths: 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: @@ -840,6 +899,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -849,31 +909,38 @@ paths: - 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' + $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: @@ -886,7 +953,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -902,7 +969,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -919,7 +986,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -932,11 +999,13 @@ paths: 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: @@ -945,6 +1014,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -954,17 +1024,18 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/api_key_update_request' + $ref: "#/components/schemas/api_key_update_request" responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/api_key_response' + $ref: "#/components/schemas/api_key_response" description: successful operation "404": content: @@ -980,7 +1051,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "401": content: @@ -994,7 +1065,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -1011,7 +1082,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1031,6 +1102,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1040,38 +1112,49 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/balance_response' + $ref: "#/components/schemas/balance_response" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -1084,7 +1167,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -1101,7 +1184,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1120,6 +1203,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1129,15 +1213,19 @@ paths: - 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 @@ -1147,56 +1235,73 @@ paths: 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' + $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: @@ -1209,7 +1314,7 @@ paths: type: parameter_validation_error log_id: 6462aa7c90fef20001633546 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: whitelist validation error "500": content: @@ -1226,7 +1331,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1239,11 +1344,13 @@ paths: 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: @@ -1252,6 +1359,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1261,48 +1369,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/charge_update' + 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' + $ref: "#/components/schemas/charges_data_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: @@ -1315,7 +1441,7 @@ paths: type: parameter_validation_error log_id: 6462aa7c90fef20001633546 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: whitelist validation error "404": content: @@ -1331,7 +1457,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -1348,7 +1474,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1362,11 +1488,13 @@ paths: 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: @@ -1375,6 +1503,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1384,22 +1513,50 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/charge_create' + 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/charges" + 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' + $ref: "#/components/schemas/charges_data_response_1" description: successful "401": content: @@ -1413,7 +1570,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -1429,7 +1586,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "428": content: @@ -1446,7 +1603,7 @@ paths: object: error type: precondition_required_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: Precondition Required "500": content: @@ -1463,7 +1620,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1477,11 +1634,13 @@ paths: 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: @@ -1490,6 +1649,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1499,22 +1659,50 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/charge_create' + 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/charges" + 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' + $ref: "#/components/schemas/ordersCreateCharges_200_response" description: successful "401": content: @@ -1528,7 +1716,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -1544,7 +1732,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "428": content: @@ -1561,7 +1749,7 @@ paths: object: error type: precondition_required_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: Precondition Required "500": content: @@ -1578,7 +1766,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1599,6 +1787,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1608,7 +1797,9 @@ paths: - 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 @@ -1618,56 +1809,73 @@ paths: 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' + $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: @@ -1680,7 +1888,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -1697,7 +1905,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1711,7 +1919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/create_company_request' + $ref: "#/components/schemas/Create_Company_Request" description: Company data required: true responses: @@ -1719,28 +1927,38 @@ paths: content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/company_response' + $ref: "#/components/schemas/company_response" description: Company created successfully headers: Date: description: The date and time that the response was sent + explode: false schema: type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: type: string + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: type: string + style: simple Conekta-Media-Type: + explode: false schema: type: string + style: simple "401": content: application/vnd.conekta-v2.2.0+json: @@ -1753,7 +1971,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -1770,7 +1988,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1783,11 +2001,13 @@ paths: 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: @@ -1796,6 +2016,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1805,38 +2026,49 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/company_response' + $ref: "#/components/schemas/company_response" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -1849,7 +2081,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -1865,7 +2097,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -1882,7 +2114,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -1904,6 +2136,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -1913,6 +2146,7 @@ paths: - es - en type: string + style: simple responses: "200": content: @@ -2026,35 +2260,45 @@ paths: three_ds_enabled: true three_ds_mode: strict schema: - $ref: '#/components/schemas/company_response' + $ref: "#/components/schemas/company_response" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -2067,7 +2311,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -2084,7 +2328,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2097,12 +2341,14 @@ paths: 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: @@ -2111,6 +2357,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2120,11 +2367,12 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/company_document_request' + $ref: "#/components/schemas/CompanyDocumentRequest" description: Document information to update. required: true responses: @@ -2132,28 +2380,38 @@ paths: content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/company_document_response' + $ref: "#/components/schemas/CompanyDocumentResponse" description: Document updated successfully. headers: Date: description: The date and time that the response was sent + explode: false schema: type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: type: string + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: type: string + style: simple Conekta-Media-Type: + explode: false schema: type: string + style: simple "401": content: application/vnd.conekta-v2.2.0+json: @@ -2166,7 +2424,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -2182,7 +2440,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -2199,7 +2457,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2211,12 +2469,14 @@ paths: 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: @@ -2225,6 +2485,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2234,11 +2495,12 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/company_document_request' + $ref: "#/components/schemas/CompanyDocumentRequest" description: Document information to upload. required: true responses: @@ -2246,28 +2508,38 @@ paths: content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/company_document_response' + $ref: "#/components/schemas/CompanyDocumentResponse" description: Document uploaded successfully. headers: Date: description: The date and time that the response was sent + explode: false schema: type: string + style: simple Content-Type: description: The format of the response body + explode: false schema: type: string + style: simple Content-Length: description: The length of the response body in bytes + explode: false schema: type: string + style: simple Connection: description: The type of connection used to transfer the response + explode: false schema: type: string + style: simple Conekta-Media-Type: + explode: false schema: type: string + style: simple "401": content: application/vnd.conekta-v2.2.0+json: @@ -2280,7 +2552,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -2296,7 +2568,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -2313,7 +2585,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2326,12 +2598,14 @@ paths: 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: @@ -2340,6 +2614,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2349,35 +2624,46 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: items: - $ref: '#/components/schemas/company_document_response' + $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: @@ -2390,7 +2676,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -2406,7 +2692,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -2423,7 +2709,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2445,6 +2731,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2454,15 +2741,19 @@ paths: - 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 @@ -2472,56 +2763,73 @@ paths: 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' + $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: @@ -2534,7 +2842,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -2551,7 +2859,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2572,6 +2880,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2581,48 +2890,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/customer' + content: + application/json: + schema: + $ref: "#/components/schemas/customer_request" + description: requested field for customer + required: true responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/customer_response' + $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: @@ -2635,7 +2962,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -2649,7 +2976,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "422": content: @@ -2664,7 +2991,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -2681,7 +3008,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2695,11 +3022,13 @@ paths: 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: @@ -2708,6 +3037,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2717,20 +3047,23 @@ paths: - 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' + $ref: "#/components/schemas/customer_response" description: successful operation "422": content: @@ -2745,7 +3078,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -2759,7 +3092,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -2775,7 +3108,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -2792,7 +3125,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2805,11 +3138,13 @@ paths: 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: @@ -2818,6 +3153,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2827,20 +3163,23 @@ paths: - 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' + $ref: "#/components/schemas/customer_response" description: successful operation "401": content: @@ -2854,7 +3193,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -2870,7 +3209,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -2887,7 +3226,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -2900,11 +3239,13 @@ paths: 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: @@ -2913,6 +3254,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -2922,22 +3264,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/update_customer' + content: + application/json: + schema: + $ref: "#/components/schemas/update_customer_request" + description: requested field for customer + required: true responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/customer_response' + $ref: "#/components/schemas/customer_response" description: successful operation "401": content: @@ -2951,7 +3301,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -2965,7 +3315,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "422": content: @@ -2980,7 +3330,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -2997,7 +3347,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3011,11 +3361,13 @@ paths: 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: @@ -3024,6 +3376,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3033,22 +3386,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/customer_fiscal_entities' + 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' + $ref: "#/components/schemas/create_customer_fiscal_entities_response" description: successful operation "401": content: @@ -3062,7 +3423,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -3078,7 +3439,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -3093,7 +3454,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -3110,7 +3471,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3124,18 +3485,22 @@ paths: 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: @@ -3144,6 +3509,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3153,22 +3519,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/customer_update_fiscal_entities' + 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' + $ref: "#/components/schemas/update_customer_fiscal_entities_response" description: successful operation "401": content: @@ -3182,7 +3556,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -3198,7 +3572,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -3213,7 +3587,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -3230,7 +3604,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3244,11 +3618,13 @@ paths: 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: @@ -3257,6 +3633,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3266,15 +3643,19 @@ paths: - 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 @@ -3284,30 +3665,37 @@ paths: 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' + $ref: "#/components/schemas/get_order_discount_lines_response" description: successful "401": content: @@ -3321,7 +3709,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -3338,7 +3726,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3351,11 +3739,13 @@ paths: 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: @@ -3364,6 +3754,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3373,22 +3764,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/discount_line_create' + 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' + $ref: "#/components/schemas/discount_lines_order_response" description: successful "401": content: @@ -3402,7 +3801,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -3418,7 +3817,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -3435,7 +3834,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3449,18 +3848,22 @@ paths: 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: @@ -3469,6 +3872,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3478,20 +3882,23 @@ paths: - 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' + $ref: "#/components/schemas/discount_lines_order_response" description: successful "401": content: @@ -3505,7 +3912,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -3521,7 +3928,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -3536,7 +3943,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -3553,7 +3960,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3566,18 +3973,22 @@ paths: 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: @@ -3586,6 +3997,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3595,20 +4007,23 @@ paths: - 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' + $ref: "#/components/schemas/discount_lines_order_response" description: successful "401": content: @@ -3622,7 +4037,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -3638,7 +4053,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -3653,7 +4068,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -3670,7 +4085,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3683,18 +4098,22 @@ paths: 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: @@ -3703,6 +4122,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3712,22 +4132,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/discount_line_update' + 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' + $ref: "#/components/schemas/discount_lines_order_response" description: successful "401": content: @@ -3741,7 +4169,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -3757,7 +4185,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -3772,7 +4200,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -3789,7 +4217,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3808,6 +4236,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3817,15 +4246,19 @@ paths: - 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 @@ -3835,56 +4268,73 @@ paths: 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' + $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: @@ -3897,7 +4347,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -3914,7 +4364,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -3934,6 +4384,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -3943,53 +4394,68 @@ paths: - 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' + $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: @@ -4002,7 +4468,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -4018,7 +4484,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -4035,7 +4501,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4049,11 +4515,13 @@ paths: 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: @@ -4062,6 +4530,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4071,11 +4540,12 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/resend_request' + $ref: "#/components/schemas/resendEvent_request" description: requested fields for resend an event required: true responses: @@ -4083,7 +4553,7 @@ paths: content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/events_resend_response' + $ref: "#/components/schemas/event_webhook_resend_response" description: successful operation "401": content: @@ -4097,7 +4567,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -4113,7 +4583,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -4130,7 +4600,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4150,6 +4620,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4159,15 +4630,19 @@ paths: - 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 @@ -4177,56 +4652,73 @@ paths: 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' + $ref: "#/components/schemas/log_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: @@ -4239,7 +4731,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -4256,7 +4748,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4270,11 +4762,13 @@ paths: 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: @@ -4283,6 +4777,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4292,20 +4787,23 @@ paths: - 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' + $ref: "#/components/schemas/log_response_for_request_1" description: successful "401": content: @@ -4319,7 +4817,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -4335,7 +4833,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -4352,7 +4850,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4372,6 +4870,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4381,15 +4880,19 @@ paths: - 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 @@ -4399,39 +4902,51 @@ paths: 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 @@ -4439,7 +4954,9 @@ paths: 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 @@ -4447,7 +4964,9 @@ paths: 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 @@ -4455,7 +4974,9 @@ paths: 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 @@ -4463,7 +4984,9 @@ paths: 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 @@ -4471,12 +4994,13 @@ paths: 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' + $ref: "#/components/schemas/get_orders_response" description: successful operation "401": content: @@ -4490,7 +5014,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -4507,7 +5031,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4526,6 +5050,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4535,33 +5060,805 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/order' + 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/a_order" + description: requested field for order + required: true responses: "200": content: application/vnd.conekta-v2.2.0+json: examples: cash: - $ref: '#/components/examples/order_cash' + value: + livemode: true + amount: 1560 + currency: MXN + payment_status: pending_payment + amount_refunded: 0 + split_payment: false + customer_info: + email: franco.longhi@conekta.com + phone: 539-933-3810 + name: franco golden + corporate: null + customer_id: null + object: customer_info + shipping_contact: null + channel: null + fiscal_entity: null + object: order + id: ord_2xayxSvfWzQ2TLz7r + metadata: {} + is_refundable: false + processing_mode: null + created_at: 1741103510 + updated_at: 1741103510 + line_items: + object: list + has_more: false + total: 1 + data: + - name: APOYO URGENTE REFERENCIA + description: null + unit_price: 1560 + quantity: 1 + sku: COL094 + tags: null + brand: CHEDRAUI + type: null + object: line_item + id: line_item_2xayxSvfWzQ2TLz7p + parent_id: ord_2xayxSvfWzQ2TLz7r + metadata: {} + antifraud_info: {} + shipping_lines: null + tax_lines: null + discount_lines: null + charges: + object: list + has_more: false + total: 1 + data: + - id: 67c72196e777ac0001f2140c + livemode: true + created_at: 1741103510 + currency: MXN + failure_code: null + failure_message: null + monthly_installments: null + device_fingerprint: null + channel: null + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001140326893401915.png + store: null + auth_code: null + agreement: null + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + reference: 10001140326893401915 + cashier_id: null + product_type: cash_in + object: charge + description: Payment from order + is_refundable: false + reference_id: null + status: pending_payment + amount: 1560 + paid_at: null + customer_id: "" + order_id: ord_2xayxSvfWzQ2TLz7r + refunds: null multiples_cash_charges: - $ref: '#/components/examples/order_cash_multiple' + value: + livemode: true + amount: 156000 + currency: MXN + payment_status: pending_payment + amount_refunded: 0 + split_payment: false + customer_info: + email: franco.longhi@conekta.com + phone: 884-712-6894 + name: franco golden + corporate: null + customer_id: null + object: customer_info + shipping_contact: null + channel: null + fiscal_entity: null + object: order + id: ord_2xazGvtKYTjxTUZU3 + metadata: {} + is_refundable: false + processing_mode: null + created_at: 1741104962 + updated_at: 1741104963 + line_items: + object: list + has_more: false + total: 1 + data: + - name: APOYO URGENTE REFERENCIA + description: null + unit_price: 156000 + quantity: 1 + sku: COL094 + tags: null + brand: CHEDRAUI + type: null + object: line_item + id: line_item_2xazGvtKYTjxTUZU1 + parent_id: ord_2xazGvtKYTjxTUZU3 + metadata: {} + antifraud_info: {} + shipping_lines: null + tax_lines: null + discount_lines: null + charges: + object: list + has_more: false + total: 2 + data: + - id: 67c72742e777ac0001f21463 + livemode: true + created_at: 1741104962 + currency: MXN + failure_code: null + failure_message: null + monthly_installments: null + device_fingerprint: null + channel: null + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/bbva/10830309851141878231.png + store: null + auth_code: null + agreement: "2409992" + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - BBVA ATM + reference: 10830309851141878231 + cashier_id: null + product_type: bbva_cash_in + object: charge + description: Payment from order + is_refundable: false + reference_id: null + status: pending_payment + amount: 156000 + paid_at: null + customer_id: "" + order_id: ord_2xazGvtKYTjxTUZU3 + refunds: null + - id: 67c72742e777ac0001f2145b + livemode: true + created_at: 1741104962 + currency: MXN + failure_code: null + failure_message: null + monthly_installments: null + device_fingerprint: null + channel: null + payment_method: + service_name: Cash + barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001244873740402013.png + store: null + auth_code: null + agreement: null + object: cash_payment + type: cash + expires_at: 1743724800 + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + reference: 10001244873740402013 + cashier_id: null + product_type: cash_in + object: charge + description: Payment from order + is_refundable: false + reference_id: null + status: pending_payment + amount: 156000 + paid_at: null + customer_id: "" + order_id: ord_2xazGvtKYTjxTUZU3 + refunds: null card: - $ref: '#/components/examples/order_card' + value: + id: 63dab7d00558720001bb3c7d + livemode: "true," + created_at: "1675278289," + currency: MXN + failure_code: suspected_fraud + failure_message: Este cargo ha sido declinado porque el comportamiento + del comprador es sospechoso. + device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba + payment_method: + name: Fulanito Perez + exp_month: 2 + exp_year: 30 + object: card_payment + type: credit + last4: 4242 + brand: visa + issuer: BANAMEX + account_type: Credit + country: MX + fraud_indicators: + - description: El usuario está utilizando una tarjeta de crédito + o débito de prueba en modo producción. + weight: null + value: null + object: charge + description: Payment from order + status: declined + amount: "20001," + fee: "116," + customer_id: null + order_id: ord_2tHuwPhgSwq6Gt7Rg bnpl: - $ref: '#/components/examples/order_bnpl' + value: + amount: 300000 + amount_refunded: 0 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pWw + segment: Checkout + charges: + data: + - amount: 300000 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pXA + segment: Checkout + created_at: 1741015718 + currency: MXN + customer_id: "" + description: Payment from order + device_fingerprint: null + failure_code: null + failure_message: null + id: 67c5caa665f9b400015dec40 + is_refundable: false + livemode: true + monthly_installments: null + object: charge + order_id: ord_2xaegxs5s69VP4pWy + paid_at: null + payment_method: + cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + expires_at: 1743694118 + failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + object: bnpl_payment + product_type: aplazo_bnpl + redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ + success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 + type: bnpl + reference_id: null + refunds: null + status: pending_payment + has_more: false + object: list + total: 1 + checkout: null + created_at: 1741015718 + currency: MXN + customer_info: + corporate: false + customer_custom_reference: null + customer_id: cus_2xZfwfjXxX9tZhVey + email: alexis.ruiz@google.com + name: Pedro Ruiz + object: customer_info + phone: "+5215555555555" + discount_lines: null + fiscal_entity: null + id: ord_2xaegxs5s69VP4pWy + is_refundable: false + line_items: + data: + - antifraud_info: {} + brand: null + description: null + id: line_item_2xaegxs5s69VP4pWv + metadata: {} + name: Test creditea + object: line_item + parent_id: ord_2xaegxs5s69VP4pWy + quantity: 1 + sku: null + tags: null + type: null + unit_price: 300000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + payment_status: pending_payment + processing_mode: null + shipping_contact: null + shipping_lines: null + split_payment: false + tax_lines: null + updated_at: 1741015718 pay_by_bank: - $ref: '#/components/examples/order_pbb' - schema: - $ref: '#/components/schemas/order_response' + value: + amount: 300000 + amount_refunded: 0 + charges: + data: + - amount: 300000 + channel: + checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f + checkout_request_type: PaymentLink + id: channel_2xaegxs5s69VP4pXA + segment: Checkout + created_at: 1741015718 + currency: MXN + customer_id: "" + description: Payment from order + device_fingerprint: null + failure_code: null + failure_message: null + id: 67c5caa665f9b400015dec40 + is_refundable: false + livemode: true + monthly_installments: null + object: charge + order_id: ord_2xaegxs5s69VP4pWy + paid_at: null + payment_method: + expires_at: 1743694118 + object: pay_by_bank_payment + product_type: bbva_pay_by_bank + redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ + deep_link: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 + type: pay_by_bank + reference: "22277523174328893295" + reference_id: null + refunds: null + status: pending_payment + has_more: false + object: list + total: 1 + checkout: null + created_at: 1741015718 + currency: MXN + customer_info: + corporate: false + customer_custom_reference: null + customer_id: cus_2xZfwfjXxX9tZhVey + email: alexis.ruiz@google.com + name: Pedro Ruiz + object: customer_info + phone: "+5215555555555" + discount_lines: null + fiscal_entity: null + id: ord_2xaegxs5s69VP4pWy + is_refundable: false + line_items: + data: + - antifraud_info: {} + brand: null + description: null + id: line_item_2xaegxs5s69VP4pWv + metadata: {} + name: Test pay by bank + object: line_item + parent_id: ord_2xaegxs5s69VP4pWy + quantity: 1 + sku: null + tags: null + type: null + unit_price: 300000 + has_more: false + object: list + total: 1 + livemode: true + metadata: {} + object: order + payment_status: pending_payment + processing_mode: null + shipping_contact: null + shipping_lines: null + split_payment: false + tax_lines: null + updated_at: 1741015718 + schema: + $ref: "#/components/schemas/order_response" description: successful operation "422": content: @@ -4576,7 +5873,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -4590,7 +5887,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -4604,7 +5901,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "500": content: @@ -4621,7 +5918,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4635,11 +5932,13 @@ paths: 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: @@ -4648,6 +5947,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4657,20 +5957,23 @@ paths: - 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' + $ref: "#/components/schemas/order_response" description: successful "401": content: @@ -4684,7 +5987,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -4700,7 +6003,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -4717,7 +6020,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4730,11 +6033,13 @@ paths: 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: @@ -4743,6 +6048,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4752,14 +6058,20 @@ paths: - es - en type: string + style: simple requestBody: - $ref: '#/components/requestBodies/order_update' + 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' + $ref: "#/components/schemas/order_response" description: successful "401": content: @@ -4773,7 +6085,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -4789,7 +6101,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -4804,7 +6116,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -4821,7 +6133,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4835,11 +6147,13 @@ paths: 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: @@ -4848,6 +6162,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4857,20 +6172,23 @@ paths: - 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' + $ref: "#/components/schemas/order_response" description: successful "401": content: @@ -4884,7 +6202,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -4898,7 +6216,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -4914,7 +6232,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "428": content: @@ -4931,7 +6249,7 @@ paths: object: error type: precondition_required_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: Precondition Required "500": content: @@ -4948,7 +6266,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -4962,11 +6280,13 @@ paths: 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: @@ -4975,6 +6295,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -4984,26 +6305,29 @@ paths: - 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' + $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' + $ref: "#/components/schemas/order_response" description: successful "401": content: @@ -5017,7 +6341,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -5033,7 +6357,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "428": content: @@ -5050,7 +6374,7 @@ paths: object: error type: precondition_required_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: Precondition Required "500": content: @@ -5067,7 +6391,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5081,11 +6405,13 @@ paths: 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: @@ -5094,6 +6420,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5103,22 +6430,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/product_create' + 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' + $ref: "#/components/schemas/product_order_response" description: successful "401": content: @@ -5132,7 +6467,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -5148,7 +6483,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -5165,7 +6500,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5179,18 +6514,22 @@ paths: 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: @@ -5199,6 +6538,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5208,20 +6548,23 @@ paths: - 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' + $ref: "#/components/schemas/product_order_response" description: successful "401": content: @@ -5235,7 +6578,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "422": content: @@ -5250,7 +6593,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "404": content: @@ -5266,7 +6609,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -5283,7 +6626,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5296,18 +6639,22 @@ paths: 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: @@ -5316,6 +6663,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5325,22 +6673,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/product_update' + 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' + $ref: "#/components/schemas/product_order_response" description: successful "401": content: @@ -5354,7 +6710,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "422": content: @@ -5369,7 +6725,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "404": content: @@ -5385,7 +6741,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -5402,7 +6758,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5417,11 +6773,13 @@ paths: 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: @@ -5430,6 +6788,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5439,22 +6798,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/order_refunds_request' + 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' + $ref: "#/components/schemas/order_response" description: successful "401": content: @@ -5468,7 +6835,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -5482,7 +6849,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -5498,7 +6865,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -5513,7 +6880,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -5530,7 +6897,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5545,18 +6912,22 @@ paths: 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: @@ -5565,6 +6936,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5574,20 +6946,23 @@ paths: - 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' + $ref: "#/components/schemas/order_response" description: successful "401": content: @@ -5601,7 +6976,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -5615,7 +6990,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -5631,7 +7006,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -5646,7 +7021,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -5663,7 +7038,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5683,6 +7058,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5692,7 +7068,9 @@ paths: - 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 @@ -5702,30 +7080,37 @@ paths: 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' + $ref: "#/components/schemas/payout_orders_response" description: successful operation "401": content: @@ -5739,7 +7124,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -5756,7 +7141,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5775,6 +7160,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5784,14 +7170,20 @@ paths: - es - en type: string + style: simple requestBody: - $ref: '#/components/requestBodies/payout_order' + 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' + $ref: "#/components/schemas/payout_order_response" description: successful operation "422": content: @@ -5806,7 +7198,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -5820,7 +7212,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -5834,7 +7226,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -5850,7 +7242,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -5867,7 +7259,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5882,11 +7274,13 @@ paths: 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: @@ -5895,6 +7289,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5904,12 +7299,13 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/payout_order_response' + $ref: "#/components/schemas/payout_order_response" description: successful operation "401": content: @@ -5923,7 +7319,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -5939,7 +7335,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -5956,7 +7352,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -5971,11 +7367,13 @@ paths: 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: @@ -5984,6 +7382,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -5993,12 +7392,13 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/payout_order_response' + $ref: "#/components/schemas/payout_order_response" description: successful operation "401": content: @@ -6012,7 +7412,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -6028,7 +7428,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -6045,7 +7445,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -6065,6 +7465,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -6074,15 +7475,19 @@ paths: - 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 @@ -6092,56 +7497,73 @@ paths: 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' + $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: @@ -6154,7 +7576,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -6168,7 +7590,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "422": content: @@ -6183,7 +7605,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -6200,7 +7622,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -6218,6 +7640,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -6227,50 +7650,68 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/checkout' + content: + application/json: + schema: + $ref: "#/components/schemas/checkout_request" + description: requested field for checkout + required: true responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/checkout_response' + $ref: "#/components/schemas/checkout_response" description: successful operation headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -6283,7 +7724,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -6297,7 +7738,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "422": content: @@ -6312,7 +7753,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -6329,7 +7770,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -6348,6 +7789,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -6357,53 +7799,68 @@ paths: - 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' + $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: @@ -6416,7 +7873,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -6430,7 +7887,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -6446,7 +7903,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -6461,7 +7918,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -6478,7 +7935,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -6497,6 +7954,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -6506,53 +7964,68 @@ paths: - 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' + $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: @@ -6565,7 +8038,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -6579,7 +8052,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -6595,7 +8068,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -6610,7 +8083,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -6627,7 +8100,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -6646,6 +8119,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -6655,55 +8129,75 @@ paths: - 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: - $ref: '#/components/requestBodies/checkout_email' + 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' + $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: @@ -6716,7 +8210,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -6730,7 +8224,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -6746,7 +8240,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -6761,7 +8255,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -6778,7 +8272,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -6797,6 +8291,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -6806,55 +8301,75 @@ paths: - 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: - $ref: '#/components/requestBodies/checkout_sms' + 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' + $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: @@ -6867,7 +8382,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -6881,7 +8396,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -6897,7 +8412,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -6912,7 +8427,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -6929,7 +8444,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -6943,11 +8458,13 @@ paths: 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: @@ -6956,6 +8473,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -6965,15 +8483,19 @@ paths: - 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 @@ -6983,32 +8505,82 @@ paths: 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: - $ref: '#/components/examples/customer_payment_source_cash_example' summary: Cash + value: + next_page_url: "null," + previous_page_url: "null," + has_more: "false," + object: "list," + data: + - id: off_ref_2xayPUpcxeTrotDHr + object: payment_source + provider: Cash + store_names: + - 7 Eleven + - Farmacias del Ahorro + - CIRCLE K + - Tiendas Extra + - Farmacia Benavides + - Soriana + - WALDO'S + - ELECZION + - Super Kiosko + - Farmacias Bazar + - Wolworth + - Del Sol + - Yepas + - Farmacias De Dios + - Farmacias Nosarco + - Farmacias Santa Cruz + - Farmacentro + - Farmacias GyM + - Farmacias San Francisco de Asis + - Farmacias Union + - Farmacias Zapotlan + - Farmatodo + - Al Super + - BBVA ATM + type: cash_recurrent + reference: 10001189383263801812_caca + barcode: 10001189383263801812 + barcode_url: https://barcode.conekta.com/cash/cashin/10001189383263801812.png + expires_at: 0 + created_at: 1741100921 + parent_id: cus_2xayPFXsb4LBZ2GUL + agreements: + - provider: bbva_cash_in + agreement: 2409526 card: summary: Card value: @@ -7033,7 +8605,7 @@ paths: payment_source_status: active visible_on_checkout: false schema: - $ref: '#/components/schemas/get_payment_method_response' + $ref: "#/components/schemas/get_payment_method_response" description: successful operation "401": content: @@ -7047,7 +8619,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -7063,7 +8635,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -7080,7 +8652,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7093,11 +8665,13 @@ paths: 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: @@ -7106,6 +8680,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7115,22 +8690,39 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/customer_payment_methods' + 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' + $ref: "#/components/schemas/create_customer_payment_methods_response" description: successful operation "401": content: @@ -7144,7 +8736,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -7160,7 +8752,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -7175,7 +8767,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -7192,7 +8784,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7206,18 +8798,22 @@ paths: 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: @@ -7226,6 +8822,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7235,20 +8832,23 @@ paths: - 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' + $ref: "#/components/schemas/update_customer_payment_methods_response" description: successful operation "401": content: @@ -7262,7 +8862,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -7278,7 +8878,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -7293,7 +8893,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -7310,7 +8910,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7323,18 +8923,22 @@ paths: 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: @@ -7343,6 +8947,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7352,22 +8957,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/customer_update_payment_methods' + 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' + $ref: "#/components/schemas/update_customer_payment_methods_response" description: successful operation "401": content: @@ -7381,7 +8994,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -7397,7 +9010,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -7412,7 +9025,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -7429,7 +9042,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7448,6 +9061,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7457,15 +9071,19 @@ paths: - 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 @@ -7475,56 +9093,73 @@ paths: 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' + $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: @@ -7538,7 +9173,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -7552,7 +9187,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -7569,7 +9204,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7588,6 +9223,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7597,48 +9233,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/plan' + content: + application/json: + schema: + $ref: "#/components/schemas/a_plan" + description: requested field for plan + required: true responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/plan_response' + $ref: "#/components/schemas/plan_response" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -7652,7 +9306,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -7666,7 +9320,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -7683,7 +9337,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7696,11 +9350,13 @@ paths: 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: @@ -7709,6 +9365,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7718,38 +9375,49 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/plan_response' + $ref: "#/components/schemas/plan_response" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -7763,7 +9431,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -7777,7 +9445,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -7793,7 +9461,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -7810,7 +9478,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7822,11 +9490,13 @@ paths: 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: @@ -7835,6 +9505,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7844,46 +9515,59 @@ paths: - 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' + $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: @@ -7897,7 +9581,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -7911,7 +9595,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -7927,7 +9611,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -7944,7 +9628,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -7956,11 +9640,13 @@ paths: 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: @@ -7969,6 +9655,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -7978,48 +9665,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/plan_update' + 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' + $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: @@ -8033,7 +9738,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -8047,7 +9752,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8063,7 +9768,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -8080,7 +9785,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8094,11 +9799,13 @@ paths: 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: @@ -8107,6 +9814,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8116,25 +9824,41 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/shipping_create' + 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: - $ref: '#/components/examples/shipping' - schema: - $ref: '#/components/schemas/shipping_order_response' + 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: @@ -8148,7 +9872,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8164,7 +9888,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -8181,7 +9905,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8195,18 +9919,22 @@ paths: 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: @@ -8215,6 +9943,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8224,20 +9953,23 @@ paths: - 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' + $ref: "#/components/schemas/shipping_order_response" description: successful "401": content: @@ -8251,7 +9983,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8267,7 +9999,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -8282,7 +10014,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "428": content: @@ -8299,7 +10031,7 @@ paths: object: error type: precondition_required_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: Precondition Required "500": content: @@ -8316,7 +10048,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8329,18 +10061,22 @@ paths: 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: @@ -8349,6 +10085,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8358,22 +10095,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/shipping_create' + 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' + $ref: "#/components/schemas/shipping_order_response" description: successful "401": content: @@ -8387,7 +10132,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8403,7 +10148,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -8418,7 +10163,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -8435,7 +10180,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8449,11 +10194,13 @@ paths: 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: @@ -8462,6 +10209,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8471,22 +10219,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/customer_shipping_contacts' + 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' + $ref: "#/components/schemas/CreateCustomerShippingContacts_200_response" description: successful operation "401": content: @@ -8500,7 +10256,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8516,7 +10272,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -8531,7 +10287,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -8548,7 +10304,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8562,18 +10318,22 @@ paths: 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: @@ -8582,6 +10342,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8591,20 +10352,23 @@ paths: - 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' + $ref: "#/components/schemas/CreateCustomerShippingContacts_200_response" description: successful operation "401": content: @@ -8618,7 +10382,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8634,7 +10398,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -8649,7 +10413,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -8666,7 +10430,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8679,18 +10443,22 @@ paths: 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: @@ -8699,6 +10467,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8708,22 +10477,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/customer_update_shipping_contacts' + 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' + $ref: "#/components/schemas/CreateCustomerShippingContacts_200_response" description: successful operation "401": content: @@ -8737,7 +10514,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8753,7 +10530,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -8768,7 +10545,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -8785,7 +10562,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8798,12 +10575,14 @@ paths: 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: @@ -8812,6 +10591,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8821,15 +10601,19 @@ paths: - 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 @@ -8839,56 +10623,73 @@ paths: 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -8901,7 +10702,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -8917,7 +10718,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -8934,7 +10735,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -8947,12 +10748,14 @@ paths: 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: @@ -8961,6 +10764,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -8970,48 +10774,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/subscription' + 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -9025,7 +10847,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -9039,7 +10861,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9055,7 +10877,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -9072,7 +10894,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -9085,19 +10907,23 @@ paths: 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: @@ -9106,6 +10932,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -9115,46 +10942,59 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -9167,7 +11007,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9183,7 +11023,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -9200,7 +11040,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -9212,19 +11052,23 @@ paths: 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: @@ -9233,6 +11077,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -9242,48 +11087,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/subscription_update' + 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -9297,7 +11160,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -9311,7 +11174,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9327,7 +11190,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -9344,7 +11207,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -9357,19 +11220,23 @@ paths: 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: @@ -9378,6 +11245,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -9387,15 +11255,19 @@ paths: - 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 @@ -9405,56 +11277,73 @@ paths: 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' + $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: @@ -9467,7 +11356,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9483,7 +11372,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -9500,7 +11389,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -9513,19 +11402,23 @@ paths: 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: @@ -9534,6 +11427,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -9543,46 +11437,59 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_2" 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: @@ -9595,7 +11502,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9611,7 +11518,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -9628,7 +11535,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -9641,19 +11548,23 @@ paths: 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: @@ -9662,6 +11573,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -9671,46 +11583,59 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -9723,7 +11648,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9739,7 +11664,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -9756,7 +11681,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -9769,19 +11694,23 @@ paths: 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: @@ -9790,6 +11719,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -9799,46 +11729,59 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -9851,7 +11794,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9867,7 +11810,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -9884,7 +11827,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -9897,19 +11840,23 @@ paths: 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: @@ -9918,6 +11865,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -9927,46 +11875,74 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -9979,7 +11955,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -9995,23 +11971,8 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $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: @@ -10027,7 +11988,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -10040,12 +12001,14 @@ paths: 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: @@ -10054,6 +12017,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10063,46 +12027,59 @@ paths: - 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' + $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: @@ -10117,7 +12094,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "401": content: @@ -10131,7 +12108,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error security: - bearerAuth: [] @@ -10144,12 +12121,14 @@ paths: 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: @@ -10158,6 +12137,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10167,46 +12147,59 @@ paths: - 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' + $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: @@ -10221,7 +12214,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "401": content: @@ -10235,7 +12228,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "422": content: @@ -10250,7 +12243,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error security: - bearerAuth: [] @@ -10265,11 +12258,13 @@ paths: 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: @@ -10278,6 +12273,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10287,38 +12283,49 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/subscription_response' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -10331,7 +12338,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -10347,7 +12354,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -10364,7 +12371,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -10379,11 +12386,13 @@ paths: 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: @@ -10392,6 +12401,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10401,48 +12411,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/subscription' + 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -10456,7 +12484,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -10470,7 +12498,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -10486,7 +12514,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -10503,7 +12531,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -10518,11 +12546,13 @@ paths: 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: @@ -10531,6 +12561,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10540,48 +12571,66 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/subscription_update' + 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -10595,7 +12644,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "401": content: @@ -10609,7 +12658,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -10625,7 +12674,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -10642,7 +12691,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -10657,11 +12706,13 @@ paths: 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: @@ -10670,6 +12721,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10679,46 +12731,59 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -10731,7 +12796,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -10747,7 +12812,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -10764,7 +12829,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -10781,11 +12846,13 @@ paths: 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: @@ -10794,6 +12861,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10803,46 +12871,59 @@ paths: - 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' + $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: @@ -10855,7 +12936,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -10869,7 +12950,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -10885,7 +12966,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -10900,7 +12981,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -10917,7 +12998,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -10932,11 +13013,13 @@ paths: 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: @@ -10945,6 +13028,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -10954,46 +13038,59 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -11006,7 +13103,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -11020,7 +13117,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -11036,7 +13133,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -11053,7 +13150,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11068,11 +13165,13 @@ paths: 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: @@ -11081,6 +13180,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11090,46 +13190,59 @@ paths: - 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' + $ref: "#/components/schemas/subscription_response_1" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -11142,7 +13255,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "402": content: @@ -11156,7 +13269,7 @@ paths: object: error type: processing_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: payment required error "404": content: @@ -11172,7 +13285,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "422": content: @@ -11187,7 +13300,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -11204,7 +13317,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11218,11 +13331,13 @@ paths: 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: @@ -11231,6 +13346,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11240,22 +13356,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/order_tax' + content: + application/json: + schema: + $ref: "#/components/schemas/a_order_tax_lines_inner" + description: requested field for a taxes + required: true responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/update_order_tax_response' + $ref: "#/components/schemas/ordersCreateTaxes_200_response" description: successful "401": content: @@ -11269,7 +13393,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -11285,7 +13409,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -11302,7 +13426,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11316,18 +13440,22 @@ paths: 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: @@ -11336,6 +13464,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11345,20 +13474,23 @@ paths: - 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_order_tax_response' + $ref: "#/components/schemas/ordersCreateTaxes_200_response" description: successful "401": content: @@ -11372,7 +13504,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "422": content: @@ -11387,7 +13519,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "404": content: @@ -11403,7 +13535,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -11420,7 +13552,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11433,18 +13565,22 @@ paths: 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: @@ -11453,6 +13589,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11462,22 +13599,30 @@ paths: - es - en type: string + style: simple - description: "In the case of a holding company, the company id of the child\ \ company to which will process the request." example: 6441b6376b60c3a638da80af + explode: false in: header name: X-Child-Company-Id required: false schema: type: string + style: simple requestBody: - $ref: '#/components/requestBodies/order_tax_update' + 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/update_order_tax_response' + $ref: "#/components/schemas/ordersCreateTaxes_200_response" description: successful "401": content: @@ -11491,7 +13636,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "422": content: @@ -11506,7 +13651,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "404": content: @@ -11522,7 +13667,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -11539,7 +13684,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11560,6 +13705,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11569,40 +13715,56 @@ paths: - es - en type: string + style: simple requestBody: - $ref: '#/components/requestBodies/token' + 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' + $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: @@ -11615,7 +13777,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "422": content: @@ -11630,7 +13792,7 @@ paths: object: error type: parameter_validation_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: parameter validation error "500": content: @@ -11647,7 +13809,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11667,6 +13829,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11676,15 +13839,19 @@ paths: - 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 @@ -11694,78 +13861,101 @@ paths: 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' + $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: @@ -11778,7 +13968,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -11795,7 +13985,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11815,6 +14005,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11824,53 +14015,68 @@ paths: - 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' + $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: @@ -11883,7 +14089,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -11897,7 +14103,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -11914,7 +14120,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -11934,6 +14140,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -11943,15 +14150,19 @@ paths: - 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 @@ -11961,56 +14172,73 @@ paths: 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' + $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: @@ -12023,7 +14251,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -12040,7 +14268,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12060,6 +14288,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12069,53 +14298,68 @@ paths: - 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' + $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: @@ -12128,7 +14372,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -12142,7 +14386,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -12159,7 +14403,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12179,6 +14423,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12188,15 +14433,19 @@ paths: - 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 @@ -12206,56 +14455,73 @@ paths: 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' + $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: @@ -12268,7 +14534,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -12285,7 +14551,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12304,6 +14570,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12313,17 +14580,18 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/webhook_key_request' + $ref: "#/components/schemas/webhook_key_request" responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/webhook-key_create_response' + $ref: "#/components/schemas/webhook_key_create_response" description: successful operation "401": content: @@ -12337,7 +14605,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -12354,7 +14622,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12367,11 +14635,13 @@ paths: 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: @@ -12380,6 +14650,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12389,38 +14660,49 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/webhook-key_delete_response' + $ref: "#/components/schemas/webhook_key_delete_response" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -12433,7 +14715,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -12449,7 +14731,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -12466,7 +14748,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12478,11 +14760,13 @@ paths: 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: @@ -12491,6 +14775,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12500,46 +14785,59 @@ paths: - 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' + $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: @@ -12552,7 +14850,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -12568,7 +14866,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -12585,7 +14883,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12598,11 +14896,13 @@ paths: 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: @@ -12611,6 +14911,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12620,17 +14921,18 @@ paths: - es - en type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/webhook_key_update_request' + $ref: "#/components/schemas/webhook_key_update_request" responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/webhook-key_response' + $ref: "#/components/schemas/webhook_key_response" description: successful operation "404": content: @@ -12646,7 +14948,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "401": content: @@ -12660,7 +14962,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -12677,7 +14979,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12698,6 +15000,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12707,15 +15010,19 @@ paths: - 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 @@ -12725,62 +15032,81 @@ paths: 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' + $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: @@ -12793,7 +15119,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -12810,7 +15136,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12833,6 +15159,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12842,14 +15169,20 @@ paths: - es - en type: string + style: simple requestBody: - $ref: '#/components/requestBodies/webhook' + content: + application/json: + schema: + $ref: "#/components/schemas/a_webhook" + description: requested field for webhook + required: true responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/webhook_response' + $ref: "#/components/schemas/webhook_response" description: successful operation "401": content: @@ -12863,7 +15196,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -12880,7 +15213,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -12893,11 +15226,13 @@ paths: 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: @@ -12906,6 +15241,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -12915,38 +15251,49 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/webhook_response' + $ref: "#/components/schemas/webhook_response" description: successful headers: Date: description: The date and time that the response was sent + explode: false schema: example: "Fri, 03 Feb 2023 16:57:48 GMT" type: string + 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: @@ -12959,7 +15306,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -12975,7 +15322,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -12992,7 +15339,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -13004,11 +15351,13 @@ paths: 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: @@ -13017,6 +15366,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -13026,46 +15376,59 @@ paths: - 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' + $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: @@ -13078,7 +15441,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -13094,7 +15457,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -13111,7 +15474,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -13130,6 +15493,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -13139,29 +15503,39 @@ paths: - 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: - $ref: '#/components/requestBodies/webhook_update' + 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' + $ref: "#/components/schemas/webhook_response" description: successful operation "404": content: @@ -13177,7 +15551,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "401": content: @@ -13191,7 +15565,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "500": content: @@ -13208,7 +15582,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -13222,11 +15596,13 @@ paths: 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: @@ -13235,6 +15611,7 @@ paths: en: summary: for english request/response value: en + explode: false in: header name: Accept-Language required: false @@ -13244,12 +15621,13 @@ paths: - es - en type: string + style: simple responses: "200": content: application/vnd.conekta-v2.2.0+json: schema: - $ref: '#/components/schemas/webhook_response' + $ref: "#/components/schemas/webhook_response" description: successful "401": content: @@ -13263,7 +15641,7 @@ paths: object: error type: authentication_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: authentication error "404": content: @@ -13279,7 +15657,7 @@ paths: object: error type: resource_not_found_error schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: not found entity "500": content: @@ -13296,7 +15674,7 @@ paths: type: api_error log_id: 641b6f2b3cd9a50001515098 schema: - $ref: '#/components/schemas/error' + $ref: "#/components/schemas/error" description: internal server error security: - bearerAuth: [] @@ -13304,1532 +15682,120 @@ paths: tags: - Webhooks components: - examples: - order_cash: - value: - livemode: true - amount: 1560 - currency: MXN - payment_status: pending_payment - amount_refunded: 0 - split_payment: false - customer_info: - email: franco.longhi@conekta.com - phone: 539-933-3810 - name: franco golden - corporate: null - customer_id: null - object: customer_info - shipping_contact: null - channel: null - fiscal_entity: null - object: order - id: ord_2xayxSvfWzQ2TLz7r - metadata: {} - is_refundable: false - processing_mode: null - created_at: 1741103510 - updated_at: 1741103510 - line_items: - object: list - has_more: false - total: 1 - data: - - name: APOYO URGENTE REFERENCIA - description: null - unit_price: 1560 - quantity: 1 - sku: COL094 - tags: null - brand: CHEDRAUI - type: null - object: line_item - id: line_item_2xayxSvfWzQ2TLz7p - parent_id: ord_2xayxSvfWzQ2TLz7r - metadata: {} - antifraud_info: {} - shipping_lines: null - tax_lines: null - discount_lines: null - charges: - object: list - has_more: false - total: 1 - data: - - id: 67c72196e777ac0001f2140c - livemode: true - created_at: 1741103510 - currency: MXN - failure_code: null - failure_message: null - monthly_installments: null - device_fingerprint: null - channel: null - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001140326893401915.png - store: null - auth_code: null - agreement: null - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - reference: 10001140326893401915 - cashier_id: null - product_type: cash_in - object: charge - description: Payment from order - is_refundable: false - reference_id: null - status: pending_payment - amount: 1560 - paid_at: null - customer_id: "" - order_id: ord_2xayxSvfWzQ2TLz7r - refunds: null - order_cash_multiple: - value: - livemode: true - amount: 156000 - currency: MXN - payment_status: pending_payment - amount_refunded: 0 - split_payment: false - customer_info: - email: franco.longhi@conekta.com - phone: 884-712-6894 - name: franco golden - corporate: null - customer_id: null - object: customer_info - shipping_contact: null - channel: null - fiscal_entity: null - object: order - id: ord_2xazGvtKYTjxTUZU3 - metadata: {} - is_refundable: false - processing_mode: null - created_at: 1741104962 - updated_at: 1741104963 - line_items: - object: list - has_more: false - total: 1 - data: - - name: APOYO URGENTE REFERENCIA - description: null - unit_price: 156000 - quantity: 1 - sku: COL094 - tags: null - brand: CHEDRAUI - type: null - object: line_item - id: line_item_2xazGvtKYTjxTUZU1 - parent_id: ord_2xazGvtKYTjxTUZU3 - metadata: {} - antifraud_info: {} - shipping_lines: null - tax_lines: null - discount_lines: null - charges: - object: list - has_more: false - total: 2 - data: - - id: 67c72742e777ac0001f21463 - livemode: true - created_at: 1741104962 - currency: MXN - failure_code: null - failure_message: null - monthly_installments: null - device_fingerprint: null - channel: null - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/bbva/10830309851141878231.png - store: null - auth_code: null - agreement: "2409992" - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - BBVA ATM - reference: 10830309851141878231 - cashier_id: null - product_type: bbva_cash_in - object: charge - description: Payment from order - is_refundable: false - reference_id: null - status: pending_payment - amount: 156000 - paid_at: null - customer_id: "" - order_id: ord_2xazGvtKYTjxTUZU3 - refunds: null - - id: 67c72742e777ac0001f2145b - livemode: true - created_at: 1741104962 - currency: MXN - failure_code: null - failure_message: null - monthly_installments: null - device_fingerprint: null - channel: null - payment_method: - service_name: Cash - barcode_url: https://barcodes.conekta.com/cash/cashin/datalogic/10001244873740402013.png - store: null - auth_code: null - agreement: null - object: cash_payment - type: cash - expires_at: 1743724800 - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - reference: 10001244873740402013 - cashier_id: null - product_type: cash_in - object: charge - description: Payment from order - is_refundable: false - reference_id: null - status: pending_payment - amount: 156000 - paid_at: null - customer_id: "" - order_id: ord_2xazGvtKYTjxTUZU3 - refunds: null - order_card: - value: - id: 63dab7d00558720001bb3c7d - livemode: "true," - created_at: "1675278289," - currency: MXN - failure_code: suspected_fraud - failure_message: Este cargo ha sido declinado porque el comportamiento del - comprador es sospechoso. - device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - payment_method: - name: Fulanito Perez - exp_month: 2 - exp_year: 30 - object: card_payment - type: credit - last4: 4242 - brand: visa - issuer: BANAMEX - account_type: Credit - country: MX - fraud_indicators: - - description: El usuario está utilizando una tarjeta de crédito o débito - de prueba en modo producción. - weight: null - value: null - object: charge - description: Payment from order - status: declined - amount: "20001," - fee: "116," - customer_id: null - order_id: ord_2tHuwPhgSwq6Gt7Rg - order_bnpl: - value: - amount: 300000 - amount_refunded: 0 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pWw - segment: Checkout - charges: - data: - - amount: 300000 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pXA - segment: Checkout - created_at: 1741015718 - currency: MXN - customer_id: "" - description: Payment from order - device_fingerprint: null - failure_code: null - failure_message: null - id: 67c5caa665f9b400015dec40 - is_refundable: false - livemode: true - monthly_installments: null - object: charge - order_id: ord_2xaegxs5s69VP4pWy - paid_at: null - payment_method: - cancel_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/cancel?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - expires_at: 1743694118 - failure_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/failure?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - object: bnpl_payment - product_type: aplazo_bnpl - redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ - success_url: https://pay.conekta.io/payment-status/fdcb06d6-c9e1-44ee-921f-17723b63852f/success?order_id=ord_2xaegxs5s69VP4pWy&charge_id=67c5caa665f9b400015dec40 - type: bnpl - reference_id: null - refunds: null - status: pending_payment - has_more: false - object: list - total: 1 - checkout: null - created_at: 1741015718 - currency: MXN - customer_info: - corporate: false - customer_custom_reference: null - customer_id: cus_2xZfwfjXxX9tZhVey - email: alexis.ruiz@google.com - name: Pedro Ruiz - object: customer_info - phone: "+5215555555555" - discount_lines: null - fiscal_entity: null - id: ord_2xaegxs5s69VP4pWy - is_refundable: false - line_items: - data: - - antifraud_info: {} - brand: null - description: null - id: line_item_2xaegxs5s69VP4pWv - metadata: {} - name: Test creditea - object: line_item - parent_id: ord_2xaegxs5s69VP4pWy - quantity: 1 - sku: null - tags: null - type: null - unit_price: 300000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - payment_status: pending_payment - processing_mode: null - shipping_contact: null - shipping_lines: null - split_payment: false - tax_lines: null - updated_at: 1741015718 - order_pbb: - value: - amount: 300000 - amount_refunded: 0 - charges: - data: - - amount: 300000 - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_type: PaymentLink - id: channel_2xaegxs5s69VP4pXA - segment: Checkout - created_at: 1741015718 - currency: MXN - customer_id: "" - description: Payment from order - device_fingerprint: null - failure_code: null - failure_message: null - id: 67c5caa665f9b400015dec40 - is_refundable: false - livemode: true - monthly_installments: null - object: charge - order_id: ord_2xaegxs5s69VP4pWy - paid_at: null - payment_method: - expires_at: 1743694118 - object: pay_by_bank_payment - product_type: bbva_pay_by_bank - redirect_url: https://pay.playground.com/na/hpp/payments/20sJ2LZ - deep_link: https://mgm.bbva.mx/WA3b/pbb?AGREEMENT=002484374&AMOUNT=1&CONCEPT=PagoDirecto&CURRENCY=MXN&REFERENCE=22277523174328893295 - type: pay_by_bank - reference: "22277523174328893295" - reference_id: null - refunds: null - status: pending_payment - has_more: false - object: list - total: 1 - checkout: null - created_at: 1741015718 - currency: MXN - customer_info: - corporate: false - customer_custom_reference: null - customer_id: cus_2xZfwfjXxX9tZhVey - email: alexis.ruiz@google.com - name: Pedro Ruiz - object: customer_info - phone: "+5215555555555" - discount_lines: null - fiscal_entity: null - id: ord_2xaegxs5s69VP4pWy - is_refundable: false - line_items: - data: - - antifraud_info: {} - brand: null - description: null - id: line_item_2xaegxs5s69VP4pWv - metadata: {} - name: Test pay by bank - object: line_item - parent_id: ord_2xaegxs5s69VP4pWy - quantity: 1 - sku: null - tags: null - type: null - unit_price: 300000 - has_more: false - object: list - total: 1 - livemode: true - metadata: {} - object: order - payment_status: pending_payment - processing_mode: null - shipping_contact: null - shipping_lines: null - split_payment: false - tax_lines: null - updated_at: 1741015718 - customer_payment_source_cash_example: - value: - next_page_url: "null," - previous_page_url: "null," - has_more: "false," - object: "list," - data: - - id: off_ref_2xayPUpcxeTrotDHr - object: payment_source - provider: Cash - store_names: - - 7 Eleven - - Farmacias del Ahorro - - CIRCLE K - - Tiendas Extra - - Farmacia Benavides - - Soriana - - WALDO'S - - ELECZION - - Super Kiosko - - Farmacias Bazar - - Wolworth - - Del Sol - - Yepas - - Farmacias De Dios - - Farmacias Nosarco - - Farmacias Santa Cruz - - Farmacentro - - Farmacias GyM - - Farmacias San Francisco de Asis - - Farmacias Union - - Farmacias Zapotlan - - Farmatodo - - Al Super - - BBVA ATM - type: cash_recurrent - reference: 10001189383263801812_caca - barcode: 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 - shipping: - value: - amount: 0 - carrier: Fedex - method: Airplane - tracking_number: TRACK123 - object: shipping_line - id: ship_lin_2sLxi45ZFs1GHJmzx - parent_id: ord_2sLxi3MqYFJ1QfTmP - deleted: true - charge_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 - charge_cash: - value: - payment_method: - type: cash - charge_pbb: - value: - payment_method: - expires_at: 1680397724 - product_type: bbva_pay_by_bank - type: pay_by_bank - order_with_charges: - summary: Create an order with charges - value: - charges: - - amount: 40000 - expires_at: 1677196303 - monthly_installments: 0 - payment_method: - type: card - token_id: tok_2897348234 - payment_source_id: src_2tLkkyfMPh6v7pFry - customer_ip_address: 0.0.0.0 - reference_id: string - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - object: customer_info - fiscal_entity: - tax_id: "1234567890" - name: Conekta Inc - email: test@gmail.com - phone: "525511223344" - metadata: - test: true - company_id: "123" - address: - street1: Nuevo Leon 254 - street2: Departamento 404 - postal_code: "06100" - city: Ciudad de Mexico - state: Ciudad de Mexico - country: MX - external_number: "123" - discount_lines: - - amount: 500 - code: "123" - type: loyalty - line_items: - - antifraud_info: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - metadata: - test: true - company_id: "123" - pre_authorize: false - shipping_contact: - phone: "525511223344" - receiver: Marvin Fuller - between_streets: Ackerman Crescent - metadata: - test: true - company_id: "123" - address: - street1: Nuevo Leon 254 - street2: Departamento 404 - postal_code: "06100" - city: Ciudad de Mexico - state: Ciudad de Mexico - country: MX - residential: true - parent_id: string - default: true - deleted: true - shipping_lines: - - amount: 100 - carrier: FEDEX - tracking_number: TRACK123 - method: TRAING - metadata: - key: value - tax_lines: - - amount: 100 - description: testing - metadata: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - order_with_charges_bnpl: - summary: Create an order with a bnpl charge - value: - channel: - checkout_request_id: fdcb06d6-c9e1-44ee-921f-17723b63852f - checkout_request_name: Test creditea - checkout_request_type: PaymentLink - charges: - - payment_method: - 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_charges_pbb: - summary: Create an order with a pay by bank charge - value: - charges: - - payment_method: - product_type: bbva_pay_by_bank - type: pay_by_bank - currency: MXN - customer_info: - customer_id: cus_2xZfwfjXxX9tZhVey - line_items: - - name: Test pay by bank - quantity: 1 - unit_price: 300000 - order_with_checkout: - summary: Create an order with checkout - value: - checkout: - allowed_payment_methods: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank - expires_at: 0 - failure_url: string - monthly_installments_enabled: false - monthly_installments_options: - - 0 - name: string - on_demand_enabled: true - success_url: string - type: Integration - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - object: customer_info - discount_lines: - - amount: 500 - code: "123" - type: loyalty - line_items: - - antifraud_info: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 20000 - quantity: 1 - tags: - - string - brand: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - metadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - pre_authorize: false - shipping_contact: - phone: "525511223344" - receiver: Marvin Fuller - between_streets: Ackerman Crescent - address: - street1: Nuevo Leon 254 - street2: Departamento 404 - postal_code: "06100" - city: Ciudad de Mexico - state: Ciudad de Mexico - country: MX - residential: true - parent_id: string - default: true - deleted: true - shipping_lines: - - amount: 100 - carrier: FEDEX - tracking_number: TRACK123 - method: TRAING - metadata: - key: value - tax_lines: - - amount: 100 - description: testing - metadata: - additionalProp1: {} - additionalProp2: {} - additionalProp3: {} - order_with_subscription: - summary: Create an order with subscription plans - value: - checkout: - allowed_payment_methods: - - card - plan_ids: - - nuevo-plan - expires_at: 1746015865 - failure_url: string - monthly_installments_enabled: false - name: Embebido Prueba - on_demand_enabled: true - success_url: string - type: Integration - max_failed_retries: 3 - is_redirect_on_failure: true - currency: MXN - customer_info: - name: Prueba - email: prueba@prueba.com - phone: "+5218181818181" - corporate: false - object: customer_info - shipping_lines: - - amount: 0 - metadata: - key: value - split_payment_with_2_cards: - summary: Create an order with 2 card charges - value: - charges: - - amount: 40000 - payment_method: - type: card - token_id: tok_2897348234 - - amount: 40000 - payment_method: - type: card - token_id: tok_2897348235 - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 40000 - quantity: 2 - brand: string - split_payment_with_cash: - summary: Create an order with 3 cash charges - value: - charges: - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 10000 - quantity: 3 - brand: string - split_payment_with_cash_card: - summary: Create an order with 3 cash and 2 card charges - value: - charges: - - amount: 10000 - payment_method: - type: card - token_id: tok_2897348234 - - amount: 10000 - payment_method: - type: card - token_id: tok_2897348235 - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - - amount: 10000 - payment_method: - type: cash - currency: MXN - customer_info: - name: DevTest - email: test@conekta.com - phone: "5522997233" - corporate: false - line_items: - description: string - sku: string - name: Box of Cohiba S1s - unit_price: 50000 - quantity: 1 - brand: string - parameters: - accept_language: - description: Use for knowing which language to use - examples: - es: - summary: for spanish request/response - value: es - en: - summary: for english request/response - value: en - in: header - name: Accept-Language - required: false - schema: - default: es - enum: - - es - - en - type: string - id: - description: Identifier of the resource - example: 6307a60c41de27127515a575 - in: path - name: id - required: true - schema: - type: string - x_child_company_id: - description: "In the case of a holding company, the company id of the child\ - \ company to which will process the request." - example: 6441b6376b60c3a638da80af - in: header - name: X-Child-Company-Id - required: false - schema: - type: string - limit: - description: "The numbers of items to return, the maximum value is 250" - in: query - name: limit - required: false - schema: - default: 20 - format: int32 - maximum: 250 - minimum: 1 - type: integer - next_page: - description: next page - in: query - name: next - required: false - schema: - type: string - previous_page: - description: previous page - in: query - name: previous - required: false - schema: - type: string - search: - description: "General order search, e.g. by mail, reference etc." - in: query - name: search - required: false - schema: - type: string - fiscal_entities_id: - description: identifier - example: fis_ent_2tQ8HkkfbauaKP9Ho - in: path - name: fiscal_entities_id - required: true - schema: - type: string - discount_lines_id: - description: discount line id identifier - example: dis_lin_2tQ974hSHcsdeSZHG - in: path - name: discount_lines_id - required: true - schema: - type: string - event_id: - description: event identifier - example: 6463d6e35a4c3e001819e760 - in: path - name: event_id - required: true - schema: - type: string - payment_status: - description: Filters by order status - in: query - name: payment_status - required: false - schema: - example: paid - type: string - last_payment_infostatus: - description: Filters by last payment info status - in: query - name: last_payment_info.status - required: false - schema: - example: pending_payment - type: string - created_at: - description: created equal to - in: query - name: created_at - required: false - schema: - example: 1612137600 - format: int64 - type: integer - created_at_gte: - description: created at greater than or equal to - in: query - name: created_at.gte - required: false - schema: - example: 1612137600 - format: int64 - type: integer - created_at_lte: - description: created at less than or equal to - in: query - name: created_at.lte - required: false - schema: - example: 1612137600 - format: int64 - type: integer - updated_at_gte: - description: updated at greater than or equal to - in: query - name: updated_at.gte - required: false - schema: - example: 1612137600 - format: int64 - type: integer - updated_at_lte: - description: updated at less than or equal to - in: query - name: updated_at.lte - required: false - schema: - example: 1612137600 - format: int64 - type: integer - line_items_id: - description: identifier - example: line_item_2tQ8HkkfbauaKP9Ho - in: path - name: line_item_id - required: true - schema: - type: string - refund_id: - description: refund identifier - example: 6407b5bee1329a000175ba11 - in: path - name: refund_id - required: true - schema: - type: string - payment_method_id: - description: Identifier of the payment method - example: src_2tQ974hSHcsdeSZHG - in: path - name: payment_method_id - required: true - schema: - type: string - shipping_id: - description: identifier - example: ship_lin_2tQ974hSHcsdeSZHG - in: path - name: shipping_id - required: true - schema: - type: string - shipping_contacts_id: - description: identifier - example: 6307a60c41de27127515a575 - in: path - name: shipping_contacts_id - required: true - schema: - type: string - customer_id: - description: Identifier of the customer resource - in: path - name: customer_id - required: true - schema: - example: cus_2tGzG1GxtDAZHEGPH - type: string - subscription_id: - description: Identifier of the subscription resource - in: path - name: id - required: true - schema: - example: sub_2tGzG1GxtDAZHEGPH - type: string - tax_id: - description: identifier - example: tax_lin_2tQ974hSHcsdeSZHG - in: path - name: tax_id - required: true - schema: - type: string - id_query: - description: id of the object to be retrieved - in: query - name: id - required: false - schema: - example: 65412a893cd69a0001c25892 - type: string - charge_id: - description: id of the charge used for filtering - in: query - name: charge_id - required: false - schema: - example: 65412a893cd69a0001c25892 - type: string - type: - description: type of the object to be retrieved - in: query - name: type - required: false - schema: - example: capture - type: string - currency: - description: currency of the object to be retrieved - in: query - name: currency - required: false - schema: - example: MXN - type: string - url: - description: url for webhook filter - in: query - name: url - required: false - schema: - type: string - requestBodies: - api_keys_create: - content: - application/json: - schema: - $ref: '#/components/schemas/api_key_request' - description: requested field for a api keys - required: true - charge_update: - content: - application/json: - schema: - $ref: '#/components/schemas/charge_update_request' - description: requested field for update a charge - required: true - charge_create: - content: - application/json: - examples: - bnpl: - $ref: '#/components/examples/charge_bnpl' - cash: - $ref: '#/components/examples/charge_cash' - pay_by_bank: - $ref: '#/components/examples/charge_pbb' - schema: - $ref: '#/components/schemas/charge_request' - description: requested field for a charge - required: true - customer: - content: - application/json: - schema: - $ref: '#/components/schemas/customer' - description: requested field for customer - required: true - update_customer: - content: - application/json: - schema: - $ref: '#/components/schemas/update_customer' - description: requested field for customer - required: true - customer_fiscal_entities: - content: - application/json: - schema: - $ref: '#/components/schemas/customer_fiscal_entities_request' - description: requested field for customer fiscal entities - required: true - customer_update_fiscal_entities: - content: - application/json: - schema: - $ref: '#/components/schemas/customer_update_fiscal_entities_request' - description: requested field for customer update fiscal entities - required: true - discount_line_create: - content: - application/json: - schema: - $ref: '#/components/schemas/order_discount_lines_request' - description: requested field for a discount lines - required: true - discount_line_update: - content: - application/json: - schema: - $ref: '#/components/schemas/update_order_discount_lines_request' - description: requested field for a discount lines - required: true - order: - content: - application/json: - examples: - order_with_charges: - $ref: '#/components/examples/order_with_charges' - order_with_bnpl_charges: - $ref: '#/components/examples/order_with_charges_bnpl' - order_with_pbb_charges: - $ref: '#/components/examples/order_with_charges_pbb' - order_with_checkout: - $ref: '#/components/examples/order_with_checkout' - order_with_subscription: - $ref: '#/components/examples/order_with_subscription' - split_payment_with_2_card_charges: - $ref: '#/components/examples/split_payment_with_2_cards' - split_payment_with_3_cash_charges: - $ref: '#/components/examples/split_payment_with_cash' - split_payment_with_cash_card_charges: - $ref: '#/components/examples/split_payment_with_cash_card' - schema: - $ref: '#/components/schemas/order_request' - description: requested field for order - required: true - order_update: - content: - application/json: - schema: - $ref: '#/components/schemas/order_update_request' - description: requested field for an order - required: true - product_create: - content: - application/json: - schema: - $ref: '#/components/schemas/product' - description: requested field for a product - required: true - product_update: - content: - application/json: - schema: - $ref: '#/components/schemas/update_product' - description: requested field for products - required: true - order_refunds_request: - content: - application/json: - schema: - $ref: '#/components/schemas/orderRefund_request' - description: requested field for a refund - required: true - payout_order: - content: - application/json: - schema: - $ref: '#/components/schemas/payout_order' - description: requested field for payout order - required: true - checkout: - content: - application/json: - schema: - $ref: '#/components/schemas/checkout' - description: requested field for checkout - required: true - checkout_email: - content: - application/json: - schema: - $ref: '#/components/schemas/emailCheckout_request' - description: requested field for sms checkout - required: true - checkout_sms: - content: - application/json: - schema: - $ref: '#/components/schemas/smsCheckout_request' - description: requested field for sms checkout - required: true - customer_payment_methods: - 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 - customer_update_payment_methods: - content: - application/json: - schema: - $ref: '#/components/schemas/update_payment_methods' - description: requested field for customer payment methods - required: true - plan: - content: - application/json: - schema: - $ref: '#/components/schemas/plan_request' - description: requested field for plan - required: true - plan_update: - content: - application/json: - schema: - $ref: '#/components/schemas/plan_update_request' - description: requested field for plan - required: true - shipping_create: - content: - application/json: - schema: - $ref: '#/components/schemas/shipping_request' - description: requested field for a shipping - required: true - customer_shipping_contacts: - content: - application/json: - schema: - $ref: '#/components/schemas/customer_shipping_contacts' - description: requested field for customer shippings contacts - required: true - customer_update_shipping_contacts: - content: - application/json: - schema: - $ref: '#/components/schemas/customer_update_shipping_contacts' - description: requested field for customer update shippings contacts - required: true - subscription: - content: - application/json: - schema: - $ref: '#/components/schemas/subscription_request' - description: requested field for subscriptions - required: true - subscription_update: - content: - application/json: - schema: - $ref: '#/components/schemas/subscription_update_request' - description: requested field for update a subscription - required: true - order_tax: - content: - application/json: - schema: - $ref: '#/components/schemas/order_tax_request' - description: requested field for a taxes - required: true - order_tax_update: - content: - application/json: - schema: - $ref: '#/components/schemas/update_order_tax_request' - description: requested field for taxes - required: true - token: - content: - application/json: - schema: - $ref: '#/components/schemas/token' - description: requested field for token - required: true - webhook: - content: - application/json: - schema: - $ref: '#/components/schemas/webhook_request' - description: requested field for webhook - required: true - webhook_update: - content: - application/json: - schema: - $ref: '#/components/schemas/webhook_update_request' - description: requested fields in order to update a webhook - required: true - responses: - "401": - content: - application/vnd.conekta-v2.2.0+json: - example: - details: - - message: Please include your access key in your request. - param: null - code: conekta.errors.authentication.missing_key - log_id: 507f1f77bcf86cd799439011 - object: error - type: authentication_error - 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. - param: null - code: conekta.errors.api.system.general_failure - object: error - type: api_error - log_id: 641b6f2b3cd9a50001515098 - schema: - $ref: '#/components/schemas/error' - description: internal server error - "404": - content: - application/vnd.conekta-v2.2.0+json: - example: - details: - - message: The resource was not found. - param: null - code: conekta.errors.resource_not_found.entity - debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could not - be found. - log_id: 641b6c253cd9a50001514fae - object: error - type: resource_not_found_error - 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 - "422_whitelist": - 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 - "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. - param: null - 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 - "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 - 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_list: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: + 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_inner: + 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 + GetRuleWhitelist_200_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/risk_rules_data' + $ref: "#/components/schemas/risk_rules_data_inner" type: array title: risk_rules - type: object + 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: - - $ref: '#/components/schemas/details' + - properties: + details: + items: + $ref: "#/components/schemas/details_error" + type: array - properties: log_id: description: log id example: 507f1f77bcf86cd799439011 - nullable: true type: string + nullable: true type: example: authentication_error type: string object: example: error type: string - type: object description: err model title: error - create_risk_rules_data: + CreateRuleWhitelist_request: properties: description: description: Description of the rule @@ -14847,38 +15813,82 @@ components: - description - field - value - type: object - page: - description: page metadata + whitelistlist_rule_response: properties: - next_page_url: - description: URL of the next page. - example: https://api.conekta.io/resources?limit=10&next=chrg_1 - nullable: true + id: + description: Whitelist rule id + example: 2fw8EWJusiRrxdPzT type: string - previous_page_url: - description: Url of the previous page. - example: https://api.conekta.io/resources?limit=10&previous=chrg_1 - nullable: true + 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: page metadata - type: object - pagination: - description: pagination metadata + title: whitelistlist_rule_response + deleted_whitelist_rule_response: 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 + id: + description: Whitelist rule id + example: 2fw8EWJusiRrxdPzT type: string - required: - - has_more - - object - title: pagination metadata - type: object + 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: @@ -14899,14 +15909,14 @@ components: deactivated_at: description: Unix timestamp in seconds of when the api key was deleted format: int64 - nullable: true type: integer + nullable: true example: null last_used_at: description: Unix timestamp in seconds with the api key was used format: int64 - nullable: true type: integer + nullable: true example: null description: description: A name or brief explanation of what this api key is used for @@ -14933,88 +15943,230 @@ components: example: private type: string title: api_key_response - type: object - api_key_response_on_delete: - description: api keys model + 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_keys_request: 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 + role: + example: private type: string - object: - description: "Object name, value is 'api_key'" - example: api_key + descripción: Indicates if the api key is private or public + required: + - role + title: api_keys_request + name: api_keys_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 + example: null + last_used_at: + description: Unix timestamp in seconds with the api key was used + format: int64 + type: integer + nullable: true + example: null + 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 - last_used_at: - description: Unix timestamp in seconds with the api key was used + 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 + example: null + 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 - nullable: true type: integer - example: null - role: - description: Indicates if the api key is private or public - example: private + currency: + description: The balance's currency + example: MXN type: string - title: api_key_response_delete - type: object + title: balance_common_fiels_response balance_response: description: balance model properties: available: description: The balance's available items: - $ref: '#/components/schemas/balance_common_field' + $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_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array conekta_retention: description: The balance's conekta retention items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array gateway: description: The balance's gateway items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array pending: description: The balance's pending items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array retained: description: The balance's retained items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array retention_amount: description: The balance's retention amount items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array target_collateral_amount: description: The balance's target collateral amount @@ -15022,194 +16174,934 @@ components: target_retention_amount: description: The balance's target retention amount items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array temporarily_retained: description: The balance's temporarily retained items: - $ref: '#/components/schemas/balance_common_field' + $ref: "#/components/schemas/balance_common_fiels_response" type: array title: balance_response - type: object - 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: Payment date - example: 1676390742 - format: int64 - nullable: true - type: integer - payment_method: - $ref: '#/components/schemas/charge_response_payment_method' - reference_id: - description: Reference ID of the charge - example: ref_2tN73UdUSNrYRPD9r - nullable: true - type: string - refunds: - $ref: '#/components/schemas/charge_response_refunds' - status: - description: Charge status - example: pending_payment - type: string - required: - - amount - - created_at - - currency - - id - - livemode - - object - - order_id - - status - title: charges_data_response - type: object - charge_order_response: + charges_data_response_channel: properties: - amount: - example: 4321 - type: integer - channel: - $ref: '#/components/schemas/charge_response_channel' - created_at: - example: 1676386026 - format: int64 - type: integer - currency: - example: MXN - type: string - customer_id: - type: string - description: - example: Payment from order - type: string - device_fingerprint: - example: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba - nullable: true + segment: + example: Checkout type: string - failure_code: - example: suspected_fraud + checkout_request_id: + example: 6fca054a-8519-4c43-971e-cea35cc519bb type: string - failure_message: - example: Este cargo ha sido declinado porque el comportamiento del comprador - es sospechoso. + checkout_request_type: + example: HostedPayment type: string id: - example: 63efa757cf65380001aec040 - type: string - livemode: - example: true - type: boolean - monthly_installments: - nullable: true - type: integer - object: - type: string - order_id: - example: ord_2tN73UdUSNrYRPD9r - type: string - paid_at: - example: 1676390742 - nullable: true - type: integer - payment_method: - $ref: '#/components/schemas/charge_order_response_payment_method' - reference_id: - description: Reference ID of the charge - example: ref_2tN73UdUSNrYRPD9r - nullable: true - type: string - refunds: - items: - type: object - type: array - status: - example: pending_payment + example: channel_2tNDzhA4Akmzj11AU type: string - title: charges_data_response - type: object - charges_order_response: + charge_response_payment_method_oneOf: allOf: - - $ref: '#/components/schemas/pagination' - properties: - data: - items: - $ref: '#/components/schemas/charges_order_response_allOf_data' - type: array - type: object - description: The charges associated with the order - company_response: - properties: - id: - description: The unique identifier for the company. - example: 6827305a1ec60400015eb116 - type: string - name: - description: The name of the company. - example: test - type: string - active: - description: Indicates if the company is active. - example: false - type: boolean - account_status: - description: The current status of the company's account. - example: signed_up - type: string - parent_company_id: - description: "The identifier of the parent company, if any." - example: 680bf1da38716d00013543bc - nullable: true - type: string - onboarding_status: + 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 + charge_response_payment_method_oneOf_1: + 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 + charge_response_payment_method_oneOf_2: + 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 + charge_response_payment_method_oneOf_3: + allOf: + - properties: + type: + type: string + object: + example: payment_source + type: string + required: + - object + - description: use for bnpl payment responses + properties: + 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 + charge_response_payment_method_oneOf_4: + 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 + 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/charge_response_payment_method_oneOf" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_1" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_2" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_3" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_4" + title: charge_response_payment_method + 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 + charges_data_response: + properties: + amount: + example: 4321 + type: integer + channel: + $ref: "#/components/schemas/charges_data_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: Payment date + example: 1676390742 + format: int64 + type: integer + nullable: true + 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" + status: + description: Charge status + example: pending_payment + type: string + required: + - amount + - created_at + - currency + - id + - livemode + - object + - order_id + - status + title: charges_data_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/charges_data_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 + - 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 + charges: + 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: charges + 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 + pbb_payment: payment_method_pbb_payment + propertyName: object + oneOf: + - $ref: "#/components/schemas/charge_response_payment_method_oneOf" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_1" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_2" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_3" + - $ref: "#/components/schemas/charge_response_payment_method_oneOf_4" + title: charge_order_response_payment_method + charges_data_response_1: + properties: + amount: + example: 4321 + type: integer + channel: + $ref: "#/components/schemas/charges_data_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: charges_data_response + ordersCreateCharges_200_response_allOf_data_inner: + allOf: + - properties: + amount: + example: 4321 + type: integer + channel: + $ref: "#/components/schemas/charges_data_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: Payment date + example: 1676390742 + format: int64 + type: integer + nullable: true + 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" + status: + description: Charge status + example: pending_payment + type: string + required: + - amount + - created_at + - currency + - id + - livemode + - object + - order_id + - status + title: charges_data_response + ordersCreateCharges_200_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/ordersCreateCharges_200_response_allOf_data_inner" + type: array + description: The charges associated with the order + company_response_documents_inner: + 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 + example: null + 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_response_documents_inner' + $ref: "#/components/schemas/company_response_documents_inner" type: array created_at: description: Timestamp of when the company was created. @@ -15232,8 +17124,8 @@ components: - smart - strict example: strict - nullable: true type: string + nullable: true required: - account_status - active @@ -15244,8 +17136,81 @@ components: - object - onboarding_status title: company_response - type: object - create_company_request: + 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. @@ -15256,15 +17221,20 @@ components: example: owner type: string comercial_info: - $ref: '#/components/schemas/create_company_request_comercial_info' + $ref: "#/components/schemas/Create_Company_Request_comercial_info" fiscal_info: - $ref: '#/components/schemas/create_company_request_fiscal_info' + $ref: "#/components/schemas/Create_Company_Request_fiscal_info" bank_account_info: - $ref: '#/components/schemas/create_company_request_bank_account_info' + $ref: "#/components/schemas/Create_Company_Request_bank_account_info" title: Create Company Request - type: object - company_document_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: | @@ -15322,8 +17292,7 @@ components: - file_data - file_name title: CompanyDocumentRequest - type: object - company_document_response: + CompanyDocumentResponse: description: Response body after uploading a company document. properties: file_classification: @@ -15368,1887 +17337,2333 @@ components: - file_name - status title: CompanyDocumentResponse - type: object - customer_response: - description: customer response + customer_antifraud_info_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 + first_paid_at: example: 1485151007 + type: integer + account_created_at: + example: 1484040996 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 - nullable: true - type: string - default_shipping_contact_id: - example: ship_cont_2tKZsTYcsryyu7Ah8 - type: string - default_payment_source_id: - example: src_2tHJfJ79KyUwpxTio - nullable: true - type: string - 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/subscription_response' - required: - - created_at - - id - - livemode - - name - - object - title: customer response - type: object - customer_fiscal_entities_request: + 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 + customer_payment_methods_data_oneOf_allOf_agreements_inner: properties: - address: - allOf: - - $ref: '#/components/schemas/customer_address' - tax_id: - type: string - email: - type: string - phone: + agreement: + description: "Agreement number, you can use this number to pay in the store/bbva" + example: "2409526" type: string - metadata: - additionalProperties: - type: object - type: object - company_name: - example: conekta + provider: + description: "Provider name, you can use this to know where to pay" + example: bbva_cash_in type: string - required: - - address - title: fiscal_entity_request - type: object - discount_lines_response: + customer_payment_methods_data_oneOf: + 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/customer_payment_methods_data_oneOf_allOf_agreements_inner" + 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 + 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/customer_payment_methods_data_oneOf_allOf_agreements_inner" + 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 + description: Alias of cash response used when type=cash_recurrent + title: payment_method_cash_recurrent_response + x-discriminator-value: cash_recurrent + customer_payment_methods_data_oneOf_1: allOf: - - $ref: '#/components/schemas/order_discount_lines_request' - properties: + type: + type: string id: - description: The discount line id - example: dis_lin_2tQQ58HPgPw7StE8z + example: src_2s8K1B3PBKDontpi9 type: string object: - description: The object name - example: discount_line + example: payment_source type: string + created_at: + example: 1675715413 + format: int64 + type: integer parent_id: - description: The order id - example: ord_2tPAmKCEJqh8RE6nY + example: cus_2s8K1B3PBKDontpi8 type: string required: + - created_at - id - object - - parent_id - type: object - title: discount_lines_order_response - 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 - type: object - resend_request: - properties: - webhooks_ids: - description: webhooks ids to resend event - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - items: + - type + - description: use for card responses + properties: + last4: + example: "6410" type: string - type: array - required: - - webhooks_ids - type: object - 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: event_webhook_resend_response - type: object - logs_response: - 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. - nullable: true - type: string - previous_page_url: - description: Url of the previous page. - nullable: true - type: string - data: - description: set to page results. - items: - $ref: '#/components/schemas/logs_response_data' - nullable: true - type: array - title: log response for request - type: object - log_response: - 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 - nullable: true - type: string - loggable_type: - example: order - nullable: true - type: string - method: - example: POST - type: string - oauth_token_id: - nullable: true - type: string - query_string: - additionalProperties: true - example: - amount: 3000 - payable: true - type: object - related: - example: FilterResource - type: string - request_body: - example: - filters: - amount: - amount_from: 0 - amount_to: 0 - created_at: - date_from: 1653627600 - date_to: 1661489999 - filterName: Payments - search_term: null - sort_by: created_at - sort_direction: desc - status: [] - type: [] - id: 78e65162-0f37-4942-847c-9bf7081d54c2 - page: "0" - report_type: charges - testMode: false - type: object - request_headers: - additionalProperties: + 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 + name: + example: Fulano Perez" + type: string + default: + type: boolean + visible_on_checkout: + type: boolean + payment_source_status: + example: active + type: string + customer_payment_methods_data_oneOf_2: + 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 - 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 - type: object - response_body: - type: object - response_headers: - additionalProperties: + reference: + example: "93000262276908" 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 - type: object - searchable_tags: - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - items: + expires_at: + example: none type: string - type: array - status: - example: "200" - type: string - updated_at: - example: 2022-08-25T16:40:44.887Z + 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 + propertyName: type + oneOf: + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf" + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_1" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_2" + 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" + 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 - url: - example: /filter_resource + street2: + example: Departamento 404 type: string - user_account_id: - example: 5a0b7001edbb6e1725b0b2c6 + postal_code: + example: "06100" type: string - version: - example: 2.2.0 + city: + example: Ciudad de Mexico type: string - required: - - created_at - - id - - livemode - title: log response for request - type: object - orders_response: - properties: - data: - items: - $ref: '#/components/schemas/order_response' - type: array - required: - - data - title: orders_response - type: object - 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 + state: + example: Ciudad de Mexico type: string - customer_info: - $ref: '#/components/schemas/order_response_customer_info' - discount_lines: - $ref: '#/components/schemas/order_discount_lines_response' - fiscal_entity: - $ref: '#/components/schemas/order_fiscal_entity_response' - id: - example: ord_2tMtQQpDvfnNjiuFG + 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 - 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 + residential: + example: true 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 - type: object - product_order_response: + nullable: true + customer_shipping_contacts_data_response: allOf: - - $ref: '#/components/schemas/product' + - 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 - parent_id: + 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 - type: object - title: product order response - payout_order_response: - description: payout order model response + required: + - has_more + - object + title: pagination metadata + - properties: + data: + items: + $ref: "#/components/schemas/customer_shipping_contacts_data_response" + type: array + subscription_response: + description: subscription model 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 + billing_cycle_start: + example: 1677626827 + format: int64 type: integer - created_at: - description: The creation date of the payout order. - example: 1677626837 + nullable: true + billing_cycle_end: + example: 1677626827 + format: int64 + type: integer + nullable: true + canceled_at: + example: 1678258162 format: int64 type: integer - currency: - default: MXN - description: The currency in which the payout order is made. - example: MXN + nullable: true + canceled_reason: + description: Reason for cancellation. This field appears when the subscription + status is 'canceled'. + example: user_cancelation type: string - customer_info: - $ref: '#/components/schemas/payout_order_response_customer_info' - expires_at: - description: The expiration date of the payout order. + 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: - description: The id of the payout order. - example: f2654d66-d740-457a-9a8c-f96b5196f44e + example: gold-plan + type: string + last_billing_cycle_order_id: + example: ord_2tSoMP7bZJbLiq4z8 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 + example: subscription 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 + paused_at: + example: 1678258162 + format: int64 + type: integer + nullable: true + plan_id: + example: plan_2tXx672QLQ68CkmMn type: string status: - description: The status of the payout order. - example: open + example: past_due type: string - updated_at: - description: The update date of the payout order. + subscription_start: + example: 1677626837 + type: integer + trial_start: example: 1677626837 format: int64 type: integer - required: - - allowed_payout_methods - - amount - - created_at - - currency - - customer_info - - id - - livemode - - object - - payouts - - reason - - updated_at - title: payout_order_response - type: object - checkout_response: - description: checkout response + nullable: true + trial_end: + example: 1677626837 + format: int64 + type: integer + nullable: true + title: subscription_response + nullable: true + customer_response: + description: customer 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 + antifraud_info: + $ref: "#/components/schemas/customer_antifraud_info_response" + corporate: + description: true if the customer is a company 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 + created_at: + description: Creation date of the object + example: 1485151007 format: int64 type: integer - failure_url: - example: https://pay.conekta.com/failure + custom_reference: + description: Custom reference + example: custom_reference type: string - force_3ds_flow: - example: false - type: boolean + 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: - example: b0bf16c4-18b9-445e-ba24-01604f329dbf + 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 - example: - key: value + maxProperties: 100 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 - nullable: true - type: integer - 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: - example: https://pay.conekta.com/success - type: string - type: - example: PaymentLink + example: customer type: string - url: - example: https://pay.conekta.com/link/b0bf16c418b9445eba2401604f329dbf - format: uri + 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/subscription_response" required: + - created_at - id - livemode - name - object - title: checkout_response - type: object - payment_method_cash_recurrent_response: - allOf: - - $ref: '#/components/schemas/payment_method_cash_response' - description: Alias of cash response used when type=cash_recurrent - title: payment_method_cash_recurrent_response - x-discriminator-value: cash_recurrent - payment_method_cash_response: - allOf: - - $ref: '#/components/schemas/payment_method_response' - - description: use for cash responses - properties: - agreements: + title: customer response + customers_response: + allOf: + - properties: + data: items: - $ref: '#/components/schemas/payment_method_cash_response_allOf_agreements' + $ref: "#/components/schemas/customer_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 - type: object - payment_method_card_response: - allOf: - - $ref: '#/components/schemas/payment_method_response' - - description: use for card responses + - description: pagination metadata 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 - name: - example: Fulano Perez" - type: string - default: + has_more: + description: Indicates if there are more pages to be requested + example: false type: boolean - visible_on_checkout: - type: boolean - payment_source_status: - example: active + object: + description: "Object type, in this case is list" + example: list type: string - type: object - payment_method_spei_recurrent: - allOf: - - $ref: '#/components/schemas/payment_method_response' - - description: use for spei responses + required: + - has_more + - object + title: pagination metadata + - description: page metadata properties: - bank: - description: Bank name for the SPEI payment method - example: STP + next_page_url: + description: URL of the next page. + example: https://api.conekta.io/resources?limit=10&next=chrg_1 type: string - reference: - example: "93000262276908" - type: string - expires_at: - example: none + nullable: true + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 type: string - type: object - plan_response: - description: plans model + nullable: true + title: page metadata + title: customers_response + customer_request_antifraud_info: properties: - amount: - example: 10000 - type: integer - created_at: - example: 1666900846 + account_created_at: + example: 1484040996 format: int64 type: integer - currency: - example: MXN - maxLength: 3 - type: string - expiry_count: - example: 12 - nullable: true - type: integer - frequency: - example: 1 + first_paid_at: + example: 1485151007 + format: int64 type: integer - id: - example: gold-plan + nullable: true + fiscal_entity_request: + properties: + address: + $ref: "#/components/schemas/fiscal_entity_request_address" + tax_id: type: string - interval: - example: month + email: type: string - livemode: - example: true - type: boolean - name: - example: Extra Plan3 + phone: type: string - object: - example: plan + metadata: + additionalProperties: + type: object + company_name: + example: conekta type: string - trial_period_days: - example: 0 - nullable: true - type: integer - max_retries: - example: 3 - type: integer - retry_delay_hours: - example: 48 - type: integer - title: plan_response - type: object - shipping_order_response: + required: + - address + title: fiscal_entity_request + payment_method_token_request: allOf: - - $ref: '#/components/schemas/shipping_request' + - 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: - id: + 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 - object: + 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 - parent_id: + 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 - type: object - 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 + 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 - nullable: true type: string address: - $ref: '#/components/schemas/customer_shipping_contacts_response_address' + $ref: "#/components/schemas/customer_shipping_contacts_request_address" parent_id: type: string default: - example: false type: boolean - id: - example: adr_1234567890 - type: string - created_at: - example: 1675715413 - format: int64 - type: integer + nullable: true + deleted: + type: boolean + nullable: true metadata: additionalProperties: true description: Metadata associated with the shipping contact maxProperties: 100 type: object - object: - example: shipping_contact + 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 - deleted: + card_id: + example: src_2qUCNd5AyQqfPMBuV + type: string + trial_end: + example: 1484040996 + type: integer + required: + - plan_id + title: subscription_request + customer_request: + description: a customer + properties: + antifraud_info: + $ref: "#/components/schemas/customer_request_antifraud_info" + corporate: + default: false + description: It is a value that allows identifying if the email is corporate + or not. example: false type: boolean - type: object - subscription_response: - description: subscription model - properties: - billing_cycle_start: - example: 1677626827 - format: int64 - nullable: true - type: integer - billing_cycle_end: - example: 1677626827 - format: int64 - nullable: true - type: integer - canceled_at: - example: 1678258162 - format: int64 - nullable: true - type: integer - canceled_reason: - description: Reason for cancellation. This field appears when the subscription - status is 'canceled'. - example: user_cancelation + custom_reference: + description: It is an undefined value. type: string - card_id: - example: src_2tKcHxhTz7xU5SymL + 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 - charge_id: - example: 2tKcHxhTz7xU5SymL - nullable: true + 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 - created_at: - example: 1677626837 - format: int64 - type: integer - customer_custom_reference: - example: dotnet_123456 + 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 - customer_id: - example: cus_2tKcHxhTz7xU5SymF + 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 - id: - example: gold-plan + 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 - last_billing_cycle_order_id: - example: ord_2tSoMP7bZJbLiq4z8 + national_id: + description: It is a parameter that allows to identify the national identification + number of the client. + example: HEGG560427MVZRRL04 type: string - object: - example: subscription + 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 - paused_at: - example: 1678258162 - format: int64 - nullable: true - type: integer plan_id: - example: plan_2tXx672QLQ68CkmMn - type: string - status: - example: past_due + 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 - subscription_start: - example: 1677626837 - type: integer - trial_start: - example: 1677626837 + 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 request + update_customer_request_antifraud_info: + properties: + account_created_at: + example: 1484040996 format: int64 - nullable: true type: integer - trial_end: - example: 1677626837 - format: int64 - nullable: true + first_paid_at: + example: 1485151007 type: integer - title: subscription_response - type: object - customer_portal_response: - description: Customer portal model + nullable: true + update_customer_request: + description: update customer properties: - slug: - description: Unique slug identifier for the portal - example: agIvD4QSBl4Nunq4TmuozMw2ThtyVC + antifraud_info: + $ref: "#/components/schemas/update_customer_request_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 - subscription_id: - description: Associated subscription ID - example: sub_2yYsQuYtXAbP1fdYu + 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 - customer_id: - description: Associated customer ID - example: cus_2yDzKtEAD3khH8Sga + 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 - livemode: - description: Whether this is a live or test mode portal + 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_details' - customer: - $ref: '#/components/schemas/customer_details' - id: - description: Customer portal ID - example: scp_2ym7QbU9dTh7Froti + $ref: "#/components/schemas/subscription_request" + title: update customer request + 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 - company_id: - description: Associated company ID - example: 63dad459920de10001d177b3 + email: type: string - object: - example: customer_portal + phone: 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 + metadata: + additionalProperties: + type: object + company_name: + example: conekta type: string - title: customer_portal_response - type: object - update_order_tax_response: + 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_order_response: allOf: - - $ref: '#/components/schemas/order_tax_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 - properties: id: - example: tax_lin_2tQ8dC5mg1UADmVPo + description: The discount line id + example: dis_lin_2tQQ58HPgPw7StE8z type: string object: - example: tax_line + description: The object name + example: discount_line type: string parent_id: + description: The order id example: ord_2tPAmKCEJqh8RE6nY type: string - type: object - description: create new taxes for an existing order response - required: - - id - token_response: - description: token response + required: + - id + - object + - parent_id + title: discount_lines_order_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_order_response" + type: array + title: get_order_discount_lines_response + order_discount_lines_request: + description: List of discounts that apply to the order. properties: - checkout: - $ref: '#/components/schemas/token_response_checkout' - id: - description: Unique identifier for the token generated by Conekta. - example: cus_2tHJfJ79KyUwpxTik + 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 - 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: + description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" + example: loyalty type: string - used: - description: Indicates if the token has been used - example: false - type: boolean required: - - id - - livemode - - object - - used - title: token response - type: object - 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." + - 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: - description: The amount of the transaction. - example: 1000 + example: 500 format: int64 + minimum: 0 type: integer - charge: - description: Randomly assigned unique order identifier associated with the - charge. - example: 5ee7ec58885a45585e6d9f8m + code: + description: Discount code. + example: "123" 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: + example: loyalty type: string - fee: - description: The amount to be deducted for taxes and commissions. - example: 560 - format: int64 + title: update_order_discount_lines_request + WebhookLog: + properties: + failed_attempts: + example: 10 type: integer id: - description: Unique identifier of the transaction. - example: 5ee7ec5b8dea41085erb7f9e + example: webhl_2svd2sh6GbqzyWBNZ 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 + last_attempted_at: + example: 1669651274 + type: integer + last_http_response_status: + example: 200 + format: int32 type: integer object: - description: "Object name, which is transaction." - example: transaction - type: string - status: - description: Code indicating transaction status. - example: pending + example: webhook_log type: string - type: - description: Transaction Type - example: capture + 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 - required: - - amount - - charge - - created_at - - currency - - fee - - id - - livemode - - net - - object - - status - - type - title: transaction_response - type: object - transfers_response: - description: "A transfer represents the action of sending an amount to a business\ - \ bank account including the status, amount and method used to make the transfer." + title: WebhookLog + event_response: + description: event model 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 + example: 1661445644 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 + data: + additionalProperties: true + example: + action: ping + livemode: true + maxProperties: 100 + type: object id: - description: Unique identifier of the transfer. - example: 5b0337d4dD344ef954fe1X4b6 + example: 6307a60c41de27127515a575 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 + example: event type: string - statement_description: - description: Description of the transfer. - example: Conekta 4401234 + type: + example: webhook_ping type: string - statement_reference: - description: Reference number of the transfer. - example: "4401234" + 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 + event_webhook_resend_response: + description: event model + properties: + failed_attempts: + example: 6 + type: integer + id: + example: webhl_2svd2sh6GbqzyWBNZ type: string - status: - description: Code indicating transfer status. - example: pending + 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: transfers_response - type: object - transfer_response: - description: "A transfer represents the action of sending an amount to a business\ - \ bank account including the status, amount and method used to make the transfer." + title: event_webhook_resend_response + logs_response_data: 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 + example: 1661445644 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 + example: 6307a60c41de27127515a575 + type: string + ip_address: + example: 54.235.131.48 + format: ipv4 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 + loggable_id: + example: ord_87632467832 type: string - statement_reference: - description: Reference number of the transfer. - example: "4401234" + nullable: true + loggable_type: + example: order type: string - status: - description: Code indicating transfer status. - example: pending + nullable: true + method: + example: POST type: string - title: transfer_response - type: object - webhook-key_response: - description: webhook keys model - properties: - id: - description: Unique identifier of the webhook key - example: 62730ba6fb7dfd6a712f118e + oauth_token_id: 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 nullable: true - type: integer - example: null - 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' + query_string: + additionalProperties: true + example: + amount: 3000 + payable: true + type: object + related: + example: FilterResource 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 + request_body: + example: + filters: + amount: + amount_from: 0 + amount_to: 0 + created_at: + date_from: 1653627600 + date_to: 1661489999 + filterName: Payments + search_term: null + sort_by: created_at + sort_direction: desc + status: [] + type: [] + id: 78e65162-0f37-4942-847c-9bf7081d54c2 + page: "0" + report_type: charges + testMode: false + 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 - title: webhook_key_response - type: object - 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 + updated_at: + example: 2022-08-25T16:40:44.887Z 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 + url: + example: /filter_resource 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' + user_account_id: + example: 5a0b7001edbb6e1725b0b2c6 type: string - title: webhook_key_create_response - type: object - 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 + version: + example: 2.2.0 type: string - livemode: - description: Indicates if the webhook key is in live mode - example: false + title: logs_response_data + log_response_for_request: + description: logs model + properties: + has_more: + description: "True, if there are more pages." + readOnly: true type: boolean object: - description: "Object name, value is webhook_key" - example: webhook_key + 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 - title: webhook_key_delete_response - type: object - webhook_response: - description: webhooks model + nullable: true + data: + description: set to page results. + items: + $ref: "#/components/schemas/logs_response_data" + type: array + nullable: true + title: log response for request + log_response_for_request_1: + description: log model properties: + created_at: + example: 1661445644 + format: int64 + type: integer 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 + ip_address: + example: 54.235.131.48 + format: ipv4 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 + loggable_id: + example: ord_87632467832 type: string - status: - description: Indicates if the webhook is ready to receive events or failing - example: listening + nullable: true + loggable_type: + example: order type: string - subscribed_events: - description: lists the events that will be sent to the webhook + nullable: true + method: + example: POST + type: string + oauth_token_id: + type: string + nullable: true + query_string: + additionalProperties: true example: - - charge.created - - charge.paid - - charge.under_fraud_review - - charge.fraudulent - - charge.refunded - - charge.preauthorized - - charge.declined - - charge.canceled - - charge.reversed - - charge.pending_confirmation + 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 + search_term: null + sort_by: created_at + sort_direction: desc + status: [] + type: [] + id: 78e65162-0f37-4942-847c-9bf7081d54c2 + page: "0" + report_type: charges + testMode: false + 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: - description: url or endpoint of the webhook - example: https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval + example: /filter_resource type: string - title: webhook_response - type: object - api_key_request: - properties: - description: - description: A name or brief explanation of what this api key is used for - example: online store + user_account_id: + example: 5a0b7001edbb6e1725b0b2c6 type: string - role: - example: private + version: + example: 2.2.0 type: string required: - - role - title: api_keys_request - type: object - charge_update_request: - description: requested field for update a charge + - created_at + - id + - livemode + title: log response for request + order_channel_response: properties: - reference_id: - description: custom reference id - example: "278482642" + segment: + example: Checkout type: string - title: charge_update_request - type: object - charge_request: - description: The charges to be made + 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_2: + allOf: + - properties: + amount: + example: 4321 + type: integer + channel: + $ref: "#/components/schemas/charges_data_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: Payment date + example: 1676390742 + format: int64 + type: integer + nullable: true + 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" + status: + description: Charge status + example: pending_payment + type: string + required: + - amount + - created_at + - currency + - id + - livemode + - object + - order_id + - status + title: charges_data_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 + - properties: + data: + items: + $ref: "#/components/schemas/charges_data_response_2" + type: array + description: The charges associated with the order + title: order_charges_response + order_response_checkout: properties: - amount: - description: Amount to be charged in cents - example: 40000 + 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 + type: array + expires_at: + example: 1676613599 format: int64 type: integer - payment_method: - $ref: '#/components/schemas/charge_request_payment_method' - reference_id: - description: Custom reference to add to the charge + failure_url: + example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx type: string - required: - - payment_method - title: charges - type: object - 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. + force_3ds_flow: 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 + id: + example: 6fca054a-8519-4c43-971e-cea35cc519bb type: string - fiscal_entities: - items: - $ref: '#/components/schemas/customer_fiscal_entities_request' - type: array + 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 - 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 + monthly_installments_enabled: + example: false + type: boolean + monthly_installments_options: items: - $ref: '#/components/schemas/customer_shipping_contacts' + format: int8 + type: integer type: array - subscription: - $ref: '#/components/schemas/subscription_request' - required: - - email - - name - - phone - title: customer request - type: object - 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 + example: ord-2tNDzhA4Akmzj11AS 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 + needs_shipping_contact: + example: false + type: boolean + object: + example: checkout type: string - corporate: - default: false - description: It is a value that allows identifying if the email is corporate - or not. + on_demand_enabled: + example: true + type: boolean + nullable: true + paid_payments_count: + example: 0 + type: integer + recurrent: example: false type: boolean - custom_reference: - description: It is an undefined value. + 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 - fiscal_entities: - items: - $ref: '#/components/schemas/customer_fiscal_entities_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 + sms_sent: + example: 0 + type: integer + success_url: + example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx 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' - type: array - subscription: - $ref: '#/components/schemas/subscription_request' - title: update customer request - type: object - customer_update_fiscal_entities_request: + starts_at: + example: 1676354400 + type: integer + status: + example: Issued + type: string + type: + example: HostedPayment + type: string + url: + example: https://pay.conekta.io/checkout/6fca054a85194c43971ecea35cc519bb + type: string + 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_order_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 + - properties: + data: + items: + $ref: "#/components/schemas/discount_lines_data_response" + type: array + title: order_discount_lines_response + 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: order_fiscal_entity_address_request + - 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: - allOf: - - $ref: '#/components/schemas/customer_address' - tax_id: - type: string + $ref: "#/components/schemas/order_fiscal_entity_address_response" email: + description: Email of the fiscal entity + example: test@gmail.com type: string - phone: - type: string + nullable: true metadata: - additionalProperties: - type: object + additionalProperties: true + description: Metadata associated with the fiscal entity + maxProperties: 100 type: object - company_name: - example: conekta + name: + description: Name of the fiscal entity + example: Conekta Inc type: string - title: update_fiscal_entity_request - type: object - 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 + 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 - minimum: 0 type: integer - code: - description: Discount code. - example: "123" + object: + example: fiscal_entity type: string - type: - description: "It can be 'loyalty', 'campaign', 'coupon' o 'sign'" - example: loyalty + phone: + description: Phone of the fiscal entity + example: "+525511223344" type: string + nullable: true required: - - amount - - code - - type - title: order_discount_lines_request - type: object - update_order_discount_lines_request: - description: List of discounts that apply to the order. + - 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: - amount: - example: 500 - format: int64 - minimum: 0 - type: integer - code: - description: Discount code. - example: "123" + 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: - example: loyalty + description: Indicates the type of action to be taken + example: redirect_to_url type: string - title: update_order_discount_lines_request - type: object - order_request: - description: a order + title: order_next_action_response + order_response_shipping_contact_allOf_address: 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/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 + object: + example: shipping_address 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. You must have at least one discount." - 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: - default: false - 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 + street1: + example: Nuevo Leon 254 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 + street2: + example: Departamento 404 type: string - shipping_contact: - $ref: '#/components/schemas/customer_shipping_contacts' - 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." - nullable: true + postal_code: + example: "06100" type: string - required: - - currency - - customer_info - - line_items - title: a order - type: object - order_update_request: - description: a order + 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 + 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/order_response_shipping_contact_allOf_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 + 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: - items: - $ref: '#/components/schemas/charge_request' - type: array + $ref: "#/components/schemas/order_charges_response" checkout: - $ref: '#/components/schemas/checkout_request' + $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: "Currency with which the payment will be made. It uses the\ - \ 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217)" + description: The three-letter ISO 4217 currency code. The currency of the + order. example: MXN - maxLength: 3 type: string customer_info: - $ref: '#/components/schemas/order_update_request_customer_info' + $ref: "#/components/schemas/order_response_customer_info" discount_lines: - description: "List of [discounts](https://developers.conekta.com/v2.2.0/reference/orderscreatediscountline)\ - \ that are applied to the order. You must have at least one discount." - items: - $ref: '#/components/schemas/order_discount_lines_request' - type: array + $ref: "#/components/schemas/order_discount_lines_response" fiscal_entity: - $ref: '#/components/schemas/order_update_fiscal_entity_request' + $ref: "#/components/schemas/order_fiscal_entity_response" + id: + example: ord_2tMtQQpDvfnNjiuFG + type: string + is_refundable: + example: false + type: boolean 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 - type: object - pre_authorize: - default: false - description: Indicates whether the order charges must be preauthorized + $ref: "#/components/schemas/order_response_products" + livemode: + description: Whether the object exists in live mode or test mode + example: false type: boolean - shipping_contact: - $ref: '#/components/schemas/customer_shipping_contacts' - 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 - type: object - 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 + 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 - 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 - type: object - update_product: - properties: - antifraud_info: - additionalProperties: - type: object - type: object - description: - maxLength: 250 + 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 - sku: + payment_status: + description: The payment status of the order. + example: paid type: string - name: - example: Box of Cohiba S1s + processing_mode: + description: "Indicates the processing mode for the order, either ecommerce,\ + \ recurrent or validation." + example: ecommerce type: string - unit_price: - example: 20000 + 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 - minimum: 0 - type: integer - quantity: - example: 1 - format: int32 - minimum: 1 type: integer - tags: - items: + 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 - type: array - brand: - type: string - metadata: - additionalProperties: + 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 - type: object - title: update_product - type: object - payout_order: - description: a payout order - properties: - allowed_payout_methods: - description: The payout methods that are allowed for the payout order. - example: - - cashout - items: + nullable: true + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 type: string - type: array - amount: - description: The amount of the payout order. - example: 100 - type: integer - currency: - default: MXN - description: The currency in which the payout order is made. - example: MXN - type: string - customer_info: - $ref: '#/components/schemas/customer_info_just_customer_id' - 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 - - payout - - reason - title: payout order request - type: object - checkout: - description: It is a sub-resource of the Order model that can be stipulated - in order to configure its corresponding checkout + 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: Those are the payment methods that will be available for the - link + 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 @@ -17256,6 +19671,12 @@ components: - bnpl - pay_by_bank items: + enum: + - cash + - card + - bank_transfer + - bnpl + - pay_by_bank type: string type: array exclude_card_networks: @@ -17270,23 +19691,28 @@ components: - mastercard - amex type: string - title: checkout_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 10 minutes\ - \ to 365 days from the creation date.\n" - example: 1680397724 + description: Unix timestamp of checkout expiration format: int64 type: integer - monthly_installments_enabled: - description: This flag allows you to specify if months without interest - will be active. - example: true + failure_url: + description: "Redirection url back to the site in case of failed payment,\ + \ applies only to HostedPayment." + type: string + monthly_installments_enabled: + example: false type: boolean monthly_installments_options: - description: This field allows you to specify the number of months without - interest. example: - 3 - 6 @@ -17295,198 +19721,200 @@ components: 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." - nullable: true - type: string + 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 charge - example: Payment Link Name 1594138857 + description: Reason for payment 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 - nullable: true type: boolean - 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 + redirection_time: + description: number of seconds to wait before redirecting to the success_url + example: 10 format: int8 type: integer - recurrent: - description: "false: single use. true: multiple payments" - example: false - type: boolean + success_url: + description: "Redirection url back to the site in case of successful payment,\ + \ applies only to HostedPayment" + type: string type: - description: It is the type of link that will be created. It must be a valid - type. - example: PaymentLink + description: This field represents the type of checkout + example: Integration type: string required: - allowed_payment_methods - - expires_at - - name - - order_template - - recurrent - - type - title: checkout_request - type: object - payment_method_token_request: - allOf: - - $ref: '#/components/schemas/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 - type: object - title: payment_method_token_request - payment_method_cash_request: - allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - properties: - expires_at: - example: 1553273553 - format: int64 - type: integer - type: object - title: payment_method_cash_request - payment_method_spei_request: - allOf: - - $ref: '#/components/schemas/customer_payment_method_request' - - properties: - expires_at: - example: 1553273553 - format: int64 - type: integer - type: object - title: payment_method_spei_request - update_payment_methods: + title: order_checkout_request + customer_info: properties: name: - description: The name of the payment method holder - example: Payment recurrent + example: DevTest 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 - type: object - plan_request: - description: a plan + 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: - 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 + customer_id: + example: cus_23874283647 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 + required: + - customer_id + title: customer_info_customer_id + a_order_customer_info: + description: Customer information + oneOf: + - $ref: "#/components/schemas/customer_info" + - $ref: "#/components/schemas/customer_info_customer_id" + order_fiscal_entity_address_request: + description: Address of the fiscal entity + properties: + street1: + description: Street name and number + example: Nuevo Leon 254 type: string - interval: - description: The interval of time between each charge. - enum: - - week - - half_month - - month - - year - nullable: false + 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: order_fiscal_entity_address_request + order_fiscal_entity_request: + description: "Fiscal entity of the order, Currently it is a purely informative\ + \ field" + properties: + address: + $ref: "#/components/schemas/order_fiscal_entity_address_request" + 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: The name of the plan. - example: Extra Plan3 + description: Name of the fiscal entity + example: Conekta Inc 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 + 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: - - amount - - frequency - - interval - - name - title: a plan - type: object - plan_update_request: - description: a plan + - address + title: order_fiscal_entity_request + product: properties: - amount: - description: The amount in cents that will be charged on the interval specified. - example: 10000 + 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 - currency: - description: "ISO 4217 for currencies, for the Mexican peso it is MXN/USD" - example: MXN - maxLength: 3 + sku: + description: The stock keeping unit for the item. It is used to identify + the item in the order. + example: XYZ12345 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 + 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 - name: - description: The name of the plan. - example: Extra Plan3 - type: string - title: update_plan - type: object + required: + - name + - quantity + - unit_price + title: product shipping_request: properties: amount: @@ -17518,105 +19946,7 @@ components: required: - amount title: shipping_request - type: object - customer_shipping_contacts: - 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_address' - parent_id: - type: string - default: - nullable: true - type: boolean - deleted: - nullable: true - type: boolean - metadata: - additionalProperties: true - description: Metadata associated with the shipping contact - maxProperties: 100 - type: object - required: - - address - title: customer_shipping_contacts_request - type: object - customer_update_shipping_contacts: - 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_address' - parent_id: - type: string - default: - nullable: true - type: boolean - deleted: - nullable: true - type: boolean - title: customer_update_shipping_contacts_request - type: object - 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 - type: object - subscription_update_request: - 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 - type: object - order_tax_request: + a_order_tax_lines_inner: description: create new taxes for an existing order properties: amount: @@ -17639,630 +19969,572 @@ components: required: - amount - description - type: object - update_order_tax_request: - description: create new taxes for an existing order + a_order: + description: a 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 + charges: + description: "List of [charges](https://developers.conekta.com/v2.2.0/reference/orderscreatecharge)\ + \ that are applied to the order" + items: + $ref: "#/components/schemas/charges" + 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/a_order_customer_info" + discount_lines: + description: "List of [discounts](https://developers.conekta.com/v2.2.0/reference/orderscreatediscountline)\ + \ that are applied to the order. You must have at least one discount." + 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: - type: object + additionalProperties: true + description: Metadata associated with the order maxProperties: 100 type: object - type: object - token: - description: a token + needs_shipping_contact: + description: Allows you to fill out the shipping information at checkout + example: false + type: boolean + pre_authorize: + default: false + 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/a_order_tax_lines_inner" + 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: a order + 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/order_fiscal_entity_address_request" + 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: - card: - $ref: '#/components/schemas/token_card' + charges: + items: + $ref: "#/components/schemas/charges" + type: array checkout: - $ref: '#/components/schemas/token_checkout' - title: token request - type: object - 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)).*$ + $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 - subscribed_events: - description: events that will be sent to the webhook - example: customer.created + 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. You must have at least one discount." items: - type: string + $ref: "#/components/schemas/order_discount_lines_request" type: array - required: - - url - title: a webhook - type: object - webhook_update_request: - 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 + 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: - type: string + $ref: "#/components/schemas/product" type: array - active: - description: whether the webhook is active or not - example: true + metadata: + additionalProperties: + type: string + pre_authorize: + default: false + description: Indicates whether the order charges must be preauthorized type: boolean - title: update_webhook - type: object - details: - properties: - details: + 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/details_error' + $ref: "#/components/schemas/shipping_request" type: array - type: object - balance_common_field: - 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 - type: object - payment_method_cash: - allOf: - - $ref: '#/components/schemas/payment_method' - - description: use for cash responses - properties: - agreement: - description: Agreement ID - example: agreement_2tN73UdUSNrYRPD9r - type: string - auth_code: - example: 542563 - nullable: true - type: integer - cashier_id: - example: OINM01010 - nullable: true - type: string - reference: - example: "93000262276908" - type: string - barcode_url: - example: https://barcodes.conekta.com/644ebf80f2243197aad6cd8810375b905b613dbe.png - type: string - expires_at: - example: 0 - format: int64 - type: integer - product_type: - description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\ - \ etc." - example: bbva_cash_in - type: string - service_name: - example: store - type: string - store: - example: 10MON50EDI - nullable: true - type: string - store_name: - example: wallmart - type: string - customer_ip_address: - example: 0.0.0.0 - type: string - title: charge_data_payment_method_cash_response - type: object - payment_method_card: - allOf: - - $ref: '#/components/schemas/payment_method' - - 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 - type: object - payment_method_bank_transfer: - allOf: - - $ref: '#/components/schemas/payment_method' - - description: use for bank transfer responses - properties: - bank: - example: STP - type: string - clabe: - example: "646180111805034237" - type: string - description: - nullable: true - type: string - executed_at: - nullable: true - type: string - expires_at: - example: 1683053729 - format: int64 - type: integer - issuing_account_bank: - nullable: true - type: string - issuing_account_number: - nullable: true - type: string - issuing_account_holder_name: - nullable: true - type: string - issuing_account_tax_id: - nullable: true - type: string - payment_attempts: - items: {} - type: array - receiving_account_holder_name: - nullable: true - type: string - receiving_account_number: - example: "646180111805034237" - type: string - receiving_account_bank: - example: STP - type: string - receiving_account_tax_id: - nullable: true - type: string - reference_number: - nullable: true - type: string - tracking_code: - nullable: true - type: string - customer_ip_address: - example: 0.0.0.0 - type: string - title: charge_data_payment_method_bank_transfer_response - type: object - payment_method_bnpl_payment: - allOf: - - $ref: '#/components/schemas/payment_method' - - description: use for bnpl payment responses - properties: - 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 + tax_lines: + items: + $ref: "#/components/schemas/a_order_tax_lines_inner" + 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 - redirect_url: - description: URL to redirect the customer to complete the payment - example: https://example.com/redirect + description: + description: Short description of the item + example: Imported From Mex. + maxLength: 250 type: string - success_url: - description: URL to redirect the customer after a successful payment - example: https://example.com/success + 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 - required: - - expires_at - - product_type - title: charge_data_payment_method_bnpl_payment_response - type: object - payment_method_pbb_payment: - allOf: - - $ref: '#/components/schemas/payment_method' - - 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 + 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 - expires_at: - description: Expiration date of the charge - example: 1683053729 - exclusiveMinimum: true - format: int64 + 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 - product_type: - description: Product type of the charge + required: + - name + - quantity + - unit_price + title: product + - properties: + id: type: string - redirect_url: - description: URL to redirect the customer to complete the payment - example: https://example.com/redirect + object: type: string - reference: - description: Reference for the payment - example: "22277523174328893295" + parent_id: type: string - required: - - deep_link - - expires_at - - product_type - - redirect_url - - reference - title: charge_data_payment_method_pbb_payment_response - type: object - customer_address: + title: product order response + update_product: 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: + antifraud_info: + additionalProperties: + type: object + description: + maxLength: 250 type: string - required: - - city - - postal_code - - street1 - type: object - order_customer_info_response: - properties: - customer_custom_reference: - description: Custom reference - example: custom_reference - nullable: true + sku: type: string name: - example: DevTest - type: string - email: - example: test@conekta.com - format: email - type: string - phone: - example: "5522997233" - type: string - corporate: - default: false - type: boolean - object: - example: customer_info + example: Box of Cohiba S1s type: string - title: order_customer_info_response - type: object - customer_info_just_customer_id_response: - properties: - customer_id: - example: cus_23874283647 + 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 - title: customer_info_response - type: object - fiscal_entity_address: - description: Address of the fiscal entity + metadata: + additionalProperties: + type: string + title: update_product + orderRefund_request: properties: - street1: - description: Street name and number - example: Nuevo Leon 254 - type: string - street2: - description: Street name and number - example: Departamento 404 - nullable: true - type: string - postal_code: - description: Postal code - example: "06100" - type: string - city: - description: City - example: Ciudad de Mexico - type: string - state: - description: State - example: Ciudad de Mexico - type: string - country: - description: "this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" - example: MX - type: string - external_number: - description: External number - example: "123" + 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: - - city - - country - - external_number - - postal_code - - street1 - title: order_fiscal_entity_address_request - type: object - payment_method_response: + - 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: - type: - type: string - id: - example: src_2s8K1B3PBKDontpi9 - type: string - object: - example: payment_source + 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 - created_at: - example: 1675715413 + expires_at: + description: The expiration date of the payout. + example: 1677626837 format: int64 type: integer - parent_id: - example: cus_2s8K1B3PBKDontpi8 - type: string - required: - - created_at - - id - - object - - type - type: object - 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 + 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 - object: - example: subscription + payout_order_id: + description: The id of the payout order. + example: f2654d66-d740-457a-9a8c-f96b5196f44e type: string status: - example: canceled - type: string - plan_id: - example: VG5 - type: string - customer_id: - example: cus_2yDzKtEAD3khH8Sga + description: The status of the payout. + example: open type: string - next_billing_cycle: - example: 1876833632 - format: int64 - nullable: true + 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 type: integer created_at: - example: 1755873642 + description: The creation date of the payout order. + example: 1677626837 format: int64 type: integer - updated_at: - example: 1761745218 + 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 - title: subscription_details - type: object - customer_details: - description: Customer details for customer portal - properties: id: - example: cus_2yDzKtEAD3khH8Sga + 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: - example: customer + description: The object of the payout order. + example: payout_order type: string - name: - example: mao + 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" + type: array + reason: + description: The reason for the payout order. + example: Payout order for the customer type: string - email: - example: maoarroya@gmail.com - format: email + status: + description: The status of the payout order. + example: open type: string - title: customer_details - type: object - payment_method_pbb_request: - allOf: - - $ref: '#/components/schemas/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 - type: object - title: payment_method_pbb_request - payment_method_bnpl_request: + 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 + - id + - livemode + - object + - payouts + - reason + - updated_at + title: payout_order_response + payout_orders_response: allOf: - - $ref: '#/components/schemas/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 + data: + items: + $ref: "#/components/schemas/payout_order_response" + type: array + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false 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 - - 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 + object: + description: "Object type, in this case is list" + example: list type: string required: - - can_not_expire - - cancel_url - - failure_url - - product_type - - success_url - - type - type: object - title: payment_method_bnpl_request - payment_method_card_request: - allOf: - - $ref: '#/components/schemas/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 + - 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 - number: - description: Card number - example: "4242424242424242" + nullable: true + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 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 + nullable: true + title: page metadata + title: payout_orders_response + customer_info_customer_id_1: + description: The customer information to whom the payout order is made. + properties: + customer_id: + example: cus_23874283647 + type: string + required: + - customer_id + title: customer_info_customer_id + 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 - required: - - cvc - - exp_month - - exp_year - - name - - number - type: object - title: payment_method_card_request - checkout_request: - description: | - [Checkout](https://developers.conekta.com/v2.2.0/reference/payment-link) details + type: array + amount: + description: The amount of the payout order. + example: 100 + type: integer + currency: + default: MXN + description: The currency in which the payout order is made. + example: MXN + type: string + customer_info: + $ref: "#/components/schemas/customer_info_customer_id_1" + 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 + - payout + - reason + title: payout order request + checkout_response: + description: checkout response 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." + description: Are the payment methods available for this link example: - cash - card @@ -18270,17 +20542,23 @@ components: - bnpl - pay_by_bank items: - enum: - - cash - - card - - bank_transfer - - bnpl - - pay_by_bank 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: - description: List of card networks to exclude from the checkout. This field - is only applicable for card payments. example: - visa - amex @@ -18290,25 +20568,28 @@ components: - 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: Unix timestamp of checkout expiration + example: 1680397724 format: int64 type: integer failure_url: - description: "Redirection url back to the site in case of failed payment,\ - \ applies only to HostedPayment." + 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 @@ -18321,379 +20602,231 @@ components: 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" - type: string - type: - description: This field represents the type of checkout - example: Integration - type: string - required: - - allowed_payment_methods - title: order_checkout_request - type: object - customer_info: - properties: name: - example: DevTest - type: string - email: - example: test@conekta.com - format: email - type: string - phone: - example: "5522997233" + description: Reason for charge + example: Payment Link Name 1594138857 type: string - corporate: + needs_shipping_contact: + example: false type: boolean object: - example: customer_info - type: string - required: - - email - - name - - phone - title: customer_info - type: object - customer_info_just_customer_id: - properties: - customer_id: - example: cus_23874283647 - type: string - required: - - customer_id - title: customer_info_customer_id - type: object - customer_payment_method_request: - 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 - type: object - payment_method: - properties: - type: - type: string - object: - example: payment_source - type: string - required: - - object - type: object - 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 - type: object - 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 - type: object - 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 - type: object - 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 + example: checkout type: string - title: deleted_blacklist_rule_response - type: object - get_api_keys_response: - allOf: - - $ref: '#/components/schemas/page' - - $ref: '#/components/schemas/pagination' - - properties: - data: - items: - $ref: '#/components/schemas/api_key_response' - type: array - type: object - title: get_api_keys_response - 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 - type: object - - $ref: '#/components/schemas/api_key_response' - title: api_key_create_response - api_key_update_request: - properties: - active: - description: Indicates if the webhook key is active - example: true + paid_payments_count: + example: 0 + type: integer + payments_limit_count: + example: 5 + format: int8 + type: integer + nullable: true + recurrent: + example: false type: boolean - description: - description: A name or brief explanation of what this api key is used for - example: online store + slug: + example: b0bf16c418b9445eba2401604f329dbf type: string - title: api_key_update_request - type: object - delete_api_keys_response: + sms_sent: + example: 0 + type: integer + starts_at: + example: 1677650400 + type: integer + status: + example: Issued + type: string + success_url: + 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: - - $ref: '#/components/schemas/api_key_response_on_delete' - - properties: - deleted: - example: true + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false type: boolean - type: object - title: delete_api_keys_response - get_charges_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/charge_response' - type: array - type: object - title: get_charges_response - get_companies_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/company_response' - type: array - type: object - title: get_companies_response - customers_response: - allOf: - - properties: - data: - items: - $ref: '#/components/schemas/customer_response' - title: customers_data_response - type: array - type: object - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - title: customers_response - create_customer_fiscal_entities_response: - allOf: - - $ref: '#/components/schemas/customer_fiscal_entities_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 + description: "Object type, in this case is list" + example: list type: string - default: - type: boolean required: - - created_at - - id + - has_more - object - type: object - title: create_customer_fiscal_entities_response - update_customer_fiscal_entities_response: - allOf: - - $ref: '#/components/schemas/customer_fiscal_entities_request' - - properties: - id: - example: fis_ent_2tKZsTYcsryyu7Ah8 - type: string - object: - example: fiscal_entities + 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 - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2tKcHxhTz7xU5SymF + nullable: true + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 type: string - default: - type: boolean - required: - - created_at - - id - - object - type: object - title: update_customer_fiscal_entities_response - get_order_discount_lines_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/discount_lines_response' - type: array - type: object - title: get_order_discount_lines_response - get_events_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' + nullable: true + title: page metadata - properties: data: items: - $ref: '#/components/schemas/event_response' + $ref: "#/components/schemas/checkout_response" type: array - type: object - title: get_events_response - get_orders_response: - allOf: - - $ref: '#/components/schemas/orders_response' - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - title: get_orders_response - order_capture_request: + title: checkouts_response + checkout_request_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_request_order_template: + description: It maintains the attributes with which the order will be created + when receiving a new payment. properties: - amount: - description: Amount to capture - example: 500 - format: int64 - minimum: 1 - nullable: false - type: integer + 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_request_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 required: - - amount - title: order_capture_request - type: object - orderRefund_request: + - currency + - line_items + checkout_request: + description: It is a sub-resource of the Order model that can be stipulated + in order to configure its corresponding checkout properties: - amount: - description: Amount to be refunded in cents - example: 500 - type: integer + 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 + type: array expires_at: - example: 1553273553 + description: "It is the time when the link will expire. \nIt is expressed\ + \ in seconds since the Unix epoch. The valid range is from 10 minutes\ + \ to 365 days from the creation date.\n" + example: 1680397724 format: int64 type: integer - reason: - description: Reason for the refund - example: suspected_fraud + 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_request_order_template" + payments_limit_count: + description: It is the number of payments that can be made through the link. + example: 5 + format: int8 + type: integer + 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: - - amount - - reason - type: object - payout_orders_response: - allOf: - - properties: - data: - items: - $ref: '#/components/schemas/payout_order_response' - title: payout_orders_data_response - type: array - type: object - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - title: payout_orders_response - checkouts_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/checkout_response' - type: array - type: object - title: checkouts_response + - allowed_payment_methods + - expires_at + - name + - order_template + - recurrent + - type + title: checkout_request emailCheckout_request: properties: email: @@ -18702,7 +20835,6 @@ components: type: string required: - email - type: object smsCheckout_request: properties: phonenumber: @@ -18710,7 +20842,6 @@ components: type: string required: - phonenumber - type: object get_customer_payment_method_data_response: discriminator: mapping: @@ -18720,29 +20851,53 @@ components: spei_recurrent: payment_method_spei_recurrent 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' + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_1" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_2" title: get_customer_payment_method_data_response get_payment_method_response: allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' + - 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' + $ref: "#/components/schemas/get_customer_payment_method_data_response" type: array - type: object 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' + - $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: @@ -18752,11 +20907,25 @@ components: spei_recurrent: payment_method_spei_recurrent 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' + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf" + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_1" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_2" 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: @@ -18766,954 +20935,785 @@ components: spei_recurrent: payment_method_spei_recurrent 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' + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf" + - $ref: "#/components/schemas/payment_method_cash_recurrent_response" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_1" + - $ref: "#/components/schemas/customer_payment_methods_data_oneOf_2" 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: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' + - 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' + $ref: "#/components/schemas/plan_response" type: array - type: object title: get_plans_response - subscription_events_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/event_response' - type: array - type: object - title: subscription_events_response - get_transactions_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - description: Transactions - items: - $ref: '#/components/schemas/transaction_response' - type: array - type: object - title: get_transactions_response - get_transfers_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - description: Transfers - items: - $ref: '#/components/schemas/transfers_response' - type: array - type: object - title: get_transfers_response - get_webhook_keys_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/webhook-key_response' - type: array - type: object - title: get_webhook_keys_response - webhook_key_request: + a_plan: + description: a plan properties: - active: - default: true - description: Indicates if the webhook key is active - example: true - type: boolean - title: webhook_key_request - type: object - webhook_key_update_request: + 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: a plan + update_plan: + description: a plan properties: - active: - default: false - description: Indicates if the webhook key is active - example: false - type: boolean - title: webhook_key_update_request - type: object - get_webhooks_response: + 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: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - properties: - data: - items: - $ref: '#/components/schemas/webhook_response' - type: array - type: object - title: get_webhooks_response - risk_rules_data: + 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 + CreateCustomerShippingContacts_200_response: + description: Contains the detail of the shipping addresses that the client has + active or has used in Conekta properties: - id: - description: rule id - example: 618c3f2fdb8b8da9be376af9 + phone: + example: "+525511223344" type: string - field: - description: field to be used for the rule - example: email + receiver: + example: Marvin Fuller type: string - created_at: - description: rule creation date - example: 2021-11-10T21:52:47.339Z + between_streets: + example: Ackerman Crescent type: string - value: - description: value to be used for the rule - example: email@example.com + nullable: true + address: + $ref: "#/components/schemas/order_response_shipping_contact_allOf_address" + parent_id: type: string - is_global: - description: if the rule is global + default: example: false type: boolean - is_test: - description: if the rule is test + 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 - description: - description: description of the rule - example: secure customer example@example.com - type: string - type: object - charge_response_channel: + 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: - segment: - example: Checkout + phone: + description: Phone contact + example: "+525511223344" type: string - checkout_request_id: - example: 6fca054a-8519-4c43-971e-cea35cc519bb + receiver: + description: Name of the person who will receive the order + example: Marvin Fuller type: string - checkout_request_type: - example: HostedPayment + between_streets: + description: The street names between which the order will be delivered. + example: Ackerman Crescent type: string - id: - example: channel_2tNDzhA4Akmzj11AU + address: + $ref: "#/components/schemas/customer_shipping_contacts_request_address" + parent_id: type: string - type: object - 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 - charge_response_refunds_data: + default: + type: boolean + nullable: true + deleted: + type: boolean + nullable: true + title: customer_update_shipping_contacts_request + subscription_response_1: + description: subscription model properties: - amount: - example: -15000 + billing_cycle_start: + example: 1677626827 format: int64 type: integer - auth_code: - example: "867372" - type: string - created_at: - example: 1678226878 + nullable: true + billing_cycle_end: + example: 1677626827 format: int64 type: integer - expires_at: - description: refund expiration date - example: 1678226878 + nullable: true + canceled_at: + example: 1678258162 format: int64 type: integer - id: - example: 6407b5bee1329a000175ba11 + nullable: true + canceled_reason: + description: Reason for cancellation. This field appears when the subscription + status is 'canceled'. + example: user_cancelation type: string - object: - example: refund + card_id: + example: src_2tKcHxhTz7xU5SymL type: string - status: - description: refund status - example: pending + charge_id: + example: 2tKcHxhTz7xU5SymL type: string - required: - - amount - - created_at - - id - - object - title: charge_response_refunds_data - type: object - charge_response_refunds: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - description: refunds - items: - $ref: '#/components/schemas/charge_response_refunds_data' - type: array - type: object - nullable: true - title: charge_response_refunds - type: object - 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 - pbb_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 - charges_order_response_allOf_data: - allOf: - - $ref: '#/components/schemas/charge_response' - company_response_documents_inner: - 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 + nullable: true + created_at: + example: 1677626837 + format: int64 + type: integer + customer_custom_reference: + example: dotnet_123456 type: string - status: - description: The status of the document. - example: pending + customer_id: + example: cus_2tKcHxhTz7xU5SymF type: string - file_name: - description: The name of the file. - nullable: true + id: + example: gold-plan type: string - example: null - type: object - 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 + last_billing_cycle_order_id: + example: ord_2tSoMP7bZJbLiq4z8 type: string - mcc: - description: The Merchant Category Code (MCC) for the company. - example: "5812" + object: + example: subscription type: string - merchant_support_email: - description: Email address for merchant support. - example: test@test.com - format: email + paused_at: + example: 1678258162 + format: int64 + type: integer + nullable: true + plan_id: + example: plan_2tXx672QLQ68CkmMn type: string - merchant_support_phone: - description: Phone number for merchant support. - example: "5300000000" + status: + example: past_due type: string - type: object - create_company_request_fiscal_info: - description: Fiscal information for the company. + 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: - 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 + plan_id: + example: f84gdgf5g48r15fd21g8w424fd1 type: string - type: object - 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" + card_id: + example: src_2qUCNd5AyQqfPMBuV type: string - type: object - customer_antifraud_info_response: - nullable: true - properties: - first_paid_at: - example: 1485151007 - type: integer - account_created_at: + trial_end: example: 1484040996 - format: int64 type: integer - title: customer_antifraud_info_response - type: object - customer_fiscal_entities_data_response: + title: updates a subscription + subscription_events_response: allOf: - - $ref: '#/components/schemas/customer_fiscal_entities_request' - - properties: - id: - example: ship_cont_2tKZsTYcsryyu7Ah8 - type: string + - description: pagination metadata + properties: + has_more: + description: Indicates if there are more pages to be requested + example: false + type: boolean object: - example: shipping_contact - type: string - created_at: - example: 1675715413 - format: int64 - type: integer - parent_id: - example: cus_2tKcHxhTz7xU5SymF + description: "Object type, in this case is list" + example: list type: string - default: - type: boolean required: - - created_at - - id + - has_more - object - type: object - title: customer_fiscal_entities_data_response - customer_fiscal_entities_response: - allOf: - - $ref: '#/components/schemas/pagination' - - properties: - data: - items: - $ref: '#/components/schemas/customer_fiscal_entities_data_response' - type: array - type: object - title: customer_fiscal_entities_response - 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 - 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' - title: customer_payment_methods_data - customer_payment_methods_response: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/customer_payment_methods_data' - title: customer_payment_methods_data - type: array - title: customerPaymentMethods - type: object - title: customer_payment_methods_response - customer_shipping_contacts_data_response: - allOf: - - $ref: '#/components/schemas/customer_shipping_contacts' - - properties: - id: - example: ship_cont_2tKZsTYcsryyu7Ah8 + 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 - object: - example: shipping_contact + nullable: true + previous_page_url: + description: Url of the previous page. + example: https://api.conekta.io/resources?limit=10&previous=chrg_1 type: string - created_at: - example: 1675715413 - format: int64 - type: integer - required: - - created_at - - id - - object - type: object - title: customer_shipping_contacts_data_response - customer_response_shipping_contacts: - allOf: - - $ref: '#/components/schemas/pagination' + nullable: true + title: page metadata - properties: data: items: - $ref: '#/components/schemas/customer_shipping_contacts_data_response' + $ref: "#/components/schemas/event_response" type: array - type: object - WebhookLog: + title: subscription_events_response + subscription_response_2: + description: subscription model properties: - failed_attempts: - example: 10 + billing_cycle_start: + example: 1677626827 + format: int64 type: integer - id: - example: webhl_2svd2sh6GbqzyWBNZ - type: string - last_attempted_at: - example: 1669651274 + nullable: true + billing_cycle_end: + example: 1677626827 + format: int64 type: integer - last_http_response_status: - example: 200 - format: int32 + nullable: true + canceled_at: + example: 1678258162 + format: int64 type: integer - object: - example: webhook_log + nullable: true + canceled_reason: + description: Reason for cancellation. This field appears when the subscription + status is 'canceled'. + example: user_cancelation 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 + card_id: + example: src_2tKcHxhTz7xU5SymL type: string - title: WebhookLog - type: object - logs_response_data: - properties: + charge_id: + example: 2tKcHxhTz7xU5SymL + type: string + nullable: true created_at: - example: 1661445644 + example: 1677626837 format: int64 type: integer - id: - example: 6307a60c41de27127515a575 + customer_custom_reference: + example: dotnet_123456 type: string - ip_address: - example: 54.235.131.48 - format: ipv4 + customer_id: + example: cus_2tKcHxhTz7xU5SymF type: string - livemode: - example: true - type: boolean - loggable_id: - example: ord_87632467832 - nullable: true + id: + example: gold-plan type: string - loggable_type: - example: order - nullable: true + last_billing_cycle_order_id: + example: ord_2tSoMP7bZJbLiq4z8 type: string - method: - example: POST + object: + example: subscription type: string - oauth_token_id: + paused_at: + example: 1678258162 + format: int64 + type: integer nullable: true + plan_id: + example: plan_2tXx672QLQ68CkmMn type: string - query_string: - additionalProperties: true - example: - amount: 3000 - payable: true - type: object - related: - example: FilterResource - type: string - request_body: - example: - filters: - amount: - amount_from: 0 - amount_to: 0 - created_at: - date_from: 1653627600 - date_to: 1661489999 - filterName: Payments - search_term: null - sort_by: created_at - sort_direction: desc - status: [] - type: [] - id: 78e65162-0f37-4942-847c-9bf7081d54c2 - page: "0" - report_type: charges - testMode: false - 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 - type: object - 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 - type: object - searchable_tags: - example: - - 6307a60c41de27127515a575 - - 6307a60c41de27127515a571 - items: - type: string - type: array status: - example: "200" + 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 + x-methods: + cancel: + operationId: cancelSubscription + subscription_details_card: + properties: + id: + example: src_2yw5zPrVahTy7xy7P type: string - updated_at: - example: 2022-08-25T16:40:44.887Z + created_at: + example: 1761745218 + format: int64 + type: integer + active: + example: true + type: boolean + object: + example: card type: string - url: - example: /filter_resource + exp_month: + example: "05" type: string - user_account_id: - example: 5a0b7001edbb6e1725b0b2c6 + exp_year: + example: "26" type: string - version: - example: 2.2.0 + brand: + example: mastercard type: string - title: logs_response_data - type: object - order_channel_response: - properties: - segment: - example: Checkout + last4: + example: "1005" type: string - checkout_request_id: - example: 6fca054a-8519-4c43-971e-cea35cc519bb + name: + example: test type: string - checkout_request_type: - example: HostedPayment + payment_source_status: + example: active type: string - id: - example: channel_2tNDzhA4Akmzj11AU + customer_id: + example: cus_2yDzKtEAD3khH8Sga type: string - title: order_channel_response - type: object - order_charges_response: - allOf: - - $ref: '#/components/schemas/pagination' - - properties: - data: - items: - allOf: - - $ref: '#/components/schemas/charge_response' - title: charges_data_response - type: array - type: object - description: The charges associated with the order - title: order_charges_response - order_response_checkout: + customer_custom_reference: + type: string + nullable: true + subscription_details_plan: 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 + id: + example: VG5 + type: string + object: + example: plan + type: string + name: + example: CLARO + type: string + amount: + example: 30000 + format: int32 type: integer - failure_url: - example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx + currency: + example: USD type: string - force_3ds_flow: - example: false - type: boolean - id: - example: 6fca054a-8519-4c43-971e-cea35cc519bb + interval: + example: month 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 + frequency: + example: 1 + format: int32 + type: integer + trial_period_days: + format: int32 + type: integer nullable: true + example: null + expiry_count: + example: 1 + format: int32 type: integer - 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 + 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 - needs_shipping_contact: - example: false - type: boolean object: - example: checkout + example: subscription type: string - on_demand_enabled: - example: true - nullable: true - type: boolean - paid_payments_count: - example: 0 + 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 - recurrent: - example: false - type: boolean - redirection_time: - description: number of seconds to wait before redirecting to the success_url - example: 2 - format: int8 nullable: true + created_at: + example: 1755873642 + format: int64 type: integer - slug: - example: 6fca054a85194c43971ecea35cc519bb - type: string - sms_sent: - example: 0 - type: integer - success_url: - example: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx - type: string - starts_at: - example: 1676354400 + updated_at: + example: 1761745218 + format: int64 type: integer - status: - example: Issued + title: subscription_details + customer_details: + description: Customer details for customer portal + properties: + id: + example: cus_2yDzKtEAD3khH8Sga type: string - type: - example: HostedPayment + object: + example: customer type: string - url: - example: https://pay.conekta.io/checkout/6fca054a85194c43971ecea35cc519bb + name: + example: mao type: string - type: object - order_response_customer_info: - allOf: - - properties: - object: - example: customer_info - type: string - type: object - - $ref: '#/components/schemas/order_customer_info_response' - - $ref: '#/components/schemas/customer_info_just_customer_id_response' - order_discount_lines_response: - allOf: - - $ref: '#/components/schemas/pagination' - - properties: - data: - items: - allOf: - - $ref: '#/components/schemas/discount_lines_response' - title: discount_lines_data_response - type: array - type: object - title: order_discount_lines_response - order_fiscal_entity_address_response: - allOf: - - $ref: '#/components/schemas/fiscal_entity_address' - - properties: - object: - example: fiscal_entity_address - type: string - type: object - 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" - nullable: true + email: + example: maoarroya@gmail.com + format: email + type: string + title: customer_details + customer_portal_response: + description: Customer portal model properties: - address: - $ref: '#/components/schemas/order_fiscal_entity_address_response' - email: - description: Email of the fiscal entity - example: test@gmail.com - nullable: true + slug: + description: Unique slug identifier for the portal + example: agIvD4QSBl4Nunq4TmuozMw2ThtyVC type: string - metadata: - additionalProperties: true - description: Metadata associated with the fiscal entity - maxProperties: 100 - type: object - name: - description: Name of the fiscal entity - example: Conekta Inc - nullable: true + subscription_id: + description: Associated subscription ID + example: sub_2yYsQuYtXAbP1fdYu type: string - tax_id: - description: Tax ID of the fiscal entity - example: "324234234" - nullable: true + 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: ID of the fiscal entity - example: fis_ent_2tN85VYaSMyDvjB3M + 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: The time at which the object was created in seconds since the - Unix epoch - example: 1676328434 + description: Unix timestamp of creation + example: 1759108828 format: int64 type: integer - object: - example: fiscal_entity - type: string - phone: - description: Phone of the fiscal entity - example: "+525511223344" - nullable: true - type: string - required: - - address - - created_at - - id - - object - title: order_fiscal_entity_response - type: object - product_data_response: - allOf: - - $ref: '#/components/schemas/product' - - properties: - id: - type: string - object: - type: string - parent_id: - type: string - type: object - title: product_data_response - order_response_products: - allOf: - - $ref: '#/components/schemas/pagination' - - $ref: '#/components/schemas/page' - - properties: - data: - items: - $ref: '#/components/schemas/product_data_response' - type: array - type: object - 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" + 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 - type: object - 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 - type: object - order_response_shipping_contact: + title: customer_portal_response + ordersCreateTaxes_200_response: allOf: - - properties: - created_at: + - 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 + - properties: id: + example: tax_lin_2tQ8dC5mg1UADmVPo type: string object: + example: tax_line type: string - type: object - - $ref: '#/components/schemas/customer_shipping_contacts_response' - payout_order_response_customer_info: - allOf: - - properties: - id: - description: The id of the customer. - example: cus_23874283647 + parent_id: + example: ord_2tPAmKCEJqh8RE6nY type: string - required: - - id - type: object - - $ref: '#/components/schemas/order_customer_info_response' - description: The customer information of the payout order. - payout_order_payouts_item: + description: create new taxes for an existing order response + required: + - id + ordersUpdateTaxes_request: + description: create new taxes for an existing order 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 + description: The amount to be collected for tax in cents + example: 100 format: int64 + minimum: 0 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 - type: object - payment_method_cash_response_allOf_agreements: - 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 + description: + description: description or tax's name + example: testing + minLength: 2 type: string - type: object - customer_shipping_contacts_response_address: + metadata: + additionalProperties: + type: object + maxProperties: 100 + token_request_card: properties: - object: - example: shipping_address + cvc: + description: It is a value that allows identifying the security code of + the card. + example: "123" + maxLength: 4 type: string - street1: - example: Nuevo Leon 254 + x-encripted: true + device_fingerprint: + description: It is a value that allows identifying the device fingerprint. + example: zptcxk4p6w1ijwz85snf1l3bqe5g09ie type: string - street2: - example: Departamento 404 + exp_month: + description: It is a value that allows identifying the expiration month + of the card. + example: "12" + maxLength: 2 type: string - postal_code: - example: "06100" + 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 - city: - example: Ciudad de Mexico + x-encripted: true + name: + description: It is a value that allows identifying the name of the cardholder. + example: Miguel type: string - state: - example: Ciudad de Mexico + x-encripted: true + number: + description: It is a value that allows identifying the number of the card. + example: "4242424242424242" type: string - country: - example: MX + 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 - residential: - example: true - nullable: true - type: boolean - type: object + 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 - nullable: true properties: allowed_payment_methods: items: @@ -19731,7 +21731,6 @@ components: items: example: visa type: string - title: token_response_exclude_card_networks type: array expires_at: description: Date and time when the checkout expires. @@ -19810,46 +21809,143 @@ components: description: Type of checkout. example: Integration type: string - type: object - transfer_method_response: - description: Method used to make the transfer. + nullable: true + token_response: + description: token response properties: - account_holder: - description: Name of the account holder. - example: John Doe + checkout: + $ref: "#/components/schemas/token_response_checkout" + id: + description: Unique identifier for the token generated by Conekta. + example: cus_2tHJfJ79KyUwpxTik type: string - account_number: - description: Account number of the bank account. - example: "012180023547896764" + 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 - bank: - description: Name of the bank. - example: BBVA Bancomer + 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 transfer. + 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 transfer. - example: pytmtd_2ide3qwTdDvNBosEC + 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 bank_transfer_payout_method." - example: bank_transfer_payout_method + description: "Object name, which is transaction." + example: transaction type: string - payee_id: - description: Unique identifier of the payee. - example: payee_2icdDewRxDENBos85 + status: + description: Code indicating transaction status. + example: pending type: string type: - description: Type of the payee. - example: BankTransferPayoutMethod + description: Transaction Type + example: capture type: string - title: transfer_method_response - type: object - transfer_destination_response: + 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: @@ -19885,397 +21981,451 @@ components: description: Type of the payee. example: BankTransferPayoutMethod type: string - title: transfer_destination_response - type: object - 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 + 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: - expires_at: - description: Method expiration date as unix timestamp - example: 1677196303 + amount: + description: Amount in cents of the transfer. + example: 10000 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 + created_at: + description: Date and time of creation of the transfer. + example: 1553273553 + format: int64 type: integer - type: - description: Type of payment method - example: card + 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 - token_id: - example: tok_2897348234 + id: + description: Unique identifier of the transfer. + example: 5b0337d4dD344ef954fe1X4b6 type: string - payment_source_id: - example: src_2tLkkyfMPh6v7pFry + 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 - cvc: - description: "Optional, It is a value that allows identifying the security\ - \ code of the card. Only for PCI merchants" - example: "123" + statement_description: + description: Description of the transfer. + example: Conekta 4401234 type: string - contract_id: - description: Optional id sent to indicate the bank contract for recurrent - card charges. - example: S781317595 + statement_reference: + description: Reference number of the transfer. + example: "4401234" 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 + status: + description: Code indicating transfer status. + example: pending type: string - required: - - type - title: payment_method_general_request - type: object - 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 - customer_antifraud_info: - nullable: true - properties: - account_created_at: - example: 1484040996 - format: int64 - type: integer - first_paid_at: - example: 1485151007 - format: int64 - type: integer - type: object - 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 - update_customer_antifraud_info: - nullable: true - properties: - account_created_at: - example: 1484040996 - format: int64 - type: integer - first_paid_at: - example: 1485151007 - type: integer - type: object - order_request_customer_info: - description: Customer information - oneOf: - - $ref: '#/components/schemas/customer_info' - - $ref: '#/components/schemas/customer_info_just_customer_id' - order_fiscal_entity_request: - description: "Fiscal entity of the order, Currently it is a purely informative\ - \ field" + 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: - address: - $ref: '#/components/schemas/fiscal_entity_address' - email: - description: Email of the fiscal entity - example: test@gmail.com - type: string - metadata: - additionalProperties: true - description: Metadata associated with the fiscal entity - maxProperties: 100 - type: object - name: - description: Name of the fiscal entity - example: Conekta Inc - nullable: true - type: string - phone: - description: Phone of the fiscal entity - example: "+525511223344" + account_holder: + description: Name of the account holder. + example: John Doe type: string - tax_id: - description: Tax ID of the fiscal entity - example: AAA010101AAA - nullable: true + account_number: + description: Account number of the bank account. + example: "012180023547896764" type: string - required: - - address - title: order_fiscal_entity_request - type: object - order_update_request_customer_info: - oneOf: - - $ref: '#/components/schemas/customer_info' - - $ref: '#/components/schemas/customer_info_just_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 + bank: + description: Name of the bank. + example: BBVA Bancomer type: string - name: - description: Name of the fiscal entity - example: Conekta Inc - nullable: true + 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 - metadata: - additionalProperties: true - description: Metadata associated with the fiscal entity - maxProperties: 100 - type: object - phone: - description: Phone of the fiscal entity - example: "+525511223344" + object: + description: "Object name, which is bank_transfer_payout_method." + example: bank_transfer_payout_method type: string - tax_id: - description: Tax ID of the fiscal entity - example: AAA010101AAA - nullable: true + payee_id: + description: Unique identifier of the payee. + example: payee_2icdDewRxDENBos85 type: string - required: - - address - title: order_update_fiscal_entity_request - type: object - payout_method: - description: The payout method of the payout order. - properties: type: - description: The type of the payout method. - example: cashout + description: Type of the payee. + example: BankTransferPayoutMethod type: string - required: - - type - title: payout_method - type: object - payout: - description: The payout information of the payout order. - properties: - payout_method: - $ref: '#/components/schemas/payout_method' - required: - - payout_method - title: payout - type: object - 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_just_customer_id' - checkout_order_template: - description: It maintains the attributes with which the order will be created - when receiving a new payment. + 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: It is the currency in which the order will be created. It must - be a valid ISO 4217 currency code. + 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 - 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 - required: - - currency - - line_items - type: object - customer_shipping_contacts_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 + id: + description: Unique identifier of the transfer. + example: 5b0337d4dD344ef954fe1X4b6 type: string - residential: + livemode: + description: Indicates whether the transfer was created in live mode or + test mode. example: true - nullable: true type: boolean - type: object - token_card: - nullable: true - properties: - cvc: - description: It is a value that allows identifying the security code of - the card. - example: "123" - maxLength: 4 + destination: + $ref: "#/components/schemas/transfer_destination_response" + object: + description: "Object name, which is transfer." + example: transfer type: string - x-encripted: true - device_fingerprint: - description: It is a value that allows identifying the device fingerprint. - example: zptcxk4p6w1ijwz85snf1l3bqe5g09ie + statement_description: + description: Description of the transfer. + example: Conekta 4401234 type: string - exp_month: - description: It is a value that allows identifying the expiration month - of the card. - example: "12" - maxLength: 2 + statement_reference: + description: Reference number of the transfer. + example: "4401234" 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 + status: + description: Code indicating transfer status. + example: pending type: string - x-encripted: true - name: - description: It is a value that allows identifying the name of the cardholder. - example: Miguel + title: transfer_response + webhook_key_response: + description: webhook keys model + properties: + id: + description: Unique identifier of the webhook key + example: 62730ba6fb7dfd6a712f118e type: string - x-encripted: true - number: - description: It is a value that allows identifying the number of the card. - example: "4242424242424242" + 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 + example: null + 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 - x-encripted: true - required: - - cvc - - exp_month - - exp_year - - name - - number - type: object - token_checkout: - deprecated: true - nullable: true - properties: - returns_control_on: - description: It is a value that allows identifying the returns control on. - example: Token + 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 - type: object - details_error: + 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: - code: - example: conekta.errors.authentication.missing_key - type: string - param: - nullable: true + 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 - message: - example: Acceso no autorizado. + 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 - debug_message: - example: Please include your access key in your request. + 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: details_error - type: object - subscription_details_card: + title: webhook_key_create_response + webhook_key_update_request: properties: - id: - example: src_2yw5zPrVahTy7xy7P - type: string + 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: - example: 1761745218 + description: Unix timestamp in seconds with the creation date of the webhook + key + example: 1577836800 format: int64 type: integer - active: + deleted: + description: Indicates if the webhook key is deleted 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 + id: + description: Unique identifier of the webhook key + example: 62730ba6fb7dfd6a712f118e type: string - customer_custom_reference: - nullable: true + 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 - example: null - type: object - subscription_details_plan: + title: webhook_key_delete_response + webhook_response: + description: webhooks model properties: id: - example: VG5 + 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: - example: plan + description: "Object name, value is 'webhook'" + example: event type: string - name: - example: CLARO + status: + description: Indicates if the webhook is ready to receive events or failing + example: listening type: string - amount: - example: 30000 - format: int32 - type: integer - currency: - example: USD + 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 - interval: - example: month + 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 + a_webhook: + 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 - frequency: - example: 1 - format: int32 - type: integer - trial_period_days: - format: int32 - nullable: true - type: integer - example: null - expiry_count: - example: 1 - format: int32 - type: integer - created_at: - example: 1742087277 - format: int64 - type: integer - type: object + subscribed_events: + description: events that will be sent to the webhook + example: customer.created + items: + type: string + type: array + required: + - url + title: a webhook + 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 diff --git a/api.yaml b/api.yaml index a3b7d14..88d1e36 100644 --- a/api.yaml +++ b/api.yaml @@ -1,4 +1,4 @@ -openapi: "3.0.3" +openapi: "3.1.0" servers: - url: https://api.conekta.io description: Conekta main server From 250018fd8c9dc4f0377a053ab31b06c7b4849695 Mon Sep 17 00:00:00 2001 From: Franklin Date: Fri, 26 Dec 2025 10:21:44 -0500 Subject: [PATCH 2/2] fix examples --- _build/api.yaml | 27 +++++++++++++++++++++++++++ requestBodies/checkouts/checkout.yml | 14 +++++++------- 2 files changed, 34 insertions(+), 7 deletions(-) diff --git a/_build/api.yaml b/_build/api.yaml index f58d7f9..0eb6c38 100644 --- a/_build/api.yaml +++ b/_build/api.yaml @@ -7664,6 +7664,33 @@ paths: 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_request" description: requested field for checkout diff --git a/requestBodies/checkouts/checkout.yml b/requestBodies/checkouts/checkout.yml index 78503e5..8b206bc 100644 --- a/requestBodies/checkouts/checkout.yml +++ b/requestBodies/checkouts/checkout.yml @@ -1,9 +1,9 @@ -description: requested field for checkout +description: requested field for checkout +required: true content: application/json: - schema: - $ref: '../../schemas/checkouts/checkout.yml' - examples: - create_checkout_with_plan_ids: {plan_ids: ["plan_id_1", "plan_id_2"]} - $ref: '../../schemas/checkouts/request_examples/create_checkout_with_plan_ids.yml' -required: true + schema: + $ref: ../../schemas/checkouts/checkout.yml + examples: + create_checkout_with_plan_ids: + $ref: ../../schemas/checkouts/request_examples/create_checkout_with_plan_ids.yml