Class: Increase::Resources::CheckTransfers

Inherits:

Object

• Object
• Increase::Resources::CheckTransfers

Defined in:

lib/increase/resources/check_transfers.rb

Instance Method Summary

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

  Approve a Check Transfer.

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

  Cancel a pending Check Transfer.

• #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, request_options: {}) ⇒ Increase::Models::CheckTransfer

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

• #initialize(client:) ⇒ CheckTransfers constructor private

  A new instance of CheckTransfers.

• #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.

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

  Retrieve a Check Transfer.

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

  Stop payment on a Check Transfer.

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:

• client (Increase::Client)

# File 'lib/increase/resources/check_transfers.rb', line 170

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:

• (Increase::Models::CheckTransfer)

See Also:

• Models::CheckTransferApproveParams

# File 'lib/increase/resources/check_transfers.rb', line 114

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 pending Check Transfer

Parameters:

• check_transfer_id (String) —

  The identifier of the pending Check Transfer to cancel.

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

Returns:

• (Increase::Models::CheckTransfer)

See Also:

• Models::CheckTransferCancelParams

# File 'lib/increase/resources/check_transfers.rb', line 134

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, 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

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

Returns:

• (Increase::Models::CheckTransfer)

See Also:

• Models::CheckTransferCreateParams

# File 'lib/increase/resources/check_transfers.rb', line 36

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:

• account_id (String) —

  Filter Check Transfers to those that originated from the specified Account.

• created_at (Increase::Models::CheckTransferListParams::CreatedAt)
• 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::CheckTransferListParams::Status)
• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Internal::Page<Increase::Models::CheckTransfer>)

See Also:

• Models::CheckTransferListParams

# File 'lib/increase/resources/check_transfers.rb', line 91

def list(params = {})
  parsed, options = Increase::CheckTransferListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "check_transfers",
    query: parsed,
    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:

• (Increase::Models::CheckTransfer)

See Also:

• Models::CheckTransferRetrieveParams

# File 'lib/increase/resources/check_transfers.rb', line 58

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:

• check_transfer_id (String) —

  The identifier of the Check Transfer.

• reason (Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason) —

  The reason why this transfer should be stopped.

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

Returns:

• (Increase::Models::CheckTransfer)

See Also:

• Models::CheckTransferStopPaymentParams

# File 'lib/increase/resources/check_transfers.rb', line 156

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