Class: WhopSDK::Models::PayoutAccountRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/payout_account_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Classes: Address, BusinessRepresentative, LatestVerification

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(date_of_birth:, first_name:, last_name:, middle_name:) ⇒ Object

Some parameter documentations has been truncated, see BusinessRepresentative for more details.

The business representative for this payout account

Parameters:

  • date_of_birth (String, nil) —

    The date of birth of the business representative in ISO 8601 format (YYYY-MM-DD)

  • first_name (String, nil) —

    The first name of the business representative.

  • last_name (String, nil) —

    The last name of the business representative.

  • middle_name (String, nil) —

    The middle name of the business representative.




# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 60

Instance Attribute Details

#address ⇒ WhopSDK::Models::PayoutAccountRetrieveResponse::Address?

The physical address associated with this payout account

Returns:



17
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 17

required :address, -> { WhopSDK::Models::PayoutAccountRetrieveResponse::Address }, nil?: true

#business_name ⇒ String?

The company’s legal name

Returns:

  • (String, nil) 


23
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 23

required :business_name, String, nil?: true

#business_representative ⇒ WhopSDK::Models::PayoutAccountRetrieveResponse::BusinessRepresentative?

The business representative for this payout account

Returns:



29
30
31
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 29

required :business_representative,
-> { WhopSDK::Models::PayoutAccountRetrieveResponse::BusinessRepresentative },
nil?: true

#email ⇒ String?

The email address of the representative

Returns:

  • (String, nil) 


37
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 37

required :email, String, nil?: true

#id ⇒ String

The unique identifier for the payout account.

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 11

required :id, String

#latest_verification ⇒ WhopSDK::Models::PayoutAccountRetrieveResponse::LatestVerification?

The latest verification for the connected account.

Returns:



43
44
45
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 43

required :latest_verification,
-> { WhopSDK::Models::PayoutAccountRetrieveResponse::LatestVerification },
nil?: true

#phone ⇒ String?

The business representative’s phone

Returns:

  • (String, nil) 


51
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 51

required :phone, String, nil?: true

#status ⇒ Symbol, ...

The granular calculated statuses reflecting payout account KYC and withdrawal readiness.

Returns:



58
 
# File 'lib/whop_sdk/models/payout_account_retrieve_response.rb', line 58

required :status, enum: -> { WhopSDK::PayoutAccountCalculatedStatuses }, nil?: true