Class: Dodopayments::Models::WebhookPayload::Data::Payout

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/webhook_payload.rb,
sig/dodopayments/models/webhook_payload.rbs

Defined Under Namespace

Modules: Status

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(amount:, business_id:, chargebacks:, created_at:, currency:, fee:, payment_method:, payout_id:, refunds:, status:, tax:, updated_at:, name: nil, payout_document_url: nil, remarks: nil, payload_type: :Payout) ⇒ Object

Parameters:

  • amount (Integer) —

    The total amount of the payout.

  • business_id (String) —

    The unique identifier of the business associated with the payout.

  • chargebacks (Integer) —

    The total value of chargebacks associated with the payout.

  • created_at (Time) —

    The timestamp when the payout was created, in UTC.

  • currency (Symbol, Dodopayments::Models::Currency) —

    The currency of the payout, represented as an ISO 4217 currency code.

  • fee (Integer) —

    The fee charged for processing the payout.

  • payment_method (String) —

    The payment method used for the payout (e.g., bank transfer, card, etc.).

  • payout_id (String) —

    The unique identifier of the payout.

  • refunds (Integer) —

    The total value of refunds associated with the payout.

  • status (Symbol, Dodopayments::Models::WebhookPayload::Data::Payout::Status) —

    The current status of the payout.

  • tax (Integer) —

    The tax applied to the payout.

  • updated_at (Time) —

    The timestamp when the payout was last updated, in UTC.

  • name (String, nil) (defaults to: nil) —

    The name of the payout recipient or purpose.

  • payout_document_url (String, nil) (defaults to: nil) —

    The URL of the document associated with the payout.

  • remarks (String, nil) (defaults to: nil) —

    Any additional remarks or notes associated with the payout.

  • payload_type (Symbol, :Payout) (defaults to: :Payout) 



# File 'lib/dodopayments/models/webhook_payload.rb', line 250

Instance Attribute Details

#amount ⇒ Integer

The total amount of the payout.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


150
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 150

required :amount, Integer

#business_id ⇒ String

The unique identifier of the business associated with the payout.

Parameters:

  • value (String)

Returns:

  • (String) 


156
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 156

required :business_id, String

#chargebacks ⇒ Integer

Deprecated.

Use the v3 payout breakup endpoints instead. Will be removed in a future

release.

The total value of chargebacks associated with the payout.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


165
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 165

required :chargebacks, Integer

#created_at ⇒ Time

The timestamp when the payout was created, in UTC.

Parameters:

  • value (Time)

Returns:

  • (Time) 


171
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 171

required :created_at, Time

#currency ⇒ Symbol, Dodopayments::Models::Currency

The currency of the payout, represented as an ISO 4217 currency code.

Parameters:

  • value (Dodopayments::Models::currency)

Returns:



177
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 177

required :currency, enum: -> { Dodopayments::Currency }

#fee ⇒ Integer

The fee charged for processing the payout.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


183
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 183

required :fee, Integer

#name ⇒ String?

The name of the payout recipient or purpose.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


236
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 236

optional :name, String, nil?: true

#payload_type ⇒ Symbol, :Payout

Parameters:

  • value (:Payout)

Returns:

  • (Symbol, :Payout) 


188
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 188

required :payload_type, const: :Payout

#payment_method ⇒ String

The payment method used for the payout (e.g., bank transfer, card, etc.).

Parameters:

  • value (String)

Returns:

  • (String) 


194
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 194

required :payment_method, String

#payout_document_url ⇒ String?

The URL of the document associated with the payout.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


242
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 242

optional :payout_document_url, String, nil?: true

#payout_id ⇒ String

The unique identifier of the payout.

Parameters:

  • value (String)

Returns:

  • (String) 


200
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 200

required :payout_id, String

#refunds ⇒ Integer

Deprecated.

Use the v3 payout breakup endpoints instead. Will be removed in a future

release.

The total value of refunds associated with the payout.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


209
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 209

required :refunds, Integer

#remarks ⇒ String?

Any additional remarks or notes associated with the payout.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


248
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 248

optional :remarks, String, nil?: true

#status ⇒ Symbol, Dodopayments::Models::WebhookPayload::Data::Payout::Status

The current status of the payout.

Parameters:

  • value (Dodopayments::Models::WebhookPayload::Data::Payout::status)

Returns:



215
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 215

required :status, enum: -> { Dodopayments::WebhookPayload::Data::Payout::Status }

#tax ⇒ Integer

Deprecated.

Use the v3 payout breakup endpoints instead. Will be removed in a future

release.

The tax applied to the payout.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


224
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 224

required :tax, Integer

#updated_at ⇒ Time

The timestamp when the payout was last updated, in UTC.

Parameters:

  • value (Time)

Returns:

  • (Time) 


230
 
# File 'lib/dodopayments/models/webhook_payload.rb', line 230

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


193
 
# File 'sig/dodopayments/models/webhook_payload.rbs', line 193

def to_hash: -> {