Class: WhopSDK::Resources::PayoutAccounts

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/resources/payout_accounts.rb,
sig/whop_sdk/resources/payout_accounts.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PayoutAccounts

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

Parameters:



33
34
35
 
# File 'lib/whop_sdk/resources/payout_accounts.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

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

Retrieves the details of an existing payout account.

Required permissions:

  • payout:account:read

Parameters:

  • id (String) —

    The unique identifier of the payout account to retrieve.

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

Returns:

See Also:



21
22
23
24
25
26
27
28
 
# File 'lib/whop_sdk/resources/payout_accounts.rb', line 21

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