Class: Inttegro::Schedule::PayoutRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/schedule/payout_request.rb

Overview

Parameters for scheduling a payout.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#destination_id ⇒ String (readonly)

Financial account that should receive the payout.

Required in the API payload. Wire name: destination_id.

Returns:

  • (String) 


41
42
43
44
45
46
 
# File 'lib/inttegro/schedule/payout_request.rb', line 41

class PayoutRequest < T::Struct
  const :destination_id, String
  const :execute_after, T.nilable(Time), default: nil
  const :max_amount, T.nilable(Integer), default: nil
  const :reference, String
end

#execute_after ⇒ Time? (readonly)

Optional future time after which execution may begin.

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

Returns:

  • (Time, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/schedule/payout_request.rb', line 41

class PayoutRequest < T::Struct
  const :destination_id, String
  const :execute_after, T.nilable(Time), default: nil
  const :max_amount, T.nilable(Integer), default: nil
  const :reference, String
end

#max_amount ⇒ Integer? (readonly)

Maximum amount, in the smallest currency unit, that this payout may transfer.

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

Returns:

  • (Integer, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/schedule/payout_request.rb', line 41

class PayoutRequest < T::Struct
  const :destination_id, String
  const :execute_after, T.nilable(Time), default: nil
  const :max_amount, T.nilable(Integer), default: nil
  const :reference, String
end

#reference ⇒ String (readonly)

Merchant reference carried on the payout.

Required in the API payload. Wire name: reference.

Returns:

  • (String) 


41
42
43
44
45
46
 
# File 'lib/inttegro/schedule/payout_request.rb', line 41

class PayoutRequest < T::Struct
  const :destination_id, String
  const :execute_after, T.nilable(Time), default: nil
  const :max_amount, T.nilable(Integer), default: nil
  const :reference, String
end