Class: ModernTreasury::Resources::IncomingPaymentDetails

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ IncomingPaymentDetails

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

Parameters:



140
141
142
 
# File 'lib/modern_treasury/resources/incoming_payment_details.rb', line 140

def initialize(client:)
  @client = client
end

Instance Method Details

#create_async(amount: nil, as_of_date: nil, currency: nil, data: nil, description: nil, direction: nil, internal_account_id: nil, type: nil, virtual_account_id: nil, request_options: {}) ⇒ ModernTreasury::Models::AsyncResponse

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

Simulate Incoming Payment Detail

Parameters:

Returns:

See Also:



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/modern_treasury/resources/incoming_payment_details.rb', line 126

def create_async(params = {})
  parsed, options = ModernTreasury::IncomingPaymentDetailCreateAsyncParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/simulations/incoming_payment_details/create_async",
    body: parsed,
    model: ModernTreasury::AsyncResponse,
    options: options
  )
end

#list(after_cursor: nil, as_of_date_end: nil, as_of_date_start: nil, direction: nil, metadata: nil, per_page: nil, status: nil, type: nil, virtual_account_id: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::IncomingPaymentDetail>

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

Get a list of Incoming Payment Details.

Parameters:

  • after_cursor (String, nil)
  • as_of_date_end (Date) —

    Filters incoming payment details with an as_of_date starting on or before the sp

  • as_of_date_start (Date) —

    Filters incoming payment details with an as_of_date starting on or after the spe

  • direction (Symbol, ModernTreasury::Models::TransactionDirection) —

    One of ‘credit` or `debit`.

  • metadata (Hash{Symbol=>String}) —

    For example, if you want to query for records with metadata key ‘Type` and value

  • per_page (Integer)
  • status (Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status) —

    The current status of the incoming payment order. One of ‘pending`, `completed`,

  • type (Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type) —

    One of: ‘ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or `w

  • virtual_account_id (String) —

    If the incoming payment detail is in a virtual account, the ID of the Virtual Ac

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

Returns:

See Also:



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/modern_treasury/resources/incoming_payment_details.rb', line 83

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

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

Get an existing Incoming Payment Detail.

Parameters:

Returns:

See Also:



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

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

#update(id, metadata: nil, request_options: {}) ⇒ ModernTreasury::Models::IncomingPaymentDetail

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

Update an existing Incoming Payment Detail.

Parameters:

  • id (String) —

    The unique identifier of the incoming payment detail.

  • metadata (Hash{Symbol=>String}) —

    Additional data in the form of key-value pairs. Pairs can be removed by passing

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

Returns:

See Also:



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/modern_treasury/resources/incoming_payment_details.rb', line 42

def update(id, params = {})
  parsed, options = ModernTreasury::IncomingPaymentDetailUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/incoming_payment_details/%1$s", id],
    body: parsed,
    model: ModernTreasury::IncomingPaymentDetail,
    options: options
  )
end