increase 1.157.0 → 1.158.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 +8 -0
- data/README.md +1 -1
- data/lib/increase/models/card_payment.rb +1313 -255
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/card_payment.rbi +2275 -244
- data/sig/increase/models/card_payment.rbs +940 -254
- metadata +1 -1
|
@@ -114,6 +114,16 @@ module Increase
|
|
|
114
114
|
-> { Increase::CardPayment::Element::CardAuthorizationExpiration },
|
|
115
115
|
nil?: true
|
|
116
116
|
|
|
117
|
+
# @!attribute card_balance_inquiry
|
|
118
|
+
# A Card Balance Inquiry object. This field will be present in the JSON response
|
|
119
|
+
# if and only if `category` is equal to `card_balance_inquiry`. Card Balance
|
|
120
|
+
# Inquiries are transactions that allow merchants to check the available balance
|
|
121
|
+
# on a card without placing a hold on funds, commonly used when a customer
|
|
122
|
+
# requests their balance at an ATM.
|
|
123
|
+
#
|
|
124
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry, nil]
|
|
125
|
+
required :card_balance_inquiry, -> { Increase::CardPayment::Element::CardBalanceInquiry }, nil?: true
|
|
126
|
+
|
|
117
127
|
# @!attribute card_decline
|
|
118
128
|
# A Card Decline object. This field will be present in the JSON response if and
|
|
119
129
|
# only if `category` is equal to `card_decline`.
|
|
@@ -208,7 +218,7 @@ module Increase
|
|
|
208
218
|
# @return [Increase::Models::CardPayment::Element::Other, nil]
|
|
209
219
|
required :other, -> { Increase::CardPayment::Element::Other }, nil?: true
|
|
210
220
|
|
|
211
|
-
# @!method initialize(card_authentication:, card_authorization:, card_authorization_expiration:, card_decline:, card_financial:, card_fuel_confirmation:, card_increment:, card_refund:, card_reversal:, card_settlement:, card_validation:, category:, created_at:, other:)
|
|
221
|
+
# @!method initialize(card_authentication:, card_authorization:, card_authorization_expiration:, card_balance_inquiry:, card_decline:, card_financial:, card_fuel_confirmation:, card_increment:, card_refund:, card_reversal:, card_settlement:, card_validation:, category:, created_at:, other:)
|
|
212
222
|
# Some parameter documentations has been truncated, see
|
|
213
223
|
# {Increase::Models::CardPayment::Element} for more details.
|
|
214
224
|
#
|
|
@@ -218,6 +228,8 @@ module Increase
|
|
|
218
228
|
#
|
|
219
229
|
# @param card_authorization_expiration [Increase::Models::CardPayment::Element::CardAuthorizationExpiration, nil] A Card Authorization Expiration object. This field will be present in the JSON r
|
|
220
230
|
#
|
|
231
|
+
# @param card_balance_inquiry [Increase::Models::CardPayment::Element::CardBalanceInquiry, nil] A Card Balance Inquiry object. This field will be present in the JSON response i
|
|
232
|
+
#
|
|
221
233
|
# @param card_decline [Increase::Models::CardPayment::Element::CardDecline, nil] A Card Decline object. This field will be present in the JSON response if and on
|
|
222
234
|
#
|
|
223
235
|
# @param card_financial [Increase::Models::CardPayment::Element::CardFinancial, nil] A Card Financial object. This field will be present in the JSON response if and
|
|
@@ -985,47 +997,1257 @@ module Increase
|
|
|
985
997
|
#
|
|
986
998
|
# @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown, nil]
|
|
987
999
|
required :unknown,
|
|
988
|
-
-> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown },
|
|
1000
|
+
-> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown },
|
|
1001
|
+
nil?: true
|
|
1002
|
+
|
|
1003
|
+
# @!attribute vision
|
|
1004
|
+
# The part of this transaction amount that was for vision-related services.
|
|
1005
|
+
#
|
|
1006
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision, nil]
|
|
1007
|
+
required :vision,
|
|
1008
|
+
-> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision },
|
|
1009
|
+
nil?: true
|
|
1010
|
+
|
|
1011
|
+
# @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
|
|
1012
|
+
# Some parameter documentations has been truncated, see
|
|
1013
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts}
|
|
1014
|
+
# for more details.
|
|
1015
|
+
#
|
|
1016
|
+
# Additional amounts associated with the card authorization, such as ATM
|
|
1017
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1018
|
+
# to provide more detailed information about the transaction.
|
|
1019
|
+
#
|
|
1020
|
+
# @param clinic [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
|
|
1021
|
+
#
|
|
1022
|
+
# @param dental [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
|
|
1023
|
+
#
|
|
1024
|
+
# @param original [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Original, nil] The original pre-authorized amount.
|
|
1025
|
+
#
|
|
1026
|
+
# @param prescription [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
|
|
1027
|
+
#
|
|
1028
|
+
# @param surcharge [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
|
|
1029
|
+
#
|
|
1030
|
+
# @param total_cumulative [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
|
|
1031
|
+
#
|
|
1032
|
+
# @param total_healthcare [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
|
|
1033
|
+
#
|
|
1034
|
+
# @param transit [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
|
|
1035
|
+
#
|
|
1036
|
+
# @param unknown [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown, nil] An unknown additional amount.
|
|
1037
|
+
#
|
|
1038
|
+
# @param vision [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
|
|
1039
|
+
|
|
1040
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#clinic
|
|
1041
|
+
class Clinic < Increase::Internal::Type::BaseModel
|
|
1042
|
+
# @!attribute amount
|
|
1043
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1044
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1045
|
+
# subtracted from the amount (such as a discount).
|
|
1046
|
+
#
|
|
1047
|
+
# @return [Integer]
|
|
1048
|
+
required :amount, Integer
|
|
1049
|
+
|
|
1050
|
+
# @!attribute currency
|
|
1051
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1052
|
+
# amount's currency.
|
|
1053
|
+
#
|
|
1054
|
+
# @return [String]
|
|
1055
|
+
required :currency, String
|
|
1056
|
+
|
|
1057
|
+
# @!method initialize(amount:, currency:)
|
|
1058
|
+
# Some parameter documentations has been truncated, see
|
|
1059
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Clinic}
|
|
1060
|
+
# for more details.
|
|
1061
|
+
#
|
|
1062
|
+
# The part of this transaction amount that was for clinic-related services.
|
|
1063
|
+
#
|
|
1064
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1065
|
+
#
|
|
1066
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1067
|
+
end
|
|
1068
|
+
|
|
1069
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#dental
|
|
1070
|
+
class Dental < Increase::Internal::Type::BaseModel
|
|
1071
|
+
# @!attribute amount
|
|
1072
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1073
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1074
|
+
# subtracted from the amount (such as a discount).
|
|
1075
|
+
#
|
|
1076
|
+
# @return [Integer]
|
|
1077
|
+
required :amount, Integer
|
|
1078
|
+
|
|
1079
|
+
# @!attribute currency
|
|
1080
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1081
|
+
# amount's currency.
|
|
1082
|
+
#
|
|
1083
|
+
# @return [String]
|
|
1084
|
+
required :currency, String
|
|
1085
|
+
|
|
1086
|
+
# @!method initialize(amount:, currency:)
|
|
1087
|
+
# Some parameter documentations has been truncated, see
|
|
1088
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Dental}
|
|
1089
|
+
# for more details.
|
|
1090
|
+
#
|
|
1091
|
+
# The part of this transaction amount that was for dental-related services.
|
|
1092
|
+
#
|
|
1093
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1094
|
+
#
|
|
1095
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1096
|
+
end
|
|
1097
|
+
|
|
1098
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#original
|
|
1099
|
+
class Original < Increase::Internal::Type::BaseModel
|
|
1100
|
+
# @!attribute amount
|
|
1101
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1102
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1103
|
+
# subtracted from the amount (such as a discount).
|
|
1104
|
+
#
|
|
1105
|
+
# @return [Integer]
|
|
1106
|
+
required :amount, Integer
|
|
1107
|
+
|
|
1108
|
+
# @!attribute currency
|
|
1109
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1110
|
+
# amount's currency.
|
|
1111
|
+
#
|
|
1112
|
+
# @return [String]
|
|
1113
|
+
required :currency, String
|
|
1114
|
+
|
|
1115
|
+
# @!method initialize(amount:, currency:)
|
|
1116
|
+
# Some parameter documentations has been truncated, see
|
|
1117
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Original}
|
|
1118
|
+
# for more details.
|
|
1119
|
+
#
|
|
1120
|
+
# The original pre-authorized amount.
|
|
1121
|
+
#
|
|
1122
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1123
|
+
#
|
|
1124
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1125
|
+
end
|
|
1126
|
+
|
|
1127
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#prescription
|
|
1128
|
+
class Prescription < Increase::Internal::Type::BaseModel
|
|
1129
|
+
# @!attribute amount
|
|
1130
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1131
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1132
|
+
# subtracted from the amount (such as a discount).
|
|
1133
|
+
#
|
|
1134
|
+
# @return [Integer]
|
|
1135
|
+
required :amount, Integer
|
|
1136
|
+
|
|
1137
|
+
# @!attribute currency
|
|
1138
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1139
|
+
# amount's currency.
|
|
1140
|
+
#
|
|
1141
|
+
# @return [String]
|
|
1142
|
+
required :currency, String
|
|
1143
|
+
|
|
1144
|
+
# @!method initialize(amount:, currency:)
|
|
1145
|
+
# Some parameter documentations has been truncated, see
|
|
1146
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Prescription}
|
|
1147
|
+
# for more details.
|
|
1148
|
+
#
|
|
1149
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
|
1150
|
+
#
|
|
1151
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1152
|
+
#
|
|
1153
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1154
|
+
end
|
|
1155
|
+
|
|
1156
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#surcharge
|
|
1157
|
+
class Surcharge < Increase::Internal::Type::BaseModel
|
|
1158
|
+
# @!attribute amount
|
|
1159
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1160
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1161
|
+
# subtracted from the amount (such as a discount).
|
|
1162
|
+
#
|
|
1163
|
+
# @return [Integer]
|
|
1164
|
+
required :amount, Integer
|
|
1165
|
+
|
|
1166
|
+
# @!attribute currency
|
|
1167
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1168
|
+
# amount's currency.
|
|
1169
|
+
#
|
|
1170
|
+
# @return [String]
|
|
1171
|
+
required :currency, String
|
|
1172
|
+
|
|
1173
|
+
# @!method initialize(amount:, currency:)
|
|
1174
|
+
# Some parameter documentations has been truncated, see
|
|
1175
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Surcharge}
|
|
1176
|
+
# for more details.
|
|
1177
|
+
#
|
|
1178
|
+
# The surcharge amount charged for this transaction by the merchant.
|
|
1179
|
+
#
|
|
1180
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1181
|
+
#
|
|
1182
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1183
|
+
end
|
|
1184
|
+
|
|
1185
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#total_cumulative
|
|
1186
|
+
class TotalCumulative < Increase::Internal::Type::BaseModel
|
|
1187
|
+
# @!attribute amount
|
|
1188
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1189
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1190
|
+
# subtracted from the amount (such as a discount).
|
|
1191
|
+
#
|
|
1192
|
+
# @return [Integer]
|
|
1193
|
+
required :amount, Integer
|
|
1194
|
+
|
|
1195
|
+
# @!attribute currency
|
|
1196
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1197
|
+
# amount's currency.
|
|
1198
|
+
#
|
|
1199
|
+
# @return [String]
|
|
1200
|
+
required :currency, String
|
|
1201
|
+
|
|
1202
|
+
# @!method initialize(amount:, currency:)
|
|
1203
|
+
# Some parameter documentations has been truncated, see
|
|
1204
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalCumulative}
|
|
1205
|
+
# for more details.
|
|
1206
|
+
#
|
|
1207
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
|
1208
|
+
#
|
|
1209
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1210
|
+
#
|
|
1211
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1212
|
+
end
|
|
1213
|
+
|
|
1214
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#total_healthcare
|
|
1215
|
+
class TotalHealthcare < Increase::Internal::Type::BaseModel
|
|
1216
|
+
# @!attribute amount
|
|
1217
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1218
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1219
|
+
# subtracted from the amount (such as a discount).
|
|
1220
|
+
#
|
|
1221
|
+
# @return [Integer]
|
|
1222
|
+
required :amount, Integer
|
|
1223
|
+
|
|
1224
|
+
# @!attribute currency
|
|
1225
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1226
|
+
# amount's currency.
|
|
1227
|
+
#
|
|
1228
|
+
# @return [String]
|
|
1229
|
+
required :currency, String
|
|
1230
|
+
|
|
1231
|
+
# @!method initialize(amount:, currency:)
|
|
1232
|
+
# Some parameter documentations has been truncated, see
|
|
1233
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalHealthcare}
|
|
1234
|
+
# for more details.
|
|
1235
|
+
#
|
|
1236
|
+
# The total amount of healthcare-related additional amounts.
|
|
1237
|
+
#
|
|
1238
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1239
|
+
#
|
|
1240
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1241
|
+
end
|
|
1242
|
+
|
|
1243
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#transit
|
|
1244
|
+
class Transit < Increase::Internal::Type::BaseModel
|
|
1245
|
+
# @!attribute amount
|
|
1246
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1247
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1248
|
+
# subtracted from the amount (such as a discount).
|
|
1249
|
+
#
|
|
1250
|
+
# @return [Integer]
|
|
1251
|
+
required :amount, Integer
|
|
1252
|
+
|
|
1253
|
+
# @!attribute currency
|
|
1254
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1255
|
+
# amount's currency.
|
|
1256
|
+
#
|
|
1257
|
+
# @return [String]
|
|
1258
|
+
required :currency, String
|
|
1259
|
+
|
|
1260
|
+
# @!method initialize(amount:, currency:)
|
|
1261
|
+
# Some parameter documentations has been truncated, see
|
|
1262
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Transit}
|
|
1263
|
+
# for more details.
|
|
1264
|
+
#
|
|
1265
|
+
# The part of this transaction amount that was for transit-related services.
|
|
1266
|
+
#
|
|
1267
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1268
|
+
#
|
|
1269
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1270
|
+
end
|
|
1271
|
+
|
|
1272
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#unknown
|
|
1273
|
+
class Unknown < Increase::Internal::Type::BaseModel
|
|
1274
|
+
# @!attribute amount
|
|
1275
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1276
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1277
|
+
# subtracted from the amount (such as a discount).
|
|
1278
|
+
#
|
|
1279
|
+
# @return [Integer]
|
|
1280
|
+
required :amount, Integer
|
|
1281
|
+
|
|
1282
|
+
# @!attribute currency
|
|
1283
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1284
|
+
# amount's currency.
|
|
1285
|
+
#
|
|
1286
|
+
# @return [String]
|
|
1287
|
+
required :currency, String
|
|
1288
|
+
|
|
1289
|
+
# @!method initialize(amount:, currency:)
|
|
1290
|
+
# Some parameter documentations has been truncated, see
|
|
1291
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown}
|
|
1292
|
+
# for more details.
|
|
1293
|
+
#
|
|
1294
|
+
# An unknown additional amount.
|
|
1295
|
+
#
|
|
1296
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1297
|
+
#
|
|
1298
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1299
|
+
end
|
|
1300
|
+
|
|
1301
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#vision
|
|
1302
|
+
class Vision < Increase::Internal::Type::BaseModel
|
|
1303
|
+
# @!attribute amount
|
|
1304
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
1305
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1306
|
+
# subtracted from the amount (such as a discount).
|
|
1307
|
+
#
|
|
1308
|
+
# @return [Integer]
|
|
1309
|
+
required :amount, Integer
|
|
1310
|
+
|
|
1311
|
+
# @!attribute currency
|
|
1312
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1313
|
+
# amount's currency.
|
|
1314
|
+
#
|
|
1315
|
+
# @return [String]
|
|
1316
|
+
required :currency, String
|
|
1317
|
+
|
|
1318
|
+
# @!method initialize(amount:, currency:)
|
|
1319
|
+
# Some parameter documentations has been truncated, see
|
|
1320
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision}
|
|
1321
|
+
# for more details.
|
|
1322
|
+
#
|
|
1323
|
+
# The part of this transaction amount that was for vision-related services.
|
|
1324
|
+
#
|
|
1325
|
+
# @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
|
|
1326
|
+
#
|
|
1327
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1328
|
+
end
|
|
1329
|
+
end
|
|
1330
|
+
|
|
1331
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1332
|
+
# transaction's currency.
|
|
1333
|
+
#
|
|
1334
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization#currency
|
|
1335
|
+
module Currency
|
|
1336
|
+
extend Increase::Internal::Type::Enum
|
|
1337
|
+
|
|
1338
|
+
# US Dollar (USD)
|
|
1339
|
+
USD = :USD
|
|
1340
|
+
|
|
1341
|
+
# @!method self.values
|
|
1342
|
+
# @return [Array<Symbol>]
|
|
1343
|
+
end
|
|
1344
|
+
|
|
1345
|
+
# The direction describes the direction the funds will move, either from the
|
|
1346
|
+
# cardholder to the merchant or from the merchant to the cardholder.
|
|
1347
|
+
#
|
|
1348
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization#direction
|
|
1349
|
+
module Direction
|
|
1350
|
+
extend Increase::Internal::Type::Enum
|
|
1351
|
+
|
|
1352
|
+
# A regular card authorization where funds are debited from the cardholder.
|
|
1353
|
+
SETTLEMENT = :settlement
|
|
1354
|
+
|
|
1355
|
+
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
|
1356
|
+
REFUND = :refund
|
|
1357
|
+
|
|
1358
|
+
# @!method self.values
|
|
1359
|
+
# @return [Array<Symbol>]
|
|
1360
|
+
end
|
|
1361
|
+
|
|
1362
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization#network_details
|
|
1363
|
+
class NetworkDetails < Increase::Internal::Type::BaseModel
|
|
1364
|
+
# @!attribute category
|
|
1365
|
+
# The payment network used to process this card authorization.
|
|
1366
|
+
#
|
|
1367
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category]
|
|
1368
|
+
required :category,
|
|
1369
|
+
enum: -> { Increase::CardPayment::Element::CardAuthorization::NetworkDetails::Category }
|
|
1370
|
+
|
|
1371
|
+
# @!attribute pulse
|
|
1372
|
+
# Fields specific to the `pulse` network.
|
|
1373
|
+
#
|
|
1374
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Pulse, nil]
|
|
1375
|
+
required :pulse,
|
|
1376
|
+
-> { Increase::CardPayment::Element::CardAuthorization::NetworkDetails::Pulse },
|
|
1377
|
+
nil?: true
|
|
1378
|
+
|
|
1379
|
+
# @!attribute visa
|
|
1380
|
+
# Fields specific to the `visa` network.
|
|
1381
|
+
#
|
|
1382
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa, nil]
|
|
1383
|
+
required :visa,
|
|
1384
|
+
-> {
|
|
1385
|
+
Increase::CardPayment::Element::CardAuthorization::NetworkDetails::Visa
|
|
1386
|
+
},
|
|
1387
|
+
nil?: true
|
|
1388
|
+
|
|
1389
|
+
# @!method initialize(category:, pulse:, visa:)
|
|
1390
|
+
# Fields specific to the `network`.
|
|
1391
|
+
#
|
|
1392
|
+
# @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category] The payment network used to process this card authorization.
|
|
1393
|
+
#
|
|
1394
|
+
# @param pulse [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
|
|
1395
|
+
#
|
|
1396
|
+
# @param visa [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
|
|
1397
|
+
|
|
1398
|
+
# The payment network used to process this card authorization.
|
|
1399
|
+
#
|
|
1400
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails#category
|
|
1401
|
+
module Category
|
|
1402
|
+
extend Increase::Internal::Type::Enum
|
|
1403
|
+
|
|
1404
|
+
# Visa
|
|
1405
|
+
VISA = :visa
|
|
1406
|
+
|
|
1407
|
+
# Pulse
|
|
1408
|
+
PULSE = :pulse
|
|
1409
|
+
|
|
1410
|
+
# @!method self.values
|
|
1411
|
+
# @return [Array<Symbol>]
|
|
1412
|
+
end
|
|
1413
|
+
|
|
1414
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails#pulse
|
|
1415
|
+
class Pulse < Increase::Internal::Type::BaseModel
|
|
1416
|
+
# @!method initialize
|
|
1417
|
+
# Fields specific to the `pulse` network.
|
|
1418
|
+
end
|
|
1419
|
+
|
|
1420
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails#visa
|
|
1421
|
+
class Visa < Increase::Internal::Type::BaseModel
|
|
1422
|
+
# @!attribute electronic_commerce_indicator
|
|
1423
|
+
# For electronic commerce transactions, this identifies the level of security used
|
|
1424
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
|
1425
|
+
# transactions, identifies the type of mail or telephone order.
|
|
1426
|
+
#
|
|
1427
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
|
|
1428
|
+
required :electronic_commerce_indicator,
|
|
1429
|
+
enum: -> {
|
|
1430
|
+
Increase::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator
|
|
1431
|
+
},
|
|
1432
|
+
nil?: true
|
|
1433
|
+
|
|
1434
|
+
# @!attribute point_of_service_entry_mode
|
|
1435
|
+
# The method used to enter the cardholder's primary account number and card
|
|
1436
|
+
# expiration date.
|
|
1437
|
+
#
|
|
1438
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
|
|
1439
|
+
required :point_of_service_entry_mode,
|
|
1440
|
+
enum: -> {
|
|
1441
|
+
Increase::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode
|
|
1442
|
+
},
|
|
1443
|
+
nil?: true
|
|
1444
|
+
|
|
1445
|
+
# @!attribute stand_in_processing_reason
|
|
1446
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
|
1447
|
+
# approved or declined by Visa through stand-in processing.
|
|
1448
|
+
#
|
|
1449
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil]
|
|
1450
|
+
required :stand_in_processing_reason,
|
|
1451
|
+
enum: -> {
|
|
1452
|
+
Increase::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason
|
|
1453
|
+
},
|
|
1454
|
+
nil?: true
|
|
1455
|
+
|
|
1456
|
+
# @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:)
|
|
1457
|
+
# Some parameter documentations has been truncated, see
|
|
1458
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa}
|
|
1459
|
+
# for more details.
|
|
1460
|
+
#
|
|
1461
|
+
# Fields specific to the `visa` network.
|
|
1462
|
+
#
|
|
1463
|
+
# @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
|
|
1464
|
+
#
|
|
1465
|
+
# @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
|
|
1466
|
+
#
|
|
1467
|
+
# @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
|
|
1468
|
+
|
|
1469
|
+
# For electronic commerce transactions, this identifies the level of security used
|
|
1470
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
|
1471
|
+
# transactions, identifies the type of mail or telephone order.
|
|
1472
|
+
#
|
|
1473
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa#electronic_commerce_indicator
|
|
1474
|
+
module ElectronicCommerceIndicator
|
|
1475
|
+
extend Increase::Internal::Type::Enum
|
|
1476
|
+
|
|
1477
|
+
# 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.
|
|
1478
|
+
MAIL_PHONE_ORDER = :mail_phone_order
|
|
1479
|
+
|
|
1480
|
+
# Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.
|
|
1481
|
+
RECURRING = :recurring
|
|
1482
|
+
|
|
1483
|
+
# 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.
|
|
1484
|
+
INSTALLMENT = :installment
|
|
1485
|
+
|
|
1486
|
+
# Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.
|
|
1487
|
+
UNKNOWN_MAIL_PHONE_ORDER = :unknown_mail_phone_order
|
|
1488
|
+
|
|
1489
|
+
# Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure
|
|
1490
|
+
SECURE_ELECTRONIC_COMMERCE = :secure_electronic_commerce
|
|
1491
|
+
|
|
1492
|
+
# 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.
|
|
1493
|
+
NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT =
|
|
1494
|
+
:non_authenticated_security_transaction_at_3ds_capable_merchant
|
|
1495
|
+
|
|
1496
|
+
# 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.
|
|
1497
|
+
NON_AUTHENTICATED_SECURITY_TRANSACTION = :non_authenticated_security_transaction
|
|
1498
|
+
|
|
1499
|
+
# Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.
|
|
1500
|
+
NON_SECURE_TRANSACTION = :non_secure_transaction
|
|
1501
|
+
|
|
1502
|
+
# @!method self.values
|
|
1503
|
+
# @return [Array<Symbol>]
|
|
1504
|
+
end
|
|
1505
|
+
|
|
1506
|
+
# The method used to enter the cardholder's primary account number and card
|
|
1507
|
+
# expiration date.
|
|
1508
|
+
#
|
|
1509
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa#point_of_service_entry_mode
|
|
1510
|
+
module PointOfServiceEntryMode
|
|
1511
|
+
extend Increase::Internal::Type::Enum
|
|
1512
|
+
|
|
1513
|
+
# Unknown
|
|
1514
|
+
UNKNOWN = :unknown
|
|
1515
|
+
|
|
1516
|
+
# Manual key entry
|
|
1517
|
+
MANUAL = :manual
|
|
1518
|
+
|
|
1519
|
+
# Magnetic stripe read, without card verification value
|
|
1520
|
+
MAGNETIC_STRIPE_NO_CVV = :magnetic_stripe_no_cvv
|
|
1521
|
+
|
|
1522
|
+
# Optical code
|
|
1523
|
+
OPTICAL_CODE = :optical_code
|
|
1524
|
+
|
|
1525
|
+
# Contact chip card
|
|
1526
|
+
INTEGRATED_CIRCUIT_CARD = :integrated_circuit_card
|
|
1527
|
+
|
|
1528
|
+
# Contactless read of chip card
|
|
1529
|
+
CONTACTLESS = :contactless
|
|
1530
|
+
|
|
1531
|
+
# Transaction initiated using a credential that has previously been stored on file
|
|
1532
|
+
CREDENTIAL_ON_FILE = :credential_on_file
|
|
1533
|
+
|
|
1534
|
+
# Magnetic stripe read
|
|
1535
|
+
MAGNETIC_STRIPE = :magnetic_stripe
|
|
1536
|
+
|
|
1537
|
+
# Contactless read of magnetic stripe data
|
|
1538
|
+
CONTACTLESS_MAGNETIC_STRIPE = :contactless_magnetic_stripe
|
|
1539
|
+
|
|
1540
|
+
# Contact chip card, without card verification value
|
|
1541
|
+
INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv
|
|
1542
|
+
|
|
1543
|
+
# @!method self.values
|
|
1544
|
+
# @return [Array<Symbol>]
|
|
1545
|
+
end
|
|
1546
|
+
|
|
1547
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
|
1548
|
+
# approved or declined by Visa through stand-in processing.
|
|
1549
|
+
#
|
|
1550
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa#stand_in_processing_reason
|
|
1551
|
+
module StandInProcessingReason
|
|
1552
|
+
extend Increase::Internal::Type::Enum
|
|
1553
|
+
|
|
1554
|
+
# Increase failed to process the authorization in a timely manner.
|
|
1555
|
+
ISSUER_ERROR = :issuer_error
|
|
1556
|
+
|
|
1557
|
+
# The physical card read had an invalid CVV, dCVV, or authorization request cryptogram.
|
|
1558
|
+
INVALID_PHYSICAL_CARD = :invalid_physical_card
|
|
1559
|
+
|
|
1560
|
+
# The 3DS cardholder authentication verification value was invalid.
|
|
1561
|
+
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
|
|
1562
|
+
:invalid_cardholder_authentication_verification_value
|
|
1563
|
+
|
|
1564
|
+
# An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.
|
|
1565
|
+
INTERNAL_VISA_ERROR = :internal_visa_error
|
|
1566
|
+
|
|
1567
|
+
# 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.
|
|
1568
|
+
MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED =
|
|
1569
|
+
:merchant_transaction_advisory_service_authentication_required
|
|
1570
|
+
|
|
1571
|
+
# The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.
|
|
1572
|
+
PAYMENT_FRAUD_DISRUPTION_ACQUIRER_BLOCK = :payment_fraud_disruption_acquirer_block
|
|
1573
|
+
|
|
1574
|
+
# An unspecific reason for stand-in processing.
|
|
1575
|
+
OTHER = :other
|
|
1576
|
+
|
|
1577
|
+
# @!method self.values
|
|
1578
|
+
# @return [Array<Symbol>]
|
|
1579
|
+
end
|
|
1580
|
+
end
|
|
1581
|
+
end
|
|
1582
|
+
|
|
1583
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization#network_identifiers
|
|
1584
|
+
class NetworkIdentifiers < Increase::Internal::Type::BaseModel
|
|
1585
|
+
# @!attribute authorization_identification_response
|
|
1586
|
+
# The randomly generated 6-character Authorization Identification Response code
|
|
1587
|
+
# sent back to the acquirer in an approved response.
|
|
1588
|
+
#
|
|
1589
|
+
# @return [String, nil]
|
|
1590
|
+
required :authorization_identification_response, String, nil?: true
|
|
1591
|
+
|
|
1592
|
+
# @!attribute retrieval_reference_number
|
|
1593
|
+
# A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
1594
|
+
# Expected to be unique per acquirer within a window of time. For some card
|
|
1595
|
+
# networks the retrieval reference number includes the trace counter.
|
|
1596
|
+
#
|
|
1597
|
+
# @return [String, nil]
|
|
1598
|
+
required :retrieval_reference_number, String, nil?: true
|
|
1599
|
+
|
|
1600
|
+
# @!attribute trace_number
|
|
1601
|
+
# A counter used to verify an individual authorization. Expected to be unique per
|
|
1602
|
+
# acquirer within a window of time.
|
|
1603
|
+
#
|
|
1604
|
+
# @return [String, nil]
|
|
1605
|
+
required :trace_number, String, nil?: true
|
|
1606
|
+
|
|
1607
|
+
# @!attribute transaction_id
|
|
1608
|
+
# A globally unique transaction identifier provided by the card network, used
|
|
1609
|
+
# across multiple life-cycle requests.
|
|
1610
|
+
#
|
|
1611
|
+
# @return [String, nil]
|
|
1612
|
+
required :transaction_id, String, nil?: true
|
|
1613
|
+
|
|
1614
|
+
# @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
|
|
1615
|
+
# Some parameter documentations has been truncated, see
|
|
1616
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers}
|
|
1617
|
+
# for more details.
|
|
1618
|
+
#
|
|
1619
|
+
# Network-specific identifiers for a specific request or transaction.
|
|
1620
|
+
#
|
|
1621
|
+
# @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
|
|
1622
|
+
#
|
|
1623
|
+
# @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
|
|
1624
|
+
#
|
|
1625
|
+
# @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
|
|
1626
|
+
#
|
|
1627
|
+
# @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
|
|
1628
|
+
end
|
|
1629
|
+
|
|
1630
|
+
# The processing category describes the intent behind the authorization, such as
|
|
1631
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
|
1632
|
+
#
|
|
1633
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization#processing_category
|
|
1634
|
+
module ProcessingCategory
|
|
1635
|
+
extend Increase::Internal::Type::Enum
|
|
1636
|
+
|
|
1637
|
+
# Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.
|
|
1638
|
+
ACCOUNT_FUNDING = :account_funding
|
|
1639
|
+
|
|
1640
|
+
# 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.
|
|
1641
|
+
AUTOMATIC_FUEL_DISPENSER = :automatic_fuel_dispenser
|
|
1642
|
+
|
|
1643
|
+
# A transaction used to pay a bill.
|
|
1644
|
+
BILL_PAYMENT = :bill_payment
|
|
1645
|
+
|
|
1646
|
+
# Original credit transactions are used to send money to a cardholder.
|
|
1647
|
+
ORIGINAL_CREDIT = :original_credit
|
|
1648
|
+
|
|
1649
|
+
# A regular purchase.
|
|
1650
|
+
PURCHASE = :purchase
|
|
1651
|
+
|
|
1652
|
+
# Quasi-cash transactions represent purchases of items which may be convertible to cash.
|
|
1653
|
+
QUASI_CASH = :quasi_cash
|
|
1654
|
+
|
|
1655
|
+
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
|
1656
|
+
REFUND = :refund
|
|
1657
|
+
|
|
1658
|
+
# Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
|
|
1659
|
+
CASH_DISBURSEMENT = :cash_disbursement
|
|
1660
|
+
|
|
1661
|
+
# A balance inquiry transaction is used to check the balance of an account associated with a card.
|
|
1662
|
+
BALANCE_INQUIRY = :balance_inquiry
|
|
1663
|
+
|
|
1664
|
+
# The processing category is unknown.
|
|
1665
|
+
UNKNOWN = :unknown
|
|
1666
|
+
|
|
1667
|
+
# @!method self.values
|
|
1668
|
+
# @return [Array<Symbol>]
|
|
1669
|
+
end
|
|
1670
|
+
|
|
1671
|
+
# A constant representing the object's type. For this resource it will always be
|
|
1672
|
+
# `card_authorization`.
|
|
1673
|
+
#
|
|
1674
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization#type
|
|
1675
|
+
module Type
|
|
1676
|
+
extend Increase::Internal::Type::Enum
|
|
1677
|
+
|
|
1678
|
+
CARD_AUTHORIZATION = :card_authorization
|
|
1679
|
+
|
|
1680
|
+
# @!method self.values
|
|
1681
|
+
# @return [Array<Symbol>]
|
|
1682
|
+
end
|
|
1683
|
+
|
|
1684
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization#verification
|
|
1685
|
+
class Verification < Increase::Internal::Type::BaseModel
|
|
1686
|
+
# @!attribute card_verification_code
|
|
1687
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1688
|
+
# the back of the card.
|
|
1689
|
+
#
|
|
1690
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode]
|
|
1691
|
+
required :card_verification_code,
|
|
1692
|
+
-> { Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode }
|
|
1693
|
+
|
|
1694
|
+
# @!attribute cardholder_address
|
|
1695
|
+
# Cardholder address provided in the authorization request and the address on file
|
|
1696
|
+
# we verified it against.
|
|
1697
|
+
#
|
|
1698
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress]
|
|
1699
|
+
required :cardholder_address,
|
|
1700
|
+
-> { Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress }
|
|
1701
|
+
|
|
1702
|
+
# @!method initialize(card_verification_code:, cardholder_address:)
|
|
1703
|
+
# Some parameter documentations has been truncated, see
|
|
1704
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::Verification} for
|
|
1705
|
+
# more details.
|
|
1706
|
+
#
|
|
1707
|
+
# Fields related to verification of cardholder-provided values.
|
|
1708
|
+
#
|
|
1709
|
+
# @param card_verification_code [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1710
|
+
#
|
|
1711
|
+
# @param cardholder_address [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
|
|
1712
|
+
|
|
1713
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::Verification#card_verification_code
|
|
1714
|
+
class CardVerificationCode < Increase::Internal::Type::BaseModel
|
|
1715
|
+
# @!attribute result
|
|
1716
|
+
# The result of verifying the Card Verification Code.
|
|
1717
|
+
#
|
|
1718
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result]
|
|
1719
|
+
required :result,
|
|
1720
|
+
enum: -> { Increase::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result }
|
|
1721
|
+
|
|
1722
|
+
# @!method initialize(result:)
|
|
1723
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1724
|
+
# the back of the card.
|
|
1725
|
+
#
|
|
1726
|
+
# @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
|
|
1727
|
+
|
|
1728
|
+
# The result of verifying the Card Verification Code.
|
|
1729
|
+
#
|
|
1730
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode#result
|
|
1731
|
+
module Result
|
|
1732
|
+
extend Increase::Internal::Type::Enum
|
|
1733
|
+
|
|
1734
|
+
# No card verification code was provided in the authorization request.
|
|
1735
|
+
NOT_CHECKED = :not_checked
|
|
1736
|
+
|
|
1737
|
+
# The card verification code matched the one on file.
|
|
1738
|
+
MATCH = :match
|
|
1739
|
+
|
|
1740
|
+
# The card verification code did not match the one on file.
|
|
1741
|
+
NO_MATCH = :no_match
|
|
1742
|
+
|
|
1743
|
+
# @!method self.values
|
|
1744
|
+
# @return [Array<Symbol>]
|
|
1745
|
+
end
|
|
1746
|
+
end
|
|
1747
|
+
|
|
1748
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::Verification#cardholder_address
|
|
1749
|
+
class CardholderAddress < Increase::Internal::Type::BaseModel
|
|
1750
|
+
# @!attribute actual_line1
|
|
1751
|
+
# Line 1 of the address on file for the cardholder.
|
|
1752
|
+
#
|
|
1753
|
+
# @return [String, nil]
|
|
1754
|
+
required :actual_line1, String, nil?: true
|
|
1755
|
+
|
|
1756
|
+
# @!attribute actual_postal_code
|
|
1757
|
+
# The postal code of the address on file for the cardholder.
|
|
1758
|
+
#
|
|
1759
|
+
# @return [String, nil]
|
|
1760
|
+
required :actual_postal_code, String, nil?: true
|
|
1761
|
+
|
|
1762
|
+
# @!attribute provided_line1
|
|
1763
|
+
# The cardholder address line 1 provided for verification in the authorization
|
|
1764
|
+
# request.
|
|
1765
|
+
#
|
|
1766
|
+
# @return [String, nil]
|
|
1767
|
+
required :provided_line1, String, nil?: true
|
|
1768
|
+
|
|
1769
|
+
# @!attribute provided_postal_code
|
|
1770
|
+
# The postal code provided for verification in the authorization request.
|
|
1771
|
+
#
|
|
1772
|
+
# @return [String, nil]
|
|
1773
|
+
required :provided_postal_code, String, nil?: true
|
|
1774
|
+
|
|
1775
|
+
# @!attribute result
|
|
1776
|
+
# The address verification result returned to the card network.
|
|
1777
|
+
#
|
|
1778
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result]
|
|
1779
|
+
required :result,
|
|
1780
|
+
enum: -> { Increase::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result }
|
|
1781
|
+
|
|
1782
|
+
# @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
|
|
1783
|
+
# Some parameter documentations has been truncated, see
|
|
1784
|
+
# {Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress}
|
|
1785
|
+
# for more details.
|
|
1786
|
+
#
|
|
1787
|
+
# Cardholder address provided in the authorization request and the address on file
|
|
1788
|
+
# we verified it against.
|
|
1789
|
+
#
|
|
1790
|
+
# @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder.
|
|
1791
|
+
#
|
|
1792
|
+
# @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
|
|
1793
|
+
#
|
|
1794
|
+
# @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
|
|
1795
|
+
#
|
|
1796
|
+
# @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
|
|
1797
|
+
#
|
|
1798
|
+
# @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result] The address verification result returned to the card network.
|
|
1799
|
+
|
|
1800
|
+
# The address verification result returned to the card network.
|
|
1801
|
+
#
|
|
1802
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress#result
|
|
1803
|
+
module Result
|
|
1804
|
+
extend Increase::Internal::Type::Enum
|
|
1805
|
+
|
|
1806
|
+
# No address information was provided in the authorization request.
|
|
1807
|
+
NOT_CHECKED = :not_checked
|
|
1808
|
+
|
|
1809
|
+
# Postal code matches, but the street address does not match or was not provided.
|
|
1810
|
+
POSTAL_CODE_MATCH_ADDRESS_NO_MATCH = :postal_code_match_address_no_match
|
|
1811
|
+
|
|
1812
|
+
# Postal code does not match, but the street address matches or was not provided.
|
|
1813
|
+
POSTAL_CODE_NO_MATCH_ADDRESS_MATCH = :postal_code_no_match_address_match
|
|
1814
|
+
|
|
1815
|
+
# Postal code and street address match.
|
|
1816
|
+
MATCH = :match
|
|
1817
|
+
|
|
1818
|
+
# Postal code and street address do not match.
|
|
1819
|
+
NO_MATCH = :no_match
|
|
1820
|
+
|
|
1821
|
+
# Postal code matches, but the street address was not verified. (deprecated)
|
|
1822
|
+
POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED = :postal_code_match_address_not_checked
|
|
1823
|
+
|
|
1824
|
+
# @!method self.values
|
|
1825
|
+
# @return [Array<Symbol>]
|
|
1826
|
+
end
|
|
1827
|
+
end
|
|
1828
|
+
end
|
|
1829
|
+
end
|
|
1830
|
+
|
|
1831
|
+
# @see Increase::Models::CardPayment::Element#card_authorization_expiration
|
|
1832
|
+
class CardAuthorizationExpiration < Increase::Internal::Type::BaseModel
|
|
1833
|
+
# @!attribute id
|
|
1834
|
+
# The Card Authorization Expiration identifier.
|
|
1835
|
+
#
|
|
1836
|
+
# @return [String]
|
|
1837
|
+
required :id, String
|
|
1838
|
+
|
|
1839
|
+
# @!attribute card_authorization_id
|
|
1840
|
+
# The identifier for the Card Authorization this reverses.
|
|
1841
|
+
#
|
|
1842
|
+
# @return [String]
|
|
1843
|
+
required :card_authorization_id, String
|
|
1844
|
+
|
|
1845
|
+
# @!attribute currency
|
|
1846
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
|
1847
|
+
# currency.
|
|
1848
|
+
#
|
|
1849
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency]
|
|
1850
|
+
required :currency, enum: -> { Increase::CardPayment::Element::CardAuthorizationExpiration::Currency }
|
|
1851
|
+
|
|
1852
|
+
# @!attribute expired_amount
|
|
1853
|
+
# The amount of this authorization expiration in the minor unit of the
|
|
1854
|
+
# transaction's currency. For dollars, for example, this is cents.
|
|
1855
|
+
#
|
|
1856
|
+
# @return [Integer]
|
|
1857
|
+
required :expired_amount, Integer
|
|
1858
|
+
|
|
1859
|
+
# @!attribute network
|
|
1860
|
+
# The card network used to process this card authorization.
|
|
1861
|
+
#
|
|
1862
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network]
|
|
1863
|
+
required :network, enum: -> { Increase::CardPayment::Element::CardAuthorizationExpiration::Network }
|
|
1864
|
+
|
|
1865
|
+
# @!attribute type
|
|
1866
|
+
# A constant representing the object's type. For this resource it will always be
|
|
1867
|
+
# `card_authorization_expiration`.
|
|
1868
|
+
#
|
|
1869
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type]
|
|
1870
|
+
required :type, enum: -> { Increase::CardPayment::Element::CardAuthorizationExpiration::Type }
|
|
1871
|
+
|
|
1872
|
+
# @!method initialize(id:, card_authorization_id:, currency:, expired_amount:, network:, type:)
|
|
1873
|
+
# Some parameter documentations has been truncated, see
|
|
1874
|
+
# {Increase::Models::CardPayment::Element::CardAuthorizationExpiration} for more
|
|
1875
|
+
# details.
|
|
1876
|
+
#
|
|
1877
|
+
# A Card Authorization Expiration object. This field will be present in the JSON
|
|
1878
|
+
# response if and only if `category` is equal to `card_authorization_expiration`.
|
|
1879
|
+
# Card Authorization Expirations are cancellations of authorizations that were
|
|
1880
|
+
# never settled by the acquirer.
|
|
1881
|
+
#
|
|
1882
|
+
# @param id [String] The Card Authorization Expiration identifier.
|
|
1883
|
+
#
|
|
1884
|
+
# @param card_authorization_id [String] The identifier for the Card Authorization this reverses.
|
|
1885
|
+
#
|
|
1886
|
+
# @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's c
|
|
1887
|
+
#
|
|
1888
|
+
# @param expired_amount [Integer] The amount of this authorization expiration in the minor unit of the transaction
|
|
1889
|
+
#
|
|
1890
|
+
# @param network [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network] The card network used to process this card authorization.
|
|
1891
|
+
#
|
|
1892
|
+
# @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type] A constant representing the object's type. For this resource it will always be `
|
|
1893
|
+
|
|
1894
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
|
1895
|
+
# currency.
|
|
1896
|
+
#
|
|
1897
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorizationExpiration#currency
|
|
1898
|
+
module Currency
|
|
1899
|
+
extend Increase::Internal::Type::Enum
|
|
1900
|
+
|
|
1901
|
+
# US Dollar (USD)
|
|
1902
|
+
USD = :USD
|
|
1903
|
+
|
|
1904
|
+
# @!method self.values
|
|
1905
|
+
# @return [Array<Symbol>]
|
|
1906
|
+
end
|
|
1907
|
+
|
|
1908
|
+
# The card network used to process this card authorization.
|
|
1909
|
+
#
|
|
1910
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorizationExpiration#network
|
|
1911
|
+
module Network
|
|
1912
|
+
extend Increase::Internal::Type::Enum
|
|
1913
|
+
|
|
1914
|
+
# Visa
|
|
1915
|
+
VISA = :visa
|
|
1916
|
+
|
|
1917
|
+
# Pulse
|
|
1918
|
+
PULSE = :pulse
|
|
1919
|
+
|
|
1920
|
+
# @!method self.values
|
|
1921
|
+
# @return [Array<Symbol>]
|
|
1922
|
+
end
|
|
1923
|
+
|
|
1924
|
+
# A constant representing the object's type. For this resource it will always be
|
|
1925
|
+
# `card_authorization_expiration`.
|
|
1926
|
+
#
|
|
1927
|
+
# @see Increase::Models::CardPayment::Element::CardAuthorizationExpiration#type
|
|
1928
|
+
module Type
|
|
1929
|
+
extend Increase::Internal::Type::Enum
|
|
1930
|
+
|
|
1931
|
+
CARD_AUTHORIZATION_EXPIRATION = :card_authorization_expiration
|
|
1932
|
+
|
|
1933
|
+
# @!method self.values
|
|
1934
|
+
# @return [Array<Symbol>]
|
|
1935
|
+
end
|
|
1936
|
+
end
|
|
1937
|
+
|
|
1938
|
+
# @see Increase::Models::CardPayment::Element#card_balance_inquiry
|
|
1939
|
+
class CardBalanceInquiry < Increase::Internal::Type::BaseModel
|
|
1940
|
+
# @!attribute id
|
|
1941
|
+
# The Card Balance Inquiry identifier.
|
|
1942
|
+
#
|
|
1943
|
+
# @return [String]
|
|
1944
|
+
required :id, String
|
|
1945
|
+
|
|
1946
|
+
# @!attribute additional_amounts
|
|
1947
|
+
# Additional amounts associated with the card authorization, such as ATM
|
|
1948
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1949
|
+
# to provide more detailed information about the transaction.
|
|
1950
|
+
#
|
|
1951
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts]
|
|
1952
|
+
required :additional_amounts, -> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts }
|
|
1953
|
+
|
|
1954
|
+
# @!attribute balance
|
|
1955
|
+
# The balance amount in the minor unit of the account's currency. For dollars, for
|
|
1956
|
+
# example, this is cents.
|
|
1957
|
+
#
|
|
1958
|
+
# @return [Integer]
|
|
1959
|
+
required :balance, Integer
|
|
1960
|
+
|
|
1961
|
+
# @!attribute card_payment_id
|
|
1962
|
+
# The ID of the Card Payment this transaction belongs to.
|
|
1963
|
+
#
|
|
1964
|
+
# @return [String]
|
|
1965
|
+
required :card_payment_id, String
|
|
1966
|
+
|
|
1967
|
+
# @!attribute currency
|
|
1968
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's
|
|
1969
|
+
# currency.
|
|
1970
|
+
#
|
|
1971
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Currency]
|
|
1972
|
+
required :currency, enum: -> { Increase::CardPayment::Element::CardBalanceInquiry::Currency }
|
|
1973
|
+
|
|
1974
|
+
# @!attribute digital_wallet_token_id
|
|
1975
|
+
# If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
|
1976
|
+
# purchase), the identifier of the token that was used.
|
|
1977
|
+
#
|
|
1978
|
+
# @return [String, nil]
|
|
1979
|
+
required :digital_wallet_token_id, String, nil?: true
|
|
1980
|
+
|
|
1981
|
+
# @!attribute merchant_acceptor_id
|
|
1982
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
1983
|
+
# is transacting with.
|
|
1984
|
+
#
|
|
1985
|
+
# @return [String]
|
|
1986
|
+
required :merchant_acceptor_id, String
|
|
1987
|
+
|
|
1988
|
+
# @!attribute merchant_category_code
|
|
1989
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
1990
|
+
# card is transacting with.
|
|
1991
|
+
#
|
|
1992
|
+
# @return [String]
|
|
1993
|
+
required :merchant_category_code, String
|
|
1994
|
+
|
|
1995
|
+
# @!attribute merchant_city
|
|
1996
|
+
# The city the merchant resides in.
|
|
1997
|
+
#
|
|
1998
|
+
# @return [String, nil]
|
|
1999
|
+
required :merchant_city, String, nil?: true
|
|
2000
|
+
|
|
2001
|
+
# @!attribute merchant_country
|
|
2002
|
+
# The country the merchant resides in.
|
|
2003
|
+
#
|
|
2004
|
+
# @return [String]
|
|
2005
|
+
required :merchant_country, String
|
|
2006
|
+
|
|
2007
|
+
# @!attribute merchant_descriptor
|
|
2008
|
+
# The merchant descriptor of the merchant the card is transacting with.
|
|
2009
|
+
#
|
|
2010
|
+
# @return [String]
|
|
2011
|
+
required :merchant_descriptor, String
|
|
2012
|
+
|
|
2013
|
+
# @!attribute merchant_postal_code
|
|
2014
|
+
# The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
2015
|
+
# ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
2016
|
+
#
|
|
2017
|
+
# @return [String, nil]
|
|
2018
|
+
required :merchant_postal_code, String, nil?: true
|
|
2019
|
+
|
|
2020
|
+
# @!attribute merchant_state
|
|
2021
|
+
# The state the merchant resides in.
|
|
2022
|
+
#
|
|
2023
|
+
# @return [String, nil]
|
|
2024
|
+
required :merchant_state, String, nil?: true
|
|
2025
|
+
|
|
2026
|
+
# @!attribute network_details
|
|
2027
|
+
# Fields specific to the `network`.
|
|
2028
|
+
#
|
|
2029
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails]
|
|
2030
|
+
required :network_details, -> { Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails }
|
|
2031
|
+
|
|
2032
|
+
# @!attribute network_identifiers
|
|
2033
|
+
# Network-specific identifiers for a specific request or transaction.
|
|
2034
|
+
#
|
|
2035
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers]
|
|
2036
|
+
required :network_identifiers,
|
|
2037
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers }
|
|
2038
|
+
|
|
2039
|
+
# @!attribute network_risk_score
|
|
2040
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
2041
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
|
|
2042
|
+
# score is from 0 to 999, where 999 is the riskiest.
|
|
2043
|
+
#
|
|
2044
|
+
# @return [Integer, nil]
|
|
2045
|
+
required :network_risk_score, Integer, nil?: true
|
|
2046
|
+
|
|
2047
|
+
# @!attribute physical_card_id
|
|
2048
|
+
# If the authorization was made in-person with a physical card, the Physical Card
|
|
2049
|
+
# that was used.
|
|
2050
|
+
#
|
|
2051
|
+
# @return [String, nil]
|
|
2052
|
+
required :physical_card_id, String, nil?: true
|
|
2053
|
+
|
|
2054
|
+
# @!attribute real_time_decision_id
|
|
2055
|
+
# The identifier of the Real-Time Decision sent to approve or decline this
|
|
2056
|
+
# transaction.
|
|
2057
|
+
#
|
|
2058
|
+
# @return [String, nil]
|
|
2059
|
+
required :real_time_decision_id, String, nil?: true
|
|
2060
|
+
|
|
2061
|
+
# @!attribute terminal_id
|
|
2062
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
2063
|
+
# is transacting with.
|
|
2064
|
+
#
|
|
2065
|
+
# @return [String, nil]
|
|
2066
|
+
required :terminal_id, String, nil?: true
|
|
2067
|
+
|
|
2068
|
+
# @!attribute type
|
|
2069
|
+
# A constant representing the object's type. For this resource it will always be
|
|
2070
|
+
# `card_balance_inquiry`.
|
|
2071
|
+
#
|
|
2072
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Type]
|
|
2073
|
+
required :type, enum: -> { Increase::CardPayment::Element::CardBalanceInquiry::Type }
|
|
2074
|
+
|
|
2075
|
+
# @!attribute verification
|
|
2076
|
+
# Fields related to verification of cardholder-provided values.
|
|
2077
|
+
#
|
|
2078
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification]
|
|
2079
|
+
required :verification, -> { Increase::CardPayment::Element::CardBalanceInquiry::Verification }
|
|
2080
|
+
|
|
2081
|
+
# @!method initialize(id:, additional_amounts:, balance:, card_payment_id:, currency:, digital_wallet_token_id:, 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:, real_time_decision_id:, terminal_id:, type:, verification:)
|
|
2082
|
+
# Some parameter documentations has been truncated, see
|
|
2083
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry} for more details.
|
|
2084
|
+
#
|
|
2085
|
+
# A Card Balance Inquiry object. This field will be present in the JSON response
|
|
2086
|
+
# if and only if `category` is equal to `card_balance_inquiry`. Card Balance
|
|
2087
|
+
# Inquiries are transactions that allow merchants to check the available balance
|
|
2088
|
+
# on a card without placing a hold on funds, commonly used when a customer
|
|
2089
|
+
# requests their balance at an ATM.
|
|
2090
|
+
#
|
|
2091
|
+
# @param id [String] The Card Balance Inquiry identifier.
|
|
2092
|
+
#
|
|
2093
|
+
# @param additional_amounts [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
|
|
2094
|
+
#
|
|
2095
|
+
# @param balance [Integer] The balance amount in the minor unit of the account's currency. For dollars, for
|
|
2096
|
+
#
|
|
2097
|
+
# @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
|
|
2098
|
+
#
|
|
2099
|
+
# @param currency [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's cu
|
|
2100
|
+
#
|
|
2101
|
+
# @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
|
|
2102
|
+
#
|
|
2103
|
+
# @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
|
|
2104
|
+
#
|
|
2105
|
+
# @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
|
|
2106
|
+
#
|
|
2107
|
+
# @param merchant_city [String, nil] The city the merchant resides in.
|
|
2108
|
+
#
|
|
2109
|
+
# @param merchant_country [String] The country the merchant resides in.
|
|
2110
|
+
#
|
|
2111
|
+
# @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
|
|
2112
|
+
#
|
|
2113
|
+
# @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
2114
|
+
#
|
|
2115
|
+
# @param merchant_state [String, nil] The state the merchant resides in.
|
|
2116
|
+
#
|
|
2117
|
+
# @param network_details [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails] Fields specific to the `network`.
|
|
2118
|
+
#
|
|
2119
|
+
# @param network_identifiers [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
|
|
2120
|
+
#
|
|
2121
|
+
# @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
2122
|
+
#
|
|
2123
|
+
# @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
|
|
2124
|
+
#
|
|
2125
|
+
# @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac
|
|
2126
|
+
#
|
|
2127
|
+
# @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
|
|
2128
|
+
#
|
|
2129
|
+
# @param type [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Type] A constant representing the object's type. For this resource it will always be `
|
|
2130
|
+
#
|
|
2131
|
+
# @param verification [Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification] Fields related to verification of cardholder-provided values.
|
|
2132
|
+
|
|
2133
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry#additional_amounts
|
|
2134
|
+
class AdditionalAmounts < Increase::Internal::Type::BaseModel
|
|
2135
|
+
# @!attribute clinic
|
|
2136
|
+
# The part of this transaction amount that was for clinic-related services.
|
|
2137
|
+
#
|
|
2138
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic, nil]
|
|
2139
|
+
required :clinic,
|
|
2140
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic },
|
|
2141
|
+
nil?: true
|
|
2142
|
+
|
|
2143
|
+
# @!attribute dental
|
|
2144
|
+
# The part of this transaction amount that was for dental-related services.
|
|
2145
|
+
#
|
|
2146
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental, nil]
|
|
2147
|
+
required :dental,
|
|
2148
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental },
|
|
2149
|
+
nil?: true
|
|
2150
|
+
|
|
2151
|
+
# @!attribute original
|
|
2152
|
+
# The original pre-authorized amount.
|
|
2153
|
+
#
|
|
2154
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original, nil]
|
|
2155
|
+
required :original,
|
|
2156
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original },
|
|
2157
|
+
nil?: true
|
|
2158
|
+
|
|
2159
|
+
# @!attribute prescription
|
|
2160
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
|
2161
|
+
#
|
|
2162
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription, nil]
|
|
2163
|
+
required :prescription,
|
|
2164
|
+
-> {
|
|
2165
|
+
Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription
|
|
2166
|
+
},
|
|
2167
|
+
nil?: true
|
|
2168
|
+
|
|
2169
|
+
# @!attribute surcharge
|
|
2170
|
+
# The surcharge amount charged for this transaction by the merchant.
|
|
2171
|
+
#
|
|
2172
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge, nil]
|
|
2173
|
+
required :surcharge,
|
|
2174
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge },
|
|
2175
|
+
nil?: true
|
|
2176
|
+
|
|
2177
|
+
# @!attribute total_cumulative
|
|
2178
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
|
2179
|
+
#
|
|
2180
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative, nil]
|
|
2181
|
+
required :total_cumulative,
|
|
2182
|
+
-> {
|
|
2183
|
+
Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative
|
|
2184
|
+
},
|
|
2185
|
+
nil?: true
|
|
2186
|
+
|
|
2187
|
+
# @!attribute total_healthcare
|
|
2188
|
+
# The total amount of healthcare-related additional amounts.
|
|
2189
|
+
#
|
|
2190
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare, nil]
|
|
2191
|
+
required :total_healthcare,
|
|
2192
|
+
-> {
|
|
2193
|
+
Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare
|
|
2194
|
+
},
|
|
2195
|
+
nil?: true
|
|
2196
|
+
|
|
2197
|
+
# @!attribute transit
|
|
2198
|
+
# The part of this transaction amount that was for transit-related services.
|
|
2199
|
+
#
|
|
2200
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit, nil]
|
|
2201
|
+
required :transit,
|
|
2202
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit },
|
|
2203
|
+
nil?: true
|
|
2204
|
+
|
|
2205
|
+
# @!attribute unknown
|
|
2206
|
+
# An unknown additional amount.
|
|
2207
|
+
#
|
|
2208
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown, nil]
|
|
2209
|
+
required :unknown,
|
|
2210
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown },
|
|
989
2211
|
nil?: true
|
|
990
2212
|
|
|
991
2213
|
# @!attribute vision
|
|
992
2214
|
# The part of this transaction amount that was for vision-related services.
|
|
993
2215
|
#
|
|
994
|
-
# @return [Increase::Models::CardPayment::Element::
|
|
2216
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision, nil]
|
|
995
2217
|
required :vision,
|
|
996
|
-
-> { Increase::CardPayment::Element::
|
|
2218
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision },
|
|
997
2219
|
nil?: true
|
|
998
2220
|
|
|
999
2221
|
# @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
|
|
1000
2222
|
# Some parameter documentations has been truncated, see
|
|
1001
|
-
# {Increase::Models::CardPayment::Element::
|
|
2223
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts}
|
|
1002
2224
|
# for more details.
|
|
1003
2225
|
#
|
|
1004
2226
|
# Additional amounts associated with the card authorization, such as ATM
|
|
1005
2227
|
# surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1006
2228
|
# to provide more detailed information about the transaction.
|
|
1007
2229
|
#
|
|
1008
|
-
# @param clinic [Increase::Models::CardPayment::Element::
|
|
2230
|
+
# @param clinic [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
|
|
1009
2231
|
#
|
|
1010
|
-
# @param dental [Increase::Models::CardPayment::Element::
|
|
2232
|
+
# @param dental [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
|
|
1011
2233
|
#
|
|
1012
|
-
# @param original [Increase::Models::CardPayment::Element::
|
|
2234
|
+
# @param original [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original, nil] The original pre-authorized amount.
|
|
1013
2235
|
#
|
|
1014
|
-
# @param prescription [Increase::Models::CardPayment::Element::
|
|
2236
|
+
# @param prescription [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
|
|
1015
2237
|
#
|
|
1016
|
-
# @param surcharge [Increase::Models::CardPayment::Element::
|
|
2238
|
+
# @param surcharge [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
|
|
1017
2239
|
#
|
|
1018
|
-
# @param total_cumulative [Increase::Models::CardPayment::Element::
|
|
2240
|
+
# @param total_cumulative [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
|
|
1019
2241
|
#
|
|
1020
|
-
# @param total_healthcare [Increase::Models::CardPayment::Element::
|
|
2242
|
+
# @param total_healthcare [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
|
|
1021
2243
|
#
|
|
1022
|
-
# @param transit [Increase::Models::CardPayment::Element::
|
|
2244
|
+
# @param transit [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
|
|
1023
2245
|
#
|
|
1024
|
-
# @param unknown [Increase::Models::CardPayment::Element::
|
|
2246
|
+
# @param unknown [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown, nil] An unknown additional amount.
|
|
1025
2247
|
#
|
|
1026
|
-
# @param vision [Increase::Models::CardPayment::Element::
|
|
2248
|
+
# @param vision [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
|
|
1027
2249
|
|
|
1028
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2250
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#clinic
|
|
1029
2251
|
class Clinic < Increase::Internal::Type::BaseModel
|
|
1030
2252
|
# @!attribute amount
|
|
1031
2253
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1044,7 +2266,7 @@ module Increase
|
|
|
1044
2266
|
|
|
1045
2267
|
# @!method initialize(amount:, currency:)
|
|
1046
2268
|
# Some parameter documentations has been truncated, see
|
|
1047
|
-
# {Increase::Models::CardPayment::Element::
|
|
2269
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic}
|
|
1048
2270
|
# for more details.
|
|
1049
2271
|
#
|
|
1050
2272
|
# The part of this transaction amount that was for clinic-related services.
|
|
@@ -1054,7 +2276,7 @@ module Increase
|
|
|
1054
2276
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1055
2277
|
end
|
|
1056
2278
|
|
|
1057
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2279
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#dental
|
|
1058
2280
|
class Dental < Increase::Internal::Type::BaseModel
|
|
1059
2281
|
# @!attribute amount
|
|
1060
2282
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1073,7 +2295,7 @@ module Increase
|
|
|
1073
2295
|
|
|
1074
2296
|
# @!method initialize(amount:, currency:)
|
|
1075
2297
|
# Some parameter documentations has been truncated, see
|
|
1076
|
-
# {Increase::Models::CardPayment::Element::
|
|
2298
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Dental}
|
|
1077
2299
|
# for more details.
|
|
1078
2300
|
#
|
|
1079
2301
|
# The part of this transaction amount that was for dental-related services.
|
|
@@ -1083,7 +2305,7 @@ module Increase
|
|
|
1083
2305
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1084
2306
|
end
|
|
1085
2307
|
|
|
1086
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2308
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#original
|
|
1087
2309
|
class Original < Increase::Internal::Type::BaseModel
|
|
1088
2310
|
# @!attribute amount
|
|
1089
2311
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1102,7 +2324,7 @@ module Increase
|
|
|
1102
2324
|
|
|
1103
2325
|
# @!method initialize(amount:, currency:)
|
|
1104
2326
|
# Some parameter documentations has been truncated, see
|
|
1105
|
-
# {Increase::Models::CardPayment::Element::
|
|
2327
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Original}
|
|
1106
2328
|
# for more details.
|
|
1107
2329
|
#
|
|
1108
2330
|
# The original pre-authorized amount.
|
|
@@ -1112,7 +2334,7 @@ module Increase
|
|
|
1112
2334
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1113
2335
|
end
|
|
1114
2336
|
|
|
1115
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2337
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#prescription
|
|
1116
2338
|
class Prescription < Increase::Internal::Type::BaseModel
|
|
1117
2339
|
# @!attribute amount
|
|
1118
2340
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1131,7 +2353,7 @@ module Increase
|
|
|
1131
2353
|
|
|
1132
2354
|
# @!method initialize(amount:, currency:)
|
|
1133
2355
|
# Some parameter documentations has been truncated, see
|
|
1134
|
-
# {Increase::Models::CardPayment::Element::
|
|
2356
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Prescription}
|
|
1135
2357
|
# for more details.
|
|
1136
2358
|
#
|
|
1137
2359
|
# The part of this transaction amount that was for healthcare prescriptions.
|
|
@@ -1141,7 +2363,7 @@ module Increase
|
|
|
1141
2363
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1142
2364
|
end
|
|
1143
2365
|
|
|
1144
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2366
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#surcharge
|
|
1145
2367
|
class Surcharge < Increase::Internal::Type::BaseModel
|
|
1146
2368
|
# @!attribute amount
|
|
1147
2369
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1160,7 +2382,7 @@ module Increase
|
|
|
1160
2382
|
|
|
1161
2383
|
# @!method initialize(amount:, currency:)
|
|
1162
2384
|
# Some parameter documentations has been truncated, see
|
|
1163
|
-
# {Increase::Models::CardPayment::Element::
|
|
2385
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Surcharge}
|
|
1164
2386
|
# for more details.
|
|
1165
2387
|
#
|
|
1166
2388
|
# The surcharge amount charged for this transaction by the merchant.
|
|
@@ -1170,7 +2392,7 @@ module Increase
|
|
|
1170
2392
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1171
2393
|
end
|
|
1172
2394
|
|
|
1173
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2395
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#total_cumulative
|
|
1174
2396
|
class TotalCumulative < Increase::Internal::Type::BaseModel
|
|
1175
2397
|
# @!attribute amount
|
|
1176
2398
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1189,7 +2411,7 @@ module Increase
|
|
|
1189
2411
|
|
|
1190
2412
|
# @!method initialize(amount:, currency:)
|
|
1191
2413
|
# Some parameter documentations has been truncated, see
|
|
1192
|
-
# {Increase::Models::CardPayment::Element::
|
|
2414
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalCumulative}
|
|
1193
2415
|
# for more details.
|
|
1194
2416
|
#
|
|
1195
2417
|
# The total amount of a series of incremental authorizations, optionally provided.
|
|
@@ -1199,7 +2421,7 @@ module Increase
|
|
|
1199
2421
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1200
2422
|
end
|
|
1201
2423
|
|
|
1202
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2424
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#total_healthcare
|
|
1203
2425
|
class TotalHealthcare < Increase::Internal::Type::BaseModel
|
|
1204
2426
|
# @!attribute amount
|
|
1205
2427
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1218,7 +2440,7 @@ module Increase
|
|
|
1218
2440
|
|
|
1219
2441
|
# @!method initialize(amount:, currency:)
|
|
1220
2442
|
# Some parameter documentations has been truncated, see
|
|
1221
|
-
# {Increase::Models::CardPayment::Element::
|
|
2443
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare}
|
|
1222
2444
|
# for more details.
|
|
1223
2445
|
#
|
|
1224
2446
|
# The total amount of healthcare-related additional amounts.
|
|
@@ -1228,7 +2450,7 @@ module Increase
|
|
|
1228
2450
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1229
2451
|
end
|
|
1230
2452
|
|
|
1231
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2453
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#transit
|
|
1232
2454
|
class Transit < Increase::Internal::Type::BaseModel
|
|
1233
2455
|
# @!attribute amount
|
|
1234
2456
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1247,7 +2469,7 @@ module Increase
|
|
|
1247
2469
|
|
|
1248
2470
|
# @!method initialize(amount:, currency:)
|
|
1249
2471
|
# Some parameter documentations has been truncated, see
|
|
1250
|
-
# {Increase::Models::CardPayment::Element::
|
|
2472
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Transit}
|
|
1251
2473
|
# for more details.
|
|
1252
2474
|
#
|
|
1253
2475
|
# The part of this transaction amount that was for transit-related services.
|
|
@@ -1257,7 +2479,7 @@ module Increase
|
|
|
1257
2479
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1258
2480
|
end
|
|
1259
2481
|
|
|
1260
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2482
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#unknown
|
|
1261
2483
|
class Unknown < Increase::Internal::Type::BaseModel
|
|
1262
2484
|
# @!attribute amount
|
|
1263
2485
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1276,7 +2498,7 @@ module Increase
|
|
|
1276
2498
|
|
|
1277
2499
|
# @!method initialize(amount:, currency:)
|
|
1278
2500
|
# Some parameter documentations has been truncated, see
|
|
1279
|
-
# {Increase::Models::CardPayment::Element::
|
|
2501
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Unknown}
|
|
1280
2502
|
# for more details.
|
|
1281
2503
|
#
|
|
1282
2504
|
# An unknown additional amount.
|
|
@@ -1286,7 +2508,7 @@ module Increase
|
|
|
1286
2508
|
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
|
1287
2509
|
end
|
|
1288
2510
|
|
|
1289
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2511
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts#vision
|
|
1290
2512
|
class Vision < Increase::Internal::Type::BaseModel
|
|
1291
2513
|
# @!attribute amount
|
|
1292
2514
|
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
@@ -1305,7 +2527,7 @@ module Increase
|
|
|
1305
2527
|
|
|
1306
2528
|
# @!method initialize(amount:, currency:)
|
|
1307
2529
|
# Some parameter documentations has been truncated, see
|
|
1308
|
-
# {Increase::Models::CardPayment::Element::
|
|
2530
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Vision}
|
|
1309
2531
|
# for more details.
|
|
1310
2532
|
#
|
|
1311
2533
|
# The part of this transaction amount that was for vision-related services.
|
|
@@ -1316,10 +2538,10 @@ module Increase
|
|
|
1316
2538
|
end
|
|
1317
2539
|
end
|
|
1318
2540
|
|
|
1319
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1320
|
-
#
|
|
2541
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's
|
|
2542
|
+
# currency.
|
|
1321
2543
|
#
|
|
1322
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2544
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry#currency
|
|
1323
2545
|
module Currency
|
|
1324
2546
|
extend Increase::Internal::Type::Enum
|
|
1325
2547
|
|
|
@@ -1330,62 +2552,43 @@ module Increase
|
|
|
1330
2552
|
# @return [Array<Symbol>]
|
|
1331
2553
|
end
|
|
1332
2554
|
|
|
1333
|
-
#
|
|
1334
|
-
# cardholder to the merchant or from the merchant to the cardholder.
|
|
1335
|
-
#
|
|
1336
|
-
# @see Increase::Models::CardPayment::Element::CardAuthorization#direction
|
|
1337
|
-
module Direction
|
|
1338
|
-
extend Increase::Internal::Type::Enum
|
|
1339
|
-
|
|
1340
|
-
# A regular card authorization where funds are debited from the cardholder.
|
|
1341
|
-
SETTLEMENT = :settlement
|
|
1342
|
-
|
|
1343
|
-
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
|
1344
|
-
REFUND = :refund
|
|
1345
|
-
|
|
1346
|
-
# @!method self.values
|
|
1347
|
-
# @return [Array<Symbol>]
|
|
1348
|
-
end
|
|
1349
|
-
|
|
1350
|
-
# @see Increase::Models::CardPayment::Element::CardAuthorization#network_details
|
|
2555
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry#network_details
|
|
1351
2556
|
class NetworkDetails < Increase::Internal::Type::BaseModel
|
|
1352
2557
|
# @!attribute category
|
|
1353
2558
|
# The payment network used to process this card authorization.
|
|
1354
2559
|
#
|
|
1355
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::
|
|
2560
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category]
|
|
1356
2561
|
required :category,
|
|
1357
|
-
enum: -> { Increase::CardPayment::Element::
|
|
2562
|
+
enum: -> { Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category }
|
|
1358
2563
|
|
|
1359
2564
|
# @!attribute pulse
|
|
1360
2565
|
# Fields specific to the `pulse` network.
|
|
1361
2566
|
#
|
|
1362
|
-
# @return [Increase::Models::CardPayment::Element::
|
|
2567
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse, nil]
|
|
1363
2568
|
required :pulse,
|
|
1364
|
-
-> { Increase::CardPayment::Element::
|
|
2569
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse },
|
|
1365
2570
|
nil?: true
|
|
1366
2571
|
|
|
1367
2572
|
# @!attribute visa
|
|
1368
2573
|
# Fields specific to the `visa` network.
|
|
1369
2574
|
#
|
|
1370
|
-
# @return [Increase::Models::CardPayment::Element::
|
|
2575
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa, nil]
|
|
1371
2576
|
required :visa,
|
|
1372
|
-
-> {
|
|
1373
|
-
Increase::CardPayment::Element::CardAuthorization::NetworkDetails::Visa
|
|
1374
|
-
},
|
|
2577
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa },
|
|
1375
2578
|
nil?: true
|
|
1376
2579
|
|
|
1377
2580
|
# @!method initialize(category:, pulse:, visa:)
|
|
1378
2581
|
# Fields specific to the `network`.
|
|
1379
2582
|
#
|
|
1380
|
-
# @param category [Symbol, Increase::Models::CardPayment::Element::
|
|
2583
|
+
# @param category [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Category] The payment network used to process this card authorization.
|
|
1381
2584
|
#
|
|
1382
|
-
# @param pulse [Increase::Models::CardPayment::Element::
|
|
2585
|
+
# @param pulse [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
|
|
1383
2586
|
#
|
|
1384
|
-
# @param visa [Increase::Models::CardPayment::Element::
|
|
2587
|
+
# @param visa [Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
|
|
1385
2588
|
|
|
1386
2589
|
# The payment network used to process this card authorization.
|
|
1387
2590
|
#
|
|
1388
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2591
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails#category
|
|
1389
2592
|
module Category
|
|
1390
2593
|
extend Increase::Internal::Type::Enum
|
|
1391
2594
|
|
|
@@ -1399,23 +2602,23 @@ module Increase
|
|
|
1399
2602
|
# @return [Array<Symbol>]
|
|
1400
2603
|
end
|
|
1401
2604
|
|
|
1402
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2605
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails#pulse
|
|
1403
2606
|
class Pulse < Increase::Internal::Type::BaseModel
|
|
1404
2607
|
# @!method initialize
|
|
1405
2608
|
# Fields specific to the `pulse` network.
|
|
1406
2609
|
end
|
|
1407
2610
|
|
|
1408
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2611
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails#visa
|
|
1409
2612
|
class Visa < Increase::Internal::Type::BaseModel
|
|
1410
2613
|
# @!attribute electronic_commerce_indicator
|
|
1411
2614
|
# For electronic commerce transactions, this identifies the level of security used
|
|
1412
2615
|
# in obtaining the customer's payment credential. For mail or telephone order
|
|
1413
2616
|
# transactions, identifies the type of mail or telephone order.
|
|
1414
2617
|
#
|
|
1415
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::
|
|
2618
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
|
|
1416
2619
|
required :electronic_commerce_indicator,
|
|
1417
2620
|
enum: -> {
|
|
1418
|
-
Increase::CardPayment::Element::
|
|
2621
|
+
Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator
|
|
1419
2622
|
},
|
|
1420
2623
|
nil?: true
|
|
1421
2624
|
|
|
@@ -1423,10 +2626,10 @@ module Increase
|
|
|
1423
2626
|
# The method used to enter the cardholder's primary account number and card
|
|
1424
2627
|
# expiration date.
|
|
1425
2628
|
#
|
|
1426
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::
|
|
2629
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
|
|
1427
2630
|
required :point_of_service_entry_mode,
|
|
1428
2631
|
enum: -> {
|
|
1429
|
-
Increase::CardPayment::Element::
|
|
2632
|
+
Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode
|
|
1430
2633
|
},
|
|
1431
2634
|
nil?: true
|
|
1432
2635
|
|
|
@@ -1434,31 +2637,31 @@ module Increase
|
|
|
1434
2637
|
# Only present when `actioner: network`. Describes why a card authorization was
|
|
1435
2638
|
# approved or declined by Visa through stand-in processing.
|
|
1436
2639
|
#
|
|
1437
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::
|
|
2640
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason, nil]
|
|
1438
2641
|
required :stand_in_processing_reason,
|
|
1439
2642
|
enum: -> {
|
|
1440
|
-
Increase::CardPayment::Element::
|
|
2643
|
+
Increase::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason
|
|
1441
2644
|
},
|
|
1442
2645
|
nil?: true
|
|
1443
2646
|
|
|
1444
2647
|
# @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:)
|
|
1445
2648
|
# Some parameter documentations has been truncated, see
|
|
1446
|
-
# {Increase::Models::CardPayment::Element::
|
|
2649
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa}
|
|
1447
2650
|
# for more details.
|
|
1448
2651
|
#
|
|
1449
2652
|
# Fields specific to the `visa` network.
|
|
1450
2653
|
#
|
|
1451
|
-
# @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::
|
|
2654
|
+
# @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
|
|
1452
2655
|
#
|
|
1453
|
-
# @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::
|
|
2656
|
+
# @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
|
|
1454
2657
|
#
|
|
1455
|
-
# @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::
|
|
2658
|
+
# @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
|
|
1456
2659
|
|
|
1457
2660
|
# For electronic commerce transactions, this identifies the level of security used
|
|
1458
2661
|
# in obtaining the customer's payment credential. For mail or telephone order
|
|
1459
2662
|
# transactions, identifies the type of mail or telephone order.
|
|
1460
2663
|
#
|
|
1461
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2664
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa#electronic_commerce_indicator
|
|
1462
2665
|
module ElectronicCommerceIndicator
|
|
1463
2666
|
extend Increase::Internal::Type::Enum
|
|
1464
2667
|
|
|
@@ -1494,7 +2697,7 @@ module Increase
|
|
|
1494
2697
|
# The method used to enter the cardholder's primary account number and card
|
|
1495
2698
|
# expiration date.
|
|
1496
2699
|
#
|
|
1497
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2700
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa#point_of_service_entry_mode
|
|
1498
2701
|
module PointOfServiceEntryMode
|
|
1499
2702
|
extend Increase::Internal::Type::Enum
|
|
1500
2703
|
|
|
@@ -1535,7 +2738,7 @@ module Increase
|
|
|
1535
2738
|
# Only present when `actioner: network`. Describes why a card authorization was
|
|
1536
2739
|
# approved or declined by Visa through stand-in processing.
|
|
1537
2740
|
#
|
|
1538
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2741
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkDetails::Visa#stand_in_processing_reason
|
|
1539
2742
|
module StandInProcessingReason
|
|
1540
2743
|
extend Increase::Internal::Type::Enum
|
|
1541
2744
|
|
|
@@ -1568,7 +2771,7 @@ module Increase
|
|
|
1568
2771
|
end
|
|
1569
2772
|
end
|
|
1570
2773
|
|
|
1571
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2774
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry#network_identifiers
|
|
1572
2775
|
class NetworkIdentifiers < Increase::Internal::Type::BaseModel
|
|
1573
2776
|
# @!attribute authorization_identification_response
|
|
1574
2777
|
# The randomly generated 6-character Authorization Identification Response code
|
|
@@ -1601,7 +2804,7 @@ module Increase
|
|
|
1601
2804
|
|
|
1602
2805
|
# @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
|
|
1603
2806
|
# Some parameter documentations has been truncated, see
|
|
1604
|
-
# {Increase::Models::CardPayment::Element::
|
|
2807
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::NetworkIdentifiers}
|
|
1605
2808
|
# for more details.
|
|
1606
2809
|
#
|
|
1607
2810
|
# Network-specific identifiers for a specific request or transaction.
|
|
@@ -1615,107 +2818,66 @@ module Increase
|
|
|
1615
2818
|
# @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
|
|
1616
2819
|
end
|
|
1617
2820
|
|
|
1618
|
-
# The processing category describes the intent behind the authorization, such as
|
|
1619
|
-
# whether it was used for bill payments or an automatic fuel dispenser.
|
|
1620
|
-
#
|
|
1621
|
-
# @see Increase::Models::CardPayment::Element::CardAuthorization#processing_category
|
|
1622
|
-
module ProcessingCategory
|
|
1623
|
-
extend Increase::Internal::Type::Enum
|
|
1624
|
-
|
|
1625
|
-
# Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.
|
|
1626
|
-
ACCOUNT_FUNDING = :account_funding
|
|
1627
|
-
|
|
1628
|
-
# 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.
|
|
1629
|
-
AUTOMATIC_FUEL_DISPENSER = :automatic_fuel_dispenser
|
|
1630
|
-
|
|
1631
|
-
# A transaction used to pay a bill.
|
|
1632
|
-
BILL_PAYMENT = :bill_payment
|
|
1633
|
-
|
|
1634
|
-
# Original credit transactions are used to send money to a cardholder.
|
|
1635
|
-
ORIGINAL_CREDIT = :original_credit
|
|
1636
|
-
|
|
1637
|
-
# A regular purchase.
|
|
1638
|
-
PURCHASE = :purchase
|
|
1639
|
-
|
|
1640
|
-
# Quasi-cash transactions represent purchases of items which may be convertible to cash.
|
|
1641
|
-
QUASI_CASH = :quasi_cash
|
|
1642
|
-
|
|
1643
|
-
# A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
|
|
1644
|
-
REFUND = :refund
|
|
1645
|
-
|
|
1646
|
-
# Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
|
|
1647
|
-
CASH_DISBURSEMENT = :cash_disbursement
|
|
1648
|
-
|
|
1649
|
-
# A balance inquiry transaction is used to check the balance of an account associated with a card.
|
|
1650
|
-
BALANCE_INQUIRY = :balance_inquiry
|
|
1651
|
-
|
|
1652
|
-
# The processing category is unknown.
|
|
1653
|
-
UNKNOWN = :unknown
|
|
1654
|
-
|
|
1655
|
-
# @!method self.values
|
|
1656
|
-
# @return [Array<Symbol>]
|
|
1657
|
-
end
|
|
1658
|
-
|
|
1659
2821
|
# A constant representing the object's type. For this resource it will always be
|
|
1660
|
-
# `
|
|
2822
|
+
# `card_balance_inquiry`.
|
|
1661
2823
|
#
|
|
1662
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2824
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry#type
|
|
1663
2825
|
module Type
|
|
1664
2826
|
extend Increase::Internal::Type::Enum
|
|
1665
2827
|
|
|
1666
|
-
|
|
2828
|
+
CARD_BALANCE_INQUIRY = :card_balance_inquiry
|
|
1667
2829
|
|
|
1668
2830
|
# @!method self.values
|
|
1669
2831
|
# @return [Array<Symbol>]
|
|
1670
2832
|
end
|
|
1671
2833
|
|
|
1672
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2834
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry#verification
|
|
1673
2835
|
class Verification < Increase::Internal::Type::BaseModel
|
|
1674
2836
|
# @!attribute card_verification_code
|
|
1675
2837
|
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1676
2838
|
# the back of the card.
|
|
1677
2839
|
#
|
|
1678
|
-
# @return [Increase::Models::CardPayment::Element::
|
|
2840
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode]
|
|
1679
2841
|
required :card_verification_code,
|
|
1680
|
-
-> { Increase::CardPayment::Element::
|
|
2842
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode }
|
|
1681
2843
|
|
|
1682
2844
|
# @!attribute cardholder_address
|
|
1683
2845
|
# Cardholder address provided in the authorization request and the address on file
|
|
1684
2846
|
# we verified it against.
|
|
1685
2847
|
#
|
|
1686
|
-
# @return [Increase::Models::CardPayment::Element::
|
|
2848
|
+
# @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress]
|
|
1687
2849
|
required :cardholder_address,
|
|
1688
|
-
-> { Increase::CardPayment::Element::
|
|
2850
|
+
-> { Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress }
|
|
1689
2851
|
|
|
1690
2852
|
# @!method initialize(card_verification_code:, cardholder_address:)
|
|
1691
2853
|
# Some parameter documentations has been truncated, see
|
|
1692
|
-
# {Increase::Models::CardPayment::Element::
|
|
2854
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification} for
|
|
1693
2855
|
# more details.
|
|
1694
2856
|
#
|
|
1695
2857
|
# Fields related to verification of cardholder-provided values.
|
|
1696
2858
|
#
|
|
1697
|
-
# @param card_verification_code [Increase::Models::CardPayment::Element::
|
|
2859
|
+
# @param card_verification_code [Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1698
2860
|
#
|
|
1699
|
-
# @param cardholder_address [Increase::Models::CardPayment::Element::
|
|
2861
|
+
# @param cardholder_address [Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
|
|
1700
2862
|
|
|
1701
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2863
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification#card_verification_code
|
|
1702
2864
|
class CardVerificationCode < Increase::Internal::Type::BaseModel
|
|
1703
2865
|
# @!attribute result
|
|
1704
2866
|
# The result of verifying the Card Verification Code.
|
|
1705
2867
|
#
|
|
1706
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::
|
|
2868
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result]
|
|
1707
2869
|
required :result,
|
|
1708
|
-
enum: -> { Increase::CardPayment::Element::
|
|
2870
|
+
enum: -> { Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result }
|
|
1709
2871
|
|
|
1710
2872
|
# @!method initialize(result:)
|
|
1711
2873
|
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1712
2874
|
# the back of the card.
|
|
1713
2875
|
#
|
|
1714
|
-
# @param result [Symbol, Increase::Models::CardPayment::Element::
|
|
2876
|
+
# @param result [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
|
|
1715
2877
|
|
|
1716
2878
|
# The result of verifying the Card Verification Code.
|
|
1717
2879
|
#
|
|
1718
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2880
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardVerificationCode#result
|
|
1719
2881
|
module Result
|
|
1720
2882
|
extend Increase::Internal::Type::Enum
|
|
1721
2883
|
|
|
@@ -1733,7 +2895,7 @@ module Increase
|
|
|
1733
2895
|
end
|
|
1734
2896
|
end
|
|
1735
2897
|
|
|
1736
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2898
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification#cardholder_address
|
|
1737
2899
|
class CardholderAddress < Increase::Internal::Type::BaseModel
|
|
1738
2900
|
# @!attribute actual_line1
|
|
1739
2901
|
# Line 1 of the address on file for the cardholder.
|
|
@@ -1763,13 +2925,13 @@ module Increase
|
|
|
1763
2925
|
# @!attribute result
|
|
1764
2926
|
# The address verification result returned to the card network.
|
|
1765
2927
|
#
|
|
1766
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::
|
|
2928
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result]
|
|
1767
2929
|
required :result,
|
|
1768
|
-
enum: -> { Increase::CardPayment::Element::
|
|
2930
|
+
enum: -> { Increase::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result }
|
|
1769
2931
|
|
|
1770
2932
|
# @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
|
|
1771
2933
|
# Some parameter documentations has been truncated, see
|
|
1772
|
-
# {Increase::Models::CardPayment::Element::
|
|
2934
|
+
# {Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress}
|
|
1773
2935
|
# for more details.
|
|
1774
2936
|
#
|
|
1775
2937
|
# Cardholder address provided in the authorization request and the address on file
|
|
@@ -1783,11 +2945,11 @@ module Increase
|
|
|
1783
2945
|
#
|
|
1784
2946
|
# @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
|
|
1785
2947
|
#
|
|
1786
|
-
# @param result [Symbol, Increase::Models::CardPayment::Element::
|
|
2948
|
+
# @param result [Symbol, Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress::Result] The address verification result returned to the card network.
|
|
1787
2949
|
|
|
1788
2950
|
# The address verification result returned to the card network.
|
|
1789
2951
|
#
|
|
1790
|
-
# @see Increase::Models::CardPayment::Element::
|
|
2952
|
+
# @see Increase::Models::CardPayment::Element::CardBalanceInquiry::Verification::CardholderAddress#result
|
|
1791
2953
|
module Result
|
|
1792
2954
|
extend Increase::Internal::Type::Enum
|
|
1793
2955
|
|
|
@@ -1816,113 +2978,6 @@ module Increase
|
|
|
1816
2978
|
end
|
|
1817
2979
|
end
|
|
1818
2980
|
|
|
1819
|
-
# @see Increase::Models::CardPayment::Element#card_authorization_expiration
|
|
1820
|
-
class CardAuthorizationExpiration < Increase::Internal::Type::BaseModel
|
|
1821
|
-
# @!attribute id
|
|
1822
|
-
# The Card Authorization Expiration identifier.
|
|
1823
|
-
#
|
|
1824
|
-
# @return [String]
|
|
1825
|
-
required :id, String
|
|
1826
|
-
|
|
1827
|
-
# @!attribute card_authorization_id
|
|
1828
|
-
# The identifier for the Card Authorization this reverses.
|
|
1829
|
-
#
|
|
1830
|
-
# @return [String]
|
|
1831
|
-
required :card_authorization_id, String
|
|
1832
|
-
|
|
1833
|
-
# @!attribute currency
|
|
1834
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
|
1835
|
-
# currency.
|
|
1836
|
-
#
|
|
1837
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency]
|
|
1838
|
-
required :currency, enum: -> { Increase::CardPayment::Element::CardAuthorizationExpiration::Currency }
|
|
1839
|
-
|
|
1840
|
-
# @!attribute expired_amount
|
|
1841
|
-
# The amount of this authorization expiration in the minor unit of the
|
|
1842
|
-
# transaction's currency. For dollars, for example, this is cents.
|
|
1843
|
-
#
|
|
1844
|
-
# @return [Integer]
|
|
1845
|
-
required :expired_amount, Integer
|
|
1846
|
-
|
|
1847
|
-
# @!attribute network
|
|
1848
|
-
# The card network used to process this card authorization.
|
|
1849
|
-
#
|
|
1850
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network]
|
|
1851
|
-
required :network, enum: -> { Increase::CardPayment::Element::CardAuthorizationExpiration::Network }
|
|
1852
|
-
|
|
1853
|
-
# @!attribute type
|
|
1854
|
-
# A constant representing the object's type. For this resource it will always be
|
|
1855
|
-
# `card_authorization_expiration`.
|
|
1856
|
-
#
|
|
1857
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type]
|
|
1858
|
-
required :type, enum: -> { Increase::CardPayment::Element::CardAuthorizationExpiration::Type }
|
|
1859
|
-
|
|
1860
|
-
# @!method initialize(id:, card_authorization_id:, currency:, expired_amount:, network:, type:)
|
|
1861
|
-
# Some parameter documentations has been truncated, see
|
|
1862
|
-
# {Increase::Models::CardPayment::Element::CardAuthorizationExpiration} for more
|
|
1863
|
-
# details.
|
|
1864
|
-
#
|
|
1865
|
-
# A Card Authorization Expiration object. This field will be present in the JSON
|
|
1866
|
-
# response if and only if `category` is equal to `card_authorization_expiration`.
|
|
1867
|
-
# Card Authorization Expirations are cancellations of authorizations that were
|
|
1868
|
-
# never settled by the acquirer.
|
|
1869
|
-
#
|
|
1870
|
-
# @param id [String] The Card Authorization Expiration identifier.
|
|
1871
|
-
#
|
|
1872
|
-
# @param card_authorization_id [String] The identifier for the Card Authorization this reverses.
|
|
1873
|
-
#
|
|
1874
|
-
# @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's c
|
|
1875
|
-
#
|
|
1876
|
-
# @param expired_amount [Integer] The amount of this authorization expiration in the minor unit of the transaction
|
|
1877
|
-
#
|
|
1878
|
-
# @param network [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network] The card network used to process this card authorization.
|
|
1879
|
-
#
|
|
1880
|
-
# @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type] A constant representing the object's type. For this resource it will always be `
|
|
1881
|
-
|
|
1882
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
|
1883
|
-
# currency.
|
|
1884
|
-
#
|
|
1885
|
-
# @see Increase::Models::CardPayment::Element::CardAuthorizationExpiration#currency
|
|
1886
|
-
module Currency
|
|
1887
|
-
extend Increase::Internal::Type::Enum
|
|
1888
|
-
|
|
1889
|
-
# US Dollar (USD)
|
|
1890
|
-
USD = :USD
|
|
1891
|
-
|
|
1892
|
-
# @!method self.values
|
|
1893
|
-
# @return [Array<Symbol>]
|
|
1894
|
-
end
|
|
1895
|
-
|
|
1896
|
-
# The card network used to process this card authorization.
|
|
1897
|
-
#
|
|
1898
|
-
# @see Increase::Models::CardPayment::Element::CardAuthorizationExpiration#network
|
|
1899
|
-
module Network
|
|
1900
|
-
extend Increase::Internal::Type::Enum
|
|
1901
|
-
|
|
1902
|
-
# Visa
|
|
1903
|
-
VISA = :visa
|
|
1904
|
-
|
|
1905
|
-
# Pulse
|
|
1906
|
-
PULSE = :pulse
|
|
1907
|
-
|
|
1908
|
-
# @!method self.values
|
|
1909
|
-
# @return [Array<Symbol>]
|
|
1910
|
-
end
|
|
1911
|
-
|
|
1912
|
-
# A constant representing the object's type. For this resource it will always be
|
|
1913
|
-
# `card_authorization_expiration`.
|
|
1914
|
-
#
|
|
1915
|
-
# @see Increase::Models::CardPayment::Element::CardAuthorizationExpiration#type
|
|
1916
|
-
module Type
|
|
1917
|
-
extend Increase::Internal::Type::Enum
|
|
1918
|
-
|
|
1919
|
-
CARD_AUTHORIZATION_EXPIRATION = :card_authorization_expiration
|
|
1920
|
-
|
|
1921
|
-
# @!method self.values
|
|
1922
|
-
# @return [Array<Symbol>]
|
|
1923
|
-
end
|
|
1924
|
-
end
|
|
1925
|
-
|
|
1926
2981
|
# @see Increase::Models::CardPayment::Element#card_decline
|
|
1927
2982
|
class CardDecline < Increase::Internal::Type::BaseModel
|
|
1928
2983
|
# @!attribute id
|
|
@@ -9284,6 +10339,9 @@ module Increase
|
|
|
9284
10339
|
# Card Authentication: details will be under the `card_authentication` object.
|
|
9285
10340
|
CARD_AUTHENTICATION = :card_authentication
|
|
9286
10341
|
|
|
10342
|
+
# Card Balance Inquiry: details will be under the `card_balance_inquiry` object.
|
|
10343
|
+
CARD_BALANCE_INQUIRY = :card_balance_inquiry
|
|
10344
|
+
|
|
9287
10345
|
# Inbound Card Validation: details will be under the `card_validation` object.
|
|
9288
10346
|
CARD_VALIDATION = :card_validation
|
|
9289
10347
|
|