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.



6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 6279

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.



6266
6267
6268
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 6266

def amount
  @amount
end

#description ⇒ Object

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



6268
6269
6270
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 6268

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.



6273
6274
6275
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 6273

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.



6275
6276
6277
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 6275

def metadata
  @metadata
end

#payment_data ⇒ Object

The data with which to populate the destination payment.



6277
6278
6279
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 6277

def payment_data
  @payment_data
end