Class: ModernTreasury::Resources::PaymentReferences

Inherits:
Object
  • Object
show all
Defined in:
lib/modern_treasury/resources/payment_references.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PaymentReferences

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

Parameters:



68
69
70
 
# File 'lib/modern_treasury/resources/payment_references.rb', line 68

def initialize(client:)
  @client = client
end

Instance Method Details

#list(after_cursor: nil, per_page: nil, reference_number: nil, referenceable_id: nil, referenceable_type: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::PaymentReference>

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

list payment_references

Parameters:

  • after_cursor (String, nil)
  • per_page (Integer)
  • reference_number (String) —

    The actual reference number assigned by the bank.

  • referenceable_id (String) —

    The id of the referenceable to search for. Must be accompanied by the referencea

  • referenceable_type (Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType) —

    One of the referenceable types. This must be accompanied by the id of the refere

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

Returns:

See Also:



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/modern_treasury/resources/payment_references.rb', line 48

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

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::PaymentReference Also known as: retireve

get payment_reference

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/modern_treasury/resources/payment_references.rb', line 17

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