Class: MethodRuby::Resources::Simulate::Accounts::VerificationSessions::Amounts

Inherits:

Object

• Object
• MethodRuby::Resources::Simulate::Accounts::VerificationSessions::Amounts

Defined in:

lib/method_ruby/resources/simulate/accounts/verification_sessions/amounts.rb

Overview

Sandbox account simulation

Instance Method Summary

• #initialize(client:) ⇒ Amounts constructor private

  A new instance of Amounts.

• #retrieve(avf_id, account_id:, method_version:, request_options: {}) ⇒ MethodRuby::Models::Simulate::Accounts::VerificationSessions::AmountRetrieveResponse

  Some parameter documentations has been truncated, see Models::Simulate::Accounts::VerificationSessions::AmountRetrieveParams for more details.

Constructor Details

#initialize(client:) ⇒ Amounts

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

Parameters:

• client (MethodRuby::Client)

# File 'lib/method_ruby/resources/simulate/accounts/verification_sessions/amounts.rb', line 54

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(avf_id, account_id:, method_version:, request_options: {}) ⇒ MethodRuby::Models::Simulate::Accounts::VerificationSessions::AmountRetrieveResponse

Some parameter documentations has been truncated, see Models::Simulate::Accounts::VerificationSessions::AmountRetrieveParams for more details.

Returns the micro-deposit amounts for a verification session in the sandbox environment. Use this to retrieve the test amounts needed to complete micro-deposit verification during development.

**Development only** - This endpoint is only available in the sandbox environment.

Parameters:

• avf_id (String) —

  Path param: Unique identifier for the verification session.

• account_id (String) —

  Path param: Unique identifier for the account.

• method_version (Symbol, MethodRuby::Models::Simulate::Accounts::VerificationSessions::AmountRetrieveParams::MethodVersion) —

  Header param: API version to use for this request. This spec targets ‘2025-12-01

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

Returns:

• (MethodRuby::Models::Simulate::Accounts::VerificationSessions::AmountRetrieveResponse)

See Also:

• Models::Simulate::Accounts::VerificationSessions::AmountRetrieveParams

# File 'lib/method_ruby/resources/simulate/accounts/verification_sessions/amounts.rb', line 34

def retrieve(avf_id, params)
  parsed, options =
    MethodRuby::Simulate::Accounts::VerificationSessions::AmountRetrieveParams.dump_request(params)
  account_id =
    parsed.delete(:account_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["simulate/accounts/%1$s/verification_sessions/%2$s/amounts", account_id, avf_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Simulate::Accounts::VerificationSessions::AmountRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end