Conekta::OrderResponse

April 10, 2025 · View on GitHub

Properties

NameTypeDescriptionNotes
amountIntegerThe total amount to be collected in cents[optional]
amount_refundedIntegerThe total amount refunded in cents[optional]
channelOrderChannelResponse[optional]
chargesOrderChargesResponse[optional]
checkoutOrderResponseCheckout[optional]
created_atIntegerThe time at which the object was created in seconds since the Unix epoch[optional]
currencyStringThe three-letter ISO 4217 currency code. The currency of the order.[optional]
customer_infoOrderResponseCustomerInfo[optional]
discount_linesOrderDiscountLinesResponse[optional]
fiscal_entityOrderFiscalEntityResponse[optional]
idString[optional]
is_refundableBoolean[optional]
line_itemsOrderResponseProducts[optional]
livemodeBooleanWhether the object exists in live mode or test mode[optional]
metadataHash<String, Object>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.[optional]
next_actionOrderNextActionResponse[optional]
objectStringString representing the object’s type. Objects of the same type share the same value.[optional]
payment_statusStringThe payment status of the order.[optional]
processing_modeStringIndicates the processing mode for the order, either ecommerce, recurrent or validation.[optional]
shipping_contactOrderResponseShippingContact[optional]
updated_atIntegerThe time at which the object was last updated in seconds since the Unix epoch[optional]

Example

require 'conekta'

instance = Conekta::OrderResponse.new(
  amount: 21605,
  amount_refunded: 0,
  channel: null,
  charges: null,
  checkout: null,
  created_at: 1676328434,
  currency: MXN,
  customer_info: null,
  discount_lines: null,
  fiscal_entity: null,
  id: ord_2tMtQQpDvfnNjiuFG,
  is_refundable: false,
  line_items: null,
  livemode: false,
  metadata: null,
  next_action: null,
  object: order,
  payment_status: paid,
  processing_mode: ecommerce,
  shipping_contact: null,
  updated_at: 1676328434
)