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

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

Parameters:



67
68
69
 
# File 'lib/increase/resources/simulations/inbound_ach_transfers.rb', line 67

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number_id: , amount: , addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_id: nil, company_name: nil, receiver_id_number: nil, receiver_name: nil, resolve_at: nil, standard_entry_class_code: nil, request_options: {}) ⇒ Increase::Models::InboundACHTransfer

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

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](increase.com/documentation/receiving-ach-transfers). Alternatively, if you don’t pass the ‘resolve_at` parameter the result will contain either a [Transaction](#transactions) or a [Declined Transaction](#declined-transactions) depending on whether or not the transfer is allowed.

Parameters:

  • 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 pus

  • addenda (Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda) —

    Additional information to include in the transfer.

  • 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 (Time) —

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

  • standard_entry_class_code (Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode) —

    The standard entry class code for the transfer.

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

Returns:

See Also:



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/increase/resources/simulations/inbound_ach_transfers.rb', line 53

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