Class: ModernTreasury::Models::PaymentFlowCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::PaymentFlowCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/payment_flow_create_params.rb

Overview

See Also:

• Resources::PaymentFlows#create

Defined Under Namespace

Modules: Direction

Instance Attribute Summary

• #amount ⇒ Integer

  Required.

• #counterparty_id ⇒ String

  Required.

• #currency ⇒ String

  Required.

• #direction ⇒ Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction

  Required.

• #due_date ⇒ Date^?

  Optional.

• #originating_account_id ⇒ String

  Required.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(amount: , counterparty_id: , currency: , direction: , originating_account_id: , due_date: nil, request_options: {}) ⇒ Object constructor

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

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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: , counterparty_id: , currency: , direction: , originating_account_id: , due_date: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::PaymentFlowCreateParams for more details.

Parameters:

• amount (Integer) (defaults to: ) —

  Required. Value in specified currency’s smallest unit. e.g. $10 would be represe

• counterparty_id (String) (defaults to: ) —

  Required. The ID of a counterparty associated with the payment. As part of the p

• currency (String) (defaults to: ) —

  Required. The currency of the payment.

• direction (Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction) (defaults to: ) —

  Required. Describes the direction money is flowing in the transaction. Can only

• originating_account_id (String) (defaults to: ) —

  Required. The ID of one of your organization’s internal accounts.

• due_date (Date) (defaults to: nil) —

  Optional. Can only be passed in when ‘effective_date_selection_enabled` is `true

• request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/modern_treasury/models/payment_flow_create_params.rb', line 51

Instance Attribute Details

#amount ⇒ Integer

Required. Value in specified currency’s smallest unit. e.g. $10 would be represented as 1000. Can be any integer up to 36 digits.

Returns:

• (Integer)

# File 'lib/modern_treasury/models/payment_flow_create_params.rb', line 15

required :amount, Integer

#counterparty_id ⇒ String

Required. The ID of a counterparty associated with the payment. As part of the payment workflow an external account will be associated with this model.

Returns:

• (String)

# File 'lib/modern_treasury/models/payment_flow_create_params.rb', line 22

required :counterparty_id, String

#currency ⇒ String

Required. The currency of the payment.

Returns:

• (String)

# File 'lib/modern_treasury/models/payment_flow_create_params.rb', line 28

required :currency, String

#direction ⇒ Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction

Required. Describes the direction money is flowing in the transaction. Can only be ‘debit`. A `debit` pulls money from someone else’s account to your own.

Returns:

• (Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction)

# File 'lib/modern_treasury/models/payment_flow_create_params.rb', line 35

required :direction, enum: -> { ModernTreasury::PaymentFlowCreateParams::Direction }

#due_date ⇒ Date^?

Optional. Can only be passed in when ‘effective_date_selection_enabled` is `true`. When set, the due date is shown to your end-user in the pre-built UI as they are selecting a payment `effective_date`.

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/payment_flow_create_params.rb', line 49

optional :due_date, Date

#originating_account_id ⇒ String

Required. The ID of one of your organization’s internal accounts.

Returns:

• (String)

# File 'lib/modern_treasury/models/payment_flow_create_params.rb', line 41

required :originating_account_id, String