Class: Increase::Resources::Simulations::InboundFundsHolds

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundFundsHolds

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 InboundFundsHolds.

Parameters:



31
32
33
 
# File 'lib/increase/resources/simulations/inbound_funds_holds.rb', line 31

def initialize(client:)
  @client = client
end

Instance Method Details

#release(inbound_funds_hold_id, request_options: {}) ⇒ Increase::Models::Simulations::InboundFundsHoldReleaseResponse

This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of e.g., an ACH debit.

Parameters:

  • inbound_funds_hold_id (String) —

    The inbound funds hold to release.

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

Returns:

See Also:



19
20
21
22
23
24
25
26
 
# File 'lib/increase/resources/simulations/inbound_funds_holds.rb', line 19

def release(inbound_funds_hold_id, params = {})
  @client.request(
    method: :post,
    path: ["simulations/inbound_funds_holds/%1$s/release", inbound_funds_hold_id],
    model: Increase::Models::Simulations::InboundFundsHoldReleaseResponse,
    options: params[:request_options]
  )
end