increase 1.32.0 → 1.34.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +1 -1
- data/lib/increase/client.rb +12 -0
- data/lib/increase/models/card_push_transfer.rb +824 -0
- data/lib/increase/models/card_push_transfer_approve_params.rb +14 -0
- data/lib/increase/models/card_push_transfer_cancel_params.rb +14 -0
- data/lib/increase/models/card_push_transfer_create_params.rb +215 -0
- data/lib/increase/models/card_push_transfer_list_params.rb +159 -0
- data/lib/increase/models/card_push_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/card_token.rb +87 -0
- data/lib/increase/models/card_token_capabilities.rb +123 -0
- data/lib/increase/models/card_token_capabilities_params.rb +14 -0
- data/lib/increase/models/card_token_list_params.rb +83 -0
- data/lib/increase/models/card_token_retrieve_params.rb +14 -0
- data/lib/increase/models/card_validation.rb +759 -0
- data/lib/increase/models/card_validation_create_params.rb +116 -0
- data/lib/increase/models/card_validation_list_params.rb +150 -0
- data/lib/increase/models/card_validation_retrieve_params.rb +14 -0
- data/lib/increase/models/entity_create_beneficial_owner_params.rb +9 -10
- data/lib/increase/models/entity_create_params.rb +9 -10
- data/lib/increase/models/entity_update_beneficial_owner_address_params.rb +9 -10
- data/lib/increase/models/simulations/card_token_create_params.rb +140 -0
- data/lib/increase/models.rb +30 -0
- data/lib/increase/resources/card_push_transfers.rb +167 -0
- data/lib/increase/resources/card_tokens.rb +86 -0
- data/lib/increase/resources/card_validations.rb +117 -0
- data/lib/increase/resources/simulations/card_tokens.rb +46 -0
- data/lib/increase/resources/simulations.rb +4 -0
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +20 -0
- data/rbi/increase/client.rbi +9 -0
- data/rbi/increase/models/card_push_transfer.rbi +1450 -0
- data/rbi/increase/models/card_push_transfer_approve_params.rbi +30 -0
- data/rbi/increase/models/card_push_transfer_cancel_params.rbi +30 -0
- data/rbi/increase/models/card_push_transfer_create_params.rbi +325 -0
- data/rbi/increase/models/card_push_transfer_list_params.rbi +329 -0
- data/rbi/increase/models/card_push_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/card_token.rbi +108 -0
- data/rbi/increase/models/card_token_capabilities.rbi +250 -0
- data/rbi/increase/models/card_token_capabilities_params.rbi +30 -0
- data/rbi/increase/models/card_token_list_params.rbi +146 -0
- data/rbi/increase/models/card_token_retrieve_params.rbi +27 -0
- data/rbi/increase/models/card_validation.rbi +1438 -0
- data/rbi/increase/models/card_validation_create_params.rbi +155 -0
- data/rbi/increase/models/card_validation_list_params.rbi +295 -0
- data/rbi/increase/models/card_validation_retrieve_params.rbi +30 -0
- data/rbi/increase/models/entity_create_beneficial_owner_params.rbi +8 -13
- data/rbi/increase/models/entity_create_params.rbi +8 -13
- data/rbi/increase/models/entity_update_beneficial_owner_address_params.rbi +8 -13
- data/rbi/increase/models/simulations/card_token_create_params.rbi +297 -0
- data/rbi/increase/models.rbi +32 -0
- data/rbi/increase/resources/card_push_transfers.rbi +157 -0
- data/rbi/increase/resources/card_tokens.rbi +62 -0
- data/rbi/increase/resources/card_validations.rbi +107 -0
- data/rbi/increase/resources/simulations/card_tokens.rbi +43 -0
- data/rbi/increase/resources/simulations.rbi +3 -0
- data/sig/increase/client.rbs +6 -0
- data/sig/increase/models/card_push_transfer.rbs +679 -0
- data/sig/increase/models/card_push_transfer_approve_params.rbs +15 -0
- data/sig/increase/models/card_push_transfer_cancel_params.rbs +15 -0
- data/sig/increase/models/card_push_transfer_create_params.rbs +172 -0
- data/sig/increase/models/card_push_transfer_list_params.rbs +163 -0
- data/sig/increase/models/card_push_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/card_token.rbs +60 -0
- data/sig/increase/models/card_token_capabilities.rbs +104 -0
- data/sig/increase/models/card_token_capabilities_params.rbs +15 -0
- data/sig/increase/models/card_token_list_params.rbs +79 -0
- data/sig/increase/models/card_token_retrieve_params.rbs +15 -0
- data/sig/increase/models/card_validation.rbs +634 -0
- data/sig/increase/models/card_validation_create_params.rbs +91 -0
- data/sig/increase/models/card_validation_list_params.rbs +151 -0
- data/sig/increase/models/card_validation_retrieve_params.rbs +15 -0
- data/sig/increase/models/entity_create_beneficial_owner_params.rbs +5 -7
- data/sig/increase/models/entity_create_params.rbs +5 -7
- data/sig/increase/models/entity_update_beneficial_owner_address_params.rbs +5 -7
- data/sig/increase/models/simulations/card_token_create_params.rbs +129 -0
- data/sig/increase/models.rbs +30 -0
- data/sig/increase/resources/card_push_transfers.rbs +53 -0
- data/sig/increase/resources/card_tokens.rbs +24 -0
- data/sig/increase/resources/card_validations.rbs +38 -0
- data/sig/increase/resources/simulations/card_tokens.rbs +18 -0
- data/sig/increase/resources/simulations.rbs +2 -0
- metadata +62 -2
|
@@ -0,0 +1,824 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::CardPushTransfers#create
|
|
6
|
+
class CardPushTransfer < Increase::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The Card Push Transfer's identifier.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute acceptance
|
|
14
|
+
# If the transfer is accepted by the recipient bank, this will contain
|
|
15
|
+
# supplemental details.
|
|
16
|
+
#
|
|
17
|
+
# @return [Increase::Models::CardPushTransfer::Acceptance, nil]
|
|
18
|
+
required :acceptance, -> { Increase::CardPushTransfer::Acceptance }, nil?: true
|
|
19
|
+
|
|
20
|
+
# @!attribute account_id
|
|
21
|
+
# The Account from which the transfer was sent.
|
|
22
|
+
#
|
|
23
|
+
# @return [String]
|
|
24
|
+
required :account_id, String
|
|
25
|
+
|
|
26
|
+
# @!attribute amount
|
|
27
|
+
# The transfer amount in USD cents.
|
|
28
|
+
#
|
|
29
|
+
# @return [Integer]
|
|
30
|
+
required :amount, Integer
|
|
31
|
+
|
|
32
|
+
# @!attribute approval
|
|
33
|
+
# If your account requires approvals for transfers and the transfer was approved,
|
|
34
|
+
# this will contain details of the approval.
|
|
35
|
+
#
|
|
36
|
+
# @return [Increase::Models::CardPushTransfer::Approval, nil]
|
|
37
|
+
required :approval, -> { Increase::CardPushTransfer::Approval }, nil?: true
|
|
38
|
+
|
|
39
|
+
# @!attribute business_application_identifier
|
|
40
|
+
# The Business Application Identifier describes the type of transaction being
|
|
41
|
+
# performed. Your program must be approved for the specified Business Application
|
|
42
|
+
# Identifier in order to use it.
|
|
43
|
+
#
|
|
44
|
+
# @return [Symbol, Increase::Models::CardPushTransfer::BusinessApplicationIdentifier]
|
|
45
|
+
required :business_application_identifier,
|
|
46
|
+
enum: -> { Increase::CardPushTransfer::BusinessApplicationIdentifier }
|
|
47
|
+
|
|
48
|
+
# @!attribute cancellation
|
|
49
|
+
# If your account requires approvals for transfers and the transfer was not
|
|
50
|
+
# approved, this will contain details of the cancellation.
|
|
51
|
+
#
|
|
52
|
+
# @return [Increase::Models::CardPushTransfer::Cancellation, nil]
|
|
53
|
+
required :cancellation, -> { Increase::CardPushTransfer::Cancellation }, nil?: true
|
|
54
|
+
|
|
55
|
+
# @!attribute created_at
|
|
56
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
57
|
+
# the transfer was created.
|
|
58
|
+
#
|
|
59
|
+
# @return [Time]
|
|
60
|
+
required :created_at, Time
|
|
61
|
+
|
|
62
|
+
# @!attribute created_by
|
|
63
|
+
# What object created the transfer, either via the API or the dashboard.
|
|
64
|
+
#
|
|
65
|
+
# @return [Increase::Models::CardPushTransfer::CreatedBy, nil]
|
|
66
|
+
required :created_by, -> { Increase::CardPushTransfer::CreatedBy }, nil?: true
|
|
67
|
+
|
|
68
|
+
# @!attribute currency
|
|
69
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
|
70
|
+
# currency.
|
|
71
|
+
#
|
|
72
|
+
# @return [Symbol, Increase::Models::CardPushTransfer::Currency]
|
|
73
|
+
required :currency, enum: -> { Increase::CardPushTransfer::Currency }
|
|
74
|
+
|
|
75
|
+
# @!attribute decline
|
|
76
|
+
# If the transfer is rejected by the card network or the destination financial
|
|
77
|
+
# institution, this will contain supplemental details.
|
|
78
|
+
#
|
|
79
|
+
# @return [Increase::Models::CardPushTransfer::Decline, nil]
|
|
80
|
+
required :decline, -> { Increase::CardPushTransfer::Decline }, nil?: true
|
|
81
|
+
|
|
82
|
+
# @!attribute idempotency_key
|
|
83
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
84
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
85
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
86
|
+
#
|
|
87
|
+
# @return [String, nil]
|
|
88
|
+
required :idempotency_key, String, nil?: true
|
|
89
|
+
|
|
90
|
+
# @!attribute merchant_category_code
|
|
91
|
+
# The merchant category code (MCC) of the merchant (generally your business)
|
|
92
|
+
# sending the transfer. This is a four-digit code that describes the type of
|
|
93
|
+
# business or service provided by the merchant. Your program must be approved for
|
|
94
|
+
# the specified MCC in order to use it.
|
|
95
|
+
#
|
|
96
|
+
# @return [String]
|
|
97
|
+
required :merchant_category_code, String
|
|
98
|
+
|
|
99
|
+
# @!attribute merchant_city_name
|
|
100
|
+
# The city name of the merchant (generally your business) sending the transfer.
|
|
101
|
+
#
|
|
102
|
+
# @return [String]
|
|
103
|
+
required :merchant_city_name, String
|
|
104
|
+
|
|
105
|
+
# @!attribute merchant_name
|
|
106
|
+
# The merchant name shows up as the statement descriptor for the transfer. This is
|
|
107
|
+
# typically the name of your business or organization.
|
|
108
|
+
#
|
|
109
|
+
# @return [String]
|
|
110
|
+
required :merchant_name, String
|
|
111
|
+
|
|
112
|
+
# @!attribute merchant_name_prefix
|
|
113
|
+
# For certain Business Application Identifiers, the statement descriptor is
|
|
114
|
+
# `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to
|
|
115
|
+
# four character prefix that identifies the merchant.
|
|
116
|
+
#
|
|
117
|
+
# @return [String]
|
|
118
|
+
required :merchant_name_prefix, String
|
|
119
|
+
|
|
120
|
+
# @!attribute merchant_postal_code
|
|
121
|
+
# The postal code of the merchant (generally your business) sending the transfer.
|
|
122
|
+
#
|
|
123
|
+
# @return [String]
|
|
124
|
+
required :merchant_postal_code, String
|
|
125
|
+
|
|
126
|
+
# @!attribute merchant_state
|
|
127
|
+
# The state of the merchant (generally your business) sending the transfer.
|
|
128
|
+
#
|
|
129
|
+
# @return [String]
|
|
130
|
+
required :merchant_state, String
|
|
131
|
+
|
|
132
|
+
# @!attribute recipient_name
|
|
133
|
+
# The name of the funds recipient.
|
|
134
|
+
#
|
|
135
|
+
# @return [String]
|
|
136
|
+
required :recipient_name, String
|
|
137
|
+
|
|
138
|
+
# @!attribute sender_address_city
|
|
139
|
+
# The city of the sender.
|
|
140
|
+
#
|
|
141
|
+
# @return [String]
|
|
142
|
+
required :sender_address_city, String
|
|
143
|
+
|
|
144
|
+
# @!attribute sender_address_line1
|
|
145
|
+
# The address line 1 of the sender.
|
|
146
|
+
#
|
|
147
|
+
# @return [String]
|
|
148
|
+
required :sender_address_line1, String
|
|
149
|
+
|
|
150
|
+
# @!attribute sender_address_postal_code
|
|
151
|
+
# The postal code of the sender.
|
|
152
|
+
#
|
|
153
|
+
# @return [String]
|
|
154
|
+
required :sender_address_postal_code, String
|
|
155
|
+
|
|
156
|
+
# @!attribute sender_address_state
|
|
157
|
+
# The state of the sender.
|
|
158
|
+
#
|
|
159
|
+
# @return [String]
|
|
160
|
+
required :sender_address_state, String
|
|
161
|
+
|
|
162
|
+
# @!attribute sender_name
|
|
163
|
+
# The name of the funds originator.
|
|
164
|
+
#
|
|
165
|
+
# @return [String]
|
|
166
|
+
required :sender_name, String
|
|
167
|
+
|
|
168
|
+
# @!attribute source_account_number_id
|
|
169
|
+
# The Account Number the recipient will see as having sent the transfer.
|
|
170
|
+
#
|
|
171
|
+
# @return [String]
|
|
172
|
+
required :source_account_number_id, String
|
|
173
|
+
|
|
174
|
+
# @!attribute status
|
|
175
|
+
# The lifecycle status of the transfer.
|
|
176
|
+
#
|
|
177
|
+
# @return [Symbol, Increase::Models::CardPushTransfer::Status]
|
|
178
|
+
required :status, enum: -> { Increase::CardPushTransfer::Status }
|
|
179
|
+
|
|
180
|
+
# @!attribute submission
|
|
181
|
+
# After the transfer is submitted to the card network, this will contain
|
|
182
|
+
# supplemental details.
|
|
183
|
+
#
|
|
184
|
+
# @return [Increase::Models::CardPushTransfer::Submission, nil]
|
|
185
|
+
required :submission, -> { Increase::CardPushTransfer::Submission }, nil?: true
|
|
186
|
+
|
|
187
|
+
# @!attribute type
|
|
188
|
+
# A constant representing the object's type. For this resource it will always be
|
|
189
|
+
# `card_push_transfer`.
|
|
190
|
+
#
|
|
191
|
+
# @return [Symbol, Increase::Models::CardPushTransfer::Type]
|
|
192
|
+
required :type, enum: -> { Increase::CardPushTransfer::Type }
|
|
193
|
+
|
|
194
|
+
# @!method initialize(id:, acceptance:, account_id:, amount:, approval:, business_application_identifier:, cancellation:, created_at:, created_by:, currency:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, status:, submission:, type:)
|
|
195
|
+
# Some parameter documentations has been truncated, see
|
|
196
|
+
# {Increase::Models::CardPushTransfer} for more details.
|
|
197
|
+
#
|
|
198
|
+
# Card Push Transfers send funds to a recipient's payment card in real-time.
|
|
199
|
+
#
|
|
200
|
+
# @param id [String] The Card Push Transfer's identifier.
|
|
201
|
+
#
|
|
202
|
+
# @param acceptance [Increase::Models::CardPushTransfer::Acceptance, nil] If the transfer is accepted by the recipient bank, this will contain supplementa
|
|
203
|
+
#
|
|
204
|
+
# @param account_id [String] The Account from which the transfer was sent.
|
|
205
|
+
#
|
|
206
|
+
# @param amount [Integer] The transfer amount in USD cents.
|
|
207
|
+
#
|
|
208
|
+
# @param approval [Increase::Models::CardPushTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
|
|
209
|
+
#
|
|
210
|
+
# @param business_application_identifier [Symbol, Increase::Models::CardPushTransfer::BusinessApplicationIdentifier] The Business Application Identifier describes the type of transaction being perf
|
|
211
|
+
#
|
|
212
|
+
# @param cancellation [Increase::Models::CardPushTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
|
|
213
|
+
#
|
|
214
|
+
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
|
215
|
+
#
|
|
216
|
+
# @param created_by [Increase::Models::CardPushTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
|
|
217
|
+
#
|
|
218
|
+
# @param currency [Symbol, Increase::Models::CardPushTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
|
|
219
|
+
#
|
|
220
|
+
# @param decline [Increase::Models::CardPushTransfer::Decline, nil] If the transfer is rejected by the card network or the destination financial ins
|
|
221
|
+
#
|
|
222
|
+
# @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
|
|
223
|
+
#
|
|
224
|
+
# @param merchant_category_code [String] The merchant category code (MCC) of the merchant (generally your business) sendi
|
|
225
|
+
#
|
|
226
|
+
# @param merchant_city_name [String] The city name of the merchant (generally your business) sending the transfer.
|
|
227
|
+
#
|
|
228
|
+
# @param merchant_name [String] The merchant name shows up as the statement descriptor for the transfer. This is
|
|
229
|
+
#
|
|
230
|
+
# @param merchant_name_prefix [String] For certain Business Application Identifiers, the statement descriptor is `merch
|
|
231
|
+
#
|
|
232
|
+
# @param merchant_postal_code [String] The postal code of the merchant (generally your business) sending the transfer.
|
|
233
|
+
#
|
|
234
|
+
# @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
|
|
235
|
+
#
|
|
236
|
+
# @param recipient_name [String] The name of the funds recipient.
|
|
237
|
+
#
|
|
238
|
+
# @param sender_address_city [String] The city of the sender.
|
|
239
|
+
#
|
|
240
|
+
# @param sender_address_line1 [String] The address line 1 of the sender.
|
|
241
|
+
#
|
|
242
|
+
# @param sender_address_postal_code [String] The postal code of the sender.
|
|
243
|
+
#
|
|
244
|
+
# @param sender_address_state [String] The state of the sender.
|
|
245
|
+
#
|
|
246
|
+
# @param sender_name [String] The name of the funds originator.
|
|
247
|
+
#
|
|
248
|
+
# @param source_account_number_id [String] The Account Number the recipient will see as having sent the transfer.
|
|
249
|
+
#
|
|
250
|
+
# @param status [Symbol, Increase::Models::CardPushTransfer::Status] The lifecycle status of the transfer.
|
|
251
|
+
#
|
|
252
|
+
# @param submission [Increase::Models::CardPushTransfer::Submission, nil] After the transfer is submitted to the card network, this will contain supplemen
|
|
253
|
+
#
|
|
254
|
+
# @param type [Symbol, Increase::Models::CardPushTransfer::Type] A constant representing the object's type. For this resource it will always be `
|
|
255
|
+
|
|
256
|
+
# @see Increase::Models::CardPushTransfer#acceptance
|
|
257
|
+
class Acceptance < Increase::Internal::Type::BaseModel
|
|
258
|
+
# @!attribute accepted_at
|
|
259
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
260
|
+
# the transfer was accepted by the issuing bank.
|
|
261
|
+
#
|
|
262
|
+
# @return [Time]
|
|
263
|
+
required :accepted_at, Time
|
|
264
|
+
|
|
265
|
+
# @!attribute authorization_identification_response
|
|
266
|
+
# The authorization identification response from the issuing bank.
|
|
267
|
+
#
|
|
268
|
+
# @return [String]
|
|
269
|
+
required :authorization_identification_response, String
|
|
270
|
+
|
|
271
|
+
# @!attribute card_verification_value2_result
|
|
272
|
+
# The result of the Card Verification Value 2 match.
|
|
273
|
+
#
|
|
274
|
+
# @return [Symbol, Increase::Models::CardPushTransfer::Acceptance::CardVerificationValue2Result, nil]
|
|
275
|
+
required :card_verification_value2_result,
|
|
276
|
+
enum: -> { Increase::CardPushTransfer::Acceptance::CardVerificationValue2Result },
|
|
277
|
+
nil?: true
|
|
278
|
+
|
|
279
|
+
# @!attribute network_transaction_identifier
|
|
280
|
+
# A unique identifier for the transaction on the card network.
|
|
281
|
+
#
|
|
282
|
+
# @return [String, nil]
|
|
283
|
+
required :network_transaction_identifier, String, nil?: true
|
|
284
|
+
|
|
285
|
+
# @!method initialize(accepted_at:, authorization_identification_response:, card_verification_value2_result:, network_transaction_identifier:)
|
|
286
|
+
# Some parameter documentations has been truncated, see
|
|
287
|
+
# {Increase::Models::CardPushTransfer::Acceptance} for more details.
|
|
288
|
+
#
|
|
289
|
+
# If the transfer is accepted by the recipient bank, this will contain
|
|
290
|
+
# supplemental details.
|
|
291
|
+
#
|
|
292
|
+
# @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
|
293
|
+
#
|
|
294
|
+
# @param authorization_identification_response [String] The authorization identification response from the issuing bank.
|
|
295
|
+
#
|
|
296
|
+
# @param card_verification_value2_result [Symbol, Increase::Models::CardPushTransfer::Acceptance::CardVerificationValue2Result, nil] The result of the Card Verification Value 2 match.
|
|
297
|
+
#
|
|
298
|
+
# @param network_transaction_identifier [String, nil] A unique identifier for the transaction on the card network.
|
|
299
|
+
|
|
300
|
+
# The result of the Card Verification Value 2 match.
|
|
301
|
+
#
|
|
302
|
+
# @see Increase::Models::CardPushTransfer::Acceptance#card_verification_value2_result
|
|
303
|
+
module CardVerificationValue2Result
|
|
304
|
+
extend Increase::Internal::Type::Enum
|
|
305
|
+
|
|
306
|
+
# The Card Verification Value 2 (CVV2) matches the expected value.
|
|
307
|
+
MATCH = :match
|
|
308
|
+
|
|
309
|
+
# The Card Verification Value 2 (CVV2) does not match the expected value.
|
|
310
|
+
NO_MATCH = :no_match
|
|
311
|
+
|
|
312
|
+
# @!method self.values
|
|
313
|
+
# @return [Array<Symbol>]
|
|
314
|
+
end
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
# @see Increase::Models::CardPushTransfer#approval
|
|
318
|
+
class Approval < Increase::Internal::Type::BaseModel
|
|
319
|
+
# @!attribute approved_at
|
|
320
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
321
|
+
# the transfer was approved.
|
|
322
|
+
#
|
|
323
|
+
# @return [Time]
|
|
324
|
+
required :approved_at, Time
|
|
325
|
+
|
|
326
|
+
# @!attribute approved_by
|
|
327
|
+
# If the Transfer was approved by a user in the dashboard, the email address of
|
|
328
|
+
# that user.
|
|
329
|
+
#
|
|
330
|
+
# @return [String, nil]
|
|
331
|
+
required :approved_by, String, nil?: true
|
|
332
|
+
|
|
333
|
+
# @!method initialize(approved_at:, approved_by:)
|
|
334
|
+
# Some parameter documentations has been truncated, see
|
|
335
|
+
# {Increase::Models::CardPushTransfer::Approval} for more details.
|
|
336
|
+
#
|
|
337
|
+
# If your account requires approvals for transfers and the transfer was approved,
|
|
338
|
+
# this will contain details of the approval.
|
|
339
|
+
#
|
|
340
|
+
# @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
|
341
|
+
#
|
|
342
|
+
# @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
# The Business Application Identifier describes the type of transaction being
|
|
346
|
+
# performed. Your program must be approved for the specified Business Application
|
|
347
|
+
# Identifier in order to use it.
|
|
348
|
+
#
|
|
349
|
+
# @see Increase::Models::CardPushTransfer#business_application_identifier
|
|
350
|
+
module BusinessApplicationIdentifier
|
|
351
|
+
extend Increase::Internal::Type::Enum
|
|
352
|
+
|
|
353
|
+
# Account to Account
|
|
354
|
+
ACCOUNT_TO_ACCOUNT = :account_to_account
|
|
355
|
+
|
|
356
|
+
# Business to Business
|
|
357
|
+
BUSINESS_TO_BUSINESS = :business_to_business
|
|
358
|
+
|
|
359
|
+
# Money Transfer Bank Initiated
|
|
360
|
+
MONEY_TRANSFER_BANK_INITIATED = :money_transfer_bank_initiated
|
|
361
|
+
|
|
362
|
+
# Non-Card Bill Payment
|
|
363
|
+
NON_CARD_BILL_PAYMENT = :non_card_bill_payment
|
|
364
|
+
|
|
365
|
+
# Consumer Bill Payment
|
|
366
|
+
CONSUMER_BILL_PAYMENT = :consumer_bill_payment
|
|
367
|
+
|
|
368
|
+
# Card Bill Payment
|
|
369
|
+
CARD_BILL_PAYMENT = :card_bill_payment
|
|
370
|
+
|
|
371
|
+
# Funds Disbursement
|
|
372
|
+
FUNDS_DISBURSEMENT = :funds_disbursement
|
|
373
|
+
|
|
374
|
+
# Funds Transfer
|
|
375
|
+
FUNDS_TRANSFER = :funds_transfer
|
|
376
|
+
|
|
377
|
+
# Loyalty and Offers
|
|
378
|
+
LOYALTY_AND_OFFERS = :loyalty_and_offers
|
|
379
|
+
|
|
380
|
+
# Merchant Disbursement
|
|
381
|
+
MERCHANT_DISBURSEMENT = :merchant_disbursement
|
|
382
|
+
|
|
383
|
+
# Merchant Payment
|
|
384
|
+
MERCHANT_PAYMENT = :merchant_payment
|
|
385
|
+
|
|
386
|
+
# Person to Person
|
|
387
|
+
PERSON_TO_PERSON = :person_to_person
|
|
388
|
+
|
|
389
|
+
# Top Up
|
|
390
|
+
TOP_UP = :top_up
|
|
391
|
+
|
|
392
|
+
# Wallet Transfer
|
|
393
|
+
WALLET_TRANSFER = :wallet_transfer
|
|
394
|
+
|
|
395
|
+
# @!method self.values
|
|
396
|
+
# @return [Array<Symbol>]
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
# @see Increase::Models::CardPushTransfer#cancellation
|
|
400
|
+
class Cancellation < Increase::Internal::Type::BaseModel
|
|
401
|
+
# @!attribute canceled_at
|
|
402
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
403
|
+
# the Transfer was canceled.
|
|
404
|
+
#
|
|
405
|
+
# @return [Time]
|
|
406
|
+
required :canceled_at, Time
|
|
407
|
+
|
|
408
|
+
# @!attribute canceled_by
|
|
409
|
+
# If the Transfer was canceled by a user in the dashboard, the email address of
|
|
410
|
+
# that user.
|
|
411
|
+
#
|
|
412
|
+
# @return [String, nil]
|
|
413
|
+
required :canceled_by, String, nil?: true
|
|
414
|
+
|
|
415
|
+
# @!method initialize(canceled_at:, canceled_by:)
|
|
416
|
+
# Some parameter documentations has been truncated, see
|
|
417
|
+
# {Increase::Models::CardPushTransfer::Cancellation} for more details.
|
|
418
|
+
#
|
|
419
|
+
# If your account requires approvals for transfers and the transfer was not
|
|
420
|
+
# approved, this will contain details of the cancellation.
|
|
421
|
+
#
|
|
422
|
+
# @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
|
423
|
+
#
|
|
424
|
+
# @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
# @see Increase::Models::CardPushTransfer#created_by
|
|
428
|
+
class CreatedBy < Increase::Internal::Type::BaseModel
|
|
429
|
+
# @!attribute api_key
|
|
430
|
+
# If present, details about the API key that created the transfer.
|
|
431
|
+
#
|
|
432
|
+
# @return [Increase::Models::CardPushTransfer::CreatedBy::APIKey, nil]
|
|
433
|
+
required :api_key, -> { Increase::CardPushTransfer::CreatedBy::APIKey }, nil?: true
|
|
434
|
+
|
|
435
|
+
# @!attribute category
|
|
436
|
+
# The type of object that created this transfer.
|
|
437
|
+
#
|
|
438
|
+
# @return [Symbol, Increase::Models::CardPushTransfer::CreatedBy::Category]
|
|
439
|
+
required :category, enum: -> { Increase::CardPushTransfer::CreatedBy::Category }
|
|
440
|
+
|
|
441
|
+
# @!attribute oauth_application
|
|
442
|
+
# If present, details about the OAuth Application that created the transfer.
|
|
443
|
+
#
|
|
444
|
+
# @return [Increase::Models::CardPushTransfer::CreatedBy::OAuthApplication, nil]
|
|
445
|
+
required :oauth_application,
|
|
446
|
+
-> {
|
|
447
|
+
Increase::CardPushTransfer::CreatedBy::OAuthApplication
|
|
448
|
+
},
|
|
449
|
+
nil?: true
|
|
450
|
+
|
|
451
|
+
# @!attribute user
|
|
452
|
+
# If present, details about the User that created the transfer.
|
|
453
|
+
#
|
|
454
|
+
# @return [Increase::Models::CardPushTransfer::CreatedBy::User, nil]
|
|
455
|
+
required :user, -> { Increase::CardPushTransfer::CreatedBy::User }, nil?: true
|
|
456
|
+
|
|
457
|
+
# @!method initialize(api_key:, category:, oauth_application:, user:)
|
|
458
|
+
# What object created the transfer, either via the API or the dashboard.
|
|
459
|
+
#
|
|
460
|
+
# @param api_key [Increase::Models::CardPushTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
|
|
461
|
+
#
|
|
462
|
+
# @param category [Symbol, Increase::Models::CardPushTransfer::CreatedBy::Category] The type of object that created this transfer.
|
|
463
|
+
#
|
|
464
|
+
# @param oauth_application [Increase::Models::CardPushTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
|
|
465
|
+
#
|
|
466
|
+
# @param user [Increase::Models::CardPushTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
|
|
467
|
+
|
|
468
|
+
# @see Increase::Models::CardPushTransfer::CreatedBy#api_key
|
|
469
|
+
class APIKey < Increase::Internal::Type::BaseModel
|
|
470
|
+
# @!attribute description
|
|
471
|
+
# The description set for the API key when it was created.
|
|
472
|
+
#
|
|
473
|
+
# @return [String, nil]
|
|
474
|
+
required :description, String, nil?: true
|
|
475
|
+
|
|
476
|
+
# @!method initialize(description:)
|
|
477
|
+
# If present, details about the API key that created the transfer.
|
|
478
|
+
#
|
|
479
|
+
# @param description [String, nil] The description set for the API key when it was created.
|
|
480
|
+
end
|
|
481
|
+
|
|
482
|
+
# The type of object that created this transfer.
|
|
483
|
+
#
|
|
484
|
+
# @see Increase::Models::CardPushTransfer::CreatedBy#category
|
|
485
|
+
module Category
|
|
486
|
+
extend Increase::Internal::Type::Enum
|
|
487
|
+
|
|
488
|
+
# An API key. Details will be under the `api_key` object.
|
|
489
|
+
API_KEY = :api_key
|
|
490
|
+
|
|
491
|
+
# An OAuth application you connected to Increase. Details will be under the `oauth_application` object.
|
|
492
|
+
OAUTH_APPLICATION = :oauth_application
|
|
493
|
+
|
|
494
|
+
# A User in the Increase dashboard. Details will be under the `user` object.
|
|
495
|
+
USER = :user
|
|
496
|
+
|
|
497
|
+
# @!method self.values
|
|
498
|
+
# @return [Array<Symbol>]
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# @see Increase::Models::CardPushTransfer::CreatedBy#oauth_application
|
|
502
|
+
class OAuthApplication < Increase::Internal::Type::BaseModel
|
|
503
|
+
# @!attribute name
|
|
504
|
+
# The name of the OAuth Application.
|
|
505
|
+
#
|
|
506
|
+
# @return [String]
|
|
507
|
+
required :name, String
|
|
508
|
+
|
|
509
|
+
# @!method initialize(name:)
|
|
510
|
+
# If present, details about the OAuth Application that created the transfer.
|
|
511
|
+
#
|
|
512
|
+
# @param name [String] The name of the OAuth Application.
|
|
513
|
+
end
|
|
514
|
+
|
|
515
|
+
# @see Increase::Models::CardPushTransfer::CreatedBy#user
|
|
516
|
+
class User < Increase::Internal::Type::BaseModel
|
|
517
|
+
# @!attribute email
|
|
518
|
+
# The email address of the User.
|
|
519
|
+
#
|
|
520
|
+
# @return [String]
|
|
521
|
+
required :email, String
|
|
522
|
+
|
|
523
|
+
# @!method initialize(email:)
|
|
524
|
+
# If present, details about the User that created the transfer.
|
|
525
|
+
#
|
|
526
|
+
# @param email [String] The email address of the User.
|
|
527
|
+
end
|
|
528
|
+
end
|
|
529
|
+
|
|
530
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
|
531
|
+
# currency.
|
|
532
|
+
#
|
|
533
|
+
# @see Increase::Models::CardPushTransfer#currency
|
|
534
|
+
module Currency
|
|
535
|
+
extend Increase::Internal::Type::Enum
|
|
536
|
+
|
|
537
|
+
# Canadian Dollar (CAD)
|
|
538
|
+
CAD = :CAD
|
|
539
|
+
|
|
540
|
+
# Swiss Franc (CHF)
|
|
541
|
+
CHF = :CHF
|
|
542
|
+
|
|
543
|
+
# Euro (EUR)
|
|
544
|
+
EUR = :EUR
|
|
545
|
+
|
|
546
|
+
# British Pound (GBP)
|
|
547
|
+
GBP = :GBP
|
|
548
|
+
|
|
549
|
+
# Japanese Yen (JPY)
|
|
550
|
+
JPY = :JPY
|
|
551
|
+
|
|
552
|
+
# US Dollar (USD)
|
|
553
|
+
USD = :USD
|
|
554
|
+
|
|
555
|
+
# @!method self.values
|
|
556
|
+
# @return [Array<Symbol>]
|
|
557
|
+
end
|
|
558
|
+
|
|
559
|
+
# @see Increase::Models::CardPushTransfer#decline
|
|
560
|
+
class Decline < Increase::Internal::Type::BaseModel
|
|
561
|
+
# @!attribute declined_at
|
|
562
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
563
|
+
# the transfer declined.
|
|
564
|
+
#
|
|
565
|
+
# @return [Time]
|
|
566
|
+
required :declined_at, Time
|
|
567
|
+
|
|
568
|
+
# @!attribute network_transaction_identifier
|
|
569
|
+
# A unique identifier for the transaction on the card network.
|
|
570
|
+
#
|
|
571
|
+
# @return [String, nil]
|
|
572
|
+
required :network_transaction_identifier, String, nil?: true
|
|
573
|
+
|
|
574
|
+
# @!attribute reason
|
|
575
|
+
# The reason why the transfer was declined.
|
|
576
|
+
#
|
|
577
|
+
# @return [Symbol, Increase::Models::CardPushTransfer::Decline::Reason]
|
|
578
|
+
required :reason, enum: -> { Increase::CardPushTransfer::Decline::Reason }
|
|
579
|
+
|
|
580
|
+
# @!method initialize(declined_at:, network_transaction_identifier:, reason:)
|
|
581
|
+
# Some parameter documentations has been truncated, see
|
|
582
|
+
# {Increase::Models::CardPushTransfer::Decline} for more details.
|
|
583
|
+
#
|
|
584
|
+
# If the transfer is rejected by the card network or the destination financial
|
|
585
|
+
# institution, this will contain supplemental details.
|
|
586
|
+
#
|
|
587
|
+
# @param declined_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
|
588
|
+
#
|
|
589
|
+
# @param network_transaction_identifier [String, nil] A unique identifier for the transaction on the card network.
|
|
590
|
+
#
|
|
591
|
+
# @param reason [Symbol, Increase::Models::CardPushTransfer::Decline::Reason] The reason why the transfer was declined.
|
|
592
|
+
|
|
593
|
+
# The reason why the transfer was declined.
|
|
594
|
+
#
|
|
595
|
+
# @see Increase::Models::CardPushTransfer::Decline#reason
|
|
596
|
+
module Reason
|
|
597
|
+
extend Increase::Internal::Type::Enum
|
|
598
|
+
|
|
599
|
+
# The card issuer has declined the transaction without providing a specific reason.
|
|
600
|
+
DO_NOT_HONOR = :do_not_honor
|
|
601
|
+
|
|
602
|
+
# The number of transactions for the card has exceeded the limit set by the issuer.
|
|
603
|
+
ACTIVITY_COUNT_LIMIT_EXCEEDED = :activity_count_limit_exceeded
|
|
604
|
+
|
|
605
|
+
# The card issuer requires the cardholder to contact them for further information regarding the transaction.
|
|
606
|
+
REFER_TO_CARD_ISSUER = :refer_to_card_issuer
|
|
607
|
+
|
|
608
|
+
# The card issuer requires the cardholder to contact them due to a special condition related to the transaction.
|
|
609
|
+
REFER_TO_CARD_ISSUER_SPECIAL_CONDITION = :refer_to_card_issuer_special_condition
|
|
610
|
+
|
|
611
|
+
# The merchant is not valid for this transaction.
|
|
612
|
+
INVALID_MERCHANT = :invalid_merchant
|
|
613
|
+
|
|
614
|
+
# The card should be retained by the terminal.
|
|
615
|
+
PICK_UP_CARD = :pick_up_card
|
|
616
|
+
|
|
617
|
+
# An error occurred during processing of the transaction.
|
|
618
|
+
ERROR = :error
|
|
619
|
+
|
|
620
|
+
# The card should be retained by the terminal due to a special condition.
|
|
621
|
+
PICK_UP_CARD_SPECIAL = :pick_up_card_special
|
|
622
|
+
|
|
623
|
+
# The transaction is invalid and cannot be processed.
|
|
624
|
+
INVALID_TRANSACTION = :invalid_transaction
|
|
625
|
+
|
|
626
|
+
# The amount of the transaction is invalid.
|
|
627
|
+
INVALID_AMOUNT = :invalid_amount
|
|
628
|
+
|
|
629
|
+
# The account number provided is invalid.
|
|
630
|
+
INVALID_ACCOUNT_NUMBER = :invalid_account_number
|
|
631
|
+
|
|
632
|
+
# The issuer of the card could not be found.
|
|
633
|
+
NO_SUCH_ISSUER = :no_such_issuer
|
|
634
|
+
|
|
635
|
+
# The transaction should be re-entered for processing.
|
|
636
|
+
RE_ENTER_TRANSACTION = :re_enter_transaction
|
|
637
|
+
|
|
638
|
+
# There is no credit account associated with the card.
|
|
639
|
+
NO_CREDIT_ACCOUNT = :no_credit_account
|
|
640
|
+
|
|
641
|
+
# The card should be retained by the terminal because it has been reported lost.
|
|
642
|
+
PICK_UP_CARD_LOST = :pick_up_card_lost
|
|
643
|
+
|
|
644
|
+
# The card should be retained by the terminal because it has been reported stolen.
|
|
645
|
+
PICK_UP_CARD_STOLEN = :pick_up_card_stolen
|
|
646
|
+
|
|
647
|
+
# The account associated with the card has been closed.
|
|
648
|
+
CLOSED_ACCOUNT = :closed_account
|
|
649
|
+
|
|
650
|
+
# There are insufficient funds in the account to complete the transaction.
|
|
651
|
+
INSUFFICIENT_FUNDS = :insufficient_funds
|
|
652
|
+
|
|
653
|
+
# There is no checking account associated with the card.
|
|
654
|
+
NO_CHECKING_ACCOUNT = :no_checking_account
|
|
655
|
+
|
|
656
|
+
# There is no savings account associated with the card.
|
|
657
|
+
NO_SAVINGS_ACCOUNT = :no_savings_account
|
|
658
|
+
|
|
659
|
+
# The card has expired and cannot be used for transactions.
|
|
660
|
+
EXPIRED_CARD = :expired_card
|
|
661
|
+
|
|
662
|
+
# The transaction is not permitted for this cardholder.
|
|
663
|
+
TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER = :transaction_not_permitted_to_cardholder
|
|
664
|
+
|
|
665
|
+
# The transaction is not allowed at this terminal.
|
|
666
|
+
TRANSACTION_NOT_ALLOWED_AT_TERMINAL = :transaction_not_allowed_at_terminal
|
|
667
|
+
|
|
668
|
+
# The transaction has been flagged as suspected fraud and cannot be processed.
|
|
669
|
+
SUSPECTED_FRAUD = :suspected_fraud
|
|
670
|
+
|
|
671
|
+
# The amount of activity on the card has exceeded the limit set by the issuer.
|
|
672
|
+
ACTIVITY_AMOUNT_LIMIT_EXCEEDED = :activity_amount_limit_exceeded
|
|
673
|
+
|
|
674
|
+
# The card has restrictions that prevent it from being used for this transaction.
|
|
675
|
+
RESTRICTED_CARD = :restricted_card
|
|
676
|
+
|
|
677
|
+
# A security violation has occurred, preventing the transaction from being processed.
|
|
678
|
+
SECURITY_VIOLATION = :security_violation
|
|
679
|
+
|
|
680
|
+
# The transaction does not meet the anti-money laundering requirements set by the issuer.
|
|
681
|
+
TRANSACTION_DOES_NOT_FULFILL_ANTI_MONEY_LAUNDERING_REQUIREMENT =
|
|
682
|
+
:transaction_does_not_fulfill_anti_money_laundering_requirement
|
|
683
|
+
|
|
684
|
+
# The first use of the card has been blocked by the issuer.
|
|
685
|
+
BLOCKED_FIRST_USE = :blocked_first_use
|
|
686
|
+
|
|
687
|
+
# The credit issuer is currently unavailable to process the transaction.
|
|
688
|
+
CREDIT_ISSUER_UNAVAILABLE = :credit_issuer_unavailable
|
|
689
|
+
|
|
690
|
+
# The card verification value (CVV) results were negative, indicating a potential issue with the card.
|
|
691
|
+
NEGATIVE_CARD_VERIFICATION_VALUE_RESULTS = :negative_card_verification_value_results
|
|
692
|
+
|
|
693
|
+
# The issuer of the card is currently unavailable to process the transaction.
|
|
694
|
+
ISSUER_UNAVAILABLE = :issuer_unavailable
|
|
695
|
+
|
|
696
|
+
# The financial institution associated with the card could not be found.
|
|
697
|
+
FINANCIAL_INSTITUTION_CANNOT_BE_FOUND = :financial_institution_cannot_be_found
|
|
698
|
+
|
|
699
|
+
# The transaction cannot be completed due to an unspecified reason.
|
|
700
|
+
TRANSACTION_CANNOT_BE_COMPLETED = :transaction_cannot_be_completed
|
|
701
|
+
|
|
702
|
+
# The transaction is a duplicate of a previous transaction and cannot be processed again.
|
|
703
|
+
DUPLICATE_TRANSACTION = :duplicate_transaction
|
|
704
|
+
|
|
705
|
+
# A system malfunction occurred, preventing the transaction from being processed.
|
|
706
|
+
SYSTEM_MALFUNCTION = :system_malfunction
|
|
707
|
+
|
|
708
|
+
# Additional customer authentication is required to complete the transaction.
|
|
709
|
+
ADDITIONAL_CUSTOMER_AUTHENTICATION_REQUIRED = :additional_customer_authentication_required
|
|
710
|
+
|
|
711
|
+
# The surcharge amount applied to the transaction is not permitted by the issuer.
|
|
712
|
+
SURCHARGE_AMOUNT_NOT_PERMITTED = :surcharge_amount_not_permitted
|
|
713
|
+
|
|
714
|
+
# The transaction was declined due to a failure in verifying the CVV2 code.
|
|
715
|
+
DECLINE_FOR_CVV2_FAILURE = :decline_for_cvv2_failure
|
|
716
|
+
|
|
717
|
+
# A stop payment order has been placed on this transaction.
|
|
718
|
+
STOP_PAYMENT_ORDER = :stop_payment_order
|
|
719
|
+
|
|
720
|
+
# An order has been placed to revoke authorization for this transaction.
|
|
721
|
+
REVOCATION_OF_AUTHORIZATION_ORDER = :revocation_of_authorization_order
|
|
722
|
+
|
|
723
|
+
# An order has been placed to revoke all authorizations for this cardholder.
|
|
724
|
+
REVOCATION_OF_ALL_AUTHORIZATIONS_ORDER = :revocation_of_all_authorizations_order
|
|
725
|
+
|
|
726
|
+
# @!method self.values
|
|
727
|
+
# @return [Array<Symbol>]
|
|
728
|
+
end
|
|
729
|
+
end
|
|
730
|
+
|
|
731
|
+
# The lifecycle status of the transfer.
|
|
732
|
+
#
|
|
733
|
+
# @see Increase::Models::CardPushTransfer#status
|
|
734
|
+
module Status
|
|
735
|
+
extend Increase::Internal::Type::Enum
|
|
736
|
+
|
|
737
|
+
# The transfer is pending approval.
|
|
738
|
+
PENDING_APPROVAL = :pending_approval
|
|
739
|
+
|
|
740
|
+
# The transfer has been canceled.
|
|
741
|
+
CANCELED = :canceled
|
|
742
|
+
|
|
743
|
+
# The transfer is pending review by Increase.
|
|
744
|
+
PENDING_REVIEWING = :pending_reviewing
|
|
745
|
+
|
|
746
|
+
# The transfer requires attention from an Increase operator.
|
|
747
|
+
REQUIRES_ATTENTION = :requires_attention
|
|
748
|
+
|
|
749
|
+
# The transfer is queued to be submitted to the card network.
|
|
750
|
+
PENDING_SUBMISSION = :pending_submission
|
|
751
|
+
|
|
752
|
+
# The transfer has been submitted and is pending a response from the card network.
|
|
753
|
+
SUBMITTED = :submitted
|
|
754
|
+
|
|
755
|
+
# The transfer has been sent successfully and is complete.
|
|
756
|
+
COMPLETE = :complete
|
|
757
|
+
|
|
758
|
+
# The transfer was declined by the network or the recipient's bank.
|
|
759
|
+
DECLINED = :declined
|
|
760
|
+
|
|
761
|
+
# @!method self.values
|
|
762
|
+
# @return [Array<Symbol>]
|
|
763
|
+
end
|
|
764
|
+
|
|
765
|
+
# @see Increase::Models::CardPushTransfer#submission
|
|
766
|
+
class Submission < Increase::Internal::Type::BaseModel
|
|
767
|
+
# @!attribute retrieval_reference_number
|
|
768
|
+
# A 12-digit retrieval reference number that identifies the transfer. Usually a
|
|
769
|
+
# combination of a timestamp and the trace number.
|
|
770
|
+
#
|
|
771
|
+
# @return [String]
|
|
772
|
+
required :retrieval_reference_number, String
|
|
773
|
+
|
|
774
|
+
# @!attribute sender_reference
|
|
775
|
+
# A unique reference for the transfer.
|
|
776
|
+
#
|
|
777
|
+
# @return [String]
|
|
778
|
+
required :sender_reference, String
|
|
779
|
+
|
|
780
|
+
# @!attribute submitted_at
|
|
781
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
782
|
+
# the transfer was submitted to card network.
|
|
783
|
+
#
|
|
784
|
+
# @return [Time]
|
|
785
|
+
required :submitted_at, Time
|
|
786
|
+
|
|
787
|
+
# @!attribute trace_number
|
|
788
|
+
# A 6-digit trace number that identifies the transfer within a small window of
|
|
789
|
+
# time.
|
|
790
|
+
#
|
|
791
|
+
# @return [String]
|
|
792
|
+
required :trace_number, String
|
|
793
|
+
|
|
794
|
+
# @!method initialize(retrieval_reference_number:, sender_reference:, submitted_at:, trace_number:)
|
|
795
|
+
# Some parameter documentations has been truncated, see
|
|
796
|
+
# {Increase::Models::CardPushTransfer::Submission} for more details.
|
|
797
|
+
#
|
|
798
|
+
# After the transfer is submitted to the card network, this will contain
|
|
799
|
+
# supplemental details.
|
|
800
|
+
#
|
|
801
|
+
# @param retrieval_reference_number [String] A 12-digit retrieval reference number that identifies the transfer. Usually a co
|
|
802
|
+
#
|
|
803
|
+
# @param sender_reference [String] A unique reference for the transfer.
|
|
804
|
+
#
|
|
805
|
+
# @param submitted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
|
806
|
+
#
|
|
807
|
+
# @param trace_number [String] A 6-digit trace number that identifies the transfer within a small window of tim
|
|
808
|
+
end
|
|
809
|
+
|
|
810
|
+
# A constant representing the object's type. For this resource it will always be
|
|
811
|
+
# `card_push_transfer`.
|
|
812
|
+
#
|
|
813
|
+
# @see Increase::Models::CardPushTransfer#type
|
|
814
|
+
module Type
|
|
815
|
+
extend Increase::Internal::Type::Enum
|
|
816
|
+
|
|
817
|
+
CARD_PUSH_TRANSFER = :card_push_transfer
|
|
818
|
+
|
|
819
|
+
# @!method self.values
|
|
820
|
+
# @return [Array<Symbol>]
|
|
821
|
+
end
|
|
822
|
+
end
|
|
823
|
+
end
|
|
824
|
+
end
|