Class: Stripe::PaymentIntent::DecrementAuthorizationParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/payment_intent.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.



12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
 
# File 'lib/stripe/resources/payment_intent.rb', line 12614

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.



12599
12600
12601
 
# File 'lib/stripe/resources/payment_intent.rb', line 12599

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).



12601
12602
12603
 
# File 'lib/stripe/resources/payment_intent.rb', line 12601

def application_fee_amount
  @application_fee_amount
end

#async_workflows ⇒ Object

Automations to be run during the PaymentIntent lifecycle



12603
12604
12605
 
# File 'lib/stripe/resources/payment_intent.rb', line 12603

def async_workflows
  @async_workflows
end

#description ⇒ Object

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



12605
12606
12607
 
# File 'lib/stripe/resources/payment_intent.rb', line 12605

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



12607
12608
12609
 
# File 'lib/stripe/resources/payment_intent.rb', line 12607

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`.



12609
12610
12611
 
# File 'lib/stripe/resources/payment_intent.rb', line 12609

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).



12612
12613
12614
 
# File 'lib/stripe/resources/payment_intent.rb', line 12612

def transfer_data
  @transfer_data
end