Class: Increase::Resources::Simulations::CardIncrements

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/simulations/card_increments.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CardIncrements

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CardIncrements.

Parameters:



40
41
42
 
# File 'lib/increase/resources/simulations/card_increments.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#create(amount: , card_payment_id: , event_subscription_id: nil, request_options: {}) ⇒ Increase::Models::CardPayment

Some parameter documentations has been truncated, see Models::Simulations::CardIncrementCreateParams for more details.

Simulates the increment of an authorization by a card acquirer. An authorization can be incremented multiple times.

Parameters:

  • amount (Integer) —

    The amount of the increment in minor units in the card authorization’s currency.

  • card_payment_id (String) —

    The identifier of the Card Payment to create a increment on.

  • event_subscription_id (String) —

    The identifier of the Event Subscription to use. If provided, will override the

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/increase/resources/simulations/card_increments.rb', line 26

def create(params)
  parsed, options = Increase::Simulations::CardIncrementCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "simulations/card_increments",
    body: parsed,
    model: Increase::CardPayment,
    options: options
  )
end