Class: Stripe::PaymentIntentCreateParams::TransferData

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::PaymentIntentCreateParams::TransferData

Defined in:

lib/stripe/params/payment_intent_create_params.rb

Instance Attribute Summary

• #amount ⇒ Object

  The amount that will be transferred automatically when a charge succeeds.

• #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.

Instance Method Summary

• #initialize(amount: nil, destination: nil) ⇒ TransferData constructor

  A new instance of TransferData.

Methods inherited from RequestParams

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

Constructor Details

#initialize(amount: nil, destination: nil) ⇒ TransferData

Returns a new instance of TransferData.

# File 'lib/stripe/params/payment_intent_create_params.rb', line 6184

def initialize(amount: nil, destination: nil)
  @amount = amount
  @destination = destination
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.

# File 'lib/stripe/params/payment_intent_create_params.rb', line 6177

def amount
  @amount
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.

# File 'lib/stripe/params/payment_intent_create_params.rb', line 6182

def destination
  @destination
end