increase 1.90.0 → 1.91.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 +18 -0
- data/README.md +1 -1
- data/lib/increase/models/transaction.rb +1296 -173
- data/lib/increase/models/transaction_list_params.rb +3 -0
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/transaction.rbi +2282 -123
- data/rbi/increase/models/transaction_list_params.rbi +7 -0
- data/sig/increase/models/transaction.rbs +768 -0
- data/sig/increase/models/transaction_list_params.rbs +4 -0
- metadata +2 -2
@@ -247,6 +247,14 @@ module Increase
|
|
247
247
|
# @return [Increase::Models::Transaction::Source::CardDisputeLoss, nil]
|
248
248
|
required :card_dispute_loss, -> { Increase::Transaction::Source::CardDisputeLoss }, nil?: true
|
249
249
|
|
250
|
+
# @!attribute card_financial
|
251
|
+
# A Card Financial object. This field will be present in the JSON response if and
|
252
|
+
# only if `category` is equal to `card_financial`. Card Financials are temporary
|
253
|
+
# holds placed on a customers funds with the intent to later clear a transaction.
|
254
|
+
#
|
255
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial, nil]
|
256
|
+
required :card_financial, -> { Increase::Transaction::Source::CardFinancial }, nil?: true
|
257
|
+
|
250
258
|
# @!attribute card_push_transfer_acceptance
|
251
259
|
# A Card Push Transfer Acceptance object. This field will be present in the JSON
|
252
260
|
# response if and only if `category` is equal to `card_push_transfer_acceptance`.
|
@@ -530,7 +538,7 @@ module Increase
|
|
530
538
|
},
|
531
539
|
nil?: true
|
532
540
|
|
533
|
-
# @!method initialize(account_revenue_payment:, account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_financial:, card_dispute_loss:, card_push_transfer_acceptance:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fednow_transfer_acknowledgement:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_fednow_transfer_confirmation:, inbound_real_time_payments_transfer_confirmation:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, swift_transfer_intention:, swift_transfer_return:, wire_transfer_intention:)
|
541
|
+
# @!method initialize(account_revenue_payment:, account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_financial:, card_dispute_loss:, card_financial:, card_push_transfer_acceptance:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fednow_transfer_acknowledgement:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_fednow_transfer_confirmation:, inbound_real_time_payments_transfer_confirmation:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, swift_transfer_intention:, swift_transfer_return:, wire_transfer_intention:)
|
534
542
|
# Some parameter documentations has been truncated, see
|
535
543
|
# {Increase::Models::Transaction::Source} for more details.
|
536
544
|
#
|
@@ -555,6 +563,8 @@ module Increase
|
|
555
563
|
#
|
556
564
|
# @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil] A Card Dispute Loss object. This field will be present in the JSON response if a
|
557
565
|
#
|
566
|
+
# @param card_financial [Increase::Models::Transaction::Source::CardFinancial, nil] A Card Financial object. This field will be present in the JSON response if and
|
567
|
+
#
|
558
568
|
# @param card_push_transfer_acceptance [Increase::Models::Transaction::Source::CardPushTransferAcceptance, nil] A Card Push Transfer Acceptance object. This field will be present in the JSON r
|
559
569
|
#
|
560
570
|
# @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil] A Card Refund object. This field will be present in the JSON response if and onl
|
@@ -1045,230 +1055,1340 @@ module Increase
|
|
1045
1055
|
# Code R70. A rare return reason. The receiving bank had not approved this return.
|
1046
1056
|
PERMISSIBLE_RETURN_ENTRY_NOT_ACCEPTED = :permissible_return_entry_not_accepted
|
1047
1057
|
|
1048
|
-
# Code R32. A rare return reason. The receiving bank could not settle this transaction.
|
1049
|
-
RDFI_NON_SETTLEMENT = :rdfi_non_settlement
|
1058
|
+
# Code R32. A rare return reason. The receiving bank could not settle this transaction.
|
1059
|
+
RDFI_NON_SETTLEMENT = :rdfi_non_settlement
|
1060
|
+
|
1061
|
+
# Code R30. A rare return reason. The receiving bank does not accept Check Truncation ACH transfers.
|
1062
|
+
RDFI_PARTICIPANT_IN_CHECK_TRUNCATION_PROGRAM = :rdfi_participant_in_check_truncation_program
|
1063
|
+
|
1064
|
+
# Code R14. A rare return reason. The payee is deceased.
|
1065
|
+
REPRESENTATIVE_PAYEE_DECEASED_OR_UNABLE_TO_CONTINUE_IN_THAT_CAPACITY =
|
1066
|
+
:representative_payee_deceased_or_unable_to_continue_in_that_capacity
|
1067
|
+
|
1068
|
+
# Code R75. A rare return reason. The originating bank disputes that an earlier `duplicate_entry` return was actually a duplicate.
|
1069
|
+
RETURN_NOT_A_DUPLICATE = :return_not_a_duplicate
|
1070
|
+
|
1071
|
+
# Code R62. A rare return reason. The originating financial institution made a mistake and this return corrects it.
|
1072
|
+
RETURN_OF_ERRONEOUS_OR_REVERSING_DEBIT = :return_of_erroneous_or_reversing_debit
|
1073
|
+
|
1074
|
+
# Code R36. A rare return reason. Return of a malformed credit entry.
|
1075
|
+
RETURN_OF_IMPROPER_CREDIT_ENTRY = :return_of_improper_credit_entry
|
1076
|
+
|
1077
|
+
# Code R35. A rare return reason. Return of a malformed debit entry.
|
1078
|
+
RETURN_OF_IMPROPER_DEBIT_ENTRY = :return_of_improper_debit_entry
|
1079
|
+
|
1080
|
+
# Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry.
|
1081
|
+
RETURN_OF_XCK_ENTRY = :return_of_xck_entry
|
1082
|
+
|
1083
|
+
# Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.
|
1084
|
+
SOURCE_DOCUMENT_PRESENTED_FOR_PAYMENT = :source_document_presented_for_payment
|
1085
|
+
|
1086
|
+
# Code R50. A rare return reason. State law prevents the bank from accepting the Represented Check ("RCK") entry.
|
1087
|
+
STATE_LAW_AFFECTING_RCK_ACCEPTANCE = :state_law_affecting_rck_acceptance
|
1088
|
+
|
1089
|
+
# Code R52. A rare return reason. A stop payment was issued on a Represented Check ("RCK") entry.
|
1090
|
+
STOP_PAYMENT_ON_ITEM_RELATED_TO_RCK_ENTRY = :stop_payment_on_item_related_to_rck_entry
|
1091
|
+
|
1092
|
+
# Code R38. A rare return reason. The source attached to the ACH, usually an ACH check conversion, includes a stop payment.
|
1093
|
+
STOP_PAYMENT_ON_SOURCE_DOCUMENT = :stop_payment_on_source_document
|
1094
|
+
|
1095
|
+
# Code R73. A rare return reason. The bank receiving an `untimely_return` believes it was on time.
|
1096
|
+
TIMELY_ORIGINAL_RETURN = :timely_original_return
|
1097
|
+
|
1098
|
+
# Code R27. A rare return reason. An ACH return's trace number does not match an originated ACH.
|
1099
|
+
TRACE_NUMBER_ERROR = :trace_number_error
|
1100
|
+
|
1101
|
+
# Code R72. A rare return reason. The dishonored return was sent too late.
|
1102
|
+
UNTIMELY_DISHONORED_RETURN = :untimely_dishonored_return
|
1103
|
+
|
1104
|
+
# Code R68. A rare return reason. The return was sent too late.
|
1105
|
+
UNTIMELY_RETURN = :untimely_return
|
1106
|
+
|
1107
|
+
# @!method self.values
|
1108
|
+
# @return [Array<Symbol>]
|
1109
|
+
end
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
# @see Increase::Models::Transaction::Source#card_dispute_acceptance
|
1113
|
+
class CardDisputeAcceptance < Increase::Internal::Type::BaseModel
|
1114
|
+
# @!attribute accepted_at
|
1115
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
1116
|
+
# the Card Dispute was accepted.
|
1117
|
+
#
|
1118
|
+
# @return [Time]
|
1119
|
+
required :accepted_at, Time
|
1120
|
+
|
1121
|
+
# @!attribute transaction_id
|
1122
|
+
# The identifier of the Transaction that was created to return the disputed funds
|
1123
|
+
# to your account.
|
1124
|
+
#
|
1125
|
+
# @return [String]
|
1126
|
+
required :transaction_id, String
|
1127
|
+
|
1128
|
+
# @!method initialize(accepted_at:, transaction_id:)
|
1129
|
+
# Some parameter documentations has been truncated, see
|
1130
|
+
# {Increase::Models::Transaction::Source::CardDisputeAcceptance} for more details.
|
1131
|
+
#
|
1132
|
+
# A Card Dispute Acceptance object. This field will be present in the JSON
|
1133
|
+
# response if and only if `category` is equal to `card_dispute_acceptance`.
|
1134
|
+
# Contains the details of a successful Card Dispute.
|
1135
|
+
#
|
1136
|
+
# @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
1137
|
+
#
|
1138
|
+
# @param transaction_id [String] The identifier of the Transaction that was created to return the disputed funds
|
1139
|
+
end
|
1140
|
+
|
1141
|
+
# @see Increase::Models::Transaction::Source#card_dispute_financial
|
1142
|
+
class CardDisputeFinancial < Increase::Internal::Type::BaseModel
|
1143
|
+
# @!attribute amount
|
1144
|
+
# The amount of the financial event.
|
1145
|
+
#
|
1146
|
+
# @return [Integer]
|
1147
|
+
required :amount, Integer
|
1148
|
+
|
1149
|
+
# @!attribute network
|
1150
|
+
# The network that the Card Dispute is associated with.
|
1151
|
+
#
|
1152
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network]
|
1153
|
+
required :network, enum: -> { Increase::Transaction::Source::CardDisputeFinancial::Network }
|
1154
|
+
|
1155
|
+
# @!attribute transaction_id
|
1156
|
+
# The identifier of the Transaction that was created to credit or debit the
|
1157
|
+
# disputed funds to or from your account.
|
1158
|
+
#
|
1159
|
+
# @return [String]
|
1160
|
+
required :transaction_id, String
|
1161
|
+
|
1162
|
+
# @!attribute visa
|
1163
|
+
# Information for events related to card dispute for card payments processed over
|
1164
|
+
# Visa's network. This field will be present in the JSON response if and only if
|
1165
|
+
# `network` is equal to `visa`.
|
1166
|
+
#
|
1167
|
+
# @return [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil]
|
1168
|
+
required :visa, -> { Increase::Transaction::Source::CardDisputeFinancial::Visa }, nil?: true
|
1169
|
+
|
1170
|
+
# @!method initialize(amount:, network:, transaction_id:, visa:)
|
1171
|
+
# Some parameter documentations has been truncated, see
|
1172
|
+
# {Increase::Models::Transaction::Source::CardDisputeFinancial} for more details.
|
1173
|
+
#
|
1174
|
+
# A Card Dispute Financial object. This field will be present in the JSON response
|
1175
|
+
# if and only if `category` is equal to `card_dispute_financial`. Financial event
|
1176
|
+
# related to a Card Dispute.
|
1177
|
+
#
|
1178
|
+
# @param amount [Integer] The amount of the financial event.
|
1179
|
+
#
|
1180
|
+
# @param network [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network] The network that the Card Dispute is associated with.
|
1181
|
+
#
|
1182
|
+
# @param transaction_id [String] The identifier of the Transaction that was created to credit or debit the disput
|
1183
|
+
#
|
1184
|
+
# @param visa [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil] Information for events related to card dispute for card payments processed over
|
1185
|
+
|
1186
|
+
# The network that the Card Dispute is associated with.
|
1187
|
+
#
|
1188
|
+
# @see Increase::Models::Transaction::Source::CardDisputeFinancial#network
|
1189
|
+
module Network
|
1190
|
+
extend Increase::Internal::Type::Enum
|
1191
|
+
|
1192
|
+
# Visa: details will be under the `visa` object.
|
1193
|
+
VISA = :visa
|
1194
|
+
|
1195
|
+
# @!method self.values
|
1196
|
+
# @return [Array<Symbol>]
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
# @see Increase::Models::Transaction::Source::CardDisputeFinancial#visa
|
1200
|
+
class Visa < Increase::Internal::Type::BaseModel
|
1201
|
+
# @!attribute event_type
|
1202
|
+
# The type of card dispute financial event.
|
1203
|
+
#
|
1204
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Visa::EventType]
|
1205
|
+
required :event_type, enum: -> { Increase::Transaction::Source::CardDisputeFinancial::Visa::EventType }
|
1206
|
+
|
1207
|
+
# @!method initialize(event_type:)
|
1208
|
+
# Information for events related to card dispute for card payments processed over
|
1209
|
+
# Visa's network. This field will be present in the JSON response if and only if
|
1210
|
+
# `network` is equal to `visa`.
|
1211
|
+
#
|
1212
|
+
# @param event_type [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Visa::EventType] The type of card dispute financial event.
|
1213
|
+
|
1214
|
+
# The type of card dispute financial event.
|
1215
|
+
#
|
1216
|
+
# @see Increase::Models::Transaction::Source::CardDisputeFinancial::Visa#event_type
|
1217
|
+
module EventType
|
1218
|
+
extend Increase::Internal::Type::Enum
|
1219
|
+
|
1220
|
+
# The user's chargeback was submitted.
|
1221
|
+
CHARGEBACK_SUBMITTED = :chargeback_submitted
|
1222
|
+
|
1223
|
+
# The user declined the merchant's pre-arbitration submission.
|
1224
|
+
MERCHANT_PREARBITRATION_DECLINE_SUBMITTED = :merchant_prearbitration_decline_submitted
|
1225
|
+
|
1226
|
+
# The merchant's pre-arbitration submission was received.
|
1227
|
+
MERCHANT_PREARBITRATION_RECEIVED = :merchant_prearbitration_received
|
1228
|
+
|
1229
|
+
# The transaction was re-presented by the merchant.
|
1230
|
+
REPRESENTED = :represented
|
1231
|
+
|
1232
|
+
# The user's pre-arbitration was declined by the merchant.
|
1233
|
+
USER_PREARBITRATION_DECLINE_RECEIVED = :user_prearbitration_decline_received
|
1234
|
+
|
1235
|
+
# The user's pre-arbitration was submitted.
|
1236
|
+
USER_PREARBITRATION_SUBMITTED = :user_prearbitration_submitted
|
1237
|
+
|
1238
|
+
# The user withdrew from the dispute.
|
1239
|
+
USER_WITHDRAWAL_SUBMITTED = :user_withdrawal_submitted
|
1240
|
+
|
1241
|
+
# @!method self.values
|
1242
|
+
# @return [Array<Symbol>]
|
1243
|
+
end
|
1244
|
+
end
|
1245
|
+
end
|
1246
|
+
|
1247
|
+
# @see Increase::Models::Transaction::Source#card_dispute_loss
|
1248
|
+
class CardDisputeLoss < Increase::Internal::Type::BaseModel
|
1249
|
+
# @!attribute explanation
|
1250
|
+
# Why the Card Dispute was lost.
|
1251
|
+
#
|
1252
|
+
# @return [String]
|
1253
|
+
required :explanation, String
|
1254
|
+
|
1255
|
+
# @!attribute lost_at
|
1256
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
1257
|
+
# the Card Dispute was lost.
|
1258
|
+
#
|
1259
|
+
# @return [Time]
|
1260
|
+
required :lost_at, Time
|
1261
|
+
|
1262
|
+
# @!attribute transaction_id
|
1263
|
+
# The identifier of the Transaction that was created to debit the disputed funds
|
1264
|
+
# from your account.
|
1265
|
+
#
|
1266
|
+
# @return [String]
|
1267
|
+
required :transaction_id, String
|
1268
|
+
|
1269
|
+
# @!method initialize(explanation:, lost_at:, transaction_id:)
|
1270
|
+
# Some parameter documentations has been truncated, see
|
1271
|
+
# {Increase::Models::Transaction::Source::CardDisputeLoss} for more details.
|
1272
|
+
#
|
1273
|
+
# A Card Dispute Loss object. This field will be present in the JSON response if
|
1274
|
+
# and only if `category` is equal to `card_dispute_loss`. Contains the details of
|
1275
|
+
# a lost Card Dispute.
|
1276
|
+
#
|
1277
|
+
# @param explanation [String] Why the Card Dispute was lost.
|
1278
|
+
#
|
1279
|
+
# @param lost_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
1280
|
+
#
|
1281
|
+
# @param transaction_id [String] The identifier of the Transaction that was created to debit the disputed funds f
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# @see Increase::Models::Transaction::Source#card_financial
|
1285
|
+
class CardFinancial < Increase::Internal::Type::BaseModel
|
1286
|
+
# @!attribute id
|
1287
|
+
# The Card Financial identifier.
|
1288
|
+
#
|
1289
|
+
# @return [String]
|
1290
|
+
required :id, String
|
1291
|
+
|
1292
|
+
# @!attribute actioner
|
1293
|
+
# Whether this financial was approved by Increase, the card network through
|
1294
|
+
# stand-in processing, or the user through a real-time decision.
|
1295
|
+
#
|
1296
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::Actioner]
|
1297
|
+
required :actioner, enum: -> { Increase::Transaction::Source::CardFinancial::Actioner }
|
1298
|
+
|
1299
|
+
# @!attribute additional_amounts
|
1300
|
+
# Additional amounts associated with the card authorization, such as ATM
|
1301
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
1302
|
+
# to provide more detailed information about the transaction.
|
1303
|
+
#
|
1304
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts]
|
1305
|
+
required :additional_amounts, -> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts }
|
1306
|
+
|
1307
|
+
# @!attribute amount
|
1308
|
+
# The pending amount in the minor unit of the transaction's currency. For dollars,
|
1309
|
+
# for example, this is cents.
|
1310
|
+
#
|
1311
|
+
# @return [Integer]
|
1312
|
+
required :amount, Integer
|
1313
|
+
|
1314
|
+
# @!attribute card_payment_id
|
1315
|
+
# The ID of the Card Payment this transaction belongs to.
|
1316
|
+
#
|
1317
|
+
# @return [String]
|
1318
|
+
required :card_payment_id, String
|
1319
|
+
|
1320
|
+
# @!attribute currency
|
1321
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
1322
|
+
# transaction's currency.
|
1323
|
+
#
|
1324
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::Currency]
|
1325
|
+
required :currency, enum: -> { Increase::Transaction::Source::CardFinancial::Currency }
|
1326
|
+
|
1327
|
+
# @!attribute digital_wallet_token_id
|
1328
|
+
# If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
1329
|
+
# purchase), the identifier of the token that was used.
|
1330
|
+
#
|
1331
|
+
# @return [String, nil]
|
1332
|
+
required :digital_wallet_token_id, String, nil?: true
|
1333
|
+
|
1334
|
+
# @!attribute direction
|
1335
|
+
# The direction describes the direction the funds will move, either from the
|
1336
|
+
# cardholder to the merchant or from the merchant to the cardholder.
|
1337
|
+
#
|
1338
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::Direction]
|
1339
|
+
required :direction, enum: -> { Increase::Transaction::Source::CardFinancial::Direction }
|
1340
|
+
|
1341
|
+
# @!attribute merchant_acceptor_id
|
1342
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
1343
|
+
# is transacting with.
|
1344
|
+
#
|
1345
|
+
# @return [String]
|
1346
|
+
required :merchant_acceptor_id, String
|
1347
|
+
|
1348
|
+
# @!attribute merchant_category_code
|
1349
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
1350
|
+
# card is transacting with.
|
1351
|
+
#
|
1352
|
+
# @return [String]
|
1353
|
+
required :merchant_category_code, String
|
1354
|
+
|
1355
|
+
# @!attribute merchant_city
|
1356
|
+
# The city the merchant resides in.
|
1357
|
+
#
|
1358
|
+
# @return [String, nil]
|
1359
|
+
required :merchant_city, String, nil?: true
|
1360
|
+
|
1361
|
+
# @!attribute merchant_country
|
1362
|
+
# The country the merchant resides in.
|
1363
|
+
#
|
1364
|
+
# @return [String]
|
1365
|
+
required :merchant_country, String
|
1366
|
+
|
1367
|
+
# @!attribute merchant_descriptor
|
1368
|
+
# The merchant descriptor of the merchant the card is transacting with.
|
1369
|
+
#
|
1370
|
+
# @return [String]
|
1371
|
+
required :merchant_descriptor, String
|
1372
|
+
|
1373
|
+
# @!attribute merchant_postal_code
|
1374
|
+
# The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
1375
|
+
# ZIP code, where the first 5 and last 4 are separated by a dash.
|
1376
|
+
#
|
1377
|
+
# @return [String, nil]
|
1378
|
+
required :merchant_postal_code, String, nil?: true
|
1379
|
+
|
1380
|
+
# @!attribute merchant_state
|
1381
|
+
# The state the merchant resides in.
|
1382
|
+
#
|
1383
|
+
# @return [String, nil]
|
1384
|
+
required :merchant_state, String, nil?: true
|
1385
|
+
|
1386
|
+
# @!attribute network_details
|
1387
|
+
# Fields specific to the `network`.
|
1388
|
+
#
|
1389
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails]
|
1390
|
+
required :network_details, -> { Increase::Transaction::Source::CardFinancial::NetworkDetails }
|
1391
|
+
|
1392
|
+
# @!attribute network_identifiers
|
1393
|
+
# Network-specific identifiers for a specific request or transaction.
|
1394
|
+
#
|
1395
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers]
|
1396
|
+
required :network_identifiers, -> { Increase::Transaction::Source::CardFinancial::NetworkIdentifiers }
|
1397
|
+
|
1398
|
+
# @!attribute network_risk_score
|
1399
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
1400
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest.
|
1401
|
+
#
|
1402
|
+
# @return [Integer, nil]
|
1403
|
+
required :network_risk_score, Integer, nil?: true
|
1404
|
+
|
1405
|
+
# @!attribute physical_card_id
|
1406
|
+
# If the authorization was made in-person with a physical card, the Physical Card
|
1407
|
+
# that was used.
|
1408
|
+
#
|
1409
|
+
# @return [String, nil]
|
1410
|
+
required :physical_card_id, String, nil?: true
|
1411
|
+
|
1412
|
+
# @!attribute presentment_amount
|
1413
|
+
# The pending amount in the minor unit of the transaction's presentment currency.
|
1414
|
+
#
|
1415
|
+
# @return [Integer]
|
1416
|
+
required :presentment_amount, Integer
|
1417
|
+
|
1418
|
+
# @!attribute presentment_currency
|
1419
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
1420
|
+
# transaction's presentment currency.
|
1421
|
+
#
|
1422
|
+
# @return [String]
|
1423
|
+
required :presentment_currency, String
|
1424
|
+
|
1425
|
+
# @!attribute processing_category
|
1426
|
+
# The processing category describes the intent behind the financial, such as
|
1427
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
1428
|
+
#
|
1429
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::ProcessingCategory]
|
1430
|
+
required :processing_category,
|
1431
|
+
enum: -> { Increase::Transaction::Source::CardFinancial::ProcessingCategory }
|
1432
|
+
|
1433
|
+
# @!attribute real_time_decision_id
|
1434
|
+
# The identifier of the Real-Time Decision sent to approve or decline this
|
1435
|
+
# transaction.
|
1436
|
+
#
|
1437
|
+
# @return [String, nil]
|
1438
|
+
required :real_time_decision_id, String, nil?: true
|
1439
|
+
|
1440
|
+
# @!attribute terminal_id
|
1441
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
1442
|
+
# is transacting with.
|
1443
|
+
#
|
1444
|
+
# @return [String, nil]
|
1445
|
+
required :terminal_id, String, nil?: true
|
1446
|
+
|
1447
|
+
# @!attribute transaction_id
|
1448
|
+
# The identifier of the Transaction associated with this Transaction.
|
1449
|
+
#
|
1450
|
+
# @return [String]
|
1451
|
+
required :transaction_id, String
|
1452
|
+
|
1453
|
+
# @!attribute type
|
1454
|
+
# A constant representing the object's type. For this resource it will always be
|
1455
|
+
# `card_financial`.
|
1456
|
+
#
|
1457
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::Type]
|
1458
|
+
required :type, enum: -> { Increase::Transaction::Source::CardFinancial::Type }
|
1459
|
+
|
1460
|
+
# @!attribute verification
|
1461
|
+
# Fields related to verification of cardholder-provided values.
|
1462
|
+
#
|
1463
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::Verification]
|
1464
|
+
required :verification, -> { Increase::Transaction::Source::CardFinancial::Verification }
|
1465
|
+
|
1466
|
+
# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, 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:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, transaction_id:, type:, verification:)
|
1467
|
+
# Some parameter documentations has been truncated, see
|
1468
|
+
# {Increase::Models::Transaction::Source::CardFinancial} for more details.
|
1469
|
+
#
|
1470
|
+
# A Card Financial object. This field will be present in the JSON response if and
|
1471
|
+
# only if `category` is equal to `card_financial`. Card Financials are temporary
|
1472
|
+
# holds placed on a customers funds with the intent to later clear a transaction.
|
1473
|
+
#
|
1474
|
+
# @param id [String] The Card Financial identifier.
|
1475
|
+
#
|
1476
|
+
# @param actioner [Symbol, Increase::Models::Transaction::Source::CardFinancial::Actioner] Whether this financial was approved by Increase, the card network through stand-
|
1477
|
+
#
|
1478
|
+
# @param additional_amounts [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
|
1479
|
+
#
|
1480
|
+
# @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars,
|
1481
|
+
#
|
1482
|
+
# @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
|
1483
|
+
#
|
1484
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
|
1485
|
+
#
|
1486
|
+
# @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
|
1487
|
+
#
|
1488
|
+
# @param direction [Symbol, Increase::Models::Transaction::Source::CardFinancial::Direction] The direction describes the direction the funds will move, either from the cardh
|
1489
|
+
#
|
1490
|
+
# @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
|
1491
|
+
#
|
1492
|
+
# @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
|
1493
|
+
#
|
1494
|
+
# @param merchant_city [String, nil] The city the merchant resides in.
|
1495
|
+
#
|
1496
|
+
# @param merchant_country [String] The country the merchant resides in.
|
1497
|
+
#
|
1498
|
+
# @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
|
1499
|
+
#
|
1500
|
+
# @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
1501
|
+
#
|
1502
|
+
# @param merchant_state [String, nil] The state the merchant resides in.
|
1503
|
+
#
|
1504
|
+
# @param network_details [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails] Fields specific to the `network`.
|
1505
|
+
#
|
1506
|
+
# @param network_identifiers [Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
|
1507
|
+
#
|
1508
|
+
# @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
|
1509
|
+
#
|
1510
|
+
# @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
|
1511
|
+
#
|
1512
|
+
# @param presentment_amount [Integer] The pending amount in the minor unit of the transaction's presentment currency.
|
1513
|
+
#
|
1514
|
+
# @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
|
1515
|
+
#
|
1516
|
+
# @param processing_category [Symbol, Increase::Models::Transaction::Source::CardFinancial::ProcessingCategory] The processing category describes the intent behind the financial, such as wheth
|
1517
|
+
#
|
1518
|
+
# @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac
|
1519
|
+
#
|
1520
|
+
# @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
|
1521
|
+
#
|
1522
|
+
# @param transaction_id [String] The identifier of the Transaction associated with this Transaction.
|
1523
|
+
#
|
1524
|
+
# @param type [Symbol, Increase::Models::Transaction::Source::CardFinancial::Type] A constant representing the object's type. For this resource it will always be `
|
1525
|
+
#
|
1526
|
+
# @param verification [Increase::Models::Transaction::Source::CardFinancial::Verification] Fields related to verification of cardholder-provided values.
|
1527
|
+
|
1528
|
+
# Whether this financial was approved by Increase, the card network through
|
1529
|
+
# stand-in processing, or the user through a real-time decision.
|
1530
|
+
#
|
1531
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#actioner
|
1532
|
+
module Actioner
|
1533
|
+
extend Increase::Internal::Type::Enum
|
1534
|
+
|
1535
|
+
# This object was actioned by the user through a real-time decision.
|
1536
|
+
USER = :user
|
1537
|
+
|
1538
|
+
# This object was actioned by Increase without user intervention.
|
1539
|
+
INCREASE = :increase
|
1540
|
+
|
1541
|
+
# This object was actioned by the network, through stand-in processing.
|
1542
|
+
NETWORK = :network
|
1543
|
+
|
1544
|
+
# @!method self.values
|
1545
|
+
# @return [Array<Symbol>]
|
1546
|
+
end
|
1547
|
+
|
1548
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#additional_amounts
|
1549
|
+
class AdditionalAmounts < Increase::Internal::Type::BaseModel
|
1550
|
+
# @!attribute clinic
|
1551
|
+
# The part of this transaction amount that was for clinic-related services.
|
1552
|
+
#
|
1553
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic, nil]
|
1554
|
+
required :clinic,
|
1555
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic },
|
1556
|
+
nil?: true
|
1557
|
+
|
1558
|
+
# @!attribute dental
|
1559
|
+
# The part of this transaction amount that was for dental-related services.
|
1560
|
+
#
|
1561
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental, nil]
|
1562
|
+
required :dental,
|
1563
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental },
|
1564
|
+
nil?: true
|
1565
|
+
|
1566
|
+
# @!attribute prescription
|
1567
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
1568
|
+
#
|
1569
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription, nil]
|
1570
|
+
required :prescription,
|
1571
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription },
|
1572
|
+
nil?: true
|
1573
|
+
|
1574
|
+
# @!attribute surcharge
|
1575
|
+
# The surcharge amount charged for this transaction by the merchant.
|
1576
|
+
#
|
1577
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge, nil]
|
1578
|
+
required :surcharge,
|
1579
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge },
|
1580
|
+
nil?: true
|
1581
|
+
|
1582
|
+
# @!attribute total_cumulative
|
1583
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
1584
|
+
#
|
1585
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative, nil]
|
1586
|
+
required :total_cumulative,
|
1587
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative },
|
1588
|
+
nil?: true
|
1589
|
+
|
1590
|
+
# @!attribute total_healthcare
|
1591
|
+
# The total amount of healthcare-related additional amounts.
|
1592
|
+
#
|
1593
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare, nil]
|
1594
|
+
required :total_healthcare,
|
1595
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare },
|
1596
|
+
nil?: true
|
1597
|
+
|
1598
|
+
# @!attribute transit
|
1599
|
+
# The part of this transaction amount that was for transit-related services.
|
1600
|
+
#
|
1601
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit, nil]
|
1602
|
+
required :transit,
|
1603
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Transit },
|
1604
|
+
nil?: true
|
1605
|
+
|
1606
|
+
# @!attribute unknown
|
1607
|
+
# An unknown additional amount.
|
1608
|
+
#
|
1609
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown, nil]
|
1610
|
+
required :unknown,
|
1611
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown },
|
1612
|
+
nil?: true
|
1613
|
+
|
1614
|
+
# @!attribute vision
|
1615
|
+
# The part of this transaction amount that was for vision-related services.
|
1616
|
+
#
|
1617
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision, nil]
|
1618
|
+
required :vision,
|
1619
|
+
-> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Vision },
|
1620
|
+
nil?: true
|
1621
|
+
|
1622
|
+
# @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
|
1623
|
+
# Some parameter documentations has been truncated, see
|
1624
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts} for
|
1625
|
+
# more details.
|
1626
|
+
#
|
1627
|
+
# Additional amounts associated with the card authorization, such as ATM
|
1628
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
1629
|
+
# to provide more detailed information about the transaction.
|
1630
|
+
#
|
1631
|
+
# @param clinic [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
|
1632
|
+
#
|
1633
|
+
# @param dental [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
|
1634
|
+
#
|
1635
|
+
# @param prescription [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
|
1636
|
+
#
|
1637
|
+
# @param surcharge [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
|
1638
|
+
#
|
1639
|
+
# @param total_cumulative [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
|
1640
|
+
#
|
1641
|
+
# @param total_healthcare [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
|
1642
|
+
#
|
1643
|
+
# @param transit [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
|
1644
|
+
#
|
1645
|
+
# @param unknown [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown, nil] An unknown additional amount.
|
1646
|
+
#
|
1647
|
+
# @param vision [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
|
1648
|
+
|
1649
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#clinic
|
1650
|
+
class Clinic < Increase::Internal::Type::BaseModel
|
1651
|
+
# @!attribute amount
|
1652
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1653
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1654
|
+
# subtracted from the amount (such as a discount).
|
1655
|
+
#
|
1656
|
+
# @return [Integer]
|
1657
|
+
required :amount, Integer
|
1658
|
+
|
1659
|
+
# @!attribute currency
|
1660
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1661
|
+
# amount's currency.
|
1662
|
+
#
|
1663
|
+
# @return [String]
|
1664
|
+
required :currency, String
|
1665
|
+
|
1666
|
+
# @!method initialize(amount:, currency:)
|
1667
|
+
# Some parameter documentations has been truncated, see
|
1668
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic}
|
1669
|
+
# for more details.
|
1670
|
+
#
|
1671
|
+
# The part of this transaction amount that was for clinic-related services.
|
1672
|
+
#
|
1673
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1674
|
+
#
|
1675
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1676
|
+
end
|
1677
|
+
|
1678
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#dental
|
1679
|
+
class Dental < Increase::Internal::Type::BaseModel
|
1680
|
+
# @!attribute amount
|
1681
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1682
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1683
|
+
# subtracted from the amount (such as a discount).
|
1684
|
+
#
|
1685
|
+
# @return [Integer]
|
1686
|
+
required :amount, Integer
|
1687
|
+
|
1688
|
+
# @!attribute currency
|
1689
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1690
|
+
# amount's currency.
|
1691
|
+
#
|
1692
|
+
# @return [String]
|
1693
|
+
required :currency, String
|
1694
|
+
|
1695
|
+
# @!method initialize(amount:, currency:)
|
1696
|
+
# Some parameter documentations has been truncated, see
|
1697
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental}
|
1698
|
+
# for more details.
|
1699
|
+
#
|
1700
|
+
# The part of this transaction amount that was for dental-related services.
|
1701
|
+
#
|
1702
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1703
|
+
#
|
1704
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1705
|
+
end
|
1706
|
+
|
1707
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#prescription
|
1708
|
+
class Prescription < Increase::Internal::Type::BaseModel
|
1709
|
+
# @!attribute amount
|
1710
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1711
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1712
|
+
# subtracted from the amount (such as a discount).
|
1713
|
+
#
|
1714
|
+
# @return [Integer]
|
1715
|
+
required :amount, Integer
|
1716
|
+
|
1717
|
+
# @!attribute currency
|
1718
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1719
|
+
# amount's currency.
|
1720
|
+
#
|
1721
|
+
# @return [String]
|
1722
|
+
required :currency, String
|
1723
|
+
|
1724
|
+
# @!method initialize(amount:, currency:)
|
1725
|
+
# Some parameter documentations has been truncated, see
|
1726
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription}
|
1727
|
+
# for more details.
|
1728
|
+
#
|
1729
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
1730
|
+
#
|
1731
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1732
|
+
#
|
1733
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1734
|
+
end
|
1735
|
+
|
1736
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#surcharge
|
1737
|
+
class Surcharge < Increase::Internal::Type::BaseModel
|
1738
|
+
# @!attribute amount
|
1739
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1740
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1741
|
+
# subtracted from the amount (such as a discount).
|
1742
|
+
#
|
1743
|
+
# @return [Integer]
|
1744
|
+
required :amount, Integer
|
1745
|
+
|
1746
|
+
# @!attribute currency
|
1747
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1748
|
+
# amount's currency.
|
1749
|
+
#
|
1750
|
+
# @return [String]
|
1751
|
+
required :currency, String
|
1752
|
+
|
1753
|
+
# @!method initialize(amount:, currency:)
|
1754
|
+
# Some parameter documentations has been truncated, see
|
1755
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge}
|
1756
|
+
# for more details.
|
1757
|
+
#
|
1758
|
+
# The surcharge amount charged for this transaction by the merchant.
|
1759
|
+
#
|
1760
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1761
|
+
#
|
1762
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1763
|
+
end
|
1764
|
+
|
1765
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#total_cumulative
|
1766
|
+
class TotalCumulative < Increase::Internal::Type::BaseModel
|
1767
|
+
# @!attribute amount
|
1768
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1769
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1770
|
+
# subtracted from the amount (such as a discount).
|
1771
|
+
#
|
1772
|
+
# @return [Integer]
|
1773
|
+
required :amount, Integer
|
1774
|
+
|
1775
|
+
# @!attribute currency
|
1776
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1777
|
+
# amount's currency.
|
1778
|
+
#
|
1779
|
+
# @return [String]
|
1780
|
+
required :currency, String
|
1781
|
+
|
1782
|
+
# @!method initialize(amount:, currency:)
|
1783
|
+
# Some parameter documentations has been truncated, see
|
1784
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative}
|
1785
|
+
# for more details.
|
1786
|
+
#
|
1787
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
1788
|
+
#
|
1789
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1790
|
+
#
|
1791
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1792
|
+
end
|
1793
|
+
|
1794
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#total_healthcare
|
1795
|
+
class TotalHealthcare < Increase::Internal::Type::BaseModel
|
1796
|
+
# @!attribute amount
|
1797
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1798
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1799
|
+
# subtracted from the amount (such as a discount).
|
1800
|
+
#
|
1801
|
+
# @return [Integer]
|
1802
|
+
required :amount, Integer
|
1803
|
+
|
1804
|
+
# @!attribute currency
|
1805
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1806
|
+
# amount's currency.
|
1807
|
+
#
|
1808
|
+
# @return [String]
|
1809
|
+
required :currency, String
|
1810
|
+
|
1811
|
+
# @!method initialize(amount:, currency:)
|
1812
|
+
# Some parameter documentations has been truncated, see
|
1813
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare}
|
1814
|
+
# for more details.
|
1815
|
+
#
|
1816
|
+
# The total amount of healthcare-related additional amounts.
|
1817
|
+
#
|
1818
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1819
|
+
#
|
1820
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1821
|
+
end
|
1822
|
+
|
1823
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#transit
|
1824
|
+
class Transit < Increase::Internal::Type::BaseModel
|
1825
|
+
# @!attribute amount
|
1826
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1827
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1828
|
+
# subtracted from the amount (such as a discount).
|
1829
|
+
#
|
1830
|
+
# @return [Integer]
|
1831
|
+
required :amount, Integer
|
1832
|
+
|
1833
|
+
# @!attribute currency
|
1834
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1835
|
+
# amount's currency.
|
1836
|
+
#
|
1837
|
+
# @return [String]
|
1838
|
+
required :currency, String
|
1839
|
+
|
1840
|
+
# @!method initialize(amount:, currency:)
|
1841
|
+
# Some parameter documentations has been truncated, see
|
1842
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit}
|
1843
|
+
# for more details.
|
1844
|
+
#
|
1845
|
+
# The part of this transaction amount that was for transit-related services.
|
1846
|
+
#
|
1847
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1848
|
+
#
|
1849
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#unknown
|
1853
|
+
class Unknown < Increase::Internal::Type::BaseModel
|
1854
|
+
# @!attribute amount
|
1855
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1856
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1857
|
+
# subtracted from the amount (such as a discount).
|
1858
|
+
#
|
1859
|
+
# @return [Integer]
|
1860
|
+
required :amount, Integer
|
1861
|
+
|
1862
|
+
# @!attribute currency
|
1863
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1864
|
+
# amount's currency.
|
1865
|
+
#
|
1866
|
+
# @return [String]
|
1867
|
+
required :currency, String
|
1868
|
+
|
1869
|
+
# @!method initialize(amount:, currency:)
|
1870
|
+
# Some parameter documentations has been truncated, see
|
1871
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown}
|
1872
|
+
# for more details.
|
1873
|
+
#
|
1874
|
+
# An unknown additional amount.
|
1875
|
+
#
|
1876
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1877
|
+
#
|
1878
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1879
|
+
end
|
1880
|
+
|
1881
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#vision
|
1882
|
+
class Vision < Increase::Internal::Type::BaseModel
|
1883
|
+
# @!attribute amount
|
1884
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
1885
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
1886
|
+
# subtracted from the amount (such as a discount).
|
1887
|
+
#
|
1888
|
+
# @return [Integer]
|
1889
|
+
required :amount, Integer
|
1890
|
+
|
1891
|
+
# @!attribute currency
|
1892
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
1893
|
+
# amount's currency.
|
1894
|
+
#
|
1895
|
+
# @return [String]
|
1896
|
+
required :currency, String
|
1897
|
+
|
1898
|
+
# @!method initialize(amount:, currency:)
|
1899
|
+
# Some parameter documentations has been truncated, see
|
1900
|
+
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision}
|
1901
|
+
# for more details.
|
1902
|
+
#
|
1903
|
+
# The part of this transaction amount that was for vision-related services.
|
1904
|
+
#
|
1905
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
1906
|
+
#
|
1907
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
1908
|
+
end
|
1909
|
+
end
|
1910
|
+
|
1911
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
1912
|
+
# transaction's currency.
|
1913
|
+
#
|
1914
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#currency
|
1915
|
+
module Currency
|
1916
|
+
extend Increase::Internal::Type::Enum
|
1917
|
+
|
1918
|
+
# Canadian Dollar (CAD)
|
1919
|
+
CAD = :CAD
|
1920
|
+
|
1921
|
+
# Swiss Franc (CHF)
|
1922
|
+
CHF = :CHF
|
1923
|
+
|
1924
|
+
# Euro (EUR)
|
1925
|
+
EUR = :EUR
|
1926
|
+
|
1927
|
+
# British Pound (GBP)
|
1928
|
+
GBP = :GBP
|
1929
|
+
|
1930
|
+
# Japanese Yen (JPY)
|
1931
|
+
JPY = :JPY
|
1932
|
+
|
1933
|
+
# US Dollar (USD)
|
1934
|
+
USD = :USD
|
1935
|
+
|
1936
|
+
# @!method self.values
|
1937
|
+
# @return [Array<Symbol>]
|
1938
|
+
end
|
1939
|
+
|
1940
|
+
# The direction describes the direction the funds will move, either from the
|
1941
|
+
# cardholder to the merchant or from the merchant to the cardholder.
|
1942
|
+
#
|
1943
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#direction
|
1944
|
+
module Direction
|
1945
|
+
extend Increase::Internal::Type::Enum
|
1946
|
+
|
1947
|
+
# A regular card authorization where funds are debited from the cardholder.
|
1948
|
+
SETTLEMENT = :settlement
|
1949
|
+
|
1950
|
+
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
1951
|
+
REFUND = :refund
|
1952
|
+
|
1953
|
+
# @!method self.values
|
1954
|
+
# @return [Array<Symbol>]
|
1955
|
+
end
|
1956
|
+
|
1957
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#network_details
|
1958
|
+
class NetworkDetails < Increase::Internal::Type::BaseModel
|
1959
|
+
# @!attribute category
|
1960
|
+
# The payment network used to process this card authorization.
|
1961
|
+
#
|
1962
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Category]
|
1963
|
+
required :category, enum: -> { Increase::Transaction::Source::CardFinancial::NetworkDetails::Category }
|
1964
|
+
|
1965
|
+
# @!attribute visa
|
1966
|
+
# Fields specific to the `visa` network.
|
1967
|
+
#
|
1968
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa, nil]
|
1969
|
+
required :visa,
|
1970
|
+
-> {
|
1971
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa
|
1972
|
+
},
|
1973
|
+
nil?: true
|
1974
|
+
|
1975
|
+
# @!method initialize(category:, visa:)
|
1976
|
+
# Fields specific to the `network`.
|
1977
|
+
#
|
1978
|
+
# @param category [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Category] The payment network used to process this card authorization.
|
1979
|
+
#
|
1980
|
+
# @param visa [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
|
1981
|
+
|
1982
|
+
# The payment network used to process this card authorization.
|
1983
|
+
#
|
1984
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::NetworkDetails#category
|
1985
|
+
module Category
|
1986
|
+
extend Increase::Internal::Type::Enum
|
1987
|
+
|
1988
|
+
# Visa
|
1989
|
+
VISA = :visa
|
1990
|
+
|
1991
|
+
# @!method self.values
|
1992
|
+
# @return [Array<Symbol>]
|
1993
|
+
end
|
1994
|
+
|
1995
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::NetworkDetails#visa
|
1996
|
+
class Visa < Increase::Internal::Type::BaseModel
|
1997
|
+
# @!attribute electronic_commerce_indicator
|
1998
|
+
# For electronic commerce transactions, this identifies the level of security used
|
1999
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
2000
|
+
# transactions, identifies the type of mail or telephone order.
|
2001
|
+
#
|
2002
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
|
2003
|
+
required :electronic_commerce_indicator,
|
2004
|
+
enum: -> {
|
2005
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator
|
2006
|
+
},
|
2007
|
+
nil?: true
|
2008
|
+
|
2009
|
+
# @!attribute point_of_service_entry_mode
|
2010
|
+
# The method used to enter the cardholder's primary account number and card
|
2011
|
+
# expiration date.
|
2012
|
+
#
|
2013
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
|
2014
|
+
required :point_of_service_entry_mode,
|
2015
|
+
enum: -> {
|
2016
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode
|
2017
|
+
},
|
2018
|
+
nil?: true
|
2019
|
+
|
2020
|
+
# @!attribute stand_in_processing_reason
|
2021
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
2022
|
+
# approved or declined by Visa through stand-in processing.
|
2023
|
+
#
|
2024
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason, nil]
|
2025
|
+
required :stand_in_processing_reason,
|
2026
|
+
enum: -> {
|
2027
|
+
Increase::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason
|
2028
|
+
},
|
2029
|
+
nil?: true
|
2030
|
+
|
2031
|
+
# @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:)
|
2032
|
+
# Some parameter documentations has been truncated, see
|
2033
|
+
# {Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa} for
|
2034
|
+
# more details.
|
2035
|
+
#
|
2036
|
+
# Fields specific to the `visa` network.
|
2037
|
+
#
|
2038
|
+
# @param electronic_commerce_indicator [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
|
2039
|
+
#
|
2040
|
+
# @param point_of_service_entry_mode [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
|
2041
|
+
#
|
2042
|
+
# @param stand_in_processing_reason [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
|
2043
|
+
|
2044
|
+
# For electronic commerce transactions, this identifies the level of security used
|
2045
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
2046
|
+
# transactions, identifies the type of mail or telephone order.
|
2047
|
+
#
|
2048
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa#electronic_commerce_indicator
|
2049
|
+
module ElectronicCommerceIndicator
|
2050
|
+
extend Increase::Internal::Type::Enum
|
2051
|
+
|
2052
|
+
# Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.
|
2053
|
+
MAIL_PHONE_ORDER = :mail_phone_order
|
2054
|
+
|
2055
|
+
# Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.
|
2056
|
+
RECURRING = :recurring
|
2057
|
+
|
2058
|
+
# Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.
|
2059
|
+
INSTALLMENT = :installment
|
2060
|
+
|
2061
|
+
# Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.
|
2062
|
+
UNKNOWN_MAIL_PHONE_ORDER = :unknown_mail_phone_order
|
2063
|
+
|
2064
|
+
# Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure
|
2065
|
+
SECURE_ELECTRONIC_COMMERCE = :secure_electronic_commerce
|
2066
|
+
|
2067
|
+
# Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.
|
2068
|
+
NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT =
|
2069
|
+
:non_authenticated_security_transaction_at_3ds_capable_merchant
|
2070
|
+
|
2071
|
+
# Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure.
|
2072
|
+
NON_AUTHENTICATED_SECURITY_TRANSACTION = :non_authenticated_security_transaction
|
2073
|
+
|
2074
|
+
# Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.
|
2075
|
+
NON_SECURE_TRANSACTION = :non_secure_transaction
|
2076
|
+
|
2077
|
+
# @!method self.values
|
2078
|
+
# @return [Array<Symbol>]
|
2079
|
+
end
|
2080
|
+
|
2081
|
+
# The method used to enter the cardholder's primary account number and card
|
2082
|
+
# expiration date.
|
2083
|
+
#
|
2084
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa#point_of_service_entry_mode
|
2085
|
+
module PointOfServiceEntryMode
|
2086
|
+
extend Increase::Internal::Type::Enum
|
2087
|
+
|
2088
|
+
# Unknown
|
2089
|
+
UNKNOWN = :unknown
|
2090
|
+
|
2091
|
+
# Manual key entry
|
2092
|
+
MANUAL = :manual
|
2093
|
+
|
2094
|
+
# Magnetic stripe read, without card verification value
|
2095
|
+
MAGNETIC_STRIPE_NO_CVV = :magnetic_stripe_no_cvv
|
2096
|
+
|
2097
|
+
# Optical code
|
2098
|
+
OPTICAL_CODE = :optical_code
|
2099
|
+
|
2100
|
+
# Contact chip card
|
2101
|
+
INTEGRATED_CIRCUIT_CARD = :integrated_circuit_card
|
2102
|
+
|
2103
|
+
# Contactless read of chip card
|
2104
|
+
CONTACTLESS = :contactless
|
2105
|
+
|
2106
|
+
# Transaction initiated using a credential that has previously been stored on file
|
2107
|
+
CREDENTIAL_ON_FILE = :credential_on_file
|
2108
|
+
|
2109
|
+
# Magnetic stripe read
|
2110
|
+
MAGNETIC_STRIPE = :magnetic_stripe
|
1050
2111
|
|
1051
|
-
|
1052
|
-
|
2112
|
+
# Contactless read of magnetic stripe data
|
2113
|
+
CONTACTLESS_MAGNETIC_STRIPE = :contactless_magnetic_stripe
|
1053
2114
|
|
1054
|
-
|
1055
|
-
|
1056
|
-
:representative_payee_deceased_or_unable_to_continue_in_that_capacity
|
2115
|
+
# Contact chip card, without card verification value
|
2116
|
+
INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv
|
1057
2117
|
|
1058
|
-
|
1059
|
-
|
2118
|
+
# @!method self.values
|
2119
|
+
# @return [Array<Symbol>]
|
2120
|
+
end
|
1060
2121
|
|
1061
|
-
|
1062
|
-
|
2122
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
2123
|
+
# approved or declined by Visa through stand-in processing.
|
2124
|
+
#
|
2125
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa#stand_in_processing_reason
|
2126
|
+
module StandInProcessingReason
|
2127
|
+
extend Increase::Internal::Type::Enum
|
1063
2128
|
|
1064
|
-
|
1065
|
-
|
2129
|
+
# Increase failed to process the authorization in a timely manner.
|
2130
|
+
ISSUER_ERROR = :issuer_error
|
1066
2131
|
|
1067
|
-
|
1068
|
-
|
2132
|
+
# The physical card read had an invalid CVV, dCVV, or authorization request cryptogram.
|
2133
|
+
INVALID_PHYSICAL_CARD = :invalid_physical_card
|
1069
2134
|
|
1070
|
-
|
1071
|
-
|
2135
|
+
# The 3DS cardholder authentication verification value was invalid.
|
2136
|
+
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
|
2137
|
+
:invalid_cardholder_authentication_verification_value
|
1072
2138
|
|
1073
|
-
|
1074
|
-
|
2139
|
+
# An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.
|
2140
|
+
INTERNAL_VISA_ERROR = :internal_visa_error
|
1075
2141
|
|
1076
|
-
|
1077
|
-
|
2142
|
+
# The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.
|
2143
|
+
MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED =
|
2144
|
+
:merchant_transaction_advisory_service_authentication_required
|
1078
2145
|
|
1079
|
-
|
1080
|
-
|
2146
|
+
# The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.
|
2147
|
+
PAYMENT_FRAUD_DISRUPTION_ACQUIRER_BLOCK = :payment_fraud_disruption_acquirer_block
|
1081
2148
|
|
1082
|
-
|
1083
|
-
|
2149
|
+
# An unspecific reason for stand-in processing.
|
2150
|
+
OTHER = :other
|
1084
2151
|
|
1085
|
-
|
1086
|
-
|
2152
|
+
# @!method self.values
|
2153
|
+
# @return [Array<Symbol>]
|
2154
|
+
end
|
2155
|
+
end
|
2156
|
+
end
|
1087
2157
|
|
1088
|
-
|
1089
|
-
|
2158
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#network_identifiers
|
2159
|
+
class NetworkIdentifiers < Increase::Internal::Type::BaseModel
|
2160
|
+
# @!attribute retrieval_reference_number
|
2161
|
+
# A life-cycle identifier used across e.g., an authorization and a reversal.
|
2162
|
+
# Expected to be unique per acquirer within a window of time. For some card
|
2163
|
+
# networks the retrieval reference number includes the trace counter.
|
2164
|
+
#
|
2165
|
+
# @return [String, nil]
|
2166
|
+
required :retrieval_reference_number, String, nil?: true
|
1090
2167
|
|
1091
|
-
#
|
1092
|
-
|
2168
|
+
# @!attribute trace_number
|
2169
|
+
# A counter used to verify an individual authorization. Expected to be unique per
|
2170
|
+
# acquirer within a window of time.
|
2171
|
+
#
|
2172
|
+
# @return [String, nil]
|
2173
|
+
required :trace_number, String, nil?: true
|
1093
2174
|
|
1094
|
-
#
|
1095
|
-
|
2175
|
+
# @!attribute transaction_id
|
2176
|
+
# A globally unique transaction identifier provided by the card network, used
|
2177
|
+
# across multiple life-cycle requests.
|
2178
|
+
#
|
2179
|
+
# @return [String, nil]
|
2180
|
+
required :transaction_id, String, nil?: true
|
1096
2181
|
|
1097
|
-
# @!method
|
1098
|
-
#
|
2182
|
+
# @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:)
|
2183
|
+
# Some parameter documentations has been truncated, see
|
2184
|
+
# {Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers} for
|
2185
|
+
# more details.
|
2186
|
+
#
|
2187
|
+
# Network-specific identifiers for a specific request or transaction.
|
2188
|
+
#
|
2189
|
+
# @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
|
2190
|
+
#
|
2191
|
+
# @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
|
2192
|
+
#
|
2193
|
+
# @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
|
1099
2194
|
end
|
1100
|
-
end
|
1101
2195
|
|
1102
|
-
|
1103
|
-
|
1104
|
-
# @!attribute accepted_at
|
1105
|
-
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
1106
|
-
# the Card Dispute was accepted.
|
2196
|
+
# The processing category describes the intent behind the financial, such as
|
2197
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
1107
2198
|
#
|
1108
|
-
#
|
1109
|
-
|
2199
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#processing_category
|
2200
|
+
module ProcessingCategory
|
2201
|
+
extend Increase::Internal::Type::Enum
|
1110
2202
|
|
1111
|
-
|
1112
|
-
|
1113
|
-
# to your account.
|
1114
|
-
#
|
1115
|
-
# @return [String]
|
1116
|
-
required :transaction_id, String
|
2203
|
+
# Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.
|
2204
|
+
ACCOUNT_FUNDING = :account_funding
|
1117
2205
|
|
1118
|
-
|
1119
|
-
|
1120
|
-
# {Increase::Models::Transaction::Source::CardDisputeAcceptance} for more details.
|
1121
|
-
#
|
1122
|
-
# A Card Dispute Acceptance object. This field will be present in the JSON
|
1123
|
-
# response if and only if `category` is equal to `card_dispute_acceptance`.
|
1124
|
-
# Contains the details of a successful Card Dispute.
|
1125
|
-
#
|
1126
|
-
# @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
|
1127
|
-
#
|
1128
|
-
# @param transaction_id [String] The identifier of the Transaction that was created to return the disputed funds
|
1129
|
-
end
|
2206
|
+
# Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.
|
2207
|
+
AUTOMATIC_FUEL_DISPENSER = :automatic_fuel_dispenser
|
1130
2208
|
|
1131
|
-
|
1132
|
-
|
1133
|
-
# @!attribute amount
|
1134
|
-
# The amount of the financial event.
|
1135
|
-
#
|
1136
|
-
# @return [Integer]
|
1137
|
-
required :amount, Integer
|
2209
|
+
# A transaction used to pay a bill.
|
2210
|
+
BILL_PAYMENT = :bill_payment
|
1138
2211
|
|
1139
|
-
|
1140
|
-
|
1141
|
-
#
|
1142
|
-
# @return [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network]
|
1143
|
-
required :network, enum: -> { Increase::Transaction::Source::CardDisputeFinancial::Network }
|
2212
|
+
# Original credit transactions are used to send money to a cardholder.
|
2213
|
+
ORIGINAL_CREDIT = :original_credit
|
1144
2214
|
|
1145
|
-
|
1146
|
-
|
1147
|
-
# disputed funds to or from your account.
|
1148
|
-
#
|
1149
|
-
# @return [String]
|
1150
|
-
required :transaction_id, String
|
2215
|
+
# A regular purchase.
|
2216
|
+
PURCHASE = :purchase
|
1151
2217
|
|
1152
|
-
|
1153
|
-
|
1154
|
-
# Visa's network. This field will be present in the JSON response if and only if
|
1155
|
-
# `network` is equal to `visa`.
|
1156
|
-
#
|
1157
|
-
# @return [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil]
|
1158
|
-
required :visa, -> { Increase::Transaction::Source::CardDisputeFinancial::Visa }, nil?: true
|
2218
|
+
# Quasi-cash transactions represent purchases of items which may be convertible to cash.
|
2219
|
+
QUASI_CASH = :quasi_cash
|
1159
2220
|
|
1160
|
-
|
1161
|
-
|
1162
|
-
# {Increase::Models::Transaction::Source::CardDisputeFinancial} for more details.
|
1163
|
-
#
|
1164
|
-
# A Card Dispute Financial object. This field will be present in the JSON response
|
1165
|
-
# if and only if `category` is equal to `card_dispute_financial`. Financial event
|
1166
|
-
# related to a Card Dispute.
|
1167
|
-
#
|
1168
|
-
# @param amount [Integer] The amount of the financial event.
|
1169
|
-
#
|
1170
|
-
# @param network [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network] The network that the Card Dispute is associated with.
|
1171
|
-
#
|
1172
|
-
# @param transaction_id [String] The identifier of the Transaction that was created to credit or debit the disput
|
1173
|
-
#
|
1174
|
-
# @param visa [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil] Information for events related to card dispute for card payments processed over
|
2221
|
+
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
2222
|
+
REFUND = :refund
|
1175
2223
|
|
1176
|
-
|
2224
|
+
# Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
|
2225
|
+
CASH_DISBURSEMENT = :cash_disbursement
|
2226
|
+
|
2227
|
+
# The processing category is unknown.
|
2228
|
+
UNKNOWN = :unknown
|
2229
|
+
|
2230
|
+
# @!method self.values
|
2231
|
+
# @return [Array<Symbol>]
|
2232
|
+
end
|
2233
|
+
|
2234
|
+
# A constant representing the object's type. For this resource it will always be
|
2235
|
+
# `card_financial`.
|
1177
2236
|
#
|
1178
|
-
# @see Increase::Models::Transaction::Source::
|
1179
|
-
module
|
2237
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#type
|
2238
|
+
module Type
|
1180
2239
|
extend Increase::Internal::Type::Enum
|
1181
2240
|
|
1182
|
-
|
1183
|
-
VISA = :visa
|
2241
|
+
CARD_FINANCIAL = :card_financial
|
1184
2242
|
|
1185
2243
|
# @!method self.values
|
1186
2244
|
# @return [Array<Symbol>]
|
1187
2245
|
end
|
1188
2246
|
|
1189
|
-
# @see Increase::Models::Transaction::Source::
|
1190
|
-
class
|
1191
|
-
# @!attribute
|
1192
|
-
#
|
2247
|
+
# @see Increase::Models::Transaction::Source::CardFinancial#verification
|
2248
|
+
class Verification < Increase::Internal::Type::BaseModel
|
2249
|
+
# @!attribute card_verification_code
|
2250
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
2251
|
+
# the back of the card.
|
1193
2252
|
#
|
1194
|
-
# @return [
|
1195
|
-
required :
|
2253
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode]
|
2254
|
+
required :card_verification_code,
|
2255
|
+
-> { Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode }
|
1196
2256
|
|
1197
|
-
# @!
|
1198
|
-
#
|
1199
|
-
#
|
1200
|
-
# `network` is equal to `visa`.
|
2257
|
+
# @!attribute cardholder_address
|
2258
|
+
# Cardholder address provided in the authorization request and the address on file
|
2259
|
+
# we verified it against.
|
1201
2260
|
#
|
1202
|
-
# @
|
2261
|
+
# @return [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress]
|
2262
|
+
required :cardholder_address,
|
2263
|
+
-> { Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress }
|
1203
2264
|
|
1204
|
-
#
|
2265
|
+
# @!method initialize(card_verification_code:, cardholder_address:)
|
2266
|
+
# Some parameter documentations has been truncated, see
|
2267
|
+
# {Increase::Models::Transaction::Source::CardFinancial::Verification} for more
|
2268
|
+
# details.
|
1205
2269
|
#
|
1206
|
-
#
|
1207
|
-
|
1208
|
-
|
1209
|
-
|
1210
|
-
|
1211
|
-
CHARGEBACK_SUBMITTED = :chargeback_submitted
|
2270
|
+
# Fields related to verification of cardholder-provided values.
|
2271
|
+
#
|
2272
|
+
# @param card_verification_code [Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
|
2273
|
+
#
|
2274
|
+
# @param cardholder_address [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
|
1212
2275
|
|
1213
|
-
|
1214
|
-
|
2276
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::Verification#card_verification_code
|
2277
|
+
class CardVerificationCode < Increase::Internal::Type::BaseModel
|
2278
|
+
# @!attribute result
|
2279
|
+
# The result of verifying the Card Verification Code.
|
2280
|
+
#
|
2281
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result]
|
2282
|
+
required :result,
|
2283
|
+
enum: -> { Increase::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result }
|
1215
2284
|
|
1216
|
-
#
|
1217
|
-
|
2285
|
+
# @!method initialize(result:)
|
2286
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
2287
|
+
# the back of the card.
|
2288
|
+
#
|
2289
|
+
# @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
|
1218
2290
|
|
1219
|
-
# The
|
1220
|
-
|
2291
|
+
# The result of verifying the Card Verification Code.
|
2292
|
+
#
|
2293
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode#result
|
2294
|
+
module Result
|
2295
|
+
extend Increase::Internal::Type::Enum
|
1221
2296
|
|
1222
|
-
|
1223
|
-
|
2297
|
+
# No card verification code was provided in the authorization request.
|
2298
|
+
NOT_CHECKED = :not_checked
|
1224
2299
|
|
1225
|
-
|
1226
|
-
|
2300
|
+
# The card verification code matched the one on file.
|
2301
|
+
MATCH = :match
|
1227
2302
|
|
1228
|
-
|
1229
|
-
|
2303
|
+
# The card verification code did not match the one on file.
|
2304
|
+
NO_MATCH = :no_match
|
1230
2305
|
|
1231
|
-
|
1232
|
-
|
2306
|
+
# @!method self.values
|
2307
|
+
# @return [Array<Symbol>]
|
2308
|
+
end
|
1233
2309
|
end
|
1234
|
-
end
|
1235
|
-
end
|
1236
2310
|
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1240
|
-
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
2311
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::Verification#cardholder_address
|
2312
|
+
class CardholderAddress < Increase::Internal::Type::BaseModel
|
2313
|
+
# @!attribute actual_line1
|
2314
|
+
# Line 1 of the address on file for the cardholder.
|
2315
|
+
#
|
2316
|
+
# @return [String, nil]
|
2317
|
+
required :actual_line1, String, nil?: true
|
1244
2318
|
|
1245
|
-
|
1246
|
-
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1250
|
-
required :lost_at, Time
|
2319
|
+
# @!attribute actual_postal_code
|
2320
|
+
# The postal code of the address on file for the cardholder.
|
2321
|
+
#
|
2322
|
+
# @return [String, nil]
|
2323
|
+
required :actual_postal_code, String, nil?: true
|
1251
2324
|
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1256
|
-
|
1257
|
-
|
2325
|
+
# @!attribute provided_line1
|
2326
|
+
# The cardholder address line 1 provided for verification in the authorization
|
2327
|
+
# request.
|
2328
|
+
#
|
2329
|
+
# @return [String, nil]
|
2330
|
+
required :provided_line1, String, nil?: true
|
1258
2331
|
|
1259
|
-
|
1260
|
-
|
1261
|
-
|
1262
|
-
|
1263
|
-
|
1264
|
-
|
1265
|
-
|
1266
|
-
|
1267
|
-
|
1268
|
-
|
1269
|
-
|
1270
|
-
|
1271
|
-
|
2332
|
+
# @!attribute provided_postal_code
|
2333
|
+
# The postal code provided for verification in the authorization request.
|
2334
|
+
#
|
2335
|
+
# @return [String, nil]
|
2336
|
+
required :provided_postal_code, String, nil?: true
|
2337
|
+
|
2338
|
+
# @!attribute result
|
2339
|
+
# The address verification result returned to the card network.
|
2340
|
+
#
|
2341
|
+
# @return [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result]
|
2342
|
+
required :result,
|
2343
|
+
enum: -> { Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result }
|
2344
|
+
|
2345
|
+
# @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
|
2346
|
+
# Some parameter documentations has been truncated, see
|
2347
|
+
# {Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress}
|
2348
|
+
# for more details.
|
2349
|
+
#
|
2350
|
+
# Cardholder address provided in the authorization request and the address on file
|
2351
|
+
# we verified it against.
|
2352
|
+
#
|
2353
|
+
# @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder.
|
2354
|
+
#
|
2355
|
+
# @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
|
2356
|
+
#
|
2357
|
+
# @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
|
2358
|
+
#
|
2359
|
+
# @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
|
2360
|
+
#
|
2361
|
+
# @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result] The address verification result returned to the card network.
|
2362
|
+
|
2363
|
+
# The address verification result returned to the card network.
|
2364
|
+
#
|
2365
|
+
# @see Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress#result
|
2366
|
+
module Result
|
2367
|
+
extend Increase::Internal::Type::Enum
|
2368
|
+
|
2369
|
+
# No address information was provided in the authorization request.
|
2370
|
+
NOT_CHECKED = :not_checked
|
2371
|
+
|
2372
|
+
# Postal code matches, but the street address does not match or was not provided.
|
2373
|
+
POSTAL_CODE_MATCH_ADDRESS_NO_MATCH = :postal_code_match_address_no_match
|
2374
|
+
|
2375
|
+
# Postal code does not match, but the street address matches or was not provided.
|
2376
|
+
POSTAL_CODE_NO_MATCH_ADDRESS_MATCH = :postal_code_no_match_address_match
|
2377
|
+
|
2378
|
+
# Postal code and street address match.
|
2379
|
+
MATCH = :match
|
2380
|
+
|
2381
|
+
# Postal code and street address do not match.
|
2382
|
+
NO_MATCH = :no_match
|
2383
|
+
|
2384
|
+
# Postal code matches, but the street address was not verified. (deprecated)
|
2385
|
+
POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED = :postal_code_match_address_not_checked
|
2386
|
+
|
2387
|
+
# @!method self.values
|
2388
|
+
# @return [Array<Symbol>]
|
2389
|
+
end
|
2390
|
+
end
|
2391
|
+
end
|
1272
2392
|
end
|
1273
2393
|
|
1274
2394
|
# @see Increase::Models::Transaction::Source#card_push_transfer_acceptance
|
@@ -4280,6 +5400,9 @@ module Increase
|
|
4280
5400
|
# Card Settlement: details will be under the `card_settlement` object.
|
4281
5401
|
CARD_SETTLEMENT = :card_settlement
|
4282
5402
|
|
5403
|
+
# Card Financial: details will be under the `card_financial` object.
|
5404
|
+
CARD_FINANCIAL = :card_financial
|
5405
|
+
|
4283
5406
|
# Card Revenue Payment: details will be under the `card_revenue_payment` object.
|
4284
5407
|
CARD_REVENUE_PAYMENT = :card_revenue_payment
|
4285
5408
|
|