increase 1.348.0 → 1.350.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_create_params.rb +15 -15
  4. data/lib/increase/models/account_number.rb +3 -3
  5. data/lib/increase/models/ach_transfer.rb +12 -12
  6. data/lib/increase/models/balance_lookup.rb +1 -1
  7. data/lib/increase/models/beneficial_owner_create_params.rb +2 -4
  8. data/lib/increase/models/beneficial_owner_update_params.rb +2 -4
  9. data/lib/increase/models/card_dispute.rb +9 -1
  10. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +4 -0
  11. data/lib/increase/models/card_payment.rb +58 -58
  12. data/lib/increase/models/card_purchase_supplement.rb +9 -1
  13. data/lib/increase/models/card_token_capabilities.rb +2 -2
  14. data/lib/increase/models/check_deposit.rb +9 -9
  15. data/lib/increase/models/check_transfer.rb +2 -2
  16. data/lib/increase/models/check_transfer_create_params.rb +9 -4
  17. data/lib/increase/models/declined_transaction.rb +12 -9
  18. data/lib/increase/models/digital_wallet_token.rb +9 -1
  19. data/lib/increase/models/entity.rb +298 -6
  20. data/lib/increase/models/entity_create_params.rb +332 -29
  21. data/lib/increase/models/entity_onboarding_session_list_params.rb +2 -2
  22. data/lib/increase/models/entity_update_params.rb +472 -15
  23. data/lib/increase/models/event.rb +3 -0
  24. data/lib/increase/models/event_list_params.rb +3 -0
  25. data/lib/increase/models/event_subscription.rb +3 -0
  26. data/lib/increase/models/event_subscription_create_params.rb +3 -0
  27. data/lib/increase/models/fednow_transfer.rb +115 -4
  28. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  29. data/lib/increase/models/inbound_ach_transfer.rb +2 -2
  30. data/lib/increase/models/inbound_check_deposit.rb +7 -4
  31. data/lib/increase/models/inbound_fednow_transfer.rb +21 -1
  32. data/lib/increase/models/inbound_mail_item.rb +14 -1
  33. data/lib/increase/models/inbound_wire_drawdown_request.rb +12 -1
  34. data/lib/increase/models/inbound_wire_transfer.rb +4 -4
  35. data/lib/increase/models/intrafi_exclusion.rb +4 -4
  36. data/lib/increase/models/lockbox_recipient_create_params.rb +2 -2
  37. data/lib/increase/models/pending_transaction.rb +20 -20
  38. data/lib/increase/models/pending_transaction_list_params.rb +5 -7
  39. data/lib/increase/models/physical_card.rb +9 -1
  40. data/lib/increase/models/physical_card_create_params.rb +6 -3
  41. data/lib/increase/models/real_time_decision.rb +18 -18
  42. data/lib/increase/models/simulations/card_authentication_create_params.rb +2 -2
  43. data/lib/increase/models/simulations/card_dispute_action_params.rb +6 -6
  44. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -3
  45. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +8 -11
  46. data/lib/increase/models/simulations/interest_payment_create_params.rb +2 -2
  47. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +2 -2
  48. data/lib/increase/models/simulations/program_create_params.rb +14 -3
  49. data/lib/increase/models/transaction.rb +146 -19
  50. data/lib/increase/models/transaction_list_params.rb +3 -0
  51. data/lib/increase/models/unwrap_webhook_event.rb +3 -0
  52. data/lib/increase/models/wire_drawdown_request.rb +12 -1
  53. data/lib/increase/models/wire_transfer_create_params.rb +2 -2
  54. data/lib/increase/resources/cards.rb +2 -2
  55. data/lib/increase/resources/check_transfers.rb +1 -1
  56. data/lib/increase/resources/entities.rb +10 -2
  57. data/lib/increase/resources/entity_onboarding_sessions.rb +1 -1
  58. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  59. data/lib/increase/resources/physical_cards.rb +2 -1
  60. data/lib/increase/resources/simulations/card_authentications.rb +1 -1
  61. data/lib/increase/resources/simulations/card_disputes.rb +2 -2
  62. data/lib/increase/resources/simulations/inbound_check_deposits.rb +4 -1
  63. data/lib/increase/resources/simulations/interest_payments.rb +1 -1
  64. data/lib/increase/resources/simulations/pending_transactions.rb +1 -1
  65. data/lib/increase/resources/simulations/physical_cards.rb +2 -2
  66. data/lib/increase/resources/simulations/programs.rb +6 -2
  67. data/lib/increase/resources/wire_transfers.rb +1 -1
  68. data/lib/increase/version.rb +1 -1
  69. data/rbi/increase/models/account_create_params.rbi +37 -21
  70. data/rbi/increase/models/account_number.rbi +3 -3
  71. data/rbi/increase/models/ach_transfer.rbi +12 -12
  72. data/rbi/increase/models/balance_lookup.rbi +1 -1
  73. data/rbi/increase/models/beneficial_owner_create_params.rbi +2 -4
  74. data/rbi/increase/models/beneficial_owner_update_params.rbi +2 -4
  75. data/rbi/increase/models/card_dispute.rbi +8 -0
  76. data/rbi/increase/models/card_dispute_submit_user_submission_params.rbi +3 -0
  77. data/rbi/increase/models/card_payment.rbi +58 -58
  78. data/rbi/increase/models/card_purchase_supplement.rbi +8 -0
  79. data/rbi/increase/models/card_token_capabilities.rbi +2 -2
  80. data/rbi/increase/models/check_deposit.rbi +9 -9
  81. data/rbi/increase/models/check_transfer.rbi +2 -2
  82. data/rbi/increase/models/check_transfer_create_params.rbi +8 -4
  83. data/rbi/increase/models/declined_transaction.rbi +16 -9
  84. data/rbi/increase/models/digital_wallet_token.rbi +8 -0
  85. data/rbi/increase/models/entity.rbi +496 -5
  86. data/rbi/increase/models/entity_create_params.rbi +547 -28
  87. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +2 -2
  88. data/rbi/increase/models/entity_update_params.rbi +814 -14
  89. data/rbi/increase/models/event.rbi +7 -0
  90. data/rbi/increase/models/event_list_params.rbi +7 -0
  91. data/rbi/increase/models/event_subscription.rbi +7 -0
  92. data/rbi/increase/models/event_subscription_create_params.rbi +7 -0
  93. data/rbi/increase/models/fednow_transfer.rbi +213 -7
  94. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  95. data/rbi/increase/models/inbound_ach_transfer.rbi +2 -2
  96. data/rbi/increase/models/inbound_check_deposit.rbi +6 -4
  97. data/rbi/increase/models/inbound_fednow_transfer.rbi +23 -0
  98. data/rbi/increase/models/inbound_mail_item.rbi +12 -0
  99. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +10 -0
  100. data/rbi/increase/models/inbound_wire_transfer.rbi +4 -4
  101. data/rbi/increase/models/intrafi_exclusion.rbi +4 -4
  102. data/rbi/increase/models/lockbox_recipient_create_params.rbi +2 -2
  103. data/rbi/increase/models/pending_transaction.rbi +20 -20
  104. data/rbi/increase/models/pending_transaction_list_params.rbi +5 -7
  105. data/rbi/increase/models/physical_card.rbi +8 -0
  106. data/rbi/increase/models/physical_card_create_params.rbi +6 -3
  107. data/rbi/increase/models/real_time_decision.rbi +18 -18
  108. data/rbi/increase/models/simulations/card_authentication_create_params.rbi +2 -2
  109. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +6 -6
  110. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +3 -3
  111. data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi +8 -23
  112. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +2 -2
  113. data/rbi/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rbi +2 -2
  114. data/rbi/increase/models/simulations/program_create_params.rbi +15 -2
  115. data/rbi/increase/models/transaction.rbi +264 -18
  116. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  117. data/rbi/increase/models/unwrap_webhook_event.rbi +7 -0
  118. data/rbi/increase/models/wire_drawdown_request.rbi +10 -0
  119. data/rbi/increase/models/wire_transfer_create_params.rbi +2 -2
  120. data/rbi/increase/resources/cards.rbi +2 -2
  121. data/rbi/increase/resources/check_transfers.rbi +1 -1
  122. data/rbi/increase/resources/entities.rbi +10 -0
  123. data/rbi/increase/resources/entity_onboarding_sessions.rbi +1 -1
  124. data/rbi/increase/resources/lockbox_recipients.rbi +1 -1
  125. data/rbi/increase/resources/physical_cards.rbi +2 -1
  126. data/rbi/increase/resources/simulations/card_authentications.rbi +1 -1
  127. data/rbi/increase/resources/simulations/card_disputes.rbi +2 -2
  128. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +4 -1
  129. data/rbi/increase/resources/simulations/interest_payments.rbi +1 -1
  130. data/rbi/increase/resources/simulations/pending_transactions.rbi +1 -1
  131. data/rbi/increase/resources/simulations/physical_cards.rbi +2 -2
  132. data/rbi/increase/resources/simulations/programs.rbi +5 -1
  133. data/rbi/increase/resources/wire_transfers.rbi +1 -1
  134. data/sig/increase/models/account_create_params.rbs +20 -12
  135. data/sig/increase/models/card_dispute.rbs +5 -0
  136. data/sig/increase/models/card_purchase_supplement.rbs +5 -0
  137. data/sig/increase/models/declined_transaction.rbs +4 -0
  138. data/sig/increase/models/digital_wallet_token.rbs +5 -0
  139. data/sig/increase/models/entity.rbs +230 -4
  140. data/sig/increase/models/entity_create_params.rbs +232 -1
  141. data/sig/increase/models/entity_update_params.rbs +366 -0
  142. data/sig/increase/models/event.rbs +4 -0
  143. data/sig/increase/models/event_list_params.rbs +4 -0
  144. data/sig/increase/models/event_subscription.rbs +4 -0
  145. data/sig/increase/models/event_subscription_create_params.rbs +4 -0
  146. data/sig/increase/models/fednow_transfer.rbs +113 -4
  147. data/sig/increase/models/fednow_transfer_list_params.rbs +4 -4
  148. data/sig/increase/models/inbound_fednow_transfer.rbs +14 -0
  149. data/sig/increase/models/inbound_mail_item.rbs +5 -0
  150. data/sig/increase/models/inbound_wire_drawdown_request.rbs +5 -0
  151. data/sig/increase/models/pending_transaction.rbs +1 -1
  152. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  153. data/sig/increase/models/physical_card.rbs +5 -0
  154. data/sig/increase/models/simulations/entity_update_validation_params.rbs +3 -3
  155. data/sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs +1 -15
  156. data/sig/increase/models/simulations/program_create_params.rbs +7 -0
  157. data/sig/increase/models/transaction.rbs +113 -0
  158. data/sig/increase/models/transaction_list_params.rbs +4 -0
  159. data/sig/increase/models/unwrap_webhook_event.rbs +4 -0
  160. data/sig/increase/models/wire_drawdown_request.rbs +5 -0
  161. data/sig/increase/resources/entities.rbs +2 -0
  162. data/sig/increase/resources/simulations/programs.rbs +1 -0
  163. metadata +2 -2
@@ -108,6 +108,14 @@ module Increase
108
108
  # @return [Increase::Models::FednowTransfer::Rejection, nil]
109
109
  required :rejection, -> { Increase::FednowTransfer::Rejection }, nil?: true
110
110
 
111
+ # @!attribute returns
112
+ # If the transfer is returned by the recipient's bank, this will contain details
113
+ # of each return. FedNow allows returning part of a transfer, so a transfer can be
114
+ # returned more than once.
115
+ #
116
+ # @return [Array<Increase::Models::FednowTransfer::Return>]
117
+ required :returns, -> { Increase::Internal::Type::ArrayOf[Increase::FednowTransfer::Return] }
118
+
111
119
  # @!attribute routing_number
112
120
  # The destination American Bankers' Association (ABA) Routing Transit Number
113
121
  # (RTN).
@@ -161,7 +169,7 @@ module Increase
161
169
  # @return [String]
162
170
  required :unstructured_remittance_information, String
163
171
 
164
- # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
172
+ # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, returns:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
165
173
  # FedNow transfers move funds, within seconds, between your Increase account and
166
174
  # any other account supporting FedNow.
167
175
  #
@@ -214,6 +222,11 @@ module Increase
214
222
  # If the transfer is rejected by FedNow or the destination financial institution,
215
223
  # this will contain supplemental details.
216
224
  #
225
+ # @param returns [Array<Increase::Models::FednowTransfer::Return>]
226
+ # If the transfer is returned by the recipient's bank, this will contain details
227
+ # of each return. FedNow allows returning part of a transfer, so a transfer can be
228
+ # returned more than once.
229
+ #
217
230
  # @param routing_number [String]
218
231
  # The destination American Bankers' Association (ABA) Routing Transit Number
219
232
  # (RTN).
@@ -543,6 +556,104 @@ module Increase
543
556
  end
544
557
  end
545
558
 
559
+ class Return < Increase::Internal::Type::BaseModel
560
+ # @!attribute amount
561
+ # The returned amount in USD cents. This is always a positive number.
562
+ #
563
+ # @return [Integer]
564
+ required :amount, Integer
565
+
566
+ # @!attribute return_reason_additional_information
567
+ # Additional information about the return provided by the recipient's bank.
568
+ #
569
+ # @return [String, nil]
570
+ required :return_reason_additional_information, String, nil?: true
571
+
572
+ # @!attribute return_reason_code
573
+ # The reason the transfer was returned as provided by the recipient's bank.
574
+ #
575
+ # @return [Symbol, Increase::Models::FednowTransfer::Return::ReturnReasonCode]
576
+ required :return_reason_code, enum: -> { Increase::FednowTransfer::Return::ReturnReasonCode }
577
+
578
+ # @!attribute transfer_id
579
+ # The identifier of the FedNow Transfer that led to this Transaction.
580
+ #
581
+ # @return [String]
582
+ required :transfer_id, String
583
+
584
+ # @!method initialize(amount:, return_reason_additional_information:, return_reason_code:, transfer_id:)
585
+ # A FedNow Transfer Return is created when a FedNow Transfer sent from Increase is
586
+ # returned by the recipient's bank.
587
+ #
588
+ # @param amount [Integer] The returned amount in USD cents. This is always a positive number.
589
+ #
590
+ # @param return_reason_additional_information [String, nil]
591
+ # Additional information about the return provided by the recipient's bank.
592
+ #
593
+ # @param return_reason_code [Symbol, Increase::Models::FednowTransfer::Return::ReturnReasonCode]
594
+ # The reason the transfer was returned as provided by the recipient's bank.
595
+ #
596
+ # @param transfer_id [String] The identifier of the FedNow Transfer that led to this Transaction.
597
+
598
+ # The reason the transfer was returned as provided by the recipient's bank.
599
+ #
600
+ # @see Increase::Models::FednowTransfer::Return#return_reason_code
601
+ module ReturnReasonCode
602
+ extend Increase::Internal::Type::Enum
603
+
604
+ # The destination account is closed. Corresponds to the FedNow reason codes `AC04` and `AC07`.
605
+ ACCOUNT_CLOSED = :account_closed
606
+
607
+ # The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.
608
+ ACCOUNT_BLOCKED = :account_blocked
609
+
610
+ # The recipient's bank was not a valid agent for this transfer. Corresponds to the FedNow reason codes `AC14` and `AGNT`.
611
+ INVALID_AGENT = :invalid_agent
612
+
613
+ # The destination account does not exist. Corresponds to the FedNow reason code `AC03`.
614
+ INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number
615
+
616
+ # The destination account number was incorrect. Corresponds to the FedNow reason code `AC01`.
617
+ INCORRECT_ACCOUNT_NUMBER = :incorrect_account_number
618
+
619
+ # The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.
620
+ END_CUSTOMER_DECEASED = :end_customer_deceased
621
+
622
+ # The transfer was not permitted by the recipient's bank. Corresponds to the FedNow reason code `AG01`.
623
+ TRANSACTION_FORBIDDEN = :transaction_forbidden
624
+
625
+ # The transfer was returned for a regulatory reason at the recipient's bank. Corresponds to the FedNow reason code `RR04`.
626
+ REGULATORY_REASON = :regulatory_reason
627
+
628
+ # The transfer was reported as fraudulent. Corresponds to the FedNow reason code `FR01`.
629
+ FRAUD = :fraud
630
+
631
+ # The transfer duplicated another transfer. Corresponds to the FedNow reason codes `AM05` and `DUPL`.
632
+ DUPLICATION = :duplication
633
+
634
+ # The transfer amount was incorrect. Corresponds to the FedNow reason code `AM09`.
635
+ WRONG_AMOUNT = :wrong_amount
636
+
637
+ # The transfer was returned at the request of the recipient's customer. Corresponds to the FedNow reason code `CUST`.
638
+ REQUESTED_BY_CUSTOMER = :requested_by_customer
639
+
640
+ # The recipient's bank could not apply the funds. Corresponds to the FedNow reason code `RUTA`.
641
+ UNABLE_TO_APPLY = :unable_to_apply
642
+
643
+ # The recipient's bank did not specify a reason. Corresponds to the FedNow reason codes `MS02` and `MS03`.
644
+ NOT_SPECIFIED = :not_specified
645
+
646
+ # The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.
647
+ NARRATIVE = :narrative
648
+
649
+ # The transfer was returned for some other reason.
650
+ OTHER = :other
651
+
652
+ # @!method self.values
653
+ # @return [Array<Symbol>]
654
+ end
655
+ end
656
+
546
657
  # The lifecycle status of the transfer.
547
658
  #
548
659
  # @see Increase::Models::FednowTransfer#status
@@ -558,9 +669,6 @@ module Increase
558
669
  # The transfer has been canceled.
559
670
  CANCELED = :canceled
560
671
 
561
- # The transfer has been rejected by Increase.
562
- REVIEWING_REJECTED = :reviewing_rejected
563
-
564
672
  # The transfer requires attention from an Increase operator.
565
673
  REQUIRES_ATTENTION = :requires_attention
566
674
 
@@ -576,6 +684,9 @@ module Increase
576
684
  # The transfer was rejected by the network or the recipient's bank.
577
685
  REJECTED = :rejected
578
686
 
687
+ # The transfer was returned by the recipient's bank.
688
+ RETURNED = :returned
689
+
579
690
  # @!method self.values
580
691
  # @return [Array<Symbol>]
581
692
  end
@@ -155,9 +155,6 @@ module Increase
155
155
  # The transfer has been canceled.
156
156
  CANCELED = :canceled
157
157
 
158
- # The transfer has been rejected by Increase.
159
- REVIEWING_REJECTED = :reviewing_rejected
160
-
161
158
  # The transfer requires attention from an Increase operator.
162
159
  REQUIRES_ATTENTION = :requires_attention
163
160
 
@@ -173,6 +170,9 @@ module Increase
173
170
  # The transfer was rejected by the network or the recipient's bank.
174
171
  REJECTED = :rejected
175
172
 
173
+ # The transfer was returned by the recipient's bank.
174
+ RETURNED = :returned
175
+
176
176
  # @!method self.values
177
177
  # @return [Array<Symbol>]
178
178
  end
@@ -117,7 +117,7 @@ module Increase
117
117
  required :originator_company_name, String
118
118
 
119
119
  # @!attribute originator_routing_number
120
- # The American Banking Association (ABA) routing number of the bank originating
120
+ # The American Bankers' Association (ABA) routing number of the bank originating
121
121
  # the transfer.
122
122
  #
123
123
  # @return [String]
@@ -229,7 +229,7 @@ module Increase
229
229
  # @param originator_company_name [String] The name of the company that initiated the transfer.
230
230
  #
231
231
  # @param originator_routing_number [String]
232
- # The American Banking Association (ABA) routing number of the bank originating
232
+ # The American Bankers' Association (ABA) routing number of the bank originating
233
233
  # the transfer.
234
234
  #
235
235
  # @param receiver_id_number [String, nil] The id of the receiver of the transfer.
@@ -60,7 +60,7 @@ module Increase
60
60
  # @!attribute bank_of_first_deposit_routing_number
61
61
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
62
62
  # bank depositing this check. In some rare cases, this is not transmitted via
63
- # Check21 and the value will be null.
63
+ # Check 21 and the value will be null.
64
64
  #
65
65
  # @return [String, nil]
66
66
  required :bank_of_first_deposit_routing_number, String, nil?: true
@@ -177,7 +177,7 @@ module Increase
177
177
  # @param bank_of_first_deposit_routing_number [String, nil]
178
178
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
179
179
  # bank depositing this check. In some rare cases, this is not transmitted via
180
- # Check21 and the value will be null.
180
+ # Check 21 and the value will be null.
181
181
  #
182
182
  # @param check_number [String, nil] The check number printed on the check being deposited.
183
183
  #
@@ -231,7 +231,8 @@ module Increase
231
231
  required :adjusted_at, Time
232
232
 
233
233
  # @!attribute amount
234
- # The amount of the adjustment.
234
+ # The amount of the adjustment in USD cents. A positive amount is a credit to your
235
+ # account and a negative amount is a debit.
235
236
  #
236
237
  # @return [Integer]
237
238
  required :amount, Integer
@@ -251,7 +252,9 @@ module Increase
251
252
  # @!method initialize(adjusted_at:, amount:, reason:, transaction_id:)
252
253
  # @param adjusted_at [Time] The time at which the return adjustment was received.
253
254
  #
254
- # @param amount [Integer] The amount of the adjustment.
255
+ # @param amount [Integer]
256
+ # The amount of the adjustment in USD cents. A positive amount is a credit to your
257
+ # account and a negative amount is a debit.
255
258
  #
256
259
  # @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason]
257
260
  # The reason for the adjustment.
@@ -78,6 +78,12 @@ module Increase
78
78
  # @return [Increase::Models::InboundFednowTransfer::Decline, nil]
79
79
  required :decline, -> { Increase::InboundFednowTransfer::Decline }, nil?: true
80
80
 
81
+ # @!attribute end_to_end_identification
82
+ # A free-form reference string set by the sender, to help identify the transfer.
83
+ #
84
+ # @return [String, nil]
85
+ required :end_to_end_identification, String, nil?: true
86
+
81
87
  # @!attribute status
82
88
  # The lifecycle status of the transfer.
83
89
  #
@@ -91,6 +97,12 @@ module Increase
91
97
  # @return [String, nil]
92
98
  required :transaction_id, String, nil?: true
93
99
 
100
+ # @!attribute transaction_identification
101
+ # The FedNow network identification of the transfer.
102
+ #
103
+ # @return [String, nil]
104
+ required :transaction_identification, String, nil?: true
105
+
94
106
  # @!attribute type
95
107
  # A constant representing the object's type. For this resource it will always be
96
108
  # `inbound_fednow_transfer`.
@@ -112,7 +124,7 @@ module Increase
112
124
  # @return [String, nil]
113
125
  required :unstructured_remittance_information, String, nil?: true
114
126
 
115
- # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
127
+ # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
116
128
  # An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
117
129
  # your account.
118
130
  #
@@ -147,6 +159,9 @@ module Increase
147
159
  # @param decline [Increase::Models::InboundFednowTransfer::Decline, nil]
148
160
  # If your transfer is declined, this will contain details of the decline.
149
161
  #
162
+ # @param end_to_end_identification [String, nil]
163
+ # A free-form reference string set by the sender, to help identify the transfer.
164
+ #
150
165
  # @param status [Symbol, Increase::Models::InboundFednowTransfer::Status]
151
166
  # The lifecycle status of the transfer.
152
167
  #
@@ -154,6 +169,8 @@ module Increase
154
169
  # The identifier of the Transaction object created when the transfer was
155
170
  # confirmed.
156
171
  #
172
+ # @param transaction_identification [String, nil] The FedNow network identification of the transfer.
173
+ #
157
174
  # @param type [Symbol, Increase::Models::InboundFednowTransfer::Type]
158
175
  # A constant representing the object's type. For this resource it will always be
159
176
  # `inbound_fednow_transfer`.
@@ -240,6 +257,9 @@ module Increase
240
257
  # Your account is not enabled to receive FedNow transfers.
241
258
  FEDNOW_NOT_ENABLED = :fednow_not_enabled
242
259
 
260
+ # The transaction is not allowed per Increase's terms.
261
+ TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
262
+
243
263
  # @!method self.values
244
264
  # @return [Array<Symbol>]
245
265
  end
@@ -10,6 +10,14 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The identifier for the Account that checks in this mail item are deposited into.
15
+ # For mail items that could not be routed to a Lockbox Recipient, this will be
16
+ # null.
17
+ #
18
+ # @return [String, nil]
19
+ required :account_id, String, nil?: true
20
+
13
21
  # @!attribute checks
14
22
  # The checks in the mail item.
15
23
  #
@@ -67,7 +75,7 @@ module Increase
67
75
  # @return [Symbol, Increase::Models::InboundMailItem::Type]
68
76
  required :type, enum: -> { Increase::InboundMailItem::Type }
69
77
 
70
- # @!method initialize(id:, checks:, created_at:, file_id:, lockbox_address_id:, lockbox_recipient_id:, recipient_name:, rejection_reason:, status:, type:)
78
+ # @!method initialize(id:, account_id:, checks:, created_at:, file_id:, lockbox_address_id:, lockbox_recipient_id:, recipient_name:, rejection_reason:, status:, type:)
71
79
  # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
72
80
  # Address. Increase automatically deposits checks mailed to a Lockbox Recipient
73
81
  # into the recipient's Account. Checks that are not matched to a Lockbox Recipient
@@ -75,6 +83,11 @@ module Increase
75
83
  #
76
84
  # @param id [String] The Inbound Mail Item identifier.
77
85
  #
86
+ # @param account_id [String, nil]
87
+ # The identifier for the Account that checks in this mail item are deposited into.
88
+ # For mail items that could not be routed to a Lockbox Recipient, this will be
89
+ # null.
90
+ #
78
91
  # @param checks [Array<Increase::Models::InboundMailItem::Check>] The checks in the mail item.
79
92
  #
80
93
  # @param created_at [Time]
@@ -10,6 +10,13 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The Account from which the recipient of this request is being requested to send
15
+ # funds.
16
+ #
17
+ # @return [String]
18
+ required :account_id, String
19
+
13
20
  # @!attribute amount
14
21
  # The amount being requested in cents.
15
22
  #
@@ -139,13 +146,17 @@ module Increase
139
146
  # @return [String, nil]
140
147
  required :unstructured_remittance_information, String, nil?: true
141
148
 
142
- # @!method initialize(id:, amount:, created_at:, creditor_account_number:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, creditor_routing_number:, currency:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, end_to_end_identification:, input_message_accountability_data:, instruction_identification:, recipient_account_number_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
149
+ # @!method initialize(id:, account_id:, amount:, created_at:, creditor_account_number:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, creditor_routing_number:, currency:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, end_to_end_identification:, input_message_accountability_data:, instruction_identification:, recipient_account_number_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
143
150
  # Inbound wire drawdown requests are requests from someone else to send them a
144
151
  # wire. For more information, see our
145
152
  # [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).
146
153
  #
147
154
  # @param id [String] The Wire drawdown request identifier.
148
155
  #
156
+ # @param account_id [String]
157
+ # The Account from which the recipient of this request is being requested to send
158
+ # funds.
159
+ #
149
160
  # @param amount [Integer] The amount being requested in cents.
150
161
  #
151
162
  # @param created_at [Time]
@@ -96,7 +96,7 @@ module Increase
96
96
  required :debtor_name, String, nil?: true
97
97
 
98
98
  # @!attribute debtor_routing_number
99
- # The American Banking Association (ABA) routing number of the sender.
99
+ # The American Bankers' Association (ABA) routing number of the sender.
100
100
  #
101
101
  # @return [String, nil]
102
102
  required :debtor_routing_number, String, nil?: true
@@ -122,7 +122,7 @@ module Increase
122
122
  required :input_message_accountability_data, String, nil?: true
123
123
 
124
124
  # @!attribute instructing_agent_routing_number
125
- # The American Banking Association (ABA) routing number of the bank that sent the
125
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
126
126
  # wire.
127
127
  #
128
128
  # @return [String, nil]
@@ -217,7 +217,7 @@ module Increase
217
217
  # @param debtor_name [String, nil] A name set by the sender.
218
218
  #
219
219
  # @param debtor_routing_number [String, nil]
220
- # The American Banking Association (ABA) routing number of the sender.
220
+ # The American Bankers' Association (ABA) routing number of the sender.
221
221
  #
222
222
  # @param description [String] An Increase-constructed description of the transfer.
223
223
  #
@@ -230,7 +230,7 @@ module Increase
230
230
  # service and is helpful when debugging wires with the originating bank.
231
231
  #
232
232
  # @param instructing_agent_routing_number [String, nil]
233
- # The American Banking Association (ABA) routing number of the bank that sent the
233
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
234
234
  # wire.
235
235
  #
236
236
  # @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
@@ -30,7 +30,7 @@ module Increase
30
30
  required :entity_id, String
31
31
 
32
32
  # @!attribute excluded_at
33
- # When this was exclusion was confirmed by IntraFi.
33
+ # When this exclusion was confirmed by IntraFi.
34
34
  #
35
35
  # @return [Time, nil]
36
36
  required :excluded_at, Time, nil?: true
@@ -57,7 +57,7 @@ module Increase
57
57
  required :status, enum: -> { Increase::IntrafiExclusion::Status }
58
58
 
59
59
  # @!attribute submitted_at
60
- # When this was exclusion was submitted to IntraFi by Increase.
60
+ # When this exclusion was submitted to IntraFi by Increase.
61
61
  #
62
62
  # @return [Time, nil]
63
63
  required :submitted_at, Time, nil?: true
@@ -85,7 +85,7 @@ module Increase
85
85
  #
86
86
  # @param entity_id [String] The entity for which this institution is excluded.
87
87
  #
88
- # @param excluded_at [Time, nil] When this was exclusion was confirmed by IntraFi.
88
+ # @param excluded_at [Time, nil] When this exclusion was confirmed by IntraFi.
89
89
  #
90
90
  # @param fdic_certificate_number [String, nil]
91
91
  # The Federal Deposit Insurance Corporation's certificate number for the
@@ -98,7 +98,7 @@ module Increase
98
98
  #
99
99
  # @param status [Symbol, Increase::Models::IntrafiExclusion::Status] The status of the exclusion request.
100
100
  #
101
- # @param submitted_at [Time, nil] When this was exclusion was submitted to IntraFi by Increase.
101
+ # @param submitted_at [Time, nil] When this exclusion was submitted to IntraFi by Increase.
102
102
  #
103
103
  # @param type [Symbol, Increase::Models::IntrafiExclusion::Type]
104
104
  # A constant representing the object's type. For this resource it will always be
@@ -27,7 +27,7 @@ module Increase
27
27
  optional :description, String
28
28
 
29
29
  # @!attribute recipient_name
30
- # The name of the Lockbox Recipient
30
+ # The name of the Lockbox Recipient.
31
31
  #
32
32
  # @return [String, nil]
33
33
  optional :recipient_name, String
@@ -42,7 +42,7 @@ module Increase
42
42
  #
43
43
  # @param description [String] The description you choose for the Lockbox Recipient.
44
44
  #
45
- # @param recipient_name [String] The name of the Lockbox Recipient
45
+ # @param recipient_name [String] The name of the Lockbox Recipient.
46
46
  #
47
47
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
48
48
  end
@@ -18,9 +18,9 @@ module Increase
18
18
 
19
19
  # @!attribute amount
20
20
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
21
- # for example, this is cents. This amount does not change after the Pending
22
- # Transaction is created. If a card authorization settles for a different amount,
23
- # the settled amount is available on the resulting Transaction and on the Card
21
+ # for example, this is cents. For a card authorization this is the amount still
22
+ # held: it decreases when the merchant reverses part of the authorization. The
23
+ # amount that settled is available on the resulting Transaction and on the Card
24
24
  # Payment's `state.settled_amount`.
25
25
  #
26
26
  # @return [Integer]
@@ -111,9 +111,9 @@ module Increase
111
111
  #
112
112
  # @param amount [Integer]
113
113
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
114
- # for example, this is cents. This amount does not change after the Pending
115
- # Transaction is created. If a card authorization settles for a different amount,
116
- # the settled amount is available on the resulting Transaction and on the Card
114
+ # for example, this is cents. For a card authorization this is the amount still
115
+ # held: it decreases when the merchant reverses part of the authorization. The
116
+ # amount that settled is available on the resulting Transaction and on the Card
117
117
  # Payment's `state.settled_amount`.
118
118
  #
119
119
  # @param completed_at [Time, nil]
@@ -768,9 +768,9 @@ module Increase
768
768
  required :actioner, enum: -> { Increase::PendingTransaction::Source::CardAuthorization::Actioner }
769
769
 
770
770
  # @!attribute additional_amounts
771
- # Additional amounts associated with the card authorization, such as ATM
772
- # surcharges fees. These are usually a subset of the `amount` field and are used
773
- # to provide more detailed information about the transaction.
771
+ # Additional amounts associated with the card authorization, such as ATM surcharge
772
+ # fees. These are usually a subset of the `amount` field and are used to provide
773
+ # more detailed information about the transaction.
774
774
  #
775
775
  # @return [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts]
776
776
  required :additional_amounts,
@@ -811,8 +811,8 @@ module Increase
811
811
  required :direction, enum: -> { Increase::PendingTransaction::Source::CardAuthorization::Direction }
812
812
 
813
813
  # @!attribute expires_at
814
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
815
- # will expire and the pending transaction will be released.
814
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which this
815
+ # authorization will expire and the pending transaction will be released.
816
816
  #
817
817
  # @return [Time]
818
818
  required :expires_at, Time
@@ -983,9 +983,9 @@ module Increase
983
983
  # stand-in processing, or the user through a real-time decision.
984
984
  #
985
985
  # @param additional_amounts [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts]
986
- # Additional amounts associated with the card authorization, such as ATM
987
- # surcharges fees. These are usually a subset of the `amount` field and are used
988
- # to provide more detailed information about the transaction.
986
+ # Additional amounts associated with the card authorization, such as ATM surcharge
987
+ # fees. These are usually a subset of the `amount` field and are used to provide
988
+ # more detailed information about the transaction.
989
989
  #
990
990
  # @param amount [Integer]
991
991
  # The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -1006,8 +1006,8 @@ module Increase
1006
1006
  # cardholder to the merchant or from the merchant to the cardholder.
1007
1007
  #
1008
1008
  # @param expires_at [Time]
1009
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
1010
- # will expire and the pending transaction will be released.
1009
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which this
1010
+ # authorization will expire and the pending transaction will be released.
1011
1011
  #
1012
1012
  # @param healthcare [Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare, nil]
1013
1013
  # The healthcare-related fields for this authorization. Only present for specific
@@ -1210,9 +1210,9 @@ module Increase
1210
1210
  nil?: true
1211
1211
 
1212
1212
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1213
- # Additional amounts associated with the card authorization, such as ATM
1214
- # surcharges fees. These are usually a subset of the `amount` field and are used
1215
- # to provide more detailed information about the transaction.
1213
+ # Additional amounts associated with the card authorization, such as ATM surcharge
1214
+ # fees. These are usually a subset of the `amount` field and are used to provide
1215
+ # more detailed information about the transaction.
1216
1216
  #
1217
1217
  # @param clinic [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic, nil]
1218
1218
  # The part of this transaction amount that was for clinic-related services.
@@ -2811,7 +2811,7 @@ module Increase
2811
2811
  # The Pending Transaction is still awaiting confirmation.
2812
2812
  PENDING = :pending
2813
2813
 
2814
- # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
2814
+ # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
2815
2815
  COMPLETE = :complete
2816
2816
 
2817
2817
  # @!method self.values
@@ -193,9 +193,8 @@ module Increase
193
193
  class Status < Increase::Internal::Type::BaseModel
194
194
  # @!attribute in_
195
195
  # Filter Pending Transactions for those with the specified status. By default only
196
- # Pending Transactions in with status `pending` will be returned. For GET
197
- # requests, this should be encoded as a comma-delimited string, such as
198
- # `?in=one,two,three`.
196
+ # Pending Transactions with status `pending` will be returned. For GET requests,
197
+ # this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
199
198
  #
200
199
  # @return [Array<Symbol, Increase::Models::PendingTransactionListParams::Status::In>, nil]
201
200
  optional :in_,
@@ -207,9 +206,8 @@ module Increase
207
206
  # @!method initialize(in_: nil)
208
207
  # @param in_ [Array<Symbol, Increase::Models::PendingTransactionListParams::Status::In>]
209
208
  # Filter Pending Transactions for those with the specified status. By default only
210
- # Pending Transactions in with status `pending` will be returned. For GET
211
- # requests, this should be encoded as a comma-delimited string, such as
212
- # `?in=one,two,three`.
209
+ # Pending Transactions with status `pending` will be returned. For GET requests,
210
+ # this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
213
211
 
214
212
  module In
215
213
  extend Increase::Internal::Type::Enum
@@ -217,7 +215,7 @@ module Increase
217
215
  # The Pending Transaction is still awaiting confirmation.
218
216
  PENDING = :pending
219
217
 
220
- # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
218
+ # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
221
219
  COMPLETE = :complete
222
220
 
223
221
  # @!method self.values
@@ -10,6 +10,12 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The identifier for the Account this Physical Card belongs to.
15
+ #
16
+ # @return [String]
17
+ required :account_id, String
18
+
13
19
  # @!attribute card_id
14
20
  # The identifier for the Card this Physical Card represents.
15
21
  #
@@ -62,7 +68,7 @@ module Increase
62
68
  # @return [Symbol, Increase::Models::PhysicalCard::Type]
63
69
  required :type, enum: -> { Increase::PhysicalCard::Type }
64
70
 
65
- # @!method initialize(id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
71
+ # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
66
72
  # Custom physical Visa cards that are shipped to your customers. The artwork is
67
73
  # configurable by a connected [Card Profile](/documentation/api#card-profiles).
68
74
  # The same Card can be used for multiple Physical Cards. Printing cards incurs a
@@ -71,6 +77,8 @@ module Increase
71
77
  #
72
78
  # @param id [String] The physical card identifier.
73
79
  #
80
+ # @param account_id [String] The identifier for the Account this Physical Card belongs to.
81
+ #
74
82
  # @param card_id [String] The identifier for the Card this Physical Card represents.
75
83
  #
76
84
  # @param cardholder [Increase::Models::PhysicalCard::Cardholder]
@@ -14,7 +14,8 @@ module Increase
14
14
  required :card_id, String
15
15
 
16
16
  # @!attribute cardholder
17
- # Details about the cardholder, as it will appear on the physical card.
17
+ # Details about the cardholder, as it will appear on the physical card. The
18
+ # combined first name and last name cannot exceed 25 characters.
18
19
  #
19
20
  # @return [Increase::Models::PhysicalCardCreateParams::Cardholder]
20
21
  required :cardholder, -> { Increase::PhysicalCardCreateParams::Cardholder }
@@ -36,7 +37,8 @@ module Increase
36
37
  # @param card_id [String] The underlying card representing this physical card.
37
38
  #
38
39
  # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
39
- # Details about the cardholder, as it will appear on the physical card.
40
+ # Details about the cardholder, as it will appear on the physical card. The
41
+ # combined first name and last name cannot exceed 25 characters.
40
42
  #
41
43
  # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
42
44
  # The details used to ship this physical card.
@@ -61,7 +63,8 @@ module Increase
61
63
  required :last_name, String
62
64
 
63
65
  # @!method initialize(first_name:, last_name:)
64
- # Details about the cardholder, as it will appear on the physical card.
66
+ # Details about the cardholder, as it will appear on the physical card. The
67
+ # combined first name and last name cannot exceed 25 characters.
65
68
  #
66
69
  # @param first_name [String] The cardholder's first name.
67
70
  #