increase 1.333.1 → 1.334.1

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 (118) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +4 -5
  4. data/lib/increase/models/ach_prenotification.rb +5 -2
  5. data/lib/increase/models/ach_prenotification_create_params.rb +2 -2
  6. data/lib/increase/models/ach_transfer.rb +6 -3
  7. data/lib/increase/models/card.rb +9 -1
  8. data/lib/increase/models/card_dispute.rb +40 -1
  9. data/lib/increase/models/card_dispute_list_params.rb +3 -0
  10. data/lib/increase/models/card_payment.rb +65 -6
  11. data/lib/increase/models/card_push_transfer.rb +53 -1
  12. data/lib/increase/models/check_transfer.rb +4 -8
  13. data/lib/increase/models/declined_transaction.rb +1 -1
  14. data/lib/increase/models/digital_wallet_token.rb +59 -1
  15. data/lib/increase/models/entity.rb +1 -1
  16. data/lib/increase/models/event.rb +12 -0
  17. data/lib/increase/models/event_list_params.rb +12 -0
  18. data/lib/increase/models/event_subscription.rb +12 -0
  19. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  20. data/lib/increase/models/export.rb +17 -1
  21. data/lib/increase/models/export_create_params.rb +78 -1
  22. data/lib/increase/models/fednow_transfer.rb +47 -1
  23. data/lib/increase/models/inbound_wire_transfer.rb +9 -1
  24. data/lib/increase/models/pending_transaction.rb +54 -1
  25. data/lib/increase/models/physical_card.rb +1 -1
  26. data/lib/increase/models/physical_card_profile.rb +38 -1
  27. data/lib/increase/models/real_time_decision.rb +52 -1
  28. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +3 -0
  29. data/lib/increase/models/simulations/card_authorization_create_params.rb +1 -1
  30. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +1 -1
  31. data/lib/increase/models/simulations/check_deposit_submit_params.rb +21 -2
  32. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +6 -0
  33. data/lib/increase/models/simulations/entity_update_validation_params.rb +1 -1
  34. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +10 -1
  35. data/lib/increase/models/simulations/physical_card_create_params.rb +1 -1
  36. data/lib/increase/models/transaction.rb +17 -5
  37. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  38. data/lib/increase/models/wire_drawdown_request.rb +20 -1
  39. data/lib/increase/resources/exports.rb +3 -1
  40. data/lib/increase/resources/simulations/check_deposits.rb +3 -0
  41. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +3 -1
  42. data/lib/increase/version.rb +1 -1
  43. data/rbi/increase/models/ach_prenotification.rbi +9 -2
  44. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  45. data/rbi/increase/models/ach_transfer.rbi +11 -4
  46. data/rbi/increase/models/card.rbi +8 -0
  47. data/rbi/increase/models/card_dispute.rbi +56 -0
  48. data/rbi/increase/models/card_dispute_list_params.rbi +7 -0
  49. data/rbi/increase/models/card_payment.rbi +135 -7
  50. data/rbi/increase/models/card_push_transfer.rbi +56 -0
  51. data/rbi/increase/models/check_transfer.rbi +4 -10
  52. data/rbi/increase/models/declined_transaction.rbi +1 -1
  53. data/rbi/increase/models/digital_wallet_token.rbi +131 -0
  54. data/rbi/increase/models/entity.rbi +1 -1
  55. data/rbi/increase/models/event.rbi +22 -0
  56. data/rbi/increase/models/event_list_params.rbi +28 -0
  57. data/rbi/increase/models/event_subscription.rbi +28 -0
  58. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  59. data/rbi/increase/models/export.rbi +25 -5
  60. data/rbi/increase/models/export_create_params.rbi +151 -0
  61. data/rbi/increase/models/fednow_transfer.rbi +77 -0
  62. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  63. data/rbi/increase/models/pending_transaction.rbi +122 -0
  64. data/rbi/increase/models/physical_card.rbi +1 -1
  65. data/rbi/increase/models/physical_card_profile.rbi +60 -0
  66. data/rbi/increase/models/real_time_decision.rbi +120 -0
  67. data/rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +7 -0
  68. data/rbi/increase/models/simulations/card_authorization_create_params.rbi +1 -1
  69. data/rbi/increase/models/simulations/card_balance_inquiry_create_params.rbi +1 -1
  70. data/rbi/increase/models/simulations/check_deposit_submit_params.rbi +21 -3
  71. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +14 -0
  72. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +1 -1
  73. data/rbi/increase/models/simulations/inbound_wire_transfer_create_params.rbi +13 -0
  74. data/rbi/increase/models/simulations/physical_card_create_params.rbi +1 -1
  75. data/rbi/increase/models/transaction.rbi +20 -6
  76. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  77. data/rbi/increase/models/wire_drawdown_request.rbi +22 -0
  78. data/rbi/increase/resources/exports.rbi +3 -0
  79. data/rbi/increase/resources/simulations/check_deposits.rbi +1 -0
  80. data/rbi/increase/resources/simulations/inbound_wire_transfers.rbi +4 -0
  81. data/sig/increase/models/ach_prenotification.rbs +7 -3
  82. data/sig/increase/models/ach_prenotification_create_params.rbs +2 -2
  83. data/sig/increase/models/ach_transfer.rbs +5 -1
  84. data/sig/increase/models/card.rbs +5 -0
  85. data/sig/increase/models/card_dispute.rbs +21 -0
  86. data/sig/increase/models/card_dispute_list_params.rbs +4 -0
  87. data/sig/increase/models/card_payment.rbs +37 -1
  88. data/sig/increase/models/card_push_transfer.rbs +30 -0
  89. data/sig/increase/models/check_transfer.rbs +5 -5
  90. data/sig/increase/models/declined_transaction.rbs +1 -1
  91. data/sig/increase/models/digital_wallet_token.rbs +61 -2
  92. data/sig/increase/models/entity.rbs +1 -1
  93. data/sig/increase/models/event.rbs +16 -0
  94. data/sig/increase/models/event_list_params.rbs +16 -0
  95. data/sig/increase/models/event_subscription.rbs +16 -0
  96. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  97. data/sig/increase/models/export.rbs +23 -3
  98. data/sig/increase/models/export_create_params.rbs +76 -0
  99. data/sig/increase/models/fednow_transfer.rbs +37 -0
  100. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  101. data/sig/increase/models/pending_transaction.rbs +36 -0
  102. data/sig/increase/models/physical_card.rbs +1 -1
  103. data/sig/increase/models/physical_card_profile.rbs +17 -0
  104. data/sig/increase/models/real_time_decision.rbs +36 -0
  105. data/sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs +5 -1
  106. data/sig/increase/models/simulations/card_authorization_create_params.rbs +1 -1
  107. data/sig/increase/models/simulations/card_balance_inquiry_create_params.rbs +1 -1
  108. data/sig/increase/models/simulations/check_deposit_submit_params.rbs +10 -3
  109. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +8 -0
  110. data/sig/increase/models/simulations/entity_update_validation_params.rbs +1 -1
  111. data/sig/increase/models/simulations/inbound_wire_transfer_create_params.rbs +7 -0
  112. data/sig/increase/models/simulations/physical_card_create_params.rbs +1 -1
  113. data/sig/increase/models/transaction.rbs +5 -0
  114. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  115. data/sig/increase/models/wire_drawdown_request.rbs +10 -0
  116. data/sig/increase/resources/exports.rbs +1 -0
  117. data/sig/increase/resources/simulations/inbound_wire_transfers.rbs +1 -0
  118. metadata +4 -4
@@ -1784,6 +1784,25 @@ module Increase
1784
1784
  end
1785
1785
  attr_accessor :direction
1786
1786
 
1787
+ # The healthcare-related fields for this authorization. Only present for specific
1788
+ # programs.
1789
+ sig do
1790
+ returns(
1791
+ T.nilable(Increase::RealTimeDecision::CardAuthorization::Healthcare)
1792
+ )
1793
+ end
1794
+ attr_reader :healthcare
1795
+
1796
+ sig do
1797
+ params(
1798
+ healthcare:
1799
+ T.nilable(
1800
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::OrHash
1801
+ )
1802
+ ).void
1803
+ end
1804
+ attr_writer :healthcare
1805
+
1787
1806
  # The merchant identifier (commonly abbreviated as MID) of the merchant the card
1788
1807
  # is transacting with.
1789
1808
  sig { returns(String) }
@@ -1954,6 +1973,10 @@ module Increase
1954
1973
  digital_wallet_token_id: T.nilable(String),
1955
1974
  direction:
1956
1975
  Increase::RealTimeDecision::CardAuthorization::Direction::OrSymbol,
1976
+ healthcare:
1977
+ T.nilable(
1978
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::OrHash
1979
+ ),
1957
1980
  merchant_acceptor_id: String,
1958
1981
  merchant_category_code: String,
1959
1982
  merchant_city: T.nilable(String),
@@ -2006,6 +2029,9 @@ module Increase
2006
2029
  # The direction describes the direction the funds will move, either from the
2007
2030
  # cardholder to the merchant or from the merchant to the cardholder.
2008
2031
  direction:,
2032
+ # The healthcare-related fields for this authorization. Only present for specific
2033
+ # programs.
2034
+ healthcare:,
2009
2035
  # The merchant identifier (commonly abbreviated as MID) of the merchant the card
2010
2036
  # is transacting with.
2011
2037
  merchant_acceptor_id:,
@@ -2087,6 +2113,10 @@ module Increase
2087
2113
  digital_wallet_token_id: T.nilable(String),
2088
2114
  direction:
2089
2115
  Increase::RealTimeDecision::CardAuthorization::Direction::TaggedSymbol,
2116
+ healthcare:
2117
+ T.nilable(
2118
+ Increase::RealTimeDecision::CardAuthorization::Healthcare
2119
+ ),
2090
2120
  merchant_acceptor_id: String,
2091
2121
  merchant_category_code: String,
2092
2122
  merchant_city: T.nilable(String),
@@ -3087,6 +3117,96 @@ module Increase
3087
3117
  end
3088
3118
  end
3089
3119
 
3120
+ class Healthcare < Increase::Internal::Type::BaseModel
3121
+ OrHash =
3122
+ T.type_alias do
3123
+ T.any(
3124
+ Increase::RealTimeDecision::CardAuthorization::Healthcare,
3125
+ Increase::Internal::AnyHash
3126
+ )
3127
+ end
3128
+
3129
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
3130
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
3131
+ # products. The eligibility is determined based on the list of merchants
3132
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
3133
+ sig do
3134
+ returns(
3135
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility::TaggedSymbol
3136
+ )
3137
+ end
3138
+ attr_accessor :merchant_ninety_percent_eligibility
3139
+
3140
+ # The healthcare-related fields for this authorization. Only present for specific
3141
+ # programs.
3142
+ sig do
3143
+ params(
3144
+ merchant_ninety_percent_eligibility:
3145
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility::OrSymbol
3146
+ ).returns(T.attached_class)
3147
+ end
3148
+ def self.new(
3149
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
3150
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
3151
+ # products. The eligibility is determined based on the list of merchants
3152
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
3153
+ merchant_ninety_percent_eligibility:
3154
+ )
3155
+ end
3156
+
3157
+ sig do
3158
+ override.returns(
3159
+ {
3160
+ merchant_ninety_percent_eligibility:
3161
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility::TaggedSymbol
3162
+ }
3163
+ )
3164
+ end
3165
+ def to_hash
3166
+ end
3167
+
3168
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
3169
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
3170
+ # products. The eligibility is determined based on the list of merchants
3171
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
3172
+ module MerchantNinetyPercentEligibility
3173
+ extend Increase::Internal::Type::Enum
3174
+
3175
+ TaggedSymbol =
3176
+ T.type_alias do
3177
+ T.all(
3178
+ Symbol,
3179
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility
3180
+ )
3181
+ end
3182
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3183
+
3184
+ # The merchant is eligible for treatment under the 90% rule.
3185
+ ELIGIBLE =
3186
+ T.let(
3187
+ :eligible,
3188
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility::TaggedSymbol
3189
+ )
3190
+
3191
+ # The merchant is not eligible for treatment under the 90% rule.
3192
+ NOT_ELIGIBLE =
3193
+ T.let(
3194
+ :not_eligible,
3195
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility::TaggedSymbol
3196
+ )
3197
+
3198
+ sig do
3199
+ override.returns(
3200
+ T::Array[
3201
+ Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility::TaggedSymbol
3202
+ ]
3203
+ )
3204
+ end
3205
+ def self.values
3206
+ end
3207
+ end
3208
+ end
3209
+
3090
3210
  class NetworkDetails < Increase::Internal::Type::BaseModel
3091
3211
  OrHash =
3092
3212
  T.type_alias do
@@ -129,6 +129,13 @@ module Increase
129
129
  Increase::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding::TaggedSymbol
130
130
  )
131
131
 
132
+ # A loan account used in a lender-borrower relationship. Uncommon.
133
+ LOAN =
134
+ T.let(
135
+ :loan,
136
+ Increase::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding::TaggedSymbol
137
+ )
138
+
132
139
  # A bank's general ledger. Uncommon.
133
140
  GENERAL_LEDGER =
134
141
  T.let(
@@ -369,7 +369,7 @@ module Increase
369
369
  Increase::Simulations::CardAuthorizationCreateParams::DeclineReason::TaggedSymbol
370
370
  )
371
371
 
372
- # The transaction was blocked by a Limit.
372
+ # The transaction was blocked by a limit or an authorization control.
373
373
  BREACHES_LIMIT =
374
374
  T.let(
375
375
  :breaches_limit,
@@ -333,7 +333,7 @@ module Increase
333
333
  Increase::Simulations::CardBalanceInquiryCreateParams::DeclineReason::TaggedSymbol
334
334
  )
335
335
 
336
- # The transaction was blocked by a Limit.
336
+ # The transaction was blocked by a limit or an authorization control.
337
337
  BREACHES_LIMIT =
338
338
  T.let(
339
339
  :breaches_limit,
@@ -20,6 +20,7 @@ module Increase
20
20
  attr_accessor :check_deposit_id
21
21
 
22
22
  # If set, the simulation will use these values for the check's scanned MICR data.
23
+ # If not set, the simulation will use random values.
23
24
  sig do
24
25
  returns(
25
26
  T.nilable(Increase::Simulations::CheckDepositSubmitParams::Scan)
@@ -45,6 +46,7 @@ module Increase
45
46
  # The identifier of the Check Deposit you wish to submit.
46
47
  check_deposit_id:,
47
48
  # If set, the simulation will use these values for the check's scanned MICR data.
49
+ # If not set, the simulation will use random values.
48
50
  scan: nil,
49
51
  request_options: {}
50
52
  )
@@ -80,18 +82,29 @@ module Increase
80
82
  attr_accessor :routing_number
81
83
 
82
84
  # The auxiliary on-us data to be returned in the check deposit's scan data.
85
+ # Auxiliary on-us is typically the check number for business checks.
83
86
  sig { returns(T.nilable(String)) }
84
87
  attr_reader :auxiliary_on_us
85
88
 
86
89
  sig { params(auxiliary_on_us: String).void }
87
90
  attr_writer :auxiliary_on_us
88
91
 
92
+ # The serial number to be returned in the check deposit's scan data. Serial number
93
+ # is typically the check number for consumer checks.
94
+ sig { returns(T.nilable(String)) }
95
+ attr_reader :serial_number
96
+
97
+ sig { params(serial_number: String).void }
98
+ attr_writer :serial_number
99
+
89
100
  # If set, the simulation will use these values for the check's scanned MICR data.
101
+ # If not set, the simulation will use random values.
90
102
  sig do
91
103
  params(
92
104
  account_number: String,
93
105
  routing_number: String,
94
- auxiliary_on_us: String
106
+ auxiliary_on_us: String,
107
+ serial_number: String
95
108
  ).returns(T.attached_class)
96
109
  end
97
110
  def self.new(
@@ -100,7 +113,11 @@ module Increase
100
113
  # The routing number to be returned in the check deposit's scan data.
101
114
  routing_number:,
102
115
  # The auxiliary on-us data to be returned in the check deposit's scan data.
103
- auxiliary_on_us: nil
116
+ # Auxiliary on-us is typically the check number for business checks.
117
+ auxiliary_on_us: nil,
118
+ # The serial number to be returned in the check deposit's scan data. Serial number
119
+ # is typically the check number for consumer checks.
120
+ serial_number: nil
104
121
  )
105
122
  end
106
123
 
@@ -109,7 +126,8 @@ module Increase
109
126
  {
110
127
  account_number: String,
111
128
  routing_number: String,
112
- auxiliary_on_us: String
129
+ auxiliary_on_us: String,
130
+ serial_number: String
113
131
  }
114
132
  )
115
133
  end
@@ -120,6 +120,20 @@ module Increase
120
120
  Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol
121
121
  )
122
122
 
123
+ # The tokenization attempt failed because the Card Verification Code (CVC) was incorrect.
124
+ INCORRECT_CARD_VERIFICATION_CODE =
125
+ T.let(
126
+ :incorrect_card_verification_code,
127
+ Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol
128
+ )
129
+
130
+ # The tokenization attempt was declined by the token requestor.
131
+ DECLINED_BY_TOKEN_REQUESTOR =
132
+ T.let(
133
+ :declined_by_token_requestor,
134
+ Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol
135
+ )
136
+
123
137
  sig do
124
138
  override.returns(
125
139
  T::Array[
@@ -116,7 +116,7 @@ module Increase
116
116
  end
117
117
  OrSymbol = T.type_alias { T.any(Symbol, String) }
118
118
 
119
- # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
119
+ # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
120
120
  ENTITY_TAX_IDENTIFIER =
121
121
  T.let(
122
122
  :entity_tax_identifier,
@@ -111,6 +111,14 @@ module Increase
111
111
  sig { params(instruction_identification: String).void }
112
112
  attr_writer :instruction_identification
113
113
 
114
+ # The sending bank will set purpose in production. You can simulate any value
115
+ # here.
116
+ sig { returns(T.nilable(String)) }
117
+ attr_reader :purpose
118
+
119
+ sig { params(purpose: String).void }
120
+ attr_writer :purpose
121
+
114
122
  # The sending bank will set unique_end_to_end_transaction_reference in production.
115
123
  # You can simulate any value here.
116
124
  sig { returns(T.nilable(String)) }
@@ -150,6 +158,7 @@ module Increase
150
158
  end_to_end_identification: String,
151
159
  instructing_agent_routing_number: String,
152
160
  instruction_identification: String,
161
+ purpose: String,
153
162
  unique_end_to_end_transaction_reference: String,
154
163
  unstructured_remittance_information: String,
155
164
  wire_drawdown_request_id: String,
@@ -194,6 +203,9 @@ module Increase
194
203
  # The sending bank will set instruction_identification in production. You can
195
204
  # simulate any value here.
196
205
  instruction_identification: nil,
206
+ # The sending bank will set purpose in production. You can simulate any value
207
+ # here.
208
+ purpose: nil,
197
209
  # The sending bank will set unique_end_to_end_transaction_reference in production.
198
210
  # You can simulate any value here.
199
211
  unique_end_to_end_transaction_reference: nil,
@@ -223,6 +235,7 @@ module Increase
223
235
  end_to_end_identification: String,
224
236
  instructing_agent_routing_number: String,
225
237
  instruction_identification: String,
238
+ purpose: String,
226
239
  unique_end_to_end_transaction_reference: String,
227
240
  unstructured_remittance_information: String,
228
241
  wire_drawdown_request_id: String,
@@ -130,7 +130,7 @@ module Increase
130
130
  Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
131
131
  )
132
132
 
133
- # The physical card has been delivered.
133
+ # The physical card has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single physical card may have more than one delivered event.
134
134
  DELIVERED =
135
135
  T.let(
136
136
  :delivered,
@@ -401,8 +401,10 @@ module Increase
401
401
  attr_writer :card_dispute_loss
402
402
 
403
403
  # A Card Financial object. This field will be present in the JSON response if and
404
- # only if `category` is equal to `card_financial`. Card Financials are temporary
405
- # holds placed on a customer's funds with the intent to later clear a transaction.
404
+ # only if `category` is equal to `card_financial`. Card Financials are card
405
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
406
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
407
+ # single message.
406
408
  sig { returns(T.nilable(Increase::Transaction::Source::CardFinancial)) }
407
409
  attr_reader :card_financial
408
410
 
@@ -1137,8 +1139,10 @@ module Increase
1137
1139
  # details of a lost Card Dispute.
1138
1140
  card_dispute_loss: nil,
1139
1141
  # A Card Financial object. This field will be present in the JSON response if and
1140
- # only if `category` is equal to `card_financial`. Card Financials are temporary
1141
- # holds placed on a customer's funds with the intent to later clear a transaction.
1142
+ # only if `category` is equal to `card_financial`. Card Financials are card
1143
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
1144
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
1145
+ # single message.
1142
1146
  card_financial: nil,
1143
1147
  # A Card Push Transfer Acceptance object. This field will be present in the JSON
1144
1148
  # response if and only if `category` is equal to `card_push_transfer_acceptance`.
@@ -3212,8 +3216,10 @@ module Increase
3212
3216
  attr_writer :verification
3213
3217
 
3214
3218
  # A Card Financial object. This field will be present in the JSON response if and
3215
- # only if `category` is equal to `card_financial`. Card Financials are temporary
3216
- # holds placed on a customer's funds with the intent to later clear a transaction.
3219
+ # only if `category` is equal to `card_financial`. Card Financials are card
3220
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
3221
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
3222
+ # single message.
3217
3223
  sig do
3218
3224
  params(
3219
3225
  id: String,
@@ -13323,6 +13329,10 @@ module Increase
13323
13329
  sig { returns(T.nilable(String)) }
13324
13330
  attr_accessor :instruction_identification
13325
13331
 
13332
+ # The reason for the wire transfer, as set by the sender.
13333
+ sig { returns(T.nilable(String)) }
13334
+ attr_accessor :purpose
13335
+
13326
13336
  # The ID of the Inbound Wire Transfer object that resulted in this Transaction.
13327
13337
  sig { returns(String) }
13328
13338
  attr_accessor :transfer_id
@@ -13357,6 +13367,7 @@ module Increase
13357
13367
  input_message_accountability_data: T.nilable(String),
13358
13368
  instructing_agent_routing_number: T.nilable(String),
13359
13369
  instruction_identification: T.nilable(String),
13370
+ purpose: T.nilable(String),
13360
13371
  transfer_id: String,
13361
13372
  unique_end_to_end_transaction_reference: T.nilable(String),
13362
13373
  unstructured_remittance_information: T.nilable(String)
@@ -13394,6 +13405,8 @@ module Increase
13394
13405
  instructing_agent_routing_number:,
13395
13406
  # The sending bank's identifier for the wire transfer.
13396
13407
  instruction_identification:,
13408
+ # The reason for the wire transfer, as set by the sender.
13409
+ purpose:,
13397
13410
  # The ID of the Inbound Wire Transfer object that resulted in this Transaction.
13398
13411
  transfer_id:,
13399
13412
  # The Unique End-to-end Transaction Reference
@@ -13422,6 +13435,7 @@ module Increase
13422
13435
  input_message_accountability_data: T.nilable(String),
13423
13436
  instructing_agent_routing_number: T.nilable(String),
13424
13437
  instruction_identification: T.nilable(String),
13438
+ purpose: T.nilable(String),
13425
13439
  transfer_id: String,
13426
13440
  unique_end_to_end_transaction_reference: T.nilable(String),
13427
13441
  unstructured_remittance_information: T.nilable(String)
@@ -580,6 +580,34 @@ module Increase
580
580
  Increase::UnwrapWebhookEvent::Category::TaggedSymbol
581
581
  )
582
582
 
583
+ # Occurs whenever a Loan Application is created.
584
+ LOAN_APPLICATION_CREATED =
585
+ T.let(
586
+ :"loan_application.created",
587
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
588
+ )
589
+
590
+ # Occurs whenever a Loan Application is updated.
591
+ LOAN_APPLICATION_UPDATED =
592
+ T.let(
593
+ :"loan_application.updated",
594
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
595
+ )
596
+
597
+ # Occurs whenever a Loan Offer is created.
598
+ LOAN_OFFER_CREATED =
599
+ T.let(
600
+ :"loan_offer.created",
601
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
602
+ )
603
+
604
+ # Occurs whenever a Loan Offer is updated.
605
+ LOAN_OFFER_UPDATED =
606
+ T.let(
607
+ :"loan_offer.updated",
608
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
609
+ )
610
+
583
611
  # Occurs whenever a Lockbox is created.
584
612
  LOCKBOX_CREATED =
585
613
  T.let(
@@ -74,6 +74,11 @@ module Increase
74
74
  sig { returns(String) }
75
75
  attr_accessor :debtor_routing_number
76
76
 
77
+ # A free-form reference string set by the sender, to be mirrored back in the
78
+ # subsequent wire transfer.
79
+ sig { returns(T.nilable(String)) }
80
+ attr_accessor :end_to_end_identification
81
+
77
82
  # If the recipient fulfills the drawdown request by sending funds, then this will
78
83
  # be the identifier of the corresponding Transaction.
79
84
  sig { returns(T.nilable(String)) }
@@ -107,6 +112,12 @@ module Increase
107
112
  sig { returns(Increase::WireDrawdownRequest::Type::TaggedSymbol) }
108
113
  attr_accessor :type
109
114
 
115
+ # The unique end-to-end transaction reference
116
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
117
+ # of the drawdown request.
118
+ sig { returns(T.nilable(String)) }
119
+ attr_accessor :unique_end_to_end_transaction_reference
120
+
110
121
  # Remittance information the debtor will see as part of the drawdown request.
111
122
  sig { returns(String) }
112
123
  attr_accessor :unstructured_remittance_information
@@ -132,12 +143,14 @@ module Increase
132
143
  debtor_external_account_id: T.nilable(String),
133
144
  debtor_name: String,
134
145
  debtor_routing_number: String,
146
+ end_to_end_identification: T.nilable(String),
135
147
  fulfillment_inbound_wire_transfer_id: T.nilable(String),
136
148
  idempotency_key: T.nilable(String),
137
149
  status: Increase::WireDrawdownRequest::Status::OrSymbol,
138
150
  submission:
139
151
  T.nilable(Increase::WireDrawdownRequest::Submission::OrHash),
140
152
  type: Increase::WireDrawdownRequest::Type::OrSymbol,
153
+ unique_end_to_end_transaction_reference: T.nilable(String),
141
154
  unstructured_remittance_information: String
142
155
  ).returns(T.attached_class)
143
156
  end
@@ -169,6 +182,9 @@ module Increase
169
182
  debtor_name:,
170
183
  # The debtor's routing number.
171
184
  debtor_routing_number:,
185
+ # A free-form reference string set by the sender, to be mirrored back in the
186
+ # subsequent wire transfer.
187
+ end_to_end_identification:,
172
188
  # If the recipient fulfills the drawdown request by sending funds, then this will
173
189
  # be the identifier of the corresponding Transaction.
174
190
  fulfillment_inbound_wire_transfer_id:,
@@ -184,6 +200,10 @@ module Increase
184
200
  # A constant representing the object's type. For this resource it will always be
185
201
  # `wire_drawdown_request`.
186
202
  type:,
203
+ # The unique end-to-end transaction reference
204
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
205
+ # of the drawdown request.
206
+ unique_end_to_end_transaction_reference:,
187
207
  # Remittance information the debtor will see as part of the drawdown request.
188
208
  unstructured_remittance_information:
189
209
  )
@@ -204,11 +224,13 @@ module Increase
204
224
  debtor_external_account_id: T.nilable(String),
205
225
  debtor_name: String,
206
226
  debtor_routing_number: String,
227
+ end_to_end_identification: T.nilable(String),
207
228
  fulfillment_inbound_wire_transfer_id: T.nilable(String),
208
229
  idempotency_key: T.nilable(String),
209
230
  status: Increase::WireDrawdownRequest::Status::TaggedSymbol,
210
231
  submission: T.nilable(Increase::WireDrawdownRequest::Submission),
211
232
  type: Increase::WireDrawdownRequest::Type::TaggedSymbol,
233
+ unique_end_to_end_transaction_reference: T.nilable(String),
212
234
  unstructured_remittance_information: String
213
235
  }
214
236
  )
@@ -18,6 +18,7 @@ module Increase
18
18
  daily_account_balance_csv:
19
19
  Increase::ExportCreateParams::DailyAccountBalanceCsv::OrHash,
20
20
  entity_csv: Increase::ExportCreateParams::EntityCsv::OrHash,
21
+ fee_csv: Increase::ExportCreateParams::FeeCsv::OrHash,
21
22
  funding_instructions:
22
23
  Increase::ExportCreateParams::FundingInstructions::OrHash,
23
24
  transaction_csv: Increase::ExportCreateParams::TransactionCsv::OrHash,
@@ -46,6 +47,8 @@ module Increase
46
47
  daily_account_balance_csv: nil,
47
48
  # Options for the created export. Required if `category` is equal to `entity_csv`.
48
49
  entity_csv: nil,
50
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
51
+ fee_csv: nil,
49
52
  # Options for the created export. Required if `category` is equal to
50
53
  # `funding_instructions`.
51
54
  funding_instructions: nil,
@@ -76,6 +76,7 @@ module Increase
76
76
  # The identifier of the Check Deposit you wish to submit.
77
77
  check_deposit_id,
78
78
  # If set, the simulation will use these values for the check's scanned MICR data.
79
+ # If not set, the simulation will use random values.
79
80
  scan: nil,
80
81
  request_options: {}
81
82
  )
@@ -20,6 +20,7 @@ module Increase
20
20
  end_to_end_identification: String,
21
21
  instructing_agent_routing_number: String,
22
22
  instruction_identification: String,
23
+ purpose: String,
23
24
  unique_end_to_end_transaction_reference: String,
24
25
  unstructured_remittance_information: String,
25
26
  wire_drawdown_request_id: String,
@@ -64,6 +65,9 @@ module Increase
64
65
  # The sending bank will set instruction_identification in production. You can
65
66
  # simulate any value here.
66
67
  instruction_identification: nil,
68
+ # The sending bank will set purpose in production. You can simulate any value
69
+ # here.
70
+ purpose: nil,
67
71
  # The sending bank will set unique_end_to_end_transaction_reference in production.
68
72
  # You can simulate any value here.
69
73
  unique_end_to_end_transaction_reference: nil,
@@ -116,10 +116,10 @@ module Increase
116
116
  module CreditDebitIndicator
117
117
  extend Increase::Internal::Type::Enum
118
118
 
119
- # The Prenotification is for an anticipated credit.
119
+ # Credit
120
120
  CREDIT: :credit
121
121
 
122
- # The Prenotification is for an anticipated debit.
122
+ # Debit
123
123
  DEBIT: :debit
124
124
 
125
125
  def self?.values: -> ::Array[Increase::Models::ACHPrenotification::credit_debit_indicator]
@@ -250,7 +250,8 @@ module Increase
250
250
  def self?.values: -> ::Array[Increase::Models::ACHPrenotification::NotificationsOfChange::change_code]
251
251
  end
252
252
 
253
- type corrected_account_funding = :checking | :savings | :general_ledger
253
+ type corrected_account_funding =
254
+ :checking | :savings | :loan | :general_ledger
254
255
 
255
256
  module CorrectedAccountFunding
256
257
  extend Increase::Internal::Type::Enum
@@ -261,6 +262,9 @@ module Increase
261
262
  # A savings account.
262
263
  SAVINGS: :savings
263
264
 
265
+ # A loan account used in a lender-borrower relationship. Uncommon.
266
+ LOAN: :loan
267
+
264
268
  # A bank's general ledger. Uncommon.
265
269
  GENERAL_LEDGER: :general_ledger
266
270
 
@@ -111,10 +111,10 @@ module Increase
111
111
  module CreditDebitIndicator
112
112
  extend Increase::Internal::Type::Enum
113
113
 
114
- # The Prenotification is for an anticipated credit.
114
+ # Credit
115
115
  CREDIT: :credit
116
116
 
117
- # The Prenotification is for an anticipated debit.
117
+ # Debit
118
118
  DEBIT: :debit
119
119
 
120
120
  def self?.values: -> ::Array[Increase::Models::ACHPrenotificationCreateParams::credit_debit_indicator]
@@ -677,7 +677,8 @@ module Increase
677
677
  def self?.values: -> ::Array[Increase::Models::ACHTransfer::NotificationsOfChange::change_code]
678
678
  end
679
679
 
680
- type corrected_account_funding = :checking | :savings | :general_ledger
680
+ type corrected_account_funding =
681
+ :checking | :savings | :loan | :general_ledger
681
682
 
682
683
  module CorrectedAccountFunding
683
684
  extend Increase::Internal::Type::Enum
@@ -688,6 +689,9 @@ module Increase
688
689
  # A savings account.
689
690
  SAVINGS: :savings
690
691
 
692
+ # A loan account used in a lender-borrower relationship. Uncommon.
693
+ LOAN: :loan
694
+
691
695
  # A bank's general ledger. Uncommon.
692
696
  GENERAL_LEDGER: :general_ledger
693
697
 
@@ -6,6 +6,7 @@ module Increase
6
6
  account_id: String,
7
7
  authorization_controls: Increase::Card::AuthorizationControls?,
8
8
  billing_address: Increase::Card::BillingAddress,
9
+ bin: String,
9
10
  created_at: Time,
10
11
  description: String?,
11
12
  digital_wallet: Increase::Card::DigitalWallet?,
@@ -27,6 +28,8 @@ module Increase
27
28
 
28
29
  attr_accessor billing_address: Increase::Card::BillingAddress
29
30
 
31
+ attr_accessor bin: String
32
+
30
33
  attr_accessor created_at: Time
31
34
 
32
35
  attr_accessor description: String?
@@ -52,6 +55,7 @@ module Increase
52
55
  account_id: String,
53
56
  authorization_controls: Increase::Card::AuthorizationControls?,
54
57
  billing_address: Increase::Card::BillingAddress,
58
+ bin: String,
55
59
  created_at: Time,
56
60
  description: String?,
57
61
  digital_wallet: Increase::Card::DigitalWallet?,
@@ -69,6 +73,7 @@ module Increase
69
73
  account_id: String,
70
74
  authorization_controls: Increase::Card::AuthorizationControls?,
71
75
  billing_address: Increase::Card::BillingAddress,
76
+ bin: String,
72
77
  created_at: Time,
73
78
  description: String?,
74
79
  digital_wallet: Increase::Card::DigitalWallet?,