Class: WhopSDK::Models::Payouts::MethodListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/payouts/method_list_response.rb,
sig/whop_sdk/models/payouts/method_list_response.rbs

Overview

See Also:

  • WhopSDK::Resources::Payouts::Methods#list

Defined Under Namespace

Modules: Object, Status Classes: PayoutDestination, Quote

Instance Attribute Summary collapse

Class Method 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(estimated_arrival:, fee:, total_received:) ⇒ Object

Standard-delivery estimate. Null if the method does not support standard delivery, or the amount does not cover the fee.

Parameters:

  • estimated_arrival (Time) —

    Estimated time the funds become available.

  • fee (Float) —

    Total fee charged, in the withdrawal currency.

  • total_received (Float) —

    Amount delivered after fees, in the withdrawal currency.




# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 84

Instance Attribute Details

#account_reference ⇒ String?

Masked identifier for the destination, such as the last four digits of a bank account.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


19
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 19

required :account_reference, String, nil?: true

#created_at ⇒ Time

When the payout method was added.

Parameters:

  • value (Time)

Returns:

  • (Time) 


25
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 25

required :created_at, Time

#destination_currency ⇒ String

Currency payouts are delivered in for this method.

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 31

required :destination_currency, String

#id ⇒ String

Payout method ID.

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 12

required :id, String

#institution_name ⇒ String?

Name of the bank or institution receiving payouts.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :institution_name, String, nil?: true

#is_default ⇒ Boolean

Whether this is the default payout method for the account.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


43
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 43

required :is_default, WhopSDK::Internal::Type::Boolean

#nickname ⇒ String?

User-defined label for the payout method.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


49
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 49

required :nickname, String, nil?: true

#object ⇒ Symbol, WhopSDK::Models::Payouts::MethodListResponse::Object

Parameters:

  • value (WhopSDK::Models::Payouts::MethodListResponse::object)

Returns:



54
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 54

required :object, enum: -> { WhopSDK::Models::Payouts::MethodListResponse::Object }

#payer_name ⇒ String?

Display name of the payout rail, such as ACH Bank Deposit.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :payer_name, String, nil?: true

#payout_destination ⇒ WhopSDK::Models::Payouts::MethodListResponse::PayoutDestination?

The payout rail this method delivers through.

Parameters:

Returns:



66
67
68
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 66

required :payout_destination,
-> { WhopSDK::Models::Payouts::MethodListResponse::PayoutDestination },
nil?: true

#quote ⇒ WhopSDK::Models::Payouts::MethodListResponse::Quote?

Fee and delivery estimate for withdrawing the requested amount through this method. Null unless an amount was provided, or when the estimate is unavailable.

Parameters:

Returns:



75
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 75

required :quote, -> { WhopSDK::Models::Payouts::MethodListResponse::Quote }, nil?: true

#status ⇒ Symbol, WhopSDK::Models::Payouts::MethodListResponse::Status

Lifecycle status: created means saved but unused, active means a payout succeeded through it, broken means the last payout failed.

Parameters:

  • value (WhopSDK::Models::Payouts::MethodListResponse::status)

Returns:



82
 
# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 82

required :status, enum: -> { WhopSDK::Models::Payouts::MethodListResponse::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/payouts/method_list_response.rb', line 118

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/whop_sdk/models/payouts/method_list_response.rbs', line 60

def to_hash: -> {