Skip to content

fix: remove SMS checkout endpoint and related schemas from documentation #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fcarrero merged 1 commit into from
Aug 12, 2026
Merged

fix: remove SMS checkout endpoint and related schemas from documentation #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 14 additions & 179 deletions _build/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8174,175 +8174,6 @@ paths:
summary: Send an email
tags:
- Payment Link
/checkouts/{id}/sms:
post:
operationId: smsCheckout
parameters:
- description: Use for knowing which language to use
examples:
es:
summary: for spanish request/response
value: es
en:
summary: for english request/response
value: en
explode: false
in: header
name: Accept-Language
required: false
schema:
default: es
enum:
- es
- en
type: string
style: simple
- description: "In the case of a holding company, the company id of the child\
\ company to which will process the request."
example: 6441b6376b60c3a638da80af
explode: false
in: header
name: X-Child-Company-Id
required: false
schema:
type: string
style: simple
- description: Identifier of the resource
explode: false
in: path
name: id
required: true
schema:
example: 6307a60c41de27127515a575
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/smsCheckout_request"
description: requested field for sms checkout
required: true
responses:
"200":
content:
application/vnd.conekta-v2.3.0+json:
schema:
$ref: "#/components/schemas/checkout_response"
description: successful operation
headers:
Date:
description: The date and time that the response was sent
explode: false
schema:
example: "Fri, 03 Feb 2023 16:57:48 GMT"
type: string
style: simple
Content-Type:
description: The format of the response body
explode: false
schema:
example: application/json; charset=utf-8
type: string
style: simple
Content-Length:
description: The length of the response body in bytes
explode: false
schema:
example: "2737"
type: string
style: simple
Connection:
description: The type of connection used to transfer the response
explode: false
schema:
example: keep-alive
type: string
style: simple
Conekta-Media-Type:
explode: false
schema:
example: conekta-v2.3.0; format=application/json
type: string
style: simple
"401":
content:
application/vnd.conekta-v2.3.0+json:
example:
details:
- message: Please include your access key in your request.
code: conekta.errors.authentication.missing_key
log_id: 507f1f77bcf86cd799439011
object: error
type: authentication_error
schema:
$ref: "#/components/schemas/error"
description: authentication error
"402":
content:
application/vnd.conekta-v2.3.0+json:
example:
details:
- message: The card could not be processed.
code: conekta.errors.processing.tokenization.used
debug_message: The token has already been used.
log_id: 641b6d073cd9a50001515007
object: error
type: processing_error
schema:
$ref: "#/components/schemas/error"
description: payment required error
"404":
content:
application/vnd.conekta-v2.3.0+json:
example:
details:
- message: The resource was not found.
code: conekta.errors.resource_not_found.entity
debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could
not be found.
log_id: 641b6c253cd9a50001514fae
object: error
type: resource_not_found_error
schema:
$ref: "#/components/schemas/error"
description: not found entity
"422":
content:
application/vnd.conekta-v2.3.0+json:
example:
details:
- message: The token does not exist.
param: payment_method.token_id
code: conekta.errors.parameter_validation.payment_method.token_id.nonexistent_token
debug_message: The token does not exist.
log_id: 641b6d813cd9a50001515017
object: error
type: parameter_validation_error
schema:
$ref: "#/components/schemas/error"
description: parameter validation error
"500":
content:
application/vnd.conekta-v2.3.0+json:
example:
details:
- debug_message: There was a runtime error and Conekta engineers have
been notified.
message: There was a runtime error and Conekta engineers have been
notified.
code: conekta.errors.api.system.general_failure
object: error
type: api_error
log_id: 641b6f2b3cd9a50001515098
schema:
$ref: "#/components/schemas/error"
description: internal server error
security:
- bearerAuth: []
summary: Send an sms
tags:
- Payment Link
/customers/{id}/payment_sources:
get:
description: Get a list of Payment Methods
Expand Down Expand Up @@ -20900,12 +20731,16 @@ components:
recurrent:
example: false
type: boolean
redirection_time:
description: It is the time in seconds that the checkout will wait before
redirecting to the success_url.
example: 30
format: int8
nullable: true
type: integer
slug:
example: b0bf16c418b9445eba2401604f329dbf
type: string
sms_sent:
example: 0
type: integer
starts_at:
example: 1677650400
type: integer
Expand Down Expand Up @@ -21121,6 +20956,13 @@ components:
format: int8
minimum: 1
type: integer
redirection_time:
description: It is the time in seconds that the checkout will wait before
redirecting to the success_url. It must be greater than 0.
example: 30
format: int8
minimum: 1
type: integer
success_url:
description: The URL to redirect to after a successful payment.
example: https://www.conekta.com/success
Expand Down Expand Up @@ -21149,13 +20991,6 @@ components:
type: string
required:
- email
smsCheckout_request:
properties:
phonenumber:
example: "5566982090"
type: string
required:
- phonenumber
get_customer_payment_method_data_response:
discriminator:
mapping:
Expand Down
2 changes: 0 additions & 2 deletions api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,6 @@ paths:
$ref: "./resources/checkouts/checkout_cancel.yml"
/checkouts/{id}/email:
$ref: "./resources/checkouts/checkout_email.yml"
/checkouts/{id}/sms:
$ref: "./resources/checkouts/checkout_sms.yml"
/customers/{id}/payment_sources:
$ref: "./resources/customers/create_customer_payment_methods.yml"
/customers/{id}/payment_sources/{payment_method_id}:
Expand Down
12 changes: 0 additions & 12 deletions requestBodies/checkouts/checkout_sms.yml
View file
Open in desktop

This file was deleted.

56 changes: 0 additions & 56 deletions resources/checkouts/checkout_sms.yml
View file
Open in desktop

This file was deleted.

6 changes: 6 additions & 0 deletions schemas/checkouts/checkout.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ properties:
example: 5
minimum: 1
description: "It is the number of payments that can be made through the link."
redirection_time:
type: integer
format: int8
minimum: 1
example: 30
description: "It is the time in seconds that the checkout will wait before redirecting to the success_url. It must be greater than 0."
success_url:
type: string
example: "https://www.conekta.com/success"
Expand Down
8 changes: 5 additions & 3 deletions schemas/checkouts/checkout_response.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,14 @@ properties:
recurrent:
type: boolean
example: false
redirection_time:
type: [integer, "null"]
format: int8
example: 30
description: "It is the time in seconds that the checkout will wait before redirecting to the success_url."
slug:
type: string
example: "b0bf16c418b9445eba2401604f329dbf"
sms_sent:
type: integer
example: 0
starts_at:
type: integer
example: 1677650400
Expand Down
Loading