Class: Increase::Resources::CheckTransfers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CheckTransfers

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

Parameters:



174
175
176
 
# File 'lib/increase/resources/check_transfers.rb', line 174

def initialize(client:)
  @client = client
end

Instance Method Details

#approve(check_transfer_id, request_options: {}) ⇒ Increase::Models::CheckTransfer

Approve a Check Transfer

Parameters:

  • check_transfer_id (String) —

    The identifier of the Check Transfer to approve.

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

Returns:

See Also:



117
118
119
120
121
122
123
124
 
# File 'lib/increase/resources/check_transfers.rb', line 117

def approve(check_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["check_transfers/%1$s/approve", check_transfer_id],
    model: Increase::CheckTransfer,
    options: params[:request_options]
  )
end

#cancel(check_transfer_id, request_options: {}) ⇒ Increase::Models::CheckTransfer

Cancel a Check Transfer with the ‘pending_approval` status. See [Transfer Approvals](/documentation/transfer-approvals) for more information.

Parameters:

  • check_transfer_id (String) —

    The identifier of the pending Check Transfer to cancel.

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

Returns:

See Also:



138
139
140
141
142
143
144
145
 
# File 'lib/increase/resources/check_transfers.rb', line 138

def cancel(check_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["check_transfers/%1$s/cancel", check_transfer_id],
    model: Increase::CheckTransfer,
    options: params[:request_options]
  )
end

#create(account_id:, amount:, fulfillment_method:, source_account_number_id:, balance_check: nil, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, valid_until_date: nil, request_options: {}) ⇒ Increase::Models::CheckTransfer

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

Create a Check Transfer

Parameters:

  • account_id (String) —

    The identifier for the account that will send the transfer.

  • amount (Integer) —

    The transfer amount in USD cents.

  • fulfillment_method (Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod) —

    Whether Increase will print and mail the check or if you will do it yourself.

  • source_account_number_id (String) —

    The identifier of the Account Number from which to send the transfer and print o

  • balance_check (Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck) —

    How the account’s available balance should be checked. If omitted, the default b

  • check_number (String) —

    The check number Increase should use for the check. This should not contain lead

  • physical_check (Increase::Models::CheckTransferCreateParams::PhysicalCheck) —

    Details relating to the physical check that Increase will print and mail. This i

  • require_approval (Boolean) —

    Whether the transfer requires explicit approval via the dashboard or API.

  • third_party (Increase::Models::CheckTransferCreateParams::ThirdParty) —

    Details relating to the custom fulfillment you will perform. This is required if

  • valid_until_date (Date) —

    If provided, the check will be valid on or before this date. After this date, th

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

Returns:

See Also:



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/increase/resources/check_transfers.rb', line 38

def create(params)
  parsed, options = Increase::CheckTransferCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "check_transfers",
    body: parsed,
    model: Increase::CheckTransfer,
    options: options
  )
end

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

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

List Check Transfers

Parameters:

Returns:

See Also:



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

def list(params = {})
  parsed, options = Increase::CheckTransferListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "check_transfers",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::CheckTransfer,
    options: options
  )
end

#retrieve(check_transfer_id, request_options: {}) ⇒ Increase::Models::CheckTransfer

Retrieve a Check Transfer

Parameters:

  • check_transfer_id (String) —

    The identifier of the Check Transfer.

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

Returns:

See Also:



60
61
62
63
64
65
66
67
 
# File 'lib/increase/resources/check_transfers.rb', line 60

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

#stop_payment(check_transfer_id, reason: nil, request_options: {}) ⇒ Increase::Models::CheckTransfer

Stop payment on a Check Transfer

Parameters:

Returns:

See Also:



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/increase/resources/check_transfers.rb', line 160

def stop_payment(check_transfer_id, params = {})
  parsed, options = Increase::CheckTransferStopPaymentParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["check_transfers/%1$s/stop_payment", check_transfer_id],
    body: parsed,
    model: Increase::CheckTransfer,
    options: options
  )
end