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:



70
71
72
 
# File 'lib/increase/resources/simulations/inbound_wire_transfers.rb', line 70

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number_id: , amount: , beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, beneficiary_reference: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_routing_number: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, sender_reference: 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.

  • beneficiary_address_line1 (String) —

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

  • beneficiary_address_line2 (String) —

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

  • beneficiary_address_line3 (String) —

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

  • beneficiary_name (String) —

    The sending bank will set beneficiary_name in production. You can simulate any v

  • beneficiary_reference (String) —

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

  • originator_address_line1 (String) —

    The sending bank will set originator_address_line1 in production. You can simula

  • originator_address_line2 (String) —

    The sending bank will set originator_address_line2 in production. You can simula

  • originator_address_line3 (String) —

    The sending bank will set originator_address_line3 in production. You can simula

  • originator_name (String) —

    The sending bank will set originator_name in production. You can simulate any va

  • originator_routing_number (String) —

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

  • originator_to_beneficiary_information_line1 (String) —

    The sending bank will set originator_to_beneficiary_information_line1 in product

  • originator_to_beneficiary_information_line2 (String) —

    The sending bank will set originator_to_beneficiary_information_line2 in product

  • originator_to_beneficiary_information_line3 (String) —

    The sending bank will set originator_to_beneficiary_information_line3 in product

  • originator_to_beneficiary_information_line4 (String) —

    The sending bank will set originator_to_beneficiary_information_line4 in product

  • sender_reference (String) —

    The sending bank will set sender_reference in production. You can simulate any v

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



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/increase/resources/simulations/inbound_wire_transfers.rb', line 56

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