Class: Increase::Resources::Simulations::InboundWireTransfers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundWireTransfers

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

Parameters:



66
67
68
 
# File 'lib/increase/resources/simulations/inbound_wire_transfers.rb', line 66

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number_id: , amount: , creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {}) ⇒ Increase::Models::InboundWireTransfer

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

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

Parameters:

  • account_number_id (String) —

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

  • amount (Integer) —

    The transfer amount in cents. Must be positive.

  • creditor_address_line1 (String) —

    The sending bank will set creditor_address_line1 in production. You can simulate

  • creditor_address_line2 (String) —

    The sending bank will set creditor_address_line2 in production. You can simulate

  • creditor_address_line3 (String) —

    The sending bank will set creditor_address_line3 in production. You can simulate

  • creditor_name (String) —

    The sending bank will set creditor_name in production. You can simulate any valu

  • debtor_address_line1 (String) —

    The sending bank will set debtor_address_line1 in production. You can simulate a

  • debtor_address_line2 (String) —

    The sending bank will set debtor_address_line2 in production. You can simulate a

  • debtor_address_line3 (String) —

    The sending bank will set debtor_address_line3 in production. You can simulate a

  • debtor_name (String) —

    The sending bank will set debtor_name in production. You can simulate any value

  • end_to_end_identification (String) —

    The sending bank will set end_to_end_identification in production. You can simul

  • instructing_agent_routing_number (String) —

    The sending bank will set instructing_agent_routing_number in production. You ca

  • instruction_identification (String) —

    The sending bank will set instruction_identification in production. You can simu

  • unique_end_to_end_transaction_reference (String) —

    The sending bank will set unique_end_to_end_transaction_reference in production.

  • unstructured_remittance_information (String) —

    The sending bank will set unstructured_remittance_information in production. You

  • wire_drawdown_request_id (String) —

    The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfillin

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

Returns:

See Also:



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

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