Class: Increase::Resources::Simulations::InboundCheckDeposits

Inherits:

Object

• Object
• Increase::Resources::Simulations::InboundCheckDeposits

Defined in:

lib/increase/resources/simulations/inbound_check_deposits.rb

Instance Method Summary

• #create(account_number_id: , amount: , check_number: , payee_name_analysis: nil, request_options: {}) ⇒ Increase::Models::InboundCheckDeposit

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

• #initialize(client:) ⇒ InboundCheckDeposits constructor private

  A new instance of InboundCheckDeposits.

Constructor Details

#initialize(client:) ⇒ InboundCheckDeposits

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

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/simulations/inbound_check_deposits.rb', line 47

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number_id: , amount: , check_number: , payee_name_analysis: nil, request_options: {}) ⇒ Increase::Models::InboundCheckDeposit

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

Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.

Parameters:

• account_number_id (String) —

  The identifier of the Account Number the Inbound Check Deposit will be against.

• amount (Integer) —

  The check amount in cents.

• check_number (String) —

  The check number on the check to be deposited.

• payee_name_analysis (Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis) —

  Simulate the outcome of [payee name checking](increase.com/documentation

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

Returns:

• (Increase::Models::InboundCheckDeposit)

See Also:

• Models::Simulations::InboundCheckDepositCreateParams

# File 'lib/increase/resources/simulations/inbound_check_deposits.rb', line 33

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