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:



73
74
75
 
# File 'lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb', line 73

def initialize(client:)
  @client = client
end

Instance Method Details

#create(amount: , creditor_account_number: , creditor_routing_number: , currency: , recipient_account_number_id: , creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_account_number: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, debtor_routing_number: nil, end_to_end_identification: nil, instruction_identification: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: 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.

  • creditor_account_number (String) —

    The creditor’s account number.

  • creditor_routing_number (String) —

    The creditor’s routing number.

  • currency (String) —

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

  • recipient_account_number_id (String) —

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

  • creditor_address_line1 (String) —

    A free-form address field set by the sender representing the first line of the c

  • creditor_address_line2 (String) —

    A free-form address field set by the sender representing the second line of the

  • creditor_address_line3 (String) —

    A free-form address field set by the sender representing the third line of the c

  • creditor_name (String) —

    A free-form name field set by the sender representing the creditor’s name.

  • debtor_account_number (String) —

    The debtor’s account number.

  • debtor_address_line1 (String) —

    A free-form address field set by the sender representing the first line of the d

  • debtor_address_line2 (String) —

    A free-form address field set by the sender representing the second line of the

  • debtor_address_line3 (String) —

    A free-form address field set by the sender.

  • debtor_name (String) —

    A free-form name field set by the sender representing the debtor’s name.

  • debtor_routing_number (String) —

    The debtor’s routing number.

  • end_to_end_identification (String) —

    A free-form reference string set by the sender, to help identify the transfer.

  • instruction_identification (String) —

    The sending bank’s identifier for the wire transfer.

  • unique_end_to_end_transaction_reference (String) —

    The Unique End-to-end Transaction Reference ([UETR](www.swift.com/paymen

  • unstructured_remittance_information (String) —

    A free-form message set by the sender.

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

Returns:

See Also:



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

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