increase 1.353.0 → 1.355.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 (152) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +18 -0
  4. data/lib/increase/models/ach_transfer.rb +3 -3
  5. data/lib/increase/models/beneficial_owner_create_params.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_update_params.rb +1 -1
  7. data/lib/increase/models/card_create_details_token_params.rb +22 -0
  8. data/lib/increase/models/card_details_token.rb +57 -0
  9. data/lib/increase/models/card_payment.rb +29 -1
  10. data/lib/increase/models/declined_transaction.rb +3 -0
  11. data/lib/increase/models/digital_wallet_token.rb +18 -0
  12. data/lib/increase/models/digital_wallet_token_request.rb +307 -0
  13. data/lib/increase/models/digital_wallet_token_request_list_params.rb +99 -0
  14. data/lib/increase/models/digital_wallet_token_request_retrieve_params.rb +22 -0
  15. data/lib/increase/models/digital_wallet_token_transition_params.rb +48 -0
  16. data/lib/increase/models/entity.rb +35 -7
  17. data/lib/increase/models/entity_beneficial_owner.rb +1 -1
  18. data/lib/increase/models/entity_create_params.rb +1 -1
  19. data/lib/increase/models/export.rb +19 -19
  20. data/lib/increase/models/export_create_params.rb +15 -15
  21. data/lib/increase/models/export_list_params.rb +19 -19
  22. data/lib/increase/models/inbound_real_time_payments_request_for_payment.rb +318 -0
  23. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rb +113 -0
  24. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rb +25 -0
  25. data/lib/increase/models/inbound_wire_transfer.rb +10 -1
  26. data/lib/increase/models/physical_check_batch.rb +266 -0
  27. data/lib/increase/models/physical_check_batch_cancel_params.rb +22 -0
  28. data/lib/increase/models/physical_check_batch_complete_params.rb +22 -0
  29. data/lib/increase/models/physical_check_batch_create_params.rb +189 -0
  30. data/lib/increase/models/real_time_decision.rb +9 -0
  31. data/lib/increase/models/real_time_decision_action_params.rb +3 -0
  32. data/lib/increase/models/real_time_payments_request_for_payment.rb +658 -0
  33. data/lib/increase/models/real_time_payments_requests_for_payment_cancel_params.rb +64 -0
  34. data/lib/increase/models/real_time_payments_requests_for_payment_create_params.rb +194 -0
  35. data/lib/increase/models/real_time_payments_requests_for_payment_list_params.rb +117 -0
  36. data/lib/increase/models/real_time_payments_requests_for_payment_retrieve_params.rb +23 -0
  37. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -0
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  39. data/lib/increase/models/simulations/fednow_transfer_complete_params.rb +103 -0
  40. data/lib/increase/models/simulations/inbound_check_deposit_accept_params.rb +24 -0
  41. data/lib/increase/models/transaction.rb +36 -2
  42. data/lib/increase/models.rb +42 -0
  43. data/lib/increase/resources/cards.rb +23 -0
  44. data/lib/increase/resources/digital_wallet_token_requests.rb +68 -0
  45. data/lib/increase/resources/digital_wallet_tokens.rb +28 -0
  46. data/lib/increase/resources/inbound_real_time_payments_requests_for_payment.rb +79 -0
  47. data/lib/increase/resources/physical_check_batches.rb +86 -0
  48. data/lib/increase/resources/real_time_payments_requests_for_payment.rb +159 -0
  49. data/lib/increase/resources/simulations/fednow_transfers.rb +43 -0
  50. data/lib/increase/resources/simulations/inbound_check_deposits.rb +22 -0
  51. data/lib/increase/resources/simulations.rb +4 -0
  52. data/lib/increase/version.rb +1 -1
  53. data/lib/increase.rb +25 -0
  54. data/rbi/increase/client.rbi +14 -0
  55. data/rbi/increase/models/ach_transfer.rbi +3 -3
  56. data/rbi/increase/models/beneficial_owner_create_params.rbi +1 -1
  57. data/rbi/increase/models/beneficial_owner_update_params.rbi +1 -1
  58. data/rbi/increase/models/card_create_details_token_params.rbi +43 -0
  59. data/rbi/increase/models/card_details_token.rbi +85 -0
  60. data/rbi/increase/models/card_payment.rbi +59 -0
  61. data/rbi/increase/models/declined_transaction.rbi +7 -0
  62. data/rbi/increase/models/digital_wallet_token.rbi +42 -0
  63. data/rbi/increase/models/digital_wallet_token_request.rbi +586 -0
  64. data/rbi/increase/models/digital_wallet_token_request_list_params.rbi +171 -0
  65. data/rbi/increase/models/digital_wallet_token_request_retrieve_params.rbi +46 -0
  66. data/rbi/increase/models/digital_wallet_token_transition_params.rbi +100 -0
  67. data/rbi/increase/models/entity.rbi +71 -6
  68. data/rbi/increase/models/entity_beneficial_owner.rbi +1 -1
  69. data/rbi/increase/models/entity_create_params.rbi +1 -1
  70. data/rbi/increase/models/export.rbi +32 -32
  71. data/rbi/increase/models/export_create_params.rbi +29 -29
  72. data/rbi/increase/models/export_list_params.rbi +37 -37
  73. data/rbi/increase/models/inbound_real_time_payments_request_for_payment.rbi +442 -0
  74. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbi +188 -0
  75. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbi +48 -0
  76. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  77. data/rbi/increase/models/physical_check_batch.rbi +382 -0
  78. data/rbi/increase/models/physical_check_batch_cancel_params.rbi +46 -0
  79. data/rbi/increase/models/physical_check_batch_complete_params.rbi +46 -0
  80. data/rbi/increase/models/physical_check_batch_create_params.rbi +326 -0
  81. data/rbi/increase/models/real_time_decision.rbi +21 -0
  82. data/rbi/increase/models/real_time_decision_action_params.rbi +7 -0
  83. data/rbi/increase/models/real_time_payments_request_for_payment.rbi +1166 -0
  84. data/rbi/increase/models/real_time_payments_requests_for_payment_cancel_params.rbi +136 -0
  85. data/rbi/increase/models/real_time_payments_requests_for_payment_create_params.rbi +303 -0
  86. data/rbi/increase/models/real_time_payments_requests_for_payment_list_params.rbi +192 -0
  87. data/rbi/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbi +46 -0
  88. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +21 -0
  89. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  90. data/rbi/increase/models/simulations/fednow_transfer_complete_params.rbi +243 -0
  91. data/rbi/increase/models/simulations/inbound_check_deposit_accept_params.rbi +48 -0
  92. data/rbi/increase/models/transaction.rbi +60 -0
  93. data/rbi/increase/models.rbi +50 -0
  94. data/rbi/increase/resources/cards.rbi +17 -0
  95. data/rbi/increase/resources/digital_wallet_token_requests.rbi +52 -0
  96. data/rbi/increase/resources/digital_wallet_tokens.rbi +21 -0
  97. data/rbi/increase/resources/inbound_real_time_payments_requests_for_payment.rbi +62 -0
  98. data/rbi/increase/resources/physical_check_batches.rbi +66 -0
  99. data/rbi/increase/resources/real_time_payments_requests_for_payment.rbi +127 -0
  100. data/rbi/increase/resources/simulations/fednow_transfers.rbi +34 -0
  101. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +16 -0
  102. data/rbi/increase/resources/simulations.rbi +3 -0
  103. data/sig/increase/client.rbs +8 -0
  104. data/sig/increase/models/ach_transfer.rbs +4 -4
  105. data/sig/increase/models/beneficial_owner_create_params.rbs +1 -1
  106. data/sig/increase/models/beneficial_owner_update_params.rbs +1 -1
  107. data/sig/increase/models/card_create_details_token_params.rbs +23 -0
  108. data/sig/increase/models/card_details_token.rbs +40 -0
  109. data/sig/increase/models/card_payment.rbs +23 -0
  110. data/sig/increase/models/declined_transaction.rbs +4 -0
  111. data/sig/increase/models/digital_wallet_token.rbs +36 -3
  112. data/sig/increase/models/digital_wallet_token_request.rbs +260 -0
  113. data/sig/increase/models/digital_wallet_token_request_list_params.rbs +86 -0
  114. data/sig/increase/models/digital_wallet_token_request_retrieve_params.rbs +24 -0
  115. data/sig/increase/models/digital_wallet_token_transition_params.rbs +48 -0
  116. data/sig/increase/models/entity.rbs +25 -6
  117. data/sig/increase/models/entity_beneficial_owner.rbs +1 -1
  118. data/sig/increase/models/entity_create_params.rbs +1 -1
  119. data/sig/increase/models/export.rbs +28 -28
  120. data/sig/increase/models/export_create_params.rbs +22 -22
  121. data/sig/increase/models/export_list_params.rbs +28 -28
  122. data/sig/increase/models/inbound_real_time_payments_request_for_payment.rbs +200 -0
  123. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbs +93 -0
  124. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  125. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  126. data/sig/increase/models/physical_check_batch.rbs +193 -0
  127. data/sig/increase/models/physical_check_batch_cancel_params.rbs +24 -0
  128. data/sig/increase/models/physical_check_batch_complete_params.rbs +24 -0
  129. data/sig/increase/models/physical_check_batch_create_params.rbs +156 -0
  130. data/sig/increase/models/real_time_decision.rbs +14 -2
  131. data/sig/increase/models/real_time_decision_action_params.rbs +4 -0
  132. data/sig/increase/models/real_time_payments_request_for_payment.rbs +513 -0
  133. data/sig/increase/models/real_time_payments_requests_for_payment_cancel_params.rbs +66 -0
  134. data/sig/increase/models/real_time_payments_requests_for_payment_create_params.rbs +149 -0
  135. data/sig/increase/models/real_time_payments_requests_for_payment_list_params.rbs +93 -0
  136. data/sig/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  137. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +12 -0
  138. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  139. data/sig/increase/models/simulations/fednow_transfer_complete_params.rbs +122 -0
  140. data/sig/increase/models/simulations/inbound_check_deposit_accept_params.rbs +26 -0
  141. data/sig/increase/models/transaction.rbs +24 -0
  142. data/sig/increase/models.rbs +36 -0
  143. data/sig/increase/resources/cards.rbs +5 -0
  144. data/sig/increase/resources/digital_wallet_token_requests.rbs +20 -0
  145. data/sig/increase/resources/digital_wallet_tokens.rbs +6 -0
  146. data/sig/increase/resources/inbound_real_time_payments_requests_for_payment.rbs +21 -0
  147. data/sig/increase/resources/physical_check_batches.rbs +24 -0
  148. data/sig/increase/resources/real_time_payments_requests_for_payment.rbs +41 -0
  149. data/sig/increase/resources/simulations/fednow_transfers.rbs +15 -0
  150. data/sig/increase/resources/simulations/inbound_check_deposits.rbs +5 -0
  151. data/sig/increase/resources/simulations.rbs +2 -0
  152. metadata +77 -2
@@ -0,0 +1,64 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::RealTimePaymentsRequestsForPayment#cancel
6
+ class RealTimePaymentsRequestsForPaymentCancelParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute real_time_payments_request_for_payment_id
11
+ # The identifier of the Real-Time Payments Request for Payment to cancel.
12
+ #
13
+ # @return [String]
14
+ required :real_time_payments_request_for_payment_id, String
15
+
16
+ # @!attribute additional_information
17
+ # Additional information about the cancellation to pass on to the recipient bank.
18
+ #
19
+ # @return [String, nil]
20
+ optional :additional_information, String
21
+
22
+ # @!attribute reason
23
+ # The reason the request for payment is being canceled. Defaults to
24
+ # `requested_by_customer`.
25
+ #
26
+ # @return [Symbol, Increase::Models::RealTimePaymentsRequestsForPaymentCancelParams::Reason, nil]
27
+ optional :reason, enum: -> { Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason }
28
+
29
+ # @!method initialize(real_time_payments_request_for_payment_id:, additional_information: nil, reason: nil, request_options: {})
30
+ # @param real_time_payments_request_for_payment_id [String]
31
+ # The identifier of the Real-Time Payments Request for Payment to cancel.
32
+ #
33
+ # @param additional_information [String]
34
+ # Additional information about the cancellation to pass on to the recipient bank.
35
+ #
36
+ # @param reason [Symbol, Increase::Models::RealTimePaymentsRequestsForPaymentCancelParams::Reason]
37
+ # The reason the request for payment is being canceled. Defaults to
38
+ # `requested_by_customer`.
39
+ #
40
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
41
+
42
+ # The reason the request for payment is being canceled. Defaults to
43
+ # `requested_by_customer`.
44
+ module Reason
45
+ extend Increase::Internal::Type::Enum
46
+
47
+ # The creditor no longer wants to be paid. Corresponds to the Real-Time Payments reason code `CUST`.
48
+ REQUESTED_BY_CUSTOMER = :requested_by_customer
49
+
50
+ # The requested payment has already been made through another channel. Corresponds to the Real-Time Payments reason code `UPAY`.
51
+ PAID_BY_OTHER_MEANS = :paid_by_other_means
52
+
53
+ # The request for payment duplicated another request for payment. Corresponds to the Real-Time Payments reason code `DUPL`.
54
+ DUPLICATE = :duplicate
55
+
56
+ # The request for payment was sent for the wrong amount. Corresponds to the Real-Time Payments reason code `AM09`.
57
+ WRONG_AMOUNT = :wrong_amount
58
+
59
+ # @!method self.values
60
+ # @return [Array<Symbol>]
61
+ end
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,194 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::RealTimePaymentsRequestsForPayment#create
6
+ class RealTimePaymentsRequestsForPaymentCreateParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute account_number_id
11
+ # The identifier of the Account Number where the funds will land.
12
+ #
13
+ # @return [String]
14
+ required :account_number_id, String
15
+
16
+ # @!attribute amount
17
+ # The requested amount in USD cents. Must be positive.
18
+ #
19
+ # @return [Integer]
20
+ required :amount, Integer
21
+
22
+ # @!attribute debtor
23
+ # Details of the person being requested to pay.
24
+ #
25
+ # @return [Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams::Debtor]
26
+ required :debtor, -> { Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor }
27
+
28
+ # @!attribute debtor_account_number
29
+ # The debtor's account number, which the funds will be requested from.
30
+ #
31
+ # @return [String]
32
+ required :debtor_account_number, String
33
+
34
+ # @!attribute debtor_routing_number
35
+ # The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
36
+ #
37
+ # @return [String]
38
+ required :debtor_routing_number, String
39
+
40
+ # @!attribute expires_at
41
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
42
+ # the request for payment is no longer valid. After this time the debtor's bank
43
+ # should no longer allow the debtor to pay it. Must not be before
44
+ # `requested_execution_at`.
45
+ #
46
+ # @return [Time]
47
+ required :expires_at, Time
48
+
49
+ # @!attribute requested_execution_at
50
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
51
+ # you are requesting the payment to be made.
52
+ #
53
+ # @return [Time]
54
+ required :requested_execution_at, Time
55
+
56
+ # @!attribute unstructured_remittance_information
57
+ # Unstructured information that will show on the recipient's bank statement.
58
+ #
59
+ # @return [String]
60
+ required :unstructured_remittance_information, String
61
+
62
+ # @!attribute creditor_name
63
+ # The name of the creditor requesting the payment. If not provided, defaults to
64
+ # the name of the account's entity.
65
+ #
66
+ # @return [String, nil]
67
+ optional :creditor_name, String
68
+
69
+ # @!method initialize(account_number_id:, amount:, debtor:, debtor_account_number:, debtor_routing_number:, expires_at:, requested_execution_at:, unstructured_remittance_information:, creditor_name: nil, request_options: {})
70
+ # @param account_number_id [String] The identifier of the Account Number where the funds will land.
71
+ #
72
+ # @param amount [Integer] The requested amount in USD cents. Must be positive.
73
+ #
74
+ # @param debtor [Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams::Debtor]
75
+ # Details of the person being requested to pay.
76
+ #
77
+ # @param debtor_account_number [String] The debtor's account number, which the funds will be requested from.
78
+ #
79
+ # @param debtor_routing_number [String]
80
+ # The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
81
+ #
82
+ # @param expires_at [Time]
83
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
84
+ # the request for payment is no longer valid. After this time the debtor's bank
85
+ # should no longer allow the debtor to pay it. Must not be before
86
+ # `requested_execution_at`.
87
+ #
88
+ # @param requested_execution_at [Time]
89
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
90
+ # you are requesting the payment to be made.
91
+ #
92
+ # @param unstructured_remittance_information [String]
93
+ # Unstructured information that will show on the recipient's bank statement.
94
+ #
95
+ # @param creditor_name [String]
96
+ # The name of the creditor requesting the payment. If not provided, defaults to
97
+ # the name of the account's entity.
98
+ #
99
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
100
+
101
+ class Debtor < Increase::Internal::Type::BaseModel
102
+ # @!attribute address
103
+ # Address of the debtor.
104
+ #
105
+ # @return [Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address]
106
+ required :address, -> { Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address }
107
+
108
+ # @!attribute name
109
+ # The name of the debtor.
110
+ #
111
+ # @return [String]
112
+ required :name, String
113
+
114
+ # @!method initialize(address:, name:)
115
+ # Details of the person being requested to pay.
116
+ #
117
+ # @param address [Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address]
118
+ # Address of the debtor.
119
+ #
120
+ # @param name [String] The name of the debtor.
121
+
122
+ # @see Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams::Debtor#address
123
+ class Address < Increase::Internal::Type::BaseModel
124
+ # @!attribute country
125
+ # The ISO 3166, Alpha-2 country code.
126
+ #
127
+ # Defaults to `US`.
128
+ #
129
+ # @return [String]
130
+ required :country, String
131
+
132
+ # @!attribute address_line2
133
+ # A second address line, such as an apartment or suite number. The first address
134
+ # line is separated into `building_number` and `street_name`.
135
+ #
136
+ # @return [String, nil]
137
+ optional :address_line2, String
138
+
139
+ # @!attribute building_number
140
+ # The number identifying the position of the building on the street.
141
+ #
142
+ # @return [String, nil]
143
+ optional :building_number, String
144
+
145
+ # @!attribute city
146
+ # The town or city.
147
+ #
148
+ # @return [String, nil]
149
+ optional :city, String
150
+
151
+ # @!attribute postal_code
152
+ # The postal code or zip.
153
+ #
154
+ # @return [String, nil]
155
+ optional :postal_code, String
156
+
157
+ # @!attribute state
158
+ # The US state component of the address.
159
+ #
160
+ # @return [String, nil]
161
+ optional :state, String
162
+
163
+ # @!attribute street_name
164
+ # The street name without the street number.
165
+ #
166
+ # @return [String, nil]
167
+ optional :street_name, String
168
+
169
+ # @!method initialize(country:, address_line2: nil, building_number: nil, city: nil, postal_code: nil, state: nil, street_name: nil)
170
+ # Address of the debtor.
171
+ #
172
+ # @param country [String]
173
+ # The ISO 3166, Alpha-2 country code.
174
+ #
175
+ # Defaults to `US`.
176
+ #
177
+ # @param address_line2 [String]
178
+ # A second address line, such as an apartment or suite number. The first address
179
+ # line is separated into `building_number` and `street_name`.
180
+ #
181
+ # @param building_number [String] The number identifying the position of the building on the street.
182
+ #
183
+ # @param city [String] The town or city.
184
+ #
185
+ # @param postal_code [String] The postal code or zip.
186
+ #
187
+ # @param state [String] The US state component of the address.
188
+ #
189
+ # @param street_name [String] The street name without the street number.
190
+ end
191
+ end
192
+ end
193
+ end
194
+ end
@@ -0,0 +1,117 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::RealTimePaymentsRequestsForPayment#list
6
+ class RealTimePaymentsRequestsForPaymentListParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute account_id
11
+ # Filter Real-Time Payments Requests for Payment to those destined to the
12
+ # specified Account.
13
+ #
14
+ # @return [String, nil]
15
+ optional :account_id, String
16
+
17
+ # @!attribute created_at
18
+ #
19
+ # @return [Increase::Models::RealTimePaymentsRequestsForPaymentListParams::CreatedAt, nil]
20
+ optional :created_at, -> { Increase::RealTimePaymentsRequestsForPaymentListParams::CreatedAt }
21
+
22
+ # @!attribute cursor
23
+ # Return the page of entries after this one.
24
+ #
25
+ # @return [String, nil]
26
+ optional :cursor, String
27
+
28
+ # @!attribute idempotency_key
29
+ # Filter records to the one with the specified `idempotency_key` you chose for
30
+ # that object. This value is unique across Increase and is used to ensure that a
31
+ # request is only processed once. Learn more about
32
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
33
+ #
34
+ # @return [String, nil]
35
+ optional :idempotency_key, String
36
+
37
+ # @!attribute limit
38
+ # Limit the size of the list that is returned. The default (and maximum) is 100
39
+ # objects.
40
+ #
41
+ # Defaults to `100`.
42
+ #
43
+ # @return [Integer, nil]
44
+ optional :limit, Integer
45
+
46
+ # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
47
+ # @param account_id [String]
48
+ # Filter Real-Time Payments Requests for Payment to those destined to the
49
+ # specified Account.
50
+ #
51
+ # @param created_at [Increase::Models::RealTimePaymentsRequestsForPaymentListParams::CreatedAt]
52
+ #
53
+ # @param cursor [String] Return the page of entries after this one.
54
+ #
55
+ # @param idempotency_key [String]
56
+ # Filter records to the one with the specified `idempotency_key` you chose for
57
+ # that object. This value is unique across Increase and is used to ensure that a
58
+ # request is only processed once. Learn more about
59
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
60
+ #
61
+ # @param limit [Integer]
62
+ # Limit the size of the list that is returned. The default (and maximum) is 100
63
+ # objects.
64
+ #
65
+ # Defaults to `100`.
66
+ #
67
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
68
+
69
+ class CreatedAt < Increase::Internal::Type::BaseModel
70
+ # @!attribute after
71
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
72
+ # timestamp.
73
+ #
74
+ # @return [Time, nil]
75
+ optional :after, Time
76
+
77
+ # @!attribute before
78
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
79
+ # timestamp.
80
+ #
81
+ # @return [Time, nil]
82
+ optional :before, Time
83
+
84
+ # @!attribute on_or_after
85
+ # Return results on or after this
86
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
87
+ #
88
+ # @return [Time, nil]
89
+ optional :on_or_after, Time
90
+
91
+ # @!attribute on_or_before
92
+ # Return results on or before this
93
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
94
+ #
95
+ # @return [Time, nil]
96
+ optional :on_or_before, Time
97
+
98
+ # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
99
+ # @param after [Time]
100
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
101
+ # timestamp.
102
+ #
103
+ # @param before [Time]
104
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
105
+ # timestamp.
106
+ #
107
+ # @param on_or_after [Time]
108
+ # Return results on or after this
109
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
110
+ #
111
+ # @param on_or_before [Time]
112
+ # Return results on or before this
113
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
114
+ end
115
+ end
116
+ end
117
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::RealTimePaymentsRequestsForPayment#retrieve
6
+ class RealTimePaymentsRequestsForPaymentRetrieveParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute real_time_payments_request_for_payment_id
11
+ # The identifier of the Real-Time Payments Request for Payment.
12
+ #
13
+ # @return [String]
14
+ required :real_time_payments_request_for_payment_id, String
15
+
16
+ # @!method initialize(real_time_payments_request_for_payment_id:, request_options: {})
17
+ # @param real_time_payments_request_for_payment_id [String]
18
+ # The identifier of the Real-Time Payments Request for Payment.
19
+ #
20
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
21
+ end
22
+ end
23
+ end
@@ -68,6 +68,15 @@ module Increase
68
68
  # The tokenization attempt was declined by the token requestor.
69
69
  DECLINED_BY_TOKEN_REQUESTOR = :declined_by_token_requestor
70
70
 
71
+ # The group was locked.
72
+ GROUP_LOCKED = :group_locked
73
+
74
+ # The account has been closed.
75
+ ACCOUNT_CLOSED = :account_closed
76
+
77
+ # The account's entity was not active.
78
+ ENTITY_NOT_ACTIVE = :entity_not_active
79
+
71
80
  # @!method self.values
72
81
  # @return [Array<Symbol>]
73
82
  end
@@ -63,6 +63,9 @@ module Increase
63
63
  # A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
64
64
  BENEFICIAL_OWNER_ADDRESS = :beneficial_owner_address
65
65
 
66
+ # A beneficial owner's full tax identifier is required. A non-US person can submit a passport or driver's license. Make changes via the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
67
+ BENEFICIAL_OWNER_TAX_IDENTIFIER = :beneficial_owner_tax_identifier
68
+
66
69
  # @!method self.values
67
70
  # @return [Array<Symbol>]
68
71
  end
@@ -0,0 +1,103 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::FednowTransfers#complete
7
+ class FednowTransferCompleteParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute fednow_transfer_id
12
+ # The identifier of the FedNow Transfer you wish to complete.
13
+ #
14
+ # @return [String]
15
+ required :fednow_transfer_id, String
16
+
17
+ # @!attribute rejection
18
+ # If set, the simulation will reject the transfer.
19
+ #
20
+ # @return [Increase::Models::Simulations::FednowTransferCompleteParams::Rejection, nil]
21
+ optional :rejection, -> { Increase::Simulations::FednowTransferCompleteParams::Rejection }
22
+
23
+ # @!method initialize(fednow_transfer_id:, rejection: nil, request_options: {})
24
+ # @param fednow_transfer_id [String] The identifier of the FedNow Transfer you wish to complete.
25
+ #
26
+ # @param rejection [Increase::Models::Simulations::FednowTransferCompleteParams::Rejection]
27
+ # If set, the simulation will reject the transfer.
28
+ #
29
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
30
+
31
+ class Rejection < Increase::Internal::Type::BaseModel
32
+ # @!attribute reject_reason_code
33
+ # The reason code that the simulated rejection will have.
34
+ #
35
+ # @return [Symbol, Increase::Models::Simulations::FednowTransferCompleteParams::Rejection::RejectReasonCode]
36
+ required :reject_reason_code,
37
+ enum: -> { Increase::Simulations::FednowTransferCompleteParams::Rejection::RejectReasonCode }
38
+
39
+ # @!method initialize(reject_reason_code:)
40
+ # If set, the simulation will reject the transfer.
41
+ #
42
+ # @param reject_reason_code [Symbol, Increase::Models::Simulations::FednowTransferCompleteParams::Rejection::RejectReasonCode]
43
+ # The reason code that the simulated rejection will have.
44
+
45
+ # The reason code that the simulated rejection will have.
46
+ #
47
+ # @see Increase::Models::Simulations::FednowTransferCompleteParams::Rejection#reject_reason_code
48
+ module RejectReasonCode
49
+ extend Increase::Internal::Type::Enum
50
+
51
+ # The destination account is closed. Corresponds to the FedNow reason code `AC04`.
52
+ ACCOUNT_CLOSED = :account_closed
53
+
54
+ # The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.
55
+ ACCOUNT_BLOCKED = :account_blocked
56
+
57
+ # The destination account is ineligible to receive FedNow transfers. Corresponds to the FedNow reason code `AC14`.
58
+ INVALID_CREDITOR_ACCOUNT_TYPE = :invalid_creditor_account_type
59
+
60
+ # The destination account does not exist. Corresponds to the FedNow reason code `AC03`.
61
+ INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number
62
+
63
+ # The destination routing number is invalid. Corresponds to the FedNow reason code `RC04`.
64
+ INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER = :invalid_creditor_financial_institution_identifier
65
+
66
+ # The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.
67
+ END_CUSTOMER_DECEASED = :end_customer_deceased
68
+
69
+ # The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.
70
+ NARRATIVE = :narrative
71
+
72
+ # FedNow transfers are not allowed to the destination account. Corresponds to the FedNow reason code `AG01`.
73
+ TRANSACTION_FORBIDDEN = :transaction_forbidden
74
+
75
+ # FedNow transfers are not enabled for the destination account. Corresponds to the FedNow reason code `AG03`.
76
+ TRANSACTION_TYPE_NOT_SUPPORTED = :transaction_type_not_supported
77
+
78
+ # The amount is higher than the recipient is authorized to send or receive. Corresponds to the FedNow reason code `E990`.
79
+ AMOUNT_EXCEEDS_BANK_LIMITS = :amount_exceeds_bank_limits
80
+
81
+ # The creditor's address is required, but missing or invalid. Corresponds to the FedNow reason code `BE04`.
82
+ INVALID_CREDITOR_ADDRESS = :invalid_creditor_address
83
+
84
+ # The debtor's address is required, but missing or invalid. Corresponds to the FedNow reason code `BE07`.
85
+ INVALID_DEBTOR_ADDRESS = :invalid_debtor_address
86
+
87
+ # There was a timeout processing the transfer. Corresponds to the FedNow reason code `E997`.
88
+ TIMEOUT = :timeout
89
+
90
+ # The transfer was rejected due to an internal Increase issue. We have been notified.
91
+ PROCESSING_ERROR = :processing_error
92
+
93
+ # Some other error or issue has occurred.
94
+ OTHER = :other
95
+
96
+ # @!method self.values
97
+ # @return [Array<Symbol>]
98
+ end
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::InboundCheckDeposits#accept
7
+ class InboundCheckDepositAcceptParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute inbound_check_deposit_id
12
+ # The identifier of the Inbound Check Deposit you wish to accept.
13
+ #
14
+ # @return [String]
15
+ required :inbound_check_deposit_id, String
16
+
17
+ # @!method initialize(inbound_check_deposit_id:, request_options: {})
18
+ # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit you wish to accept.
19
+ #
20
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
21
+ end
22
+ end
23
+ end
24
+ end
@@ -3367,6 +3367,12 @@ module Increase
3367
3367
  # @return [String, nil]
3368
3368
  required :merchant_state, String, nil?: true
3369
3369
 
3370
+ # @!attribute network
3371
+ # The card network on which this transaction was processed.
3372
+ #
3373
+ # @return [Symbol, Increase::Models::Transaction::Source::CardRefund::Network]
3374
+ required :network, enum: -> { Increase::Transaction::Source::CardRefund::Network }
3375
+
3370
3376
  # @!attribute network_identifiers
3371
3377
  # Network-specific identifiers for this refund.
3372
3378
  #
@@ -3417,7 +3423,7 @@ module Increase
3417
3423
  # @return [Symbol, Increase::Models::Transaction::Source::CardRefund::Type]
3418
3424
  required :type, enum: -> { Increase::Transaction::Source::CardRefund::Type }
3419
3425
 
3420
- # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, transaction_id:, type:)
3426
+ # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, transaction_id:, type:)
3421
3427
  # A Card Refund object. This field will be present in the JSON response if and
3422
3428
  # only if `category` is equal to `card_refund`. Card Refunds move money back to
3423
3429
  # the cardholder. While they are usually connected to a Card Settlement, an
@@ -3460,6 +3466,9 @@ module Increase
3460
3466
  #
3461
3467
  # @param merchant_state [String, nil] The state the merchant resides in.
3462
3468
  #
3469
+ # @param network [Symbol, Increase::Models::Transaction::Source::CardRefund::Network]
3470
+ # The card network on which this transaction was processed.
3471
+ #
3463
3472
  # @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers]
3464
3473
  # Network-specific identifiers for this refund.
3465
3474
  #
@@ -3593,6 +3602,22 @@ module Increase
3593
3602
  end
3594
3603
  end
3595
3604
 
3605
+ # The card network on which this transaction was processed.
3606
+ #
3607
+ # @see Increase::Models::Transaction::Source::CardRefund#network
3608
+ module Network
3609
+ extend Increase::Internal::Type::Enum
3610
+
3611
+ # Visa
3612
+ VISA = :visa
3613
+
3614
+ # Pulse
3615
+ PULSE = :pulse
3616
+
3617
+ # @!method self.values
3618
+ # @return [Array<Symbol>]
3619
+ end
3620
+
3596
3621
  # @see Increase::Models::Transaction::Source::CardRefund#network_identifiers
3597
3622
  class NetworkIdentifiers < Increase::Internal::Type::BaseModel
3598
3623
  # @!attribute acquirer_business_id
@@ -8993,6 +9018,12 @@ module Increase
8993
9018
  # @return [String, nil]
8994
9019
  required :instructing_agent_routing_number, String, nil?: true
8995
9020
 
9021
+ # @!attribute instruction_for_creditor_agent
9022
+ # A free-form instruction for the receiving bank set by the sender.
9023
+ #
9024
+ # @return [String, nil]
9025
+ required :instruction_for_creditor_agent, String, nil?: true
9026
+
8996
9027
  # @!attribute instruction_identification
8997
9028
  # The sending bank's identifier for the wire transfer.
8998
9029
  #
@@ -9025,7 +9056,7 @@ module Increase
9025
9056
  # @return [String, nil]
9026
9057
  required :unstructured_remittance_information, String, nil?: true
9027
9058
 
9028
- # @!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:)
9059
+ # @!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_for_creditor_agent:, instruction_identification:, purpose:, transfer_id:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
9029
9060
  # An Inbound Wire Transfer Intention object. This field will be present in the
9030
9061
  # JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
9031
9062
  # Inbound Wire Transfer Intention is created when a wire transfer is initiated at
@@ -9063,6 +9094,9 @@ module Increase
9063
9094
  # The American Bankers' Association (ABA) routing number of the bank that sent the
9064
9095
  # wire.
9065
9096
  #
9097
+ # @param instruction_for_creditor_agent [String, nil]
9098
+ # A free-form instruction for the receiving bank set by the sender.
9099
+ #
9066
9100
  # @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
9067
9101
  #
9068
9102
  # @param purpose [String, nil] The reason for the wire transfer, as set by the sender.