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

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundCheckDeposits

Returns a new instance of InboundCheckDeposits.



7
8
9
 
# File 'lib/increase/resources/simulations/inbound_check_deposits.rb', line 7

def initialize(client:)
  @client = client
end

Instance Method Details

#create(params = {}, opts = {}) ⇒ Increase::Models::InboundCheckDeposit

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:

  • params (Hash) (defaults to: {}) —

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :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.

Returns:



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

def create(params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/simulations/inbound_check_deposits"
  req[:body] = params
  req[:model] = Increase::Models::InboundCheckDeposit
  @client.request(req, opts)
end