Class: Increase::Resources::Simulations::InboundACHTransfers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundACHTransfers

Returns a new instance of InboundACHTransfers.



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

def initialize(client:)
  @client = client
end

Instance Method Details

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

Simulates an inbound ACH transfer to your account. This imitates initiating a transfer to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the amount is positive or negative. The result of calling this API will contain the created transfer. You can pass a resolve_at parameter to allow for a window to action on the Inbound ACH Transfer. Alternatively, if you don't pass the resolve_at parameter the result will contain either a Transaction or a Declined Transaction depending on whether or not the transfer is allowed.

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 ACH Transfer is for.

  • :amount (Integer) —

    The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.

  • :company_descriptive_date (String) —

    The description of the date of the transfer.

  • :company_discretionary_data (String) —

    Data associated with the transfer set by the sender.

  • :company_entry_description (String) —

    The description of the transfer set by the sender.

  • :company_id (String) —

    The sender's company ID.

  • :company_name (String) —

    The name of the sender.

  • :receiver_id_number (String) —

    The ID of the receiver of the transfer.

  • :receiver_name (String) —

    The name of the receiver of the transfer.

  • :resolve_at (String) —

    The time at which the transfer should be resolved. If not provided will resolve immediately.

  • :standard_entry_class_code (Symbol) —

    The standard entry class code for the transfer.

Returns:



41
42
43
44
45
46
47
48
 
# File 'lib/increase/resources/simulations/inbound_ach_transfers.rb', line 41

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