Class: Stripe::PaymentIntentCreateParams::TransferData

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

Defined Under Namespace

Classes: PaymentData

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(amount: nil, description: nil, destination: nil, metadata: nil, payment_data: nil) ⇒ TransferData

Returns a new instance of TransferData.



5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 5744

def initialize(
  amount: nil,
  description: nil,
  destination: nil,
  metadata: nil,
  payment_data: nil
)
  @amount = amount
  @description = description
  @destination = destination
  @metadata = metadata
  @payment_data = payment_data
end

Instance Attribute Details

#amount ⇒ Object

The amount that will be transferred automatically when a charge succeeds. The amount is capped at the total transaction amount and if no amount is set, the full amount is transferred.

If you intend to collect a fee and you need a more robust reporting experience, using [application_fee_amount](docs.stripe.com/api/payment_intents/create#create_payment_intent-application_fee_amount) might be a better fit for your integration.



5731
5732
5733
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 5731

def amount
  @amount
end

#description ⇒ Object

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



5733
5734
5735
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 5733

def description
  @description
end

#destination ⇒ Object

If specified, successful charges will be attributed to the destination account for tax reporting, and the funds from charges will be transferred to the destination account. The ID of the resulting transfer will be returned on the successful charge’s ‘transfer` field.



5738
5739
5740
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 5738

def destination
  @destination
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



5740
5741
5742
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 5740

def metadata
  @metadata
end

#payment_data ⇒ Object

The data with which to populate the destination payment.



5742
5743
5744
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 5742

def payment_data
  @payment_data
end