Class: Stripe::PaymentIntentService::DecrementAuthorizationParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/payment_intent_service.rb

Defined Under Namespace

Classes: AsyncWorkflows, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, application_fee_amount: nil, async_workflows: nil, description: nil, expand: nil, metadata: nil, transfer_data: nil) ⇒ DecrementAuthorizationParams

Returns a new instance of DecrementAuthorizationParams.



10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10712

def initialize(
  amount: nil,
  application_fee_amount: nil,
  async_workflows: nil,
  description: nil,
  expand: nil,
  metadata: nil,
  transfer_data: nil
)
  @amount = amount
  @application_fee_amount = application_fee_amount
  @async_workflows = async_workflows
  @description = description
  @expand = expand
  @metadata = metadata
  @transfer_data = transfer_data
end

Instance Attribute Details

#amount ⇒ Object

The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount and greater than the already captured amount.



10697
10698
10699
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10697

def amount
  @amount
end

#application_fee_amount ⇒ Object

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](stripe.com/docs/payments/connected-accounts).



10699
10700
10701
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10699

def application_fee_amount
  @application_fee_amount
end

#async_workflows ⇒ Object

Automations to be run during the PaymentIntent lifecycle



10701
10702
10703
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10701

def async_workflows
  @async_workflows
end

#description ⇒ Object

An arbitrary string attached to the object. Often useful for displaying to users.



10703
10704
10705
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10703

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



10705
10706
10707
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10705

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



10707
10708
10709
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10707

def metadata
  @metadata
end

#transfer_data ⇒ Object

The parameters used to automatically create a transfer after the payment is captured. Learn more about the [use case for connected accounts](stripe.com/docs/payments/connected-accounts).



10710
10711
10712
 
# File 'lib/stripe/services/payment_intent_service.rb', line 10710

def transfer_data
  @transfer_data
end