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
@@ -967,6 +967,13 @@ module Increase
967
967
  # @return [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction]
968
968
  required :direction, enum: -> { Increase::RealTimeDecision::CardAuthorization::Direction }
969
969
 
970
+ # @!attribute healthcare
971
+ # The healthcare-related fields for this authorization. Only present for specific
972
+ # programs.
973
+ #
974
+ # @return [Increase::Models::RealTimeDecision::CardAuthorization::Healthcare, nil]
975
+ required :healthcare, -> { Increase::RealTimeDecision::CardAuthorization::Healthcare }, nil?: true
976
+
970
977
  # @!attribute merchant_acceptor_id
971
978
  # The merchant identifier (commonly abbreviated as MID) of the merchant the card
972
979
  # is transacting with.
@@ -1109,7 +1116,7 @@ module Increase
1109
1116
  # @return [Increase::Models::RealTimeDecision::CardAuthorization::Verification]
1110
1117
  required :verification, -> { Increase::RealTimeDecision::CardAuthorization::Verification }
1111
1118
 
1112
- # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, decline:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, partial_approval_capability:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:)
1119
+ # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, decline:, digital_wallet_token_id:, direction:, 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:, partial_approval_capability:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:)
1113
1120
  # Some parameter documentations has been truncated, see
1114
1121
  # {Increase::Models::RealTimeDecision::CardAuthorization} for more details.
1115
1122
  #
@@ -1131,6 +1138,8 @@ module Increase
1131
1138
  #
1132
1139
  # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction] The direction describes the direction the funds will move, either from the cardh
1133
1140
  #
1141
+ # @param healthcare [Increase::Models::RealTimeDecision::CardAuthorization::Healthcare, nil] The healthcare-related fields for this authorization. Only present for specific
1142
+ #
1134
1143
  # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1135
1144
  #
1136
1145
  # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
@@ -1671,6 +1680,48 @@ module Increase
1671
1680
  # @return [Array<Symbol>]
1672
1681
  end
1673
1682
 
1683
+ # @see Increase::Models::RealTimeDecision::CardAuthorization#healthcare
1684
+ class Healthcare < Increase::Internal::Type::BaseModel
1685
+ # @!attribute merchant_ninety_percent_eligibility
1686
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1687
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1688
+ # products. The eligibility is determined based on the list of merchants
1689
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1690
+ #
1691
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility]
1692
+ required :merchant_ninety_percent_eligibility,
1693
+ enum: -> { Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility }
1694
+
1695
+ # @!method initialize(merchant_ninety_percent_eligibility:)
1696
+ # Some parameter documentations has been truncated, see
1697
+ # {Increase::Models::RealTimeDecision::CardAuthorization::Healthcare} for more
1698
+ # details.
1699
+ #
1700
+ # The healthcare-related fields for this authorization. Only present for specific
1701
+ # programs.
1702
+ #
1703
+ # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility] The merchant's eligibility under the Internal Revenue Service's 90% Rule for Fle
1704
+
1705
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1706
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1707
+ # products. The eligibility is determined based on the list of merchants
1708
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1709
+ #
1710
+ # @see Increase::Models::RealTimeDecision::CardAuthorization::Healthcare#merchant_ninety_percent_eligibility
1711
+ module MerchantNinetyPercentEligibility
1712
+ extend Increase::Internal::Type::Enum
1713
+
1714
+ # The merchant is eligible for treatment under the 90% rule.
1715
+ ELIGIBLE = :eligible
1716
+
1717
+ # The merchant is not eligible for treatment under the 90% rule.
1718
+ NOT_ELIGIBLE = :not_eligible
1719
+
1720
+ # @!method self.values
1721
+ # @return [Array<Symbol>]
1722
+ end
1723
+ end
1724
+
1674
1725
  # @see Increase::Models::RealTimeDecision::CardAuthorization#network_details
1675
1726
  class NetworkDetails < Increase::Internal::Type::BaseModel
1676
1727
  # @!attribute category
@@ -2044,6 +2095,9 @@ module Increase
2044
2095
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
2045
2096
  CASH_DISBURSEMENT = :cash_disbursement
2046
2097
 
2098
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
2099
+ CASH_DEPOSIT = :cash_deposit
2100
+
2047
2101
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
2048
2102
  BALANCE_INQUIRY = :balance_inquiry
2049
2103
 
@@ -67,6 +67,9 @@ module Increase
67
67
  # A savings account.
68
68
  SAVINGS = :savings
69
69
 
70
+ # A loan account used in a lender-borrower relationship. Uncommon.
71
+ LOAN = :loan
72
+
70
73
  # A bank's general ledger. Uncommon.
71
74
  GENERAL_LEDGER = :general_ledger
72
75
 
@@ -199,7 +199,7 @@ module Increase
199
199
  # The attempted card transaction is not allowed per Increase's terms.
200
200
  TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
201
201
 
202
- # The transaction was blocked by a Limit.
202
+ # The transaction was blocked by a limit or an authorization control.
203
203
  BREACHES_LIMIT = :breaches_limit
204
204
 
205
205
  # Your application declined the transaction via webhook.
@@ -355,6 +355,9 @@ module Increase
355
355
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
356
356
  CASH_DISBURSEMENT = :cash_disbursement
357
357
 
358
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
359
+ CASH_DEPOSIT = :cash_deposit
360
+
358
361
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
359
362
  BALANCE_INQUIRY = :balance_inquiry
360
363
 
@@ -182,7 +182,7 @@ module Increase
182
182
  # The attempted card transaction is not allowed per Increase's terms.
183
183
  TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
184
184
 
185
- # The transaction was blocked by a Limit.
185
+ # The transaction was blocked by a limit or an authorization control.
186
186
  BREACHES_LIMIT = :breaches_limit
187
187
 
188
188
  # Your application declined the transaction via webhook.
@@ -16,11 +16,15 @@ module Increase
16
16
 
17
17
  # @!attribute scan
18
18
  # If set, the simulation will use these values for the check's scanned MICR data.
19
+ # If not set, the simulation will use random values.
19
20
  #
20
21
  # @return [Increase::Models::Simulations::CheckDepositSubmitParams::Scan, nil]
21
22
  optional :scan, -> { Increase::Simulations::CheckDepositSubmitParams::Scan }
22
23
 
23
24
  # @!method initialize(check_deposit_id:, scan: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {Increase::Models::Simulations::CheckDepositSubmitParams} for more details.
27
+ #
24
28
  # @param check_deposit_id [String] The identifier of the Check Deposit you wish to submit.
25
29
  #
26
30
  # @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan] If set, the simulation will use these values for the check's scanned MICR data.
@@ -42,18 +46,33 @@ module Increase
42
46
 
43
47
  # @!attribute auxiliary_on_us
44
48
  # The auxiliary on-us data to be returned in the check deposit's scan data.
49
+ # Auxiliary on-us is typically the check number for business checks.
45
50
  #
46
51
  # @return [String, nil]
47
52
  optional :auxiliary_on_us, String
48
53
 
49
- # @!method initialize(account_number:, routing_number:, auxiliary_on_us: nil)
54
+ # @!attribute serial_number
55
+ # The serial number to be returned in the check deposit's scan data. Serial number
56
+ # is typically the check number for consumer checks.
57
+ #
58
+ # @return [String, nil]
59
+ optional :serial_number, String
60
+
61
+ # @!method initialize(account_number:, routing_number:, auxiliary_on_us: nil, serial_number: nil)
62
+ # Some parameter documentations has been truncated, see
63
+ # {Increase::Models::Simulations::CheckDepositSubmitParams::Scan} for more
64
+ # details.
65
+ #
50
66
  # If set, the simulation will use these values for the check's scanned MICR data.
67
+ # If not set, the simulation will use random values.
51
68
  #
52
69
  # @param account_number [String] The account number to be returned in the check deposit's scan data.
53
70
  #
54
71
  # @param routing_number [String] The routing number to be returned in the check deposit's scan data.
55
72
  #
56
- # @param auxiliary_on_us [String] The auxiliary on-us data to be returned in the check deposit's scan data.
73
+ # @param auxiliary_on_us [String] The auxiliary on-us data to be returned in the check deposit's scan data. Auxili
74
+ #
75
+ # @param serial_number [String] The serial number to be returned in the check deposit's scan data. Serial number
57
76
  end
58
77
  end
59
78
  end
@@ -60,6 +60,12 @@ module Increase
60
60
  # Your webhook declined the token provisioning attempt.
61
61
  WEBHOOK_DECLINED = :webhook_declined
62
62
 
63
+ # The tokenization attempt failed because the Card Verification Code (CVC) was incorrect.
64
+ INCORRECT_CARD_VERIFICATION_CODE = :incorrect_card_verification_code
65
+
66
+ # The tokenization attempt was declined by the token requestor.
67
+ DECLINED_BY_TOKEN_REQUESTOR = :declined_by_token_requestor
68
+
63
69
  # @!method self.values
64
70
  # @return [Array<Symbol>]
65
71
  end
@@ -48,7 +48,7 @@ module Increase
48
48
  module Category
49
49
  extend Increase::Internal::Type::Enum
50
50
 
51
- # 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).
51
+ # 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).
52
52
  ENTITY_TAX_IDENTIFIER = :entity_tax_identifier
53
53
 
54
54
  # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
@@ -97,6 +97,13 @@ module Increase
97
97
  # @return [String, nil]
98
98
  optional :instruction_identification, String
99
99
 
100
+ # @!attribute purpose
101
+ # The sending bank will set purpose in production. You can simulate any value
102
+ # here.
103
+ #
104
+ # @return [String, nil]
105
+ optional :purpose, String
106
+
100
107
  # @!attribute unique_end_to_end_transaction_reference
101
108
  # The sending bank will set unique_end_to_end_transaction_reference in production.
102
109
  # You can simulate any value here.
@@ -118,7 +125,7 @@ module Increase
118
125
  # @return [String, nil]
119
126
  optional :wire_drawdown_request_id, String
120
127
 
121
- # @!method initialize(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
128
+ # @!method initialize(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, purpose: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
122
129
  # Some parameter documentations has been truncated, see
123
130
  # {Increase::Models::Simulations::InboundWireTransferCreateParams} for more
124
131
  # details.
@@ -149,6 +156,8 @@ module Increase
149
156
  #
150
157
  # @param instruction_identification [String] The sending bank will set instruction_identification in production. You can simu
151
158
  #
159
+ # @param purpose [String] The sending bank will set purpose in production. You can simulate any value here
160
+ #
152
161
  # @param unique_end_to_end_transaction_reference [String] The sending bank will set unique_end_to_end_transaction_reference in production.
153
162
  #
154
163
  # @param unstructured_remittance_information [String] The sending bank will set unstructured_remittance_information in production. You
@@ -73,7 +73,7 @@ module Increase
73
73
  # The physical card has been processed for delivery.
74
74
  PROCESSED_FOR_DELIVERY = :processed_for_delivery
75
75
 
76
- # The physical card has been delivered.
76
+ # 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.
77
77
  DELIVERED = :delivered
78
78
 
79
79
  # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender.
@@ -24,8 +24,8 @@ module Increase
24
24
  required :amount, Integer
25
25
 
26
26
  # @!attribute created_at
27
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
28
- # Transaction occurred.
27
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
28
+ # the Transaction occurred.
29
29
  #
30
30
  # @return [Time]
31
31
  required :created_at, Time
@@ -89,7 +89,7 @@ module Increase
89
89
  #
90
90
  # @param amount [Integer] The Transaction amount in the minor unit of its currency. For dollars, for examp
91
91
  #
92
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transac
92
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
93
93
  #
94
94
  # @param currency [Symbol, Increase::Models::Transaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction'
95
95
  #
@@ -261,8 +261,10 @@ module Increase
261
261
 
262
262
  # @!attribute card_financial
263
263
  # A Card Financial object. This field will be present in the JSON response if and
264
- # only if `category` is equal to `card_financial`. Card Financials are temporary
265
- # holds placed on a customer's funds with the intent to later clear a transaction.
264
+ # only if `category` is equal to `card_financial`. Card Financials are card
265
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
266
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
267
+ # single message.
266
268
  #
267
269
  # @return [Increase::Models::Transaction::Source::CardFinancial, nil]
268
270
  optional :card_financial, -> { Increase::Transaction::Source::CardFinancial }, nil?: true
@@ -1650,8 +1652,10 @@ module Increase
1650
1652
  # {Increase::Models::Transaction::Source::CardFinancial} for more details.
1651
1653
  #
1652
1654
  # A Card Financial object. This field will be present in the JSON response if and
1653
- # only if `category` is equal to `card_financial`. Card Financials are temporary
1654
- # holds placed on a customer's funds with the intent to later clear a transaction.
1655
+ # only if `category` is equal to `card_financial`. Card Financials are card
1656
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
1657
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
1658
+ # single message.
1655
1659
  #
1656
1660
  # @param id [String] The Card Financial identifier.
1657
1661
  #
@@ -2519,6 +2523,9 @@ module Increase
2519
2523
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
2520
2524
  CASH_DISBURSEMENT = :cash_disbursement
2521
2525
 
2526
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
2527
+ CASH_DEPOSIT = :cash_deposit
2528
+
2522
2529
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
2523
2530
  BALANCE_INQUIRY = :balance_inquiry
2524
2531
 
@@ -7178,6 +7185,12 @@ module Increase
7178
7185
  # @return [String, nil]
7179
7186
  required :instruction_identification, String, nil?: true
7180
7187
 
7188
+ # @!attribute purpose
7189
+ # The reason for the wire transfer, as set by the sender.
7190
+ #
7191
+ # @return [String, nil]
7192
+ required :purpose, String, nil?: true
7193
+
7181
7194
  # @!attribute transfer_id
7182
7195
  # The ID of the Inbound Wire Transfer object that resulted in this Transaction.
7183
7196
  #
@@ -7198,7 +7211,7 @@ module Increase
7198
7211
  # @return [String, nil]
7199
7212
  required :unstructured_remittance_information, String, nil?: true
7200
7213
 
7201
- # @!method initialize(amount:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, transfer_id:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
7214
+ # @!method initialize(amount:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, transfer_id:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
7202
7215
  # Some parameter documentations has been truncated, see
7203
7216
  # {Increase::Models::Transaction::Source::InboundWireTransfer} for more details.
7204
7217
  #
@@ -7235,6 +7248,8 @@ module Increase
7235
7248
  #
7236
7249
  # @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
7237
7250
  #
7251
+ # @param purpose [String, nil] The reason for the wire transfer, as set by the sender.
7252
+ #
7238
7253
  # @param transfer_id [String] The ID of the Inbound Wire Transfer object that resulted in this Transaction.
7239
7254
  #
7240
7255
  # @param unique_end_to_end_transaction_reference [String, nil] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
@@ -279,6 +279,18 @@ module Increase
279
279
  # Occurs whenever an IntraFi Exclusion is updated.
280
280
  INTRAFI_EXCLUSION_UPDATED = :"intrafi_exclusion.updated"
281
281
 
282
+ # Occurs whenever a Loan Application is created.
283
+ LOAN_APPLICATION_CREATED = :"loan_application.created"
284
+
285
+ # Occurs whenever a Loan Application is updated.
286
+ LOAN_APPLICATION_UPDATED = :"loan_application.updated"
287
+
288
+ # Occurs whenever a Loan Offer is created.
289
+ LOAN_OFFER_CREATED = :"loan_offer.created"
290
+
291
+ # Occurs whenever a Loan Offer is updated.
292
+ LOAN_OFFER_UPDATED = :"loan_offer.updated"
293
+
282
294
  # Occurs whenever a Lockbox is created.
283
295
  LOCKBOX_CREATED = :"lockbox.created"
284
296
 
@@ -79,6 +79,13 @@ module Increase
79
79
  # @return [String]
80
80
  required :debtor_routing_number, String
81
81
 
82
+ # @!attribute end_to_end_identification
83
+ # A free-form reference string set by the sender, to be mirrored back in the
84
+ # subsequent wire transfer.
85
+ #
86
+ # @return [String, nil]
87
+ required :end_to_end_identification, String, nil?: true
88
+
82
89
  # @!attribute fulfillment_inbound_wire_transfer_id
83
90
  # If the recipient fulfills the drawdown request by sending funds, then this will
84
91
  # be the identifier of the corresponding Transaction.
@@ -114,13 +121,21 @@ module Increase
114
121
  # @return [Symbol, Increase::Models::WireDrawdownRequest::Type]
115
122
  required :type, enum: -> { Increase::WireDrawdownRequest::Type }
116
123
 
124
+ # @!attribute unique_end_to_end_transaction_reference
125
+ # The unique end-to-end transaction reference
126
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
127
+ # of the drawdown request.
128
+ #
129
+ # @return [String, nil]
130
+ required :unique_end_to_end_transaction_reference, String, nil?: true
131
+
117
132
  # @!attribute unstructured_remittance_information
118
133
  # Remittance information the debtor will see as part of the drawdown request.
119
134
  #
120
135
  # @return [String]
121
136
  required :unstructured_remittance_information, String
122
137
 
123
- # @!method initialize(id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unstructured_remittance_information:)
138
+ # @!method initialize(id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
124
139
  # Some parameter documentations has been truncated, see
125
140
  # {Increase::Models::WireDrawdownRequest} for more details.
126
141
  #
@@ -155,6 +170,8 @@ module Increase
155
170
  #
156
171
  # @param debtor_routing_number [String] The debtor's routing number.
157
172
  #
173
+ # @param end_to_end_identification [String, nil] A free-form reference string set by the sender, to be mirrored back in the subse
174
+ #
158
175
  # @param fulfillment_inbound_wire_transfer_id [String, nil] If the recipient fulfills the drawdown request by sending funds, then this will
159
176
  #
160
177
  # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
@@ -165,6 +182,8 @@ module Increase
165
182
  #
166
183
  # @param type [Symbol, Increase::Models::WireDrawdownRequest::Type] A constant representing the object's type. For this resource it will always be `
167
184
  #
185
+ # @param unique_end_to_end_transaction_reference [String, nil] The unique end-to-end transaction reference ([UETR](https://www.swift.com/paymen
186
+ #
168
187
  # @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the drawdown request.
169
188
 
170
189
  # @see Increase::Models::WireDrawdownRequest#creditor_address
@@ -64,7 +64,10 @@ module Increase
64
64
  #
65
65
  # @param headers [Hash{String=>String}] The raw HTTP headers that came with the payload
66
66
  #
67
- # @param key [String, nil] The webhook signing key
67
+ # @param key [String, nil] The webhook signing key, as the raw secret string. It is Base64-encoded before
68
+ # being passed to StandardWebhooks, so to sign a synthetic payload in tests,
69
+ # construct the signer the same way:
70
+ # StandardWebhooks::Webhook.new(Base64.strict_encode64(key))
68
71
  #
69
72
  # @return [Increase::Models::UnwrapWebhookEvent]
70
73
  def unwrap(payload, headers:, key: @client.webhook_secret)
@@ -8,7 +8,7 @@ module Increase
8
8
  #
9
9
  # Create an Export
10
10
  #
11
- # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
11
+ # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, fee_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
12
12
  #
13
13
  # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
14
14
  #
@@ -25,6 +25,8 @@ module Increase
25
25
  #
26
26
  # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
27
27
  #
28
+ # @param fee_csv [Increase::Models::ExportCreateParams::FeeCsv] Options for the created export. Required if `category` is equal to `fee_csv`.
29
+ #
28
30
  # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
29
31
  #
30
32
  # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
@@ -79,6 +79,9 @@ module Increase
79
79
  )
80
80
  end
81
81
 
82
+ # Some parameter documentations has been truncated, see
83
+ # {Increase::Models::Simulations::CheckDepositSubmitParams} for more details.
84
+ #
82
85
  # Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
83
86
  # Reserve. This Check Deposit must first have a `status` of `pending`.
84
87
  #
@@ -10,7 +10,7 @@ module Increase
10
10
  #
11
11
  # Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.
12
12
  #
13
- # @overload create(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
13
+ # @overload create(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, purpose: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
14
14
  #
15
15
  # @param account_number_id [String] The identifier of the Account Number the inbound Wire Transfer is for.
16
16
  #
@@ -38,6 +38,8 @@ module Increase
38
38
  #
39
39
  # @param instruction_identification [String] The sending bank will set instruction_identification in production. You can simu
40
40
  #
41
+ # @param purpose [String] The sending bank will set purpose in production. You can simulate any value here
42
+ #
41
43
  # @param unique_end_to_end_transaction_reference [String] The sending bank will set unique_end_to_end_transaction_reference in production.
42
44
  #
43
45
  # @param unstructured_remittance_information [String] The sending bank will set unstructured_remittance_information in production. You
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.333.1"
4
+ VERSION = "1.335.0"
5
5
  end
@@ -259,14 +259,14 @@ module Increase
259
259
  end
260
260
  OrSymbol = T.type_alias { T.any(Symbol, String) }
261
261
 
262
- # The Prenotification is for an anticipated credit.
262
+ # Credit
263
263
  CREDIT =
264
264
  T.let(
265
265
  :credit,
266
266
  Increase::ACHPrenotification::CreditDebitIndicator::TaggedSymbol
267
267
  )
268
268
 
269
- # The Prenotification is for an anticipated debit.
269
+ # Debit
270
270
  DEBIT =
271
271
  T.let(
272
272
  :debit,
@@ -568,6 +568,13 @@ module Increase
568
568
  Increase::ACHPrenotification::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
569
569
  )
570
570
 
571
+ # A loan account used in a lender-borrower relationship. Uncommon.
572
+ LOAN =
573
+ T.let(
574
+ :loan,
575
+ Increase::ACHPrenotification::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
576
+ )
577
+
571
578
  # A bank's general ledger. Uncommon.
572
579
  GENERAL_LEDGER =
573
580
  T.let(
@@ -217,14 +217,14 @@ module Increase
217
217
  end
218
218
  OrSymbol = T.type_alias { T.any(Symbol, String) }
219
219
 
220
- # The Prenotification is for an anticipated credit.
220
+ # Credit
221
221
  CREDIT =
222
222
  T.let(
223
223
  :credit,
224
224
  Increase::ACHPrenotificationCreateParams::CreditDebitIndicator::TaggedSymbol
225
225
  )
226
226
 
227
- # The Prenotification is for an anticipated debit.
227
+ # Debit
228
228
  DEBIT =
229
229
  T.let(
230
230
  :debit,
@@ -161,8 +161,8 @@ module Increase
161
161
  sig { returns(Increase::ACHTransfer::Network::TaggedSymbol) }
162
162
  attr_accessor :network
163
163
 
164
- # If the receiving bank accepts the transfer but notifies that future transfers
165
- # should use different details, this will contain those details.
164
+ # If the receiving bank notifies that future transfers should use different
165
+ # details, this will contain those details.
166
166
  sig { returns(T::Array[Increase::ACHTransfer::NotificationsOfChange]) }
167
167
  attr_accessor :notifications_of_change
168
168
 
@@ -363,8 +363,8 @@ module Increase
363
363
  individual_name:,
364
364
  # The transfer's network.
365
365
  network:,
366
- # If the receiving bank accepts the transfer but notifies that future transfers
367
- # should use different details, this will contain those details.
366
+ # If the receiving bank notifies that future transfers should use different
367
+ # details, this will contain those details.
368
368
  notifications_of_change:,
369
369
  # The ID for the pending transaction representing the transfer. A pending
370
370
  # transaction is created when the transfer
@@ -1146,6 +1146,9 @@ module Increase
1146
1146
  # A savings account.
1147
1147
  SAVINGS = T.let(:savings, Increase::ACHTransfer::Funding::TaggedSymbol)
1148
1148
 
1149
+ # A loan account used in a lender-borrower relationship. Uncommon.
1150
+ LOAN = T.let(:loan, Increase::ACHTransfer::Funding::TaggedSymbol)
1151
+
1149
1152
  # A bank's general ledger. Uncommon.
1150
1153
  GENERAL_LEDGER =
1151
1154
  T.let(:general_ledger, Increase::ACHTransfer::Funding::TaggedSymbol)
@@ -1676,6 +1679,13 @@ module Increase
1676
1679
  Increase::ACHTransfer::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
1677
1680
  )
1678
1681
 
1682
+ # A loan account used in a lender-borrower relationship. Uncommon.
1683
+ LOAN =
1684
+ T.let(
1685
+ :loan,
1686
+ Increase::ACHTransfer::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
1687
+ )
1688
+
1679
1689
  # A bank's general ledger. Uncommon.
1680
1690
  GENERAL_LEDGER =
1681
1691
  T.let(
@@ -706,6 +706,10 @@ module Increase
706
706
  Increase::ACHTransferCreateParams::Funding::TaggedSymbol
707
707
  )
708
708
 
709
+ # A loan account used in a lender-borrower relationship. Uncommon.
710
+ LOAN =
711
+ T.let(:loan, Increase::ACHTransferCreateParams::Funding::TaggedSymbol)
712
+
709
713
  # A bank's general ledger. Uncommon.
710
714
  GENERAL_LEDGER =
711
715
  T.let(
@@ -35,6 +35,10 @@ module Increase
35
35
  end
36
36
  attr_writer :billing_address
37
37
 
38
+ # The Bank Identification Number (BIN) of the Card.
39
+ sig { returns(String) }
40
+ attr_accessor :bin
41
+
38
42
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
39
43
  # the Card was created.
40
44
  sig { returns(Time) }
@@ -100,6 +104,7 @@ module Increase
100
104
  authorization_controls:
101
105
  T.nilable(Increase::Card::AuthorizationControls::OrHash),
102
106
  billing_address: Increase::Card::BillingAddress::OrHash,
107
+ bin: String,
103
108
  created_at: Time,
104
109
  description: T.nilable(String),
105
110
  digital_wallet: T.nilable(Increase::Card::DigitalWallet::OrHash),
@@ -121,6 +126,8 @@ module Increase
121
126
  authorization_controls:,
122
127
  # The Card's billing address.
123
128
  billing_address:,
129
+ # The Bank Identification Number (BIN) of the Card.
130
+ bin:,
124
131
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
125
132
  # the Card was created.
126
133
  created_at:,
@@ -158,6 +165,7 @@ module Increase
158
165
  authorization_controls:
159
166
  T.nilable(Increase::Card::AuthorizationControls),
160
167
  billing_address: Increase::Card::BillingAddress,
168
+ bin: String,
161
169
  created_at: Time,
162
170
  description: T.nilable(String),
163
171
  digital_wallet: T.nilable(Increase::Card::DigitalWallet),