Class: Increase::Resources::WireDrawdownRequests

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ WireDrawdownRequests

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

Parameters:



110
111
112
 
# File 'lib/increase/resources/wire_drawdown_requests.rb', line 110

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number_id: , amount: , message_to_recipient: , recipient_account_number: , recipient_name: , recipient_routing_number: , originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, recipient_address_line1: nil, recipient_address_line2: nil, recipient_address_line3: nil, request_options: {}) ⇒ Increase::Models::WireDrawdownRequest

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

Create a Wire Drawdown Request

Parameters:

  • account_number_id (String) —

    The Account Number to which the recipient should send funds.

  • amount (Integer) —

    The amount requested from the recipient, in USD cents.

  • message_to_recipient (String) —

    A message the recipient will see as part of the request.

  • recipient_account_number (String) —

    The drawdown request’s recipient’s account number.

  • recipient_name (String) —

    The drawdown request’s recipient’s name.

  • recipient_routing_number (String) —

    The drawdown request’s recipient’s routing number.

  • originator_address_line1 (String) —

    The drawdown request originator’s address line 1. This is only necessary if you’

  • originator_address_line2 (String) —

    The drawdown request originator’s address line 2. This is only necessary if you’

  • originator_address_line3 (String) —

    The drawdown request originator’s address line 3. This is only necessary if you’

  • originator_name (String) —

    The drawdown request originator’s name. This is only necessary if you’re request

  • recipient_address_line1 (String) —

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

  • recipient_address_line2 (String) —

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

  • recipient_address_line3 (String) —

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

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

Returns:

See Also:



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/increase/resources/wire_drawdown_requests.rb', line 44

def create(params)
  parsed, options = Increase::WireDrawdownRequestCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "wire_drawdown_requests",
    body: parsed,
    model: Increase::WireDrawdownRequest,
    options: options
  )
end

#list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::WireDrawdownRequest>

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

List Wire Drawdown Requests

Parameters:

  • cursor (String) —

    Return the page of entries after this one.

  • idempotency_key (String) —

    Filter records to the one with the specified ‘idempotency_key` you chose for tha

  • limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 ob

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

Returns:

See Also:



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/increase/resources/wire_drawdown_requests.rb', line 95

def list(params = {})
  parsed, options = Increase::WireDrawdownRequestListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "wire_drawdown_requests",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::WireDrawdownRequest,
    options: options
  )
end

#retrieve(wire_drawdown_request_id, request_options: {}) ⇒ Increase::Models::WireDrawdownRequest

Retrieve a Wire Drawdown Request

Parameters:

  • wire_drawdown_request_id (String) —

    The identifier of the Wire Drawdown Request to retrieve.

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

Returns:

See Also:



66
67
68
69
70
71
72
73
 
# File 'lib/increase/resources/wire_drawdown_requests.rb', line 66

def retrieve(wire_drawdown_request_id, params = {})
  @client.request(
    method: :get,
    path: ["wire_drawdown_requests/%1$s", wire_drawdown_request_id],
    model: Increase::WireDrawdownRequest,
    options: params[:request_options]
  )
end