Conekta::TokenResponseCheckout

December 21, 2023 ยท View on GitHub

Properties

NameTypeDescriptionNotes
allowed_payment_methodsArray<String>[optional]
can_not_expireBooleanIndicates if the checkout can not expire.[optional]
emails_sentInteger[optional]
exclude_card_networksArray<String>[optional]
expires_atIntegerDate and time when the checkout expires.[optional]
failure_urlStringURL to redirect the customer to if the payment process fails.[optional]
force_3ds_flowBooleanIndicates if the checkout forces the 3DS flow.[optional]
idString[optional]
livemodeBoolean[optional]
metadataHash<String, Object>[optional]
monthly_installments_enabledBooleanIndicates if the checkout allows monthly installments.[optional]
monthly_installments_optionsArray<Integer>List of monthly installments options.[optional]
nameString[optional]
needs_shipping_contactBoolean[optional]
objectStringIndicates the type of object, in this case checkout.[optional]
on_demand_enabledBooleanIndicates if the checkout allows on demand payments.[optional]
paid_payments_countIntegerNumber of payments that have been paid.[optional]
recurrentBooleanIndicates if the checkout is recurrent.[optional]
sms_sentInteger[optional]
starts_atIntegerDate and time when the checkout starts.[optional]
statusStringStatus of the checkout.[optional]
success_urlStringURL to redirect the customer to after the payment process is completed.[optional]
typeStringType of checkout.[optional]

Example

require 'conekta'

instance = Conekta::TokenResponseCheckout.new(
  allowed_payment_methods: null,
  can_not_expire: false,
  emails_sent: 0,
  exclude_card_networks: null,
  expires_at: 1675715413,
  failure_url: https://example.com/failure,
  force_3ds_flow: false,
  id: 524f9d2f-8c2e-4e64-a33d-6006711a91bd,
  livemode: true,
  metadata: {&quot;key&quot;:&quot;value&quot;},
  monthly_installments_enabled: false,
  monthly_installments_options: null,
  name: tok-2toNoPZpJgRU4PvgZ,
  needs_shipping_contact: false,
  object: checkout,
  on_demand_enabled: false,
  paid_payments_count: 0,
  recurrent: false,
  sms_sent: 0,
  starts_at: 1675715413,
  status: Issued,
  success_url: https://example.com/success,
  type: Integration
)