Class: ModernTreasury::Resources::Returns

Inherits:

Object

• Object
• ModernTreasury::Resources::Returns

Defined in:

lib/modern_treasury/resources/returns.rb

Instance Method Summary

• #create(returnable_id: , returnable_type: , additional_information: nil, code: nil, corrections: nil, data: nil, date_of_death: nil, reason: nil, reconciliation_status: nil, request_options: {}) ⇒ ModernTreasury::Models::ReturnObject

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

• #initialize(client:) ⇒ Returns constructor private

  A new instance of Returns.

• #list(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, per_page: nil, returnable_id: nil, returnable_type: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::ReturnObject>

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

• #retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::ReturnObject

  Get a single return.

Constructor Details

#initialize(client:) ⇒ Returns

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

Parameters:

• client (ModernTreasury::Client)

# File 'lib/modern_treasury/resources/returns.rb', line 106

def initialize(client:)
  @client = client
end

Instance Method Details

#create(returnable_id: , returnable_type: , additional_information: nil, code: nil, corrections: nil, data: nil, date_of_death: nil, reason: nil, reconciliation_status: nil, request_options: {}) ⇒ ModernTreasury::Models::ReturnObject

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

Create a return.

Parameters:

• returnable_id (String, nil) —

  The ID of the object being returned or ‘null`.

• returnable_type (Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType) —

  The type of object being returned. Currently, this may only be incoming*payment*

• additional_information (String, nil) —

  Some returns may include additional information from the bank. In these cases, t

• code (Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil) —

  The return code. For ACH returns, this is the required ACH return code.

• corrections (ModernTreasury::Models::ReturnCreateParams::Corrections, nil) —

  Only relevant for ACH NOC returns. This is an object containing all of the new a

• data (Object, nil) —

  The raw data from the return file that we get from the bank.

• date_of_death (Date, nil) —

  If the return code is ‘R14` or `R15` this is the date the deceased counterparty

• reason (String, nil) —

  An optional description of the reason for the return. This is for internal usage

• reconciliation_status (Symbol, ModernTreasury::Models::ReturnCreateParams::ReconciliationStatus) —

  One of ‘unreconciled`, `tentatively_reconciled` or `reconciled`.

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

Returns:

• (ModernTreasury::Models::ReturnObject)

See Also:

• Models::ReturnCreateParams

# File 'lib/modern_treasury/resources/returns.rb', line 36

def create(params)
  parsed, options = ModernTreasury::ReturnCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/returns",
    body: parsed,
    model: ModernTreasury::ReturnObject,
    options: options
  )
end

#list(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, per_page: nil, returnable_id: nil, returnable_type: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::ReturnObject>

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

Get a list of returns.

Parameters:

• after_cursor (String, nil)
• counterparty_id (String) —

  Specify ‘counterparty_id` if you wish to see returns that occurred with a specif

• internal_account_id (String) —

  Specify ‘internal_account_id` if you wish to see returns to/from a specific acco

• per_page (Integer)
• returnable_id (String) —

  The ID of a valid returnable. Must be accompanied by ‘returnable_type`.

• returnable_type (Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType) —

  One of ‘payment_order`, `reversal`, or `incoming_payment_detail`. Must be accomp

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

Returns:

• (ModernTreasury::Internal::Page<ModernTreasury::Models::ReturnObject>)

See Also:

• Models::ReturnListParams

# File 'lib/modern_treasury/resources/returns.rb', line 91

def list(params = {})
  parsed, options = ModernTreasury::ReturnListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "api/returns",
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::ReturnObject,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::ReturnObject

Get a single return.

Parameters:

• id (String) —

  The ID of an existing return.

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

Returns:

• (ModernTreasury::Models::ReturnObject)

See Also:

• Models::ReturnRetrieveParams

# File 'lib/modern_treasury/resources/returns.rb', line 58

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["api/returns/%1$s", id],
    model: ModernTreasury::ReturnObject,
    options: params[:request_options]
  )
end