Class: WhopSDK::Resources::LedgerAccounts

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/resources/ledger_accounts.rb

Overview

Ledger accounts

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ LedgerAccounts

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

Parameters:



38
39
40
 
# File 'lib/whop_sdk/resources/ledger_accounts.rb', line 38

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(id, request_options: {}) ⇒ WhopSDK::Models::LedgerAccountRetrieveResponse

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

Retrieves the details of an existing ledger account.

Required permissions:

  • ‘company:balance:read`

  • ‘payout:account:read`

Parameters:

  • id (String) —

    The identifier to look up the ledger account. Accepts a user ID (‘user_xxx’), co

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

Returns:

See Also:



26
27
28
29
30
31
32
33
 
# File 'lib/whop_sdk/resources/ledger_accounts.rb', line 26

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["ledger_accounts/%1$s", id],
    model: WhopSDK::Models::LedgerAccountRetrieveResponse,
    options: params[:request_options]
  )
end