Class: Stripe::PaymentIntentCreateParams::AmountDetails

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/payment_intent_create_params.rb

Defined Under Namespace

Classes: LineItem, Shipping, Surcharge, Tax, Tip

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(discount_amount: nil, enforce_arithmetic_validation: nil, line_items: nil, shipping: nil, surcharge: nil, tax: nil, tip: nil) ⇒ AmountDetails

Returns a new instance of AmountDetails.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 269

def initialize(
  discount_amount: nil,
  enforce_arithmetic_validation: nil,
  line_items: nil,
  shipping: nil,
  surcharge: nil,
  tax: nil,
  tip: nil
)
  @discount_amount = discount_amount
  @enforce_arithmetic_validation = enforce_arithmetic_validation
  @line_items = line_items
  @shipping = shipping
  @surcharge = surcharge
  @tax = tax
  @tip = tip
end

Instance Attribute Details

#discount_amount ⇒ Object

The total discount applied on the transaction represented in the smallest currency unit. An integer greater than 0.

This field is mutually exclusive with the amount_details[line_items][#][discount_amount] field.



251
252
253
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 251

def discount_amount
  @discount_amount
end

#enforce_arithmetic_validation ⇒ Object

Set to false to return arithmetic validation errors in the response without failing the request. Use this when you want the operation to proceed regardless of arithmetic errors in the line item data.

Omit or set to true to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies.

For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error.



257
258
259
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 257

def enforce_arithmetic_validation
  @enforce_arithmetic_validation
end

#line_items ⇒ Object

A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.



259
260
261
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 259

def line_items
  @line_items
end

#shipping ⇒ Object

Contains information about the shipping portion of the amount.



261
262
263
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 261

def shipping
  @shipping
end

#surcharge ⇒ Object

Contains information about the surcharge portion of the amount.



263
264
265
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 263

def surcharge
  @surcharge
end

#tax ⇒ Object

Contains information about the tax portion of the amount.



265
266
267
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 265

def tax
  @tax
end

#tip ⇒ Object

Contains information about the tip portion of the amount.



267
268
269
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 267

def tip
  @tip
end