Class: Stripe::Issuing::AuthorizationCaptureParams

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

Defined Under Namespace

Classes: PurchaseDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(capture_amount: nil, close_authorization: nil, expand: nil, purchase_details: nil) ⇒ AuthorizationCaptureParams

Returns a new instance of AuthorizationCaptureParams.



252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/stripe/params/issuing/authorization_capture_params.rb', line 252

def initialize(
  capture_amount: nil,
  close_authorization: nil,
  expand: nil,
  purchase_details: nil
)
  @capture_amount = capture_amount
  @close_authorization = close_authorization
  @expand = expand
  @purchase_details = purchase_details
end

Instance Attribute Details

#capture_amount ⇒ Object

The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



244
245
246
 
# File 'lib/stripe/params/issuing/authorization_capture_params.rb', line 244

def capture_amount
  @capture_amount
end

#close_authorization ⇒ Object

Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.



246
247
248
 
# File 'lib/stripe/params/issuing/authorization_capture_params.rb', line 246

def close_authorization
  @close_authorization
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



248
249
250
 
# File 'lib/stripe/params/issuing/authorization_capture_params.rb', line 248

def expand
  @expand
end

#purchase_details ⇒ Object

Additional purchase information that is optionally provided by the merchant.



250
251
252
 
# File 'lib/stripe/params/issuing/authorization_capture_params.rb', line 250

def purchase_details
  @purchase_details
end