Conekta::Checkout

October 9, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
allowed_payment_methodsArray<String>Those are the payment methods that will be available for the link
expires_atIntegerIt is the time when the link will expire. It is expressed in seconds since the Unix epoch. The valid range is from 2 to 365 days (the valid range will be taken from the next day of the creation date at 00:01 hrs)
monthly_installments_enabledBooleanThis flag allows you to specify if months without interest will be active.[optional]
monthly_installments_optionsArray<Integer>This field allows you to specify the number of months without interest.[optional]
three_ds_modeStringIndicates 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.[optional]
nameStringReason for charge
needs_shipping_contactBooleanThis flag allows you to fill in the shipping information at checkout.[optional]
on_demand_enabledBooleanThis flag allows you to specify if the link will be on demand.[optional]
plan_idsArray<String>It is a list of plan IDs that will be associated with the order.[optional]
order_templateCheckoutOrderTemplate
payments_limit_countIntegerIt is the number of payments that can be made through the link.[optional]
recurrentBooleanfalse: single use. true: multiple payments
typeStringIt is the type of link that will be created. It must be a valid type.

Example

require 'conekta'

instance = Conekta::Checkout.new(
  allowed_payment_methods: [&quot;cash&quot;,&quot;card&quot;,&quot;bank_transfer&quot;,&quot;bnpl&quot;,&quot;pay_by_bank&quot;],
  expires_at: 1680397724,
  monthly_installments_enabled: true,
  monthly_installments_options: [3,6,12],
  three_ds_mode: null,
  name: Payment Link Name 1594138857,
  needs_shipping_contact: false,
  on_demand_enabled: true,
  plan_ids: [&quot;plan_123&quot;,&quot;plan_456&quot;],
  order_template: null,
  payments_limit_count: 5,
  recurrent: false,
  type: PaymentLink
)