Class: Stripe::Charge::CaptureParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/charge.rb

Defined Under Namespace

Classes: PaymentDetails, 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, payment_details: nil, receipt_email: nil, statement_descriptor: nil, statement_descriptor_suffix: nil, transfer_data: nil, transfer_group: nil) ⇒ CaptureParams

Returns a new instance of CaptureParams.



2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
 
# File 'lib/stripe/resources/charge.rb', line 2926

def initialize(
  amount: nil,
  application_fee: nil,
  application_fee_amount: nil,
  expand: nil,
  payment_details: 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
  @payment_details = payment_details
  @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. Any additional amount will be automatically refunded.



2904
2905
2906
 
# File 'lib/stripe/resources/charge.rb', line 2904

def amount
  @amount
end

#application_fee ⇒ Object

An application fee to add on to this charge.



2906
2907
2908
 
# File 'lib/stripe/resources/charge.rb', line 2906

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.



2908
2909
2910
 
# File 'lib/stripe/resources/charge.rb', line 2908

def application_fee_amount
  @application_fee_amount
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



2910
2911
2912
 
# File 'lib/stripe/resources/charge.rb', line 2910

def expand
  @expand
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



2912
2913
2914
 
# File 'lib/stripe/resources/charge.rb', line 2912

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



2914
2915
2916
 
# File 'lib/stripe/resources/charge.rb', line 2914

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.



2918
2919
2920
 
# File 'lib/stripe/resources/charge.rb', line 2918

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.



2920
2921
2922
 
# File 'lib/stripe/resources/charge.rb', line 2920

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.



2922
2923
2924
 
# File 'lib/stripe/resources/charge.rb', line 2922

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.



2924
2925
2926
 
# File 'lib/stripe/resources/charge.rb', line 2924

def transfer_group
  @transfer_group
end