Conekta::CheckoutRequest

September 19, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
allowed_payment_methodsArray<String>Are the payment methods available for this link. For subscriptions, only 'card' is allowed due to the recurring nature of the payments.
plan_idsArray<String>List of plan IDs that will be available for subscription. This field is required for subscription payments.[optional]
expires_atIntegerUnix timestamp of checkout expiration[optional]
failure_urlStringRedirection url back to the site in case of failed payment, applies only to HostedPayment.[optional]
monthly_installments_enabledBoolean[optional]
monthly_installments_optionsArray<Integer>[optional]
max_failed_retriesIntegerNumber of retries allowed before the checkout is marked as failed[optional]
nameStringReason for payment[optional]
on_demand_enabledBoolean[optional]
redirection_timeIntegernumber of seconds to wait before redirecting to the success_url[optional]
success_urlStringRedirection url back to the site in case of successful payment, applies only to HostedPayment[optional]
typeStringThis field represents the type of checkout[optional]

Example

require 'conekta'

instance = Conekta::CheckoutRequest.new(
  allowed_payment_methods: [&quot;cash&quot;,&quot;card&quot;,&quot;bank_transfer&quot;,&quot;bnpl&quot;,&quot;pay_by_bank&quot;],
  plan_ids: [&quot;plan_123&quot;,&quot;plan_456&quot;],
  expires_at: null,
  failure_url: null,
  monthly_installments_enabled: false,
  monthly_installments_options: [3,6,12],
  max_failed_retries: 3,
  name: null,
  on_demand_enabled: true,
  redirection_time: 10,
  success_url: null,
  type: Integration
)