increase 1.333.1 → 1.335.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 (123) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +26 -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 +9 -3
  7. data/lib/increase/models/ach_transfer_create_params.rb +3 -0
  8. data/lib/increase/models/card.rb +9 -1
  9. data/lib/increase/models/card_dispute.rb +40 -1
  10. data/lib/increase/models/card_dispute_list_params.rb +3 -0
  11. data/lib/increase/models/card_payment.rb +74 -6
  12. data/lib/increase/models/card_push_transfer.rb +53 -1
  13. data/lib/increase/models/check_transfer.rb +4 -8
  14. data/lib/increase/models/declined_transaction.rb +4 -1
  15. data/lib/increase/models/digital_wallet_token.rb +59 -1
  16. data/lib/increase/models/entity.rb +1 -1
  17. data/lib/increase/models/event.rb +12 -0
  18. data/lib/increase/models/event_list_params.rb +12 -0
  19. data/lib/increase/models/event_subscription.rb +12 -0
  20. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  21. data/lib/increase/models/export.rb +17 -1
  22. data/lib/increase/models/export_create_params.rb +78 -1
  23. data/lib/increase/models/fednow_transfer.rb +47 -1
  24. data/lib/increase/models/inbound_wire_transfer.rb +9 -1
  25. data/lib/increase/models/pending_transaction.rb +57 -1
  26. data/lib/increase/models/physical_card.rb +1 -1
  27. data/lib/increase/models/physical_card_profile.rb +38 -1
  28. data/lib/increase/models/real_time_decision.rb +55 -1
  29. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +3 -0
  30. data/lib/increase/models/simulations/card_authorization_create_params.rb +4 -1
  31. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +1 -1
  32. data/lib/increase/models/simulations/check_deposit_submit_params.rb +21 -2
  33. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +6 -0
  34. data/lib/increase/models/simulations/entity_update_validation_params.rb +1 -1
  35. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +10 -1
  36. data/lib/increase/models/simulations/physical_card_create_params.rb +1 -1
  37. data/lib/increase/models/transaction.rb +23 -8
  38. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  39. data/lib/increase/models/wire_drawdown_request.rb +20 -1
  40. data/lib/increase/resources/events.rb +4 -1
  41. data/lib/increase/resources/exports.rb +3 -1
  42. data/lib/increase/resources/simulations/check_deposits.rb +3 -0
  43. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +3 -1
  44. data/lib/increase/version.rb +1 -1
  45. data/rbi/increase/models/ach_prenotification.rbi +9 -2
  46. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  47. data/rbi/increase/models/ach_transfer.rbi +14 -4
  48. data/rbi/increase/models/ach_transfer_create_params.rbi +4 -0
  49. data/rbi/increase/models/card.rbi +8 -0
  50. data/rbi/increase/models/card_dispute.rbi +56 -0
  51. data/rbi/increase/models/card_dispute_list_params.rbi +7 -0
  52. data/rbi/increase/models/card_payment.rbi +156 -7
  53. data/rbi/increase/models/card_push_transfer.rbi +56 -0
  54. data/rbi/increase/models/check_transfer.rbi +4 -10
  55. data/rbi/increase/models/declined_transaction.rbi +8 -1
  56. data/rbi/increase/models/digital_wallet_token.rbi +131 -0
  57. data/rbi/increase/models/entity.rbi +1 -1
  58. data/rbi/increase/models/event.rbi +22 -0
  59. data/rbi/increase/models/event_list_params.rbi +28 -0
  60. data/rbi/increase/models/event_subscription.rbi +28 -0
  61. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  62. data/rbi/increase/models/export.rbi +25 -5
  63. data/rbi/increase/models/export_create_params.rbi +151 -0
  64. data/rbi/increase/models/fednow_transfer.rbi +77 -0
  65. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  66. data/rbi/increase/models/pending_transaction.rbi +129 -0
  67. data/rbi/increase/models/physical_card.rbi +1 -1
  68. data/rbi/increase/models/physical_card_profile.rbi +60 -0
  69. data/rbi/increase/models/real_time_decision.rbi +127 -0
  70. data/rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +7 -0
  71. data/rbi/increase/models/simulations/card_authorization_create_params.rbi +8 -1
  72. data/rbi/increase/models/simulations/card_balance_inquiry_create_params.rbi +1 -1
  73. data/rbi/increase/models/simulations/check_deposit_submit_params.rbi +21 -3
  74. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +14 -0
  75. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +1 -1
  76. data/rbi/increase/models/simulations/inbound_wire_transfer_create_params.rbi +13 -0
  77. data/rbi/increase/models/simulations/physical_card_create_params.rbi +1 -1
  78. data/rbi/increase/models/transaction.rbi +31 -10
  79. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  80. data/rbi/increase/models/wire_drawdown_request.rbi +22 -0
  81. data/rbi/increase/resources/events.rbi +4 -1
  82. data/rbi/increase/resources/exports.rbi +3 -0
  83. data/rbi/increase/resources/simulations/check_deposits.rbi +1 -0
  84. data/rbi/increase/resources/simulations/inbound_wire_transfers.rbi +4 -0
  85. data/sig/increase/models/ach_prenotification.rbs +7 -3
  86. data/sig/increase/models/ach_prenotification_create_params.rbs +2 -2
  87. data/sig/increase/models/ach_transfer.rbs +9 -2
  88. data/sig/increase/models/ach_transfer_create_params.rbs +4 -1
  89. data/sig/increase/models/card.rbs +5 -0
  90. data/sig/increase/models/card_dispute.rbs +21 -0
  91. data/sig/increase/models/card_dispute_list_params.rbs +4 -0
  92. data/sig/increase/models/card_payment.rbs +49 -1
  93. data/sig/increase/models/card_push_transfer.rbs +30 -0
  94. data/sig/increase/models/check_transfer.rbs +5 -5
  95. data/sig/increase/models/declined_transaction.rbs +5 -1
  96. data/sig/increase/models/digital_wallet_token.rbs +61 -2
  97. data/sig/increase/models/entity.rbs +1 -1
  98. data/sig/increase/models/event.rbs +16 -0
  99. data/sig/increase/models/event_list_params.rbs +16 -0
  100. data/sig/increase/models/event_subscription.rbs +16 -0
  101. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  102. data/sig/increase/models/export.rbs +23 -3
  103. data/sig/increase/models/export_create_params.rbs +76 -0
  104. data/sig/increase/models/fednow_transfer.rbs +37 -0
  105. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  106. data/sig/increase/models/pending_transaction.rbs +40 -0
  107. data/sig/increase/models/physical_card.rbs +1 -1
  108. data/sig/increase/models/physical_card_profile.rbs +17 -0
  109. data/sig/increase/models/real_time_decision.rbs +40 -0
  110. data/sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs +5 -1
  111. data/sig/increase/models/simulations/card_authorization_create_params.rbs +5 -1
  112. data/sig/increase/models/simulations/card_balance_inquiry_create_params.rbs +1 -1
  113. data/sig/increase/models/simulations/check_deposit_submit_params.rbs +10 -3
  114. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +8 -0
  115. data/sig/increase/models/simulations/entity_update_validation_params.rbs +1 -1
  116. data/sig/increase/models/simulations/inbound_wire_transfer_create_params.rbs +7 -0
  117. data/sig/increase/models/simulations/physical_card_create_params.rbs +1 -1
  118. data/sig/increase/models/transaction.rbs +9 -0
  119. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  120. data/sig/increase/models/wire_drawdown_request.rbs +10 -0
  121. data/sig/increase/resources/exports.rbs +1 -0
  122. data/sig/increase/resources/simulations/inbound_wire_transfers.rbs +1 -0
  123. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 17c6eda87a2350446e60a566026605fba537b89b315a0fe00f9597e777ca4d9c
4
- data.tar.gz: a84f4282ba83d306cb79193339254c3ec72f113b1aac59fc11a77eda1bb4e995
3
+ metadata.gz: 3fc22de92c329bbd0c21bdf33a84eb2a88cc071b0cdd727aac925c60d2934a9f
4
+ data.tar.gz: 2417aeb99f89e5507f223477aac5946ee8469cf022f2fd628c29a0eb445f3bd5
5
5
  SHA512:
6
- metadata.gz: a984e139eb6d29b5210499872b4c37a18f947149597b73a43a9db358ec2348f7b7a1d0a4944f1447de3d5fe9f12ba1e5873191994440e5010a02bc4b5d07dc01
7
- data.tar.gz: 424ae29f0f20fc8dddd5b40ae51f6cbe843e3eb4d1c259c8aa9382f11d8e13e31bd3ed19043b80402f2bccb493ef83d02be5f8109e8f0454bec3bd50adbdb716
6
+ metadata.gz: 85a1b699cf6399f16b9c21083e75125d1c974787d49ea1a6238bb6771d091eb54524215f4e112fb49ddde7f0025367069bb64afd8fa2b32aff53296d5aea1408
7
+ data.tar.gz: ad9b6471bead2acbe265d8eadbe81051e5c0379324284c8eae73271b346e131fae4c7ddd2eac51b04179e68f50b9cf32fca66afa9e20a40818efbb541d19665e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.335.0](https://github.com/Increase/increase-ruby/compare/v1.334.1...v1.335.0) (2026-06-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** api update ([#451](https://github.com/Increase/increase-ruby/issues/451)) ([b0ece67](https://github.com/Increase/increase-ruby/commit/b0ece6779717f29245e8f50b1a6d3122b29bf48f))
9
+
10
+ ## [1.334.1](https://github.com/Increase/increase-ruby/compare/v1.334.0...v1.334.1) (2026-06-12)
11
+
12
+
13
+ ### Chores
14
+
15
+ * pin rubygems credentials action to v2.0.0 ([#447](https://github.com/Increase/increase-ruby/issues/447)) ([bd6f9d6](https://github.com/Increase/increase-ruby/commit/bd6f9d6171a43bd4405f8f936ee7c04f231ab338))
16
+
17
+ ## [1.334.0](https://github.com/Increase/increase-ruby/compare/v1.333.1...v1.334.0) (2026-06-12)
18
+
19
+
20
+ ### Features
21
+
22
+ * **api:** api update ([#445](https://github.com/Increase/increase-ruby/issues/445)) ([48a834e](https://github.com/Increase/increase-ruby/commit/48a834ef8fa30082652254d66b71f39a54205209))
23
+
3
24
  ## [1.333.1](https://github.com/Increase/increase-ruby/compare/v1.333.0...v1.333.1) (2026-05-20)
4
25
 
5
26
 
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Increase Ruby API library
2
2
 
3
- The Increase Ruby library provides convenient access to the Increase REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Increase/increase-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
3
+ The Increase Ruby library provides convenient access to the Increase REST API from any Ruby 3.3.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Increase/increase-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
4
4
 
5
5
  ## Documentation
6
6
 
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.333.1"
18
+ gem "increase", "~> 1.335.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -27,8 +27,7 @@ require "bundler/setup"
27
27
  require "increase"
28
28
 
29
29
  increase = Increase::Client.new(
30
- api_key: ENV["INCREASE_API_KEY"], # This is the default and can be omitted
31
- environment: "sandbox" # defaults to "production"
30
+ api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
32
31
  )
33
32
 
34
33
  account = increase.accounts.create(
@@ -40,6 +39,9 @@ account = increase.accounts.create(
40
39
  puts(account.id)
41
40
  ```
42
41
 
42
+ > [!IMPORTANT]
43
+ > Fields whose names collide with Ruby keywords are suffixed with an underscore. For example, the `return` field on an ACH Transfer is exposed as `transfer.return_`, and the return simulation is `client.simulations.ach_transfers.return_`.
44
+
43
45
  ### Pagination
44
46
 
45
47
  List methods in the Increase API are paginated.
@@ -68,6 +70,8 @@ if page.next_page?
68
70
  end
69
71
  ```
70
72
 
73
+ Note that page objects are not `Enumerable` — access the current page's items with `#data`, or iterate across pages with `#auto_paging_each` as above.
74
+
71
75
  ### File uploads
72
76
 
73
77
  Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
@@ -90,6 +94,21 @@ puts(file.id)
90
94
 
91
95
  Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
92
96
 
97
+ ### Webhook verification
98
+
99
+ This library includes a helper for verifying webhook signatures. Construct the client with your `webhook_secret` (read from `ENV["INCREASE_WEBHOOK_SECRET"]` by default), then pass the raw request body and headers to `events.unwrap`, which verifies the signature and parses the payload:
100
+
101
+ ```ruby
102
+ increase = Increase::Client.new(
103
+ webhook_secret: ENV["INCREASE_WEBHOOK_SECRET"] # This is the default and can be omitted
104
+ )
105
+
106
+ # In your webhook handler, e.g. a Rails controller action:
107
+ event = increase.events.unwrap(request.body.read, headers: request.headers.to_h)
108
+ ```
109
+
110
+ `StandardWebhooks::WebhookVerificationError` is raised if the signature is invalid, so a webhook that unwraps without raising is guaranteed authentic. Note that the secret is Base64-encoded before being passed to `StandardWebhooks::Webhook` — to sign a synthetic payload in tests, construct the signer the same way: `StandardWebhooks::Webhook.new(Base64.strict_encode64(secret))`.
111
+
93
112
  ### Handling errors
94
113
 
95
114
  When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Increase::Errors::APIError` will be thrown:
@@ -123,6 +142,8 @@ Error codes are as follows:
123
142
  | Timeout | `APITimeoutError` |
124
143
  | Network error | `APIConnectionError` |
125
144
 
145
+ All errors raised by this gem, including `Increase::Errors::APIError` and response-parsing errors like `Increase::Errors::ConversionError`, inherit from `Increase::Errors::Error`, which you can rescue to catch anything the gem raises.
146
+
126
147
  ### Retries
127
148
 
128
149
  Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
@@ -304,7 +325,7 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
304
325
 
305
326
  ## Requirements
306
327
 
307
- Ruby 3.2.0 or higher.
328
+ Ruby 3.3.0 or higher.
308
329
 
309
330
  ## Contributing
310
331
 
@@ -190,10 +190,10 @@ module Increase
190
190
  module CreditDebitIndicator
191
191
  extend Increase::Internal::Type::Enum
192
192
 
193
- # The Prenotification is for an anticipated credit.
193
+ # Credit
194
194
  CREDIT = :credit
195
195
 
196
- # The Prenotification is for an anticipated debit.
196
+ # Debit
197
197
  DEBIT = :debit
198
198
 
199
199
  # @!method self.values
@@ -345,6 +345,9 @@ module Increase
345
345
  # A savings account.
346
346
  SAVINGS = :savings
347
347
 
348
+ # A loan account used in a lender-borrower relationship. Uncommon.
349
+ LOAN = :loan
350
+
348
351
  # A bank's general ledger. Uncommon.
349
352
  GENERAL_LEDGER = :general_ledger
350
353
 
@@ -128,10 +128,10 @@ module Increase
128
128
  module CreditDebitIndicator
129
129
  extend Increase::Internal::Type::Enum
130
130
 
131
- # The Prenotification is for an anticipated credit.
131
+ # Credit
132
132
  CREDIT = :credit
133
133
 
134
- # The Prenotification is for an anticipated debit.
134
+ # Debit
135
135
  DEBIT = :debit
136
136
 
137
137
  # @!method self.values
@@ -162,8 +162,8 @@ module Increase
162
162
  required :network, enum: -> { Increase::ACHTransfer::Network }
163
163
 
164
164
  # @!attribute notifications_of_change
165
- # If the receiving bank accepts the transfer but notifies that future transfers
166
- # should use different details, this will contain those details.
165
+ # If the receiving bank notifies that future transfers should use different
166
+ # details, this will contain those details.
167
167
  #
168
168
  # @return [Array<Increase::Models::ACHTransfer::NotificationsOfChange>]
169
169
  required :notifications_of_change,
@@ -304,7 +304,7 @@ module Increase
304
304
  #
305
305
  # @param network [Symbol, Increase::Models::ACHTransfer::Network] The transfer's network.
306
306
  #
307
- # @param notifications_of_change [Array<Increase::Models::ACHTransfer::NotificationsOfChange>] If the receiving bank accepts the transfer but notifies that future transfers sh
307
+ # @param notifications_of_change [Array<Increase::Models::ACHTransfer::NotificationsOfChange>] If the receiving bank notifies that future transfers should use different detail
308
308
  #
309
309
  # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
310
310
  #
@@ -672,6 +672,9 @@ module Increase
672
672
  # A savings account.
673
673
  SAVINGS = :savings
674
674
 
675
+ # A loan account used in a lender-borrower relationship. Uncommon.
676
+ LOAN = :loan
677
+
675
678
  # A bank's general ledger. Uncommon.
676
679
  GENERAL_LEDGER = :general_ledger
677
680
 
@@ -966,6 +969,9 @@ module Increase
966
969
  # A savings account.
967
970
  SAVINGS = :savings
968
971
 
972
+ # A loan account used in a lender-borrower relationship. Uncommon.
973
+ LOAN = :loan
974
+
969
975
  # A bank's general ledger. Uncommon.
970
976
  GENERAL_LEDGER = :general_ledger
971
977
 
@@ -343,6 +343,9 @@ module Increase
343
343
  # A savings account.
344
344
  SAVINGS = :savings
345
345
 
346
+ # A loan account used in a lender-borrower relationship. Uncommon.
347
+ LOAN = :loan
348
+
346
349
  # A bank's general ledger. Uncommon.
347
350
  GENERAL_LEDGER = :general_ledger
348
351
 
@@ -28,6 +28,12 @@ module Increase
28
28
  # @return [Increase::Models::Card::BillingAddress]
29
29
  required :billing_address, -> { Increase::Card::BillingAddress }
30
30
 
31
+ # @!attribute bin
32
+ # The Bank Identification Number (BIN) of the Card.
33
+ #
34
+ # @return [String]
35
+ required :bin, String
36
+
31
37
  # @!attribute created_at
32
38
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
33
39
  # the Card was created.
@@ -94,7 +100,7 @@ module Increase
94
100
  # @return [Symbol, Increase::Models::Card::Type]
95
101
  required :type, enum: -> { Increase::Card::Type }
96
102
 
97
- # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
103
+ # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
98
104
  # Some parameter documentations has been truncated, see {Increase::Models::Card}
99
105
  # for more details.
100
106
  #
@@ -112,6 +118,8 @@ module Increase
112
118
  #
113
119
  # @param billing_address [Increase::Models::Card::BillingAddress] The Card's billing address.
114
120
  #
121
+ # @param bin [String] The Bank Identification Number (BIN) of the Card.
122
+ #
115
123
  # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
116
124
  #
117
125
  # @param description [String, nil] The card's description for display purposes.
@@ -56,6 +56,13 @@ module Increase
56
56
  # @return [Symbol, Increase::Models::CardDispute::Network]
57
57
  required :network, enum: -> { Increase::CardDispute::Network }
58
58
 
59
+ # @!attribute rejection
60
+ # If the Card Dispute has been rejected, this will contain details of the
61
+ # rejection.
62
+ #
63
+ # @return [Increase::Models::CardDispute::Rejection, nil]
64
+ required :rejection, -> { Increase::CardDispute::Rejection }, nil?: true
65
+
59
66
  # @!attribute status
60
67
  # The status of the Card Dispute.
61
68
  #
@@ -100,7 +107,7 @@ module Increase
100
107
  # @return [Increase::Models::CardDispute::Withdrawal, nil]
101
108
  required :withdrawal, -> { Increase::CardDispute::Withdrawal }, nil?: true
102
109
 
103
- # @!method initialize(id:, amount:, card_id:, created_at:, disputed_transaction_id:, idempotency_key:, loss:, network:, status:, type:, user_submission_required_by:, visa:, win:, withdrawal:)
110
+ # @!method initialize(id:, amount:, card_id:, created_at:, disputed_transaction_id:, idempotency_key:, loss:, network:, rejection:, status:, type:, user_submission_required_by:, visa:, win:, withdrawal:)
104
111
  # Some parameter documentations has been truncated, see
105
112
  # {Increase::Models::CardDispute} for more details.
106
113
  #
@@ -123,6 +130,8 @@ module Increase
123
130
  #
124
131
  # @param network [Symbol, Increase::Models::CardDispute::Network] The network that the Card Dispute is associated with.
125
132
  #
133
+ # @param rejection [Increase::Models::CardDispute::Rejection, nil] If the Card Dispute has been rejected, this will contain details of the rejectio
134
+ #
126
135
  # @param status [Symbol, Increase::Models::CardDispute::Status] The status of the Card Dispute.
127
136
  #
128
137
  # @param type [Symbol, Increase::Models::CardDispute::Type] A constant representing the object's type. For this resource it will always be `
@@ -194,6 +203,33 @@ module Increase
194
203
  # @return [Array<Symbol>]
195
204
  end
196
205
 
206
+ # @see Increase::Models::CardDispute#rejection
207
+ class Rejection < Increase::Internal::Type::BaseModel
208
+ # @!attribute explanation
209
+ # Why the Card Dispute was rejected.
210
+ #
211
+ # @return [String]
212
+ required :explanation, String
213
+
214
+ # @!attribute rejected_at
215
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
216
+ # the Card Dispute was rejected.
217
+ #
218
+ # @return [Time]
219
+ required :rejected_at, Time
220
+
221
+ # @!method initialize(explanation:, rejected_at:)
222
+ # Some parameter documentations has been truncated, see
223
+ # {Increase::Models::CardDispute::Rejection} for more details.
224
+ #
225
+ # If the Card Dispute has been rejected, this will contain details of the
226
+ # rejection.
227
+ #
228
+ # @param explanation [String] Why the Card Dispute was rejected.
229
+ #
230
+ # @param rejected_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
231
+ end
232
+
197
233
  # The status of the Card Dispute.
198
234
  #
199
235
  # @see Increase::Models::CardDispute#status
@@ -221,6 +257,9 @@ module Increase
221
257
  # The Card Dispute has been won and no further action can be taken.
222
258
  WON = :won
223
259
 
260
+ # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
261
+ REJECTED = :rejected
262
+
224
263
  # @!method self.values
225
264
  # @return [Array<Symbol>]
226
265
  end
@@ -138,6 +138,9 @@ module Increase
138
138
  # The Card Dispute has been won and no further action can be taken.
139
139
  WON = :won
140
140
 
141
+ # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
142
+ REJECTED = :rejected
143
+
141
144
  # @!method self.values
142
145
  # @return [Array<Symbol>]
143
146
  end
@@ -147,8 +147,10 @@ module Increase
147
147
 
148
148
  # @!attribute card_financial
149
149
  # A Card Financial object. This field will be present in the JSON response if and
150
- # only if `category` is equal to `card_financial`. Card Financials are temporary
151
- # holds placed on a customer's funds with the intent to later clear a transaction.
150
+ # only if `category` is equal to `card_financial`. Card Financials are card
151
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
152
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
153
+ # single message.
152
154
  #
153
155
  # @return [Increase::Models::CardPayment::Element::CardFinancial, nil]
154
156
  optional :card_financial, -> { Increase::CardPayment::Element::CardFinancial }, nil?: true
@@ -1327,6 +1329,17 @@ module Increase
1327
1329
  # @return [Time]
1328
1330
  required :expires_at, Time
1329
1331
 
1332
+ # @!attribute healthcare
1333
+ # The healthcare-related fields for this authorization. Only present for specific
1334
+ # programs.
1335
+ #
1336
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::Healthcare, nil]
1337
+ required :healthcare,
1338
+ -> {
1339
+ Increase::CardPayment::Element::CardAuthorization::Healthcare
1340
+ },
1341
+ nil?: true
1342
+
1330
1343
  # @!attribute merchant_acceptor_id
1331
1344
  # The merchant identifier (commonly abbreviated as MID) of the merchant the card
1332
1345
  # is transacting with.
@@ -1461,7 +1474,7 @@ module Increase
1461
1474
  # @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification]
1462
1475
  required :verification, -> { Increase::CardPayment::Element::CardAuthorization::Verification }
1463
1476
 
1464
- # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
1477
+ # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
1465
1478
  # Some parameter documentations has been truncated, see
1466
1479
  # {Increase::Models::CardPayment::Element::CardAuthorization} for more details.
1467
1480
  #
@@ -1488,6 +1501,8 @@ module Increase
1488
1501
  #
1489
1502
  # @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization w
1490
1503
  #
1504
+ # @param healthcare [Increase::Models::CardPayment::Element::CardAuthorization::Healthcare, nil] The healthcare-related fields for this authorization. Only present for specific
1505
+ #
1491
1506
  # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1492
1507
  #
1493
1508
  # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
@@ -1987,6 +2002,48 @@ module Increase
1987
2002
  # @return [Array<Symbol>]
1988
2003
  end
1989
2004
 
2005
+ # @see Increase::Models::CardPayment::Element::CardAuthorization#healthcare
2006
+ class Healthcare < Increase::Internal::Type::BaseModel
2007
+ # @!attribute merchant_ninety_percent_eligibility
2008
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
2009
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
2010
+ # products. The eligibility is determined based on the list of merchants
2011
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
2012
+ #
2013
+ # @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility]
2014
+ required :merchant_ninety_percent_eligibility,
2015
+ enum: -> { Increase::CardPayment::Element::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility }
2016
+
2017
+ # @!method initialize(merchant_ninety_percent_eligibility:)
2018
+ # Some parameter documentations has been truncated, see
2019
+ # {Increase::Models::CardPayment::Element::CardAuthorization::Healthcare} for more
2020
+ # details.
2021
+ #
2022
+ # The healthcare-related fields for this authorization. Only present for specific
2023
+ # programs.
2024
+ #
2025
+ # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility] The merchant's eligibility under the Internal Revenue Service's 90% Rule for Fle
2026
+
2027
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
2028
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
2029
+ # products. The eligibility is determined based on the list of merchants
2030
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
2031
+ #
2032
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::Healthcare#merchant_ninety_percent_eligibility
2033
+ module MerchantNinetyPercentEligibility
2034
+ extend Increase::Internal::Type::Enum
2035
+
2036
+ # The merchant is eligible for treatment under the 90% rule.
2037
+ ELIGIBLE = :eligible
2038
+
2039
+ # The merchant is not eligible for treatment under the 90% rule.
2040
+ NOT_ELIGIBLE = :not_eligible
2041
+
2042
+ # @!method self.values
2043
+ # @return [Array<Symbol>]
2044
+ end
2045
+ end
2046
+
1990
2047
  # @see Increase::Models::CardPayment::Element::CardAuthorization#network_details
1991
2048
  class NetworkDetails < Increase::Internal::Type::BaseModel
1992
2049
  # @!attribute category
@@ -2343,6 +2400,9 @@ module Increase
2343
2400
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
2344
2401
  CASH_DISBURSEMENT = :cash_disbursement
2345
2402
 
2403
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
2404
+ CASH_DEPOSIT = :cash_deposit
2405
+
2346
2406
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
2347
2407
  BALANCE_INQUIRY = :balance_inquiry
2348
2408
 
@@ -5237,6 +5297,9 @@ module Increase
5237
5297
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
5238
5298
  CASH_DISBURSEMENT = :cash_disbursement
5239
5299
 
5300
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
5301
+ CASH_DEPOSIT = :cash_deposit
5302
+
5240
5303
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
5241
5304
  BALANCE_INQUIRY = :balance_inquiry
5242
5305
 
@@ -5315,7 +5378,7 @@ module Increase
5315
5378
  # The attempted card transaction is not allowed per Increase's terms.
5316
5379
  TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
5317
5380
 
5318
- # The transaction was blocked by a Limit.
5381
+ # The transaction was blocked by a limit or an authorization control.
5319
5382
  BREACHES_LIMIT = :breaches_limit
5320
5383
 
5321
5384
  # Your application declined the transaction via webhook.
@@ -5904,8 +5967,10 @@ module Increase
5904
5967
  # {Increase::Models::CardPayment::Element::CardFinancial} for more details.
5905
5968
  #
5906
5969
  # A Card Financial object. This field will be present in the JSON response if and
5907
- # only if `category` is equal to `card_financial`. Card Financials are temporary
5908
- # holds placed on a customer's funds with the intent to later clear a transaction.
5970
+ # only if `category` is equal to `card_financial`. Card Financials are card
5971
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
5972
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
5973
+ # single message.
5909
5974
  #
5910
5975
  # @param id [String] The Card Financial identifier.
5911
5976
  #
@@ -6773,6 +6838,9 @@ module Increase
6773
6838
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
6774
6839
  CASH_DISBURSEMENT = :cash_disbursement
6775
6840
 
6841
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
6842
+ CASH_DEPOSIT = :cash_deposit
6843
+
6776
6844
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
6777
6845
  BALANCE_INQUIRY = :balance_inquiry
6778
6846
 
@@ -95,6 +95,13 @@ module Increase
95
95
  # @return [String]
96
96
  required :merchant_city_name, String
97
97
 
98
+ # @!attribute merchant_legal_business_name
99
+ # The legal business name of the merchant (generally your business) sending the
100
+ # transfer.
101
+ #
102
+ # @return [String, nil]
103
+ required :merchant_legal_business_name, String, nil?: true
104
+
98
105
  # @!attribute merchant_name
99
106
  # The merchant name shows up as the statement descriptor for the transfer. This is
100
107
  # typically the name of your business or organization.
@@ -122,6 +129,13 @@ module Increase
122
129
  # @return [String]
123
130
  required :merchant_state, String
124
131
 
132
+ # @!attribute merchant_street_address
133
+ # The street address of the merchant (generally your business) sending the
134
+ # transfer.
135
+ #
136
+ # @return [String, nil]
137
+ required :merchant_street_address, String, nil?: true
138
+
125
139
  # @!attribute presentment_amount
126
140
  # The amount that was transferred. The receiving bank will have converted this to
127
141
  # the cardholder's currency. The amount that is applied to your Increase account
@@ -130,6 +144,32 @@ module Increase
130
144
  # @return [Increase::Models::CardPushTransfer::PresentmentAmount]
131
145
  required :presentment_amount, -> { Increase::CardPushTransfer::PresentmentAmount }
132
146
 
147
+ # @!attribute recipient_address_city
148
+ # The city of the recipient. Required if the card is issued in Canada.
149
+ #
150
+ # @return [String, nil]
151
+ required :recipient_address_city, String, nil?: true
152
+
153
+ # @!attribute recipient_address_line1
154
+ # The first line of the recipient's address. Required if the card is issued in
155
+ # Canada.
156
+ #
157
+ # @return [String, nil]
158
+ required :recipient_address_line1, String, nil?: true
159
+
160
+ # @!attribute recipient_address_postal_code
161
+ # The postal code of the recipient. Required if the card is issued in Canada.
162
+ #
163
+ # @return [String, nil]
164
+ required :recipient_address_postal_code, String, nil?: true
165
+
166
+ # @!attribute recipient_address_state
167
+ # The state or province of the recipient. Required if the card is issued in
168
+ # Canada.
169
+ #
170
+ # @return [String, nil]
171
+ required :recipient_address_state, String, nil?: true
172
+
133
173
  # @!attribute recipient_name
134
174
  # The name of the funds recipient.
135
175
  #
@@ -198,7 +238,7 @@ module Increase
198
238
  # @return [Symbol, Increase::Models::CardPushTransfer::Type]
199
239
  required :type, enum: -> { Increase::CardPushTransfer::Type }
200
240
 
201
- # @!method initialize(id:, acceptance:, account_id:, approval:, business_application_identifier:, cancellation:, card_token_id:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, presentment_amount:, recipient_name:, route:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, status:, submission:, type:)
241
+ # @!method initialize(id:, acceptance:, account_id:, approval:, business_application_identifier:, cancellation:, card_token_id:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_legal_business_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, merchant_street_address:, presentment_amount:, recipient_address_city:, recipient_address_line1:, recipient_address_postal_code:, recipient_address_state:, recipient_name:, route:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, status:, submission:, type:)
202
242
  # Some parameter documentations has been truncated, see
203
243
  # {Increase::Models::CardPushTransfer} for more details.
204
244
  #
@@ -230,6 +270,8 @@ module Increase
230
270
  #
231
271
  # @param merchant_city_name [String] The city name of the merchant (generally your business) sending the transfer.
232
272
  #
273
+ # @param merchant_legal_business_name [String, nil] The legal business name of the merchant (generally your business) sending the tr
274
+ #
233
275
  # @param merchant_name [String] The merchant name shows up as the statement descriptor for the transfer. This is
234
276
  #
235
277
  # @param merchant_name_prefix [String] For certain Business Application Identifiers, the statement descriptor is `merch
@@ -238,8 +280,18 @@ module Increase
238
280
  #
239
281
  # @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
240
282
  #
283
+ # @param merchant_street_address [String, nil] The street address of the merchant (generally your business) sending the transfe
284
+ #
241
285
  # @param presentment_amount [Increase::Models::CardPushTransfer::PresentmentAmount] The amount that was transferred. The receiving bank will have converted this to
242
286
  #
287
+ # @param recipient_address_city [String, nil] The city of the recipient. Required if the card is issued in Canada.
288
+ #
289
+ # @param recipient_address_line1 [String, nil] The first line of the recipient's address. Required if the card is issued in Can
290
+ #
291
+ # @param recipient_address_postal_code [String, nil] The postal code of the recipient. Required if the card is issued in Canada.
292
+ #
293
+ # @param recipient_address_state [String, nil] The state or province of the recipient. Required if the card is issued in Canada
294
+ #
243
295
  # @param recipient_name [String] The name of the funds recipient.
244
296
  #
245
297
  # @param route [Symbol, Increase::Models::CardPushTransfer::Route] The card network route used for the transfer.
@@ -506,12 +506,8 @@ module Increase
506
506
  # @!attribute shipping_method
507
507
  # The shipping method for the check.
508
508
  #
509
- # @return [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil]
510
- required :shipping_method,
511
- enum: -> {
512
- Increase::CheckTransfer::PhysicalCheck::ShippingMethod
513
- },
514
- nil?: true
509
+ # @return [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod]
510
+ required :shipping_method, enum: -> { Increase::CheckTransfer::PhysicalCheck::ShippingMethod }
515
511
 
516
512
  # @!attribute signature
517
513
  # The signature that will appear on the check.
@@ -549,7 +545,7 @@ module Increase
549
545
  #
550
546
  # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil] The return address to be printed on the check.
551
547
  #
552
- # @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil] The shipping method for the check.
548
+ # @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod] The shipping method for the check.
553
549
  #
554
550
  # @param signature [Increase::Models::CheckTransfer::PhysicalCheck::Signature] The signature that will appear on the check.
555
551
  #
@@ -789,7 +785,7 @@ module Increase
789
785
  # The check has been processed for delivery.
790
786
  PROCESSED_FOR_DELIVERY = :processed_for_delivery
791
787
 
792
- # The check has been delivered.
788
+ # The check has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single check may have more than one delivered event.
793
789
  DELIVERED = :delivered
794
790
 
795
791
  # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be returned to sender.
@@ -1541,6 +1541,9 @@ module Increase
1541
1541
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
1542
1542
  CASH_DISBURSEMENT = :cash_disbursement
1543
1543
 
1544
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
1545
+ CASH_DEPOSIT = :cash_deposit
1546
+
1544
1547
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
1545
1548
  BALANCE_INQUIRY = :balance_inquiry
1546
1549
 
@@ -1619,7 +1622,7 @@ module Increase
1619
1622
  # The attempted card transaction is not allowed per Increase's terms.
1620
1623
  TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
1621
1624
 
1622
- # The transaction was blocked by a Limit.
1625
+ # The transaction was blocked by a limit or an authorization control.
1623
1626
  BREACHES_LIMIT = :breaches_limit
1624
1627
 
1625
1628
  # Your application declined the transaction via webhook.