Class: Stripe::ChargeService::CaptureParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/charge_service.rb

Defined Under Namespace

Classes: TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, application_fee: nil, application_fee_amount: nil, expand: nil, receipt_email: nil, statement_descriptor: nil, statement_descriptor_suffix: nil, transfer_data: nil, transfer_group: nil) ⇒ CaptureParams

Returns a new instance of CaptureParams.



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/stripe/services/charge_service.rb', line 385

def initialize(
  amount: nil,
  application_fee: nil,
  application_fee_amount: nil,
  expand: nil,
  receipt_email: nil,
  statement_descriptor: nil,
  statement_descriptor_suffix: nil,
  transfer_data: nil,
  transfer_group: nil
)
  @amount = amount
  @application_fee = application_fee
  @application_fee_amount = application_fee_amount
  @expand = expand
  @receipt_email = receipt_email
  @statement_descriptor = statement_descriptor
  @statement_descriptor_suffix = statement_descriptor_suffix
  @transfer_data = transfer_data
  @transfer_group = transfer_group
end

Instance Attribute Details

#amount ⇒ Object

The amount to capture, which must be less than or equal to the original amount.



365
366
367
 
# File 'lib/stripe/services/charge_service.rb', line 365

def amount
  @amount
end

#application_fee ⇒ Object

An application fee to add on to this charge.



367
368
369
 
# File 'lib/stripe/services/charge_service.rb', line 367

def application_fee
  @application_fee
end

#application_fee_amount ⇒ Object

An application fee amount to add on to this charge, which must be less than or equal to the original amount.



369
370
371
 
# File 'lib/stripe/services/charge_service.rb', line 369

def application_fee_amount
  @application_fee_amount
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



371
372
373
 
# File 'lib/stripe/services/charge_service.rb', line 371

def expand
  @expand
end

#receipt_email ⇒ Object

The email address to send this charge’s receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.



373
374
375
 
# File 'lib/stripe/services/charge_service.rb', line 373

def receipt_email
  @receipt_email
end

#statement_descriptor ⇒ Object

For a non-card charge, text that appears on the customer’s statement as the statement descriptor. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](docs.stripe.com/get-started/account/statement-descriptors).

For a card charge, this value is ignored unless you don’t specify a ‘statement_descriptor_suffix`, in which case this value is used as the suffix.



377
378
379
 
# File 'lib/stripe/services/charge_service.rb', line 377

def statement_descriptor
  @statement_descriptor
end

#statement_descriptor_suffix ⇒ Object

Provides information about a card charge. Concatenated to the account’s [statement descriptor prefix](docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer’s statement. If the account has no prefix value, the suffix is concatenated to the account’s statement descriptor.



379
380
381
 
# File 'lib/stripe/services/charge_service.rb', line 379

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#transfer_data ⇒ Object

An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](stripe.com/docs/connect/destination-charges) for details.



381
382
383
 
# File 'lib/stripe/services/charge_service.rb', line 381

def transfer_data
  @transfer_data
end

#transfer_group ⇒ Object

A string that identifies this transaction as part of a group. ‘transfer_group` may only be provided if it has not been set. See the [Connect documentation](stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.



383
384
385
 
# File 'lib/stripe/services/charge_service.rb', line 383

def transfer_group
  @transfer_group
end