Class: Increase::Resources::Simulations::InboundWireDrawdownRequests

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundWireDrawdownRequests

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

Parameters:



75
76
77
 
# File 'lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb', line 75

def initialize(client:)
  @client = client
end

Instance Method Details

#create(amount: , beneficiary_account_number: , beneficiary_routing_number: , currency: , message_to_recipient: , originator_account_number: , originator_routing_number: , recipient_account_number_id: , beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: 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, request_options: {}) ⇒ Increase::Models::InboundWireDrawdownRequest

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

Simulates receiving an [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).

Parameters:

  • amount (Integer) —

    The amount being requested in cents.

  • beneficiary_account_number (String) —

    The drawdown request’s beneficiary’s account number.

  • beneficiary_routing_number (String) —

    The drawdown request’s beneficiary’s routing number.

  • currency (String) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the amount being

  • message_to_recipient (String) —

    A message from the drawdown request’s originator.

  • originator_account_number (String) —

    The drawdown request’s originator’s account number.

  • originator_routing_number (String) —

    The drawdown request’s originator’s routing number.

  • recipient_account_number_id (String) —

    The Account Number to which the recipient of this request is being requested to

  • beneficiary_address_line1 (String) —

    Line 1 of the drawdown request’s beneficiary’s address.

  • beneficiary_address_line2 (String) —

    Line 2 of the drawdown request’s beneficiary’s address.

  • beneficiary_address_line3 (String) —

    Line 3 of the drawdown request’s beneficiary’s address.

  • beneficiary_name (String) —

    The drawdown request’s beneficiary’s name.

  • originator_address_line1 (String) —

    Line 1 of the drawdown request’s originator’s address.

  • originator_address_line2 (String) —

    Line 2 of the drawdown request’s originator’s address.

  • originator_address_line3 (String) —

    Line 3 of the drawdown request’s originator’s address.

  • originator_name (String) —

    The drawdown request’s originator’s name.

  • originator_to_beneficiary_information_line1 (String) —

    Line 1 of the information conveyed from the originator of the message to the ben

  • originator_to_beneficiary_information_line2 (String) —

    Line 2 of the information conveyed from the originator of the message to the ben

  • originator_to_beneficiary_information_line3 (String) —

    Line 3 of the information conveyed from the originator of the message to the ben

  • originator_to_beneficiary_information_line4 (String) —

    Line 4 of the information conveyed from the originator of the message to the ben

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

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb', line 61

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