Skip to content

Latest commit

 

History

History
48 lines (42 loc) · 2.98 KB

OrderRequest.md

File metadata and controls

48 lines (42 loc) · 2.98 KB

Conekta::OrderRequest

Properties

Name Type Description Notes
charges Array<ChargeRequest> List of charges that are applied to the order [optional]
checkout CheckoutRequest [optional]
currency String Currency with which the payment will be made. It uses the 3-letter code of the International Standard ISO 4217.
customer_info OrderRequestCustomerInfo
discount_lines Array<OrderDiscountLinesRequest> List of discounts that are applied to the order. You must have at least one discount. [optional]
fiscal_entity OrderFiscalEntityRequest [optional]
line_items Array<Product> List of products that are sold in the order. You must have at least one product.
metadata Hash<String, Object> Metadata associated with the order [optional]
needs_shipping_contact Boolean Allows you to fill out the shipping information at checkout [optional]
pre_authorize Boolean Indicates whether the order charges must be preauthorized [optional][default to false]
processing_mode String Indicates the processing mode for the order, either ecommerce, recurrent or validation. [optional]
return_url String Indicates the redirection callback upon completion of the 3DS2 flow. Do not use this parameter if your order has a checkout parameter [optional]
shipping_contact CustomerShippingContacts [optional]
shipping_lines Array<ShippingRequest> List of shipping costs. If the online store offers digital products. [optional]
tax_lines Array<OrderTaxRequest> List of taxes that are applied to the order. [optional]
three_ds_mode String Indicates the 3DS2 mode for the order, either smart or strict. [optional]

Example

require 'conekta'

instance = Conekta::OrderRequest.new(
  charges: null,
  checkout: null,
  currency: MXN,
  customer_info: null,
  discount_lines: null,
  fiscal_entity: null,
  line_items: null,
  metadata: null,
  needs_shipping_contact: false,
  pre_authorize: null,
  processing_mode: ecommerce,
  return_url: https://my-website.com,
  shipping_contact: null,
  shipping_lines: null,
  tax_lines: null,
  three_ds_mode: null
)