Class: Increase::Resources::Simulations::PendingTransactions

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PendingTransactions

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

Parameters:



38
39
40
 
# File 'lib/increase/resources/simulations/pending_transactions.rb', line 38

def initialize(client:)
  @client = client
end

Instance Method Details

#release_inbound_funds_hold(pending_transaction_id, request_options: {}) ⇒ Increase::Models::PendingTransaction

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

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

Parameters:

  • pending_transaction_id (String) —

    The pending transaction to release. The pending transaction must have a ‘inbound

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

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/increase/resources/simulations/pending_transactions.rb', line 23

def release_inbound_funds_hold(pending_transaction_id, params = {})
  @client.request(
    method: :post,
    path: [
      "simulations/pending_transactions/%1$s/release_inbound_funds_hold",
      pending_transaction_id
    ],
    model: Increase::PendingTransaction,
    options: params[:request_options]
  )
end