Class: Increase::Resources::Simulations::InboundFednowTransfers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundFednowTransfers

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

Parameters:



43
44
45
 
# File 'lib/increase/resources/simulations/inbound_fednow_transfers.rb', line 43

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number_id: , amount: , debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, unstructured_remittance_information: nil, request_options: {}) ⇒ Increase::Models::InboundFednowTransfer

Simulates an [Inbound FedNow Transfer](#inbound-fednow-transfers) to your account.

Parameters:

  • account_number_id (String) —

    The identifier of the Account Number the inbound FedNow Transfer is for.

  • amount (Integer) —

    The transfer amount in USD cents. Must be positive.

  • debtor_account_number (String) —

    The account number of the account that sent the transfer.

  • debtor_name (String) —

    The name provided by the sender of the transfer.

  • debtor_routing_number (String) —

    The routing number of the account that sent the transfer.

  • unstructured_remittance_information (String) —

    Additional information included with the transfer.

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

Returns:

See Also:



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/increase/resources/simulations/inbound_fednow_transfers.rb', line 29

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