Class: ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/modern_treasury/models/bulk_request_create_params.rb

Defined Under Namespace

Modules: ChargeBearer, Direction, FallbackType, ForeignExchangeIndicator, Priority, ReconciliationStatus, Status Classes: Accounting, LineItem, ReceivingAccount

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(amount:, accounting_category_id: nil, description: nil, metadata: nil) ⇒ Object

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

Parameters:

  • amount (Integer) —

    Value in specified currency’s smallest unit. e.g. $10 would be represented as 10

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

    The ID of one of your accounting categories. Note that these will only be access

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

    A free-form description of the line item.

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Additional data represented as key-value pairs. Both the key and value must be s




# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1785

Instance Attribute Details

#accounting ⇒ ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Accounting?

Deprecated.

Returns:



1498
1499
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1498

optional :accounting,
-> { ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Accounting }

#accounting_category_id ⇒ String?

Deprecated.

The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected.

Returns:

  • (String, nil) 


1508
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1508

optional :accounting_category_id, String, nil?: true

#accounting_ledger_class_id ⇒ String?

Deprecated.

The ID of one of your accounting ledger classes. Note that these will only be accessible if your accounting system has been connected.

Returns:

  • (String, nil) 


1517
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1517

optional :accounting_ledger_class_id, String, nil?: true

#amount ⇒ Integer?

Value in specified currency’s smallest unit. e.g. $10 would be represented as 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.

Returns:

  • (Integer, nil) 


1524
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1524

optional :amount, Integer

#charge_bearer ⇒ Symbol, ...

The party that will pay the fees for the payment order. See docs.moderntreasury.com/payments/docs/charge-bearer to understand the differences between the options.

Returns:



1532
1533
1534
1535
1536
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1532

optional :charge_bearer,
enum: -> {
  ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer
},
nil?: true

#counterparty_id ⇒ String?

Required when receiving_account_id is passed the ID of an external account.

Returns:

  • (String, nil) 


1542
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1542

optional :counterparty_id, String, nil?: true

#currency ⇒ Symbol, ...

Defaults to the currency of the originating account.

Returns:



1548
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1548

optional :currency, enum: -> { ModernTreasury::Currency }

#description ⇒ String?

An optional description for internal use.

Returns:

  • (String, nil) 


1554
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1554

optional :description, String, nil?: true

#direction ⇒ Symbol, ...

One of ‘credit`, `debit`. Describes the direction money is flowing in the transaction. A `credit` moves money from your account to someone else’s. A ‘debit` pulls money from someone else’s account to your own. Note that wire, rtp, and check payments will always be ‘credit`.

Returns:



1563
1564
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1563

optional :direction,
enum: -> { ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Direction }

#effective_date ⇒ Date?

Date transactions are to be posted to the participants’ account. Defaults to the current business day or the next business day if the current day is a bank holiday or weekend. Format: yyyy-mm-dd.

Returns:

  • (Date, nil) 


1572
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1572

optional :effective_date, Date

#expires_at ⇒ Time?

RFP payments require an expires_at. This value must be past the effective_date.

Returns:

  • (Time, nil) 


1578
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1578

optional :expires_at, Time, nil?: true

#external_id ⇒ String?

An optional user-defined 180 character unique identifier.

Returns:

  • (String, nil) 


1584
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1584

optional :external_id, String, nil?: true

#fallback_type ⇒ Symbol, ...

A payment type to fallback to if the original type is not valid for the receiving account. Currently, this only supports falling back from RTP to ACH (type=rtp and fallback_type=ach)

Returns:



1592
1593
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1592

optional :fallback_type,
enum: -> { ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::FallbackType }

#foreign_exchange_contract ⇒ String?

If present, indicates a specific foreign exchange contract number that has been generated by your financial institution.

Returns:

  • (String, nil) 


1600
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1600

optional :foreign_exchange_contract, String, nil?: true

#foreign_exchange_indicator ⇒ Symbol, ...

Indicates the type of FX transfer to initiate, can be either ‘variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order currency matches the originating account currency.

Returns:



1608
1609
1610
1611
1612
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1608

optional :foreign_exchange_indicator,
enum: -> {
  ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ForeignExchangeIndicator
},
nil?: true

#id ⇒ String?

Returns:

  • (String, nil) 


1492
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1492

optional :id, String

#line_items ⇒ Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::LineItem>?

An array of line items that must sum up to the amount of the payment order.

Returns:



1618
1619
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1618

optional :line_items,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::LineItem] }

#metadata ⇒ Hash{Symbol=>String}?

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

  • (Hash{Symbol=>String}, nil) 


1626
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1626

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#nsf_protected ⇒ Boolean?

A boolean to determine if NSF Protection is enabled for this payment order. Note that this setting must also be turned on in your organization settings page.

Returns:

  • (Boolean, nil) 


1633
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1633

optional :nsf_protected, ModernTreasury::Internal::Type::Boolean

#originating_account_id ⇒ String?

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

Returns:

  • (String, nil) 


1639
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1639

optional :originating_account_id, String

#originating_party_name ⇒ String?

If present, this will replace your default company name on receiver’s bank statement. This field can only be used for ACH payments currently. For ACH, only the first 16 characters of this string will be used. Any additional characters will be truncated.

Returns:

  • (String, nil) 


1648
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1648

optional :originating_party_name, String, nil?: true

#priority ⇒ Symbol, ...

Either ‘normal` or `high`. For ACH and EFT payments, `high` represents a same-day ACH or EFT transfer, respectively. For check payments, `high` can mean an overnight check rather than standard mail.

Returns:



1656
1657
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1656

optional :priority,
enum: -> { ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Priority }

#process_after ⇒ Time?

If present, Modern Treasury will not process the payment until after this time. If ‘process_after` is past the cutoff for `effective_date`, `process_after` will take precedence and `effective_date` will automatically update to reflect the earliest possible sending date after `process_after`. Format is ISO8601 timestamp.

Returns:

  • (Time, nil) 


1667
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1667

optional :process_after, Time, nil?: true

#purpose ⇒ String?

For ‘wire`, this is usually the purpose which is transmitted via the “InstrForDbtrAgt” field in the ISO20022 file. For `eft`, this field is the 3 digit CPA Code that will be attached to the payment.

Returns:

  • (String, nil) 


1675
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1675

optional :purpose, String, nil?: true

#receiving_account ⇒ ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount?

Either ‘receiving_account` or `receiving_account_id` must be present. When using `receiving_account_id`, you may pass the id of an external account or an internal account.

Returns:



1683
1684
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1683

optional :receiving_account,
-> { ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount }

#receiving_account_id ⇒ String?

Either ‘receiving_account` or `receiving_account_id` must be present. When using `receiving_account_id`, you may pass the id of an external account or an internal account.

Returns:

  • (String, nil) 


1692
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1692

optional :receiving_account_id, String

#reconciliation_status ⇒ Symbol, ...

One of ‘unreconciled`, `tentatively_reconciled` or `reconciled`.

Returns:



1698
1699
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1698

optional :reconciliation_status,
enum: -> { ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReconciliationStatus }

#remittance_information ⇒ String?

For ‘ach`, this field will be passed through on an addenda record. For `wire` payments the field will be passed through as the “Originator to Beneficiary Information”, also known as OBI or Fedwire tag 6000.

Returns:

  • (String, nil) 


1707
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1707

optional :remittance_information, String, nil?: true

#send_remittance_advice ⇒ Boolean?

Send an email to the counterparty when the payment order is sent to the bank. If ‘null`, `send_remittance_advice` on the Counterparty is used.

Returns:

  • (Boolean, nil) 


1714
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1714

optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean, nil?: true

#statement_descriptor ⇒ String?

An optional descriptor which will appear in the receiver’s statement. For ‘check` payments this field will be used as the memo line. For `ach` the maximum length is 10 characters. Note that for ACH payments, the name on your bank account will be included automatically by the bank, so you can use the characters for other useful information. For `eft` the maximum length is 15 characters.

Returns:

  • (String, nil) 


1725
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1725

optional :statement_descriptor, String, nil?: true

#status ⇒ Symbol, ...

To cancel a payment order, use ‘cancelled`. To redraft a returned payment order, use `approved`. To undo approval on a denied or approved payment order, use `needs_approval`.

Returns:



1733
1734
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1733

optional :status,
enum: -> { ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Status }

#subtype ⇒ Symbol, ...

An additional layer of classification for the type of payment order you are doing. This field is only used for ‘ach` payment orders currently. For `ach` payment orders, the `subtype` represents the SEC code. We currently support `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.

Returns:



1743
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1743

optional :subtype, enum: -> { ModernTreasury::PaymentOrderSubtype }, nil?: true

#type ⇒ Symbol, ...

One of ‘ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`, `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.

Returns:



1751
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1751

optional :type, enum: -> { ModernTreasury::PaymentOrderType }

#ultimate_originating_party_identifier ⇒ String?

This represents the identifier by which the person is known to the receiver when using the CIE subtype for ACH payments. Only the first 22 characters of this string will be used. Any additional characters will be truncated.

Returns:

  • (String, nil) 


1759
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1759

optional :ultimate_originating_party_identifier, String, nil?: true

#ultimate_originating_party_name ⇒ String?

This represents the name of the person that the payment is on behalf of when using the CIE subtype for ACH payments. Only the first 15 characters of this string will be used. Any additional characters will be truncated.

Returns:

  • (String, nil) 


1767
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1767

optional :ultimate_originating_party_name, String, nil?: true

#ultimate_receiving_party_identifier ⇒ String?

This represents the name of the merchant that the payment is being sent to when using the CIE subtype for ACH payments. Only the first 22 characters of this string will be used. Any additional characters will be truncated.

Returns:

  • (String, nil) 


1775
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1775

optional :ultimate_receiving_party_identifier, String, nil?: true

#ultimate_receiving_party_name ⇒ String?

This represents the identifier by which the merchant is known to the person initiating an ACH payment with CIE subtype. Only the first 15 characters of this string will be used. Any additional characters will be truncated.

Returns:

  • (String, nil) 


1783
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1783

optional :ultimate_receiving_party_name, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1909