Class: Inttegro::Payout

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/payout/payout.rb,
lib/inttegro/payout/base.rb,
lib/inttegro/payout/page.rb,
lib/inttegro/payout/error.rb,
lib/inttegro/payout/status.rb,
lib/inttegro/payout/failure.rb,
lib/inttegro/payout/response.rb,
lib/inttegro/payout/destinations.rb,
lib/inttegro/payout/page_request.rb,
lib/inttegro/payout/page_response.rb,
lib/inttegro/payout/cancel_request.rb,
lib/inttegro/payout/failure_reason.rb,
lib/inttegro/payout/lookup_request.rb,
lib/inttegro/payout/settings_lookup.rb,
lib/inttegro/payout/settings_mutation.rb,
lib/inttegro/payout/balance_transaction.rb,
lib/inttegro/payout/get_settings_request.rb,
lib/inttegro/payout/enable_automatic_request.rb,
lib/inttegro/payout/set_destinations_request.rb,
lib/inttegro/payout/settings_lookup_response.rb,
lib/inttegro/payout/settings_lookup_schedule.rb,
lib/inttegro/payout/disable_automatic_request.rb,
lib/inttegro/payout/balance_transaction_status.rb,
lib/inttegro/payout/disable_automatic_response.rb,
lib/inttegro/payout/settings_mutation_response.rb,
lib/inttegro/payout/settings_mutation_schedule.rb,
lib/inttegro/payout/settings_mutation_schedule_spec.rb,
lib/inttegro/payout/settings_lookup_schedule_aging_spec.rb

Overview

A payout scheduled from your Inttegro balance to a destination financial account

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Defined Under Namespace

Classes: BalanceTransaction, BalanceTransactionStatus, CancelRequest, Destinations, DisableAutomaticRequest, DisableAutomaticResponse, EnableAutomaticRequest, Error, Failure, FailureReason, GetSettingsRequest, LookupRequest, Page, PageRequest, PageResponse, Response, SetDestinationsRequest, SettingsLookup, SettingsLookupResponse, SettingsLookupSchedule, SettingsLookupScheduleAgingSpec, SettingsMutation, SettingsMutationResponse, SettingsMutationSchedule, SettingsMutationScheduleSpec, Status

Instance Attribute Summary collapse

Instance Attribute Details

#amount ⇒ Inttegro::Money::Amount? (readonly)

Value of the amount field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: amount.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#balance_transaction_id ⇒ String? (readonly)

Immutable debit balance transaction created when this payout succeeds.

Optional in the API payload; omitted values default to nil. Wire name: balance_transaction_id.

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#balance_transactions ⇒ Array<Inttegro::Payout::BalanceTransaction>? (readonly)

Balance transactions that contributed to this payout. Each item includes the source transaction's original amount and the exact portion allocated to this payout. The difference between those two amounts is not necessarily still available because refunds or other payouts may also consume the source.

Optional in the API payload; omitted values default to nil. Wire name: balance_transactions.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#canceled_at ⇒ Time? (readonly)

When the payout was canceled

Optional in the API payload; omitted values default to nil. Wire name: canceled_at.

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#custom_data ⇒ Inttegro::CustomData? (readonly)

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

Optional in the API payload; omitted values default to nil. Wire name: custom_data.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#destination_id ⇒ String (readonly)

Financial account receiving the funds

Required in the API payload. Wire name: destination_id.

Returns:

  • (String) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#error ⇒ Inttegro::Payout::Error? (readonly)

Deprecated compatibility projection of failure. New integrations should use failure.

Optional in the API payload; omitted values default to nil. Wire name: error.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#execute_after ⇒ Time (readonly)

Earliest moment payout execution may begin

Required in the API payload. Wire name: execute_after.

Returns:

  • (Time) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#executed_by ⇒ String? (readonly)

Actor that executed the payout

Optional in the API payload; omitted values default to nil. Wire name: executed_by.

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#expected_at ⇒ Time? (readonly)

Expected completion time

Optional in the API payload; omitted values default to nil. Wire name: expected_at.

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#failed_at ⇒ Time? (readonly)

When the payout entered the failed state.

Optional in the API payload; omitted values default to nil. Wire name: failed_at.

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#failure ⇒ Inttegro::Payout::Failure? (readonly)

Caller-safe failure information. Present only when status is failed.

Optional in the API payload; omitted values default to nil. Wire name: failure.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#id ⇒ String (readonly)

Unique payout identifier

Required in the API payload. Wire name: id.

Returns:

  • (String) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#initiated_at ⇒ Time (readonly)

When the payout was created

Required in the API payload. Wire name: initiated_at.

Returns:

  • (Time) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#initiated_by ⇒ String? (readonly)

Actor that initiated the payout

Optional in the API payload; omitted values default to nil. Wire name: initiated_by.

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#max_amount ⇒ Inttegro::Money::Amount (readonly)

Value of the max_amount field in the Inttegro API payload.

Required in the API payload. Wire name: max_amount.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#reference ⇒ String? (readonly)

Merchant reference carried on the payout

Optional in the API payload; omitted values default to nil. Wire name: reference.

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#schedule_id ⇒ String? (readonly)

Schedule associated with the payout

Optional in the API payload; omitted values default to nil. Wire name: schedule_id.

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#scheduled_at ⇒ Time? (readonly)

When the payout was scheduled

Optional in the API payload; omitted values default to nil. Wire name: scheduled_at.

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#scheduled_by ⇒ String? (readonly)

Actor that scheduled the payout

Optional in the API payload; omitted values default to nil. Wire name: scheduled_by.

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#sent_at ⇒ Time? (readonly)

When the transfer was sent

Optional in the API payload; omitted values default to nil. Wire name: sent_at.

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#source_id ⇒ String? (readonly)

Source identifier associated with the payout

Optional in the API payload; omitted values default to nil. Wire name: source_id.

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#status ⇒ Inttegro::Payout::Status (readonly)

Current payout lifecycle state

Required in the API payload. Wire name: status.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end

#succeeded_at ⇒ Time? (readonly)

When the payout succeeded

Optional in the API payload; omitted values default to nil. Wire name: succeeded_at.

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/payout/payout.rb', line 170

class Payout
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :balance_transactions, T.nilable(T::Array[Inttegro::Payout::BalanceTransaction]), default: nil
  const :balance_transaction_id, T.nilable(String), default: nil
  const :canceled_at, T.nilable(Time), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :destination_id, String
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
  const :execute_after, Time
  const :executed_by, T.nilable(String), default: nil
  const :expected_at, T.nilable(Time), default: nil
  const :failed_at, T.nilable(Time), default: nil
  const :failure, T.nilable(Inttegro::Payout::Failure), default: nil
  const :id, String
  const :initiated_at, Time
  const :initiated_by, T.nilable(String), default: nil
  const :max_amount, Inttegro::Money::Amount
  const :reference, T.nilable(String), default: nil
  const :schedule_id, T.nilable(String), default: nil
  const :scheduled_at, T.nilable(Time), default: nil
  const :scheduled_by, T.nilable(String), default: nil
  const :sent_at, T.nilable(Time), default: nil
  const :source_id, T.nilable(String), default: nil
  const :status, Inttegro::Payout::Status
  const :succeeded_at, T.nilable(Time), default: nil
end