increase 0.378.0 → 0.380.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/package.json +1 -1
  3. package/resources/card-payments.d.mts +547 -4
  4. package/resources/card-payments.d.mts.map +1 -1
  5. package/resources/card-payments.d.ts +547 -4
  6. package/resources/card-payments.d.ts.map +1 -1
  7. package/resources/check-transfers.d.mts +14 -3
  8. package/resources/check-transfers.d.mts.map +1 -1
  9. package/resources/check-transfers.d.ts +14 -3
  10. package/resources/check-transfers.d.ts.map +1 -1
  11. package/resources/declined-transactions.d.mts +3 -1
  12. package/resources/declined-transactions.d.mts.map +1 -1
  13. package/resources/declined-transactions.d.ts +3 -1
  14. package/resources/declined-transactions.d.ts.map +1 -1
  15. package/resources/entities.d.mts +20 -3
  16. package/resources/entities.d.mts.map +1 -1
  17. package/resources/entities.d.ts +20 -3
  18. package/resources/entities.d.ts.map +1 -1
  19. package/resources/event-subscriptions.d.mts +6 -2
  20. package/resources/event-subscriptions.d.mts.map +1 -1
  21. package/resources/event-subscriptions.d.ts +6 -2
  22. package/resources/event-subscriptions.d.ts.map +1 -1
  23. package/resources/events.d.mts +4 -2
  24. package/resources/events.d.mts.map +1 -1
  25. package/resources/events.d.ts +4 -2
  26. package/resources/events.d.ts.map +1 -1
  27. package/resources/pending-transactions.d.mts +7 -4
  28. package/resources/pending-transactions.d.mts.map +1 -1
  29. package/resources/pending-transactions.d.ts +7 -4
  30. package/resources/pending-transactions.d.ts.map +1 -1
  31. package/resources/pending-transactions.js +4 -3
  32. package/resources/pending-transactions.js.map +1 -1
  33. package/resources/pending-transactions.mjs +4 -3
  34. package/resources/pending-transactions.mjs.map +1 -1
  35. package/resources/real-time-decisions.d.mts +786 -185
  36. package/resources/real-time-decisions.d.mts.map +1 -1
  37. package/resources/real-time-decisions.d.ts +786 -185
  38. package/resources/real-time-decisions.d.ts.map +1 -1
  39. package/resources/simulations/card-authorizations.d.mts +3 -1
  40. package/resources/simulations/card-authorizations.d.mts.map +1 -1
  41. package/resources/simulations/card-authorizations.d.ts +3 -1
  42. package/resources/simulations/card-authorizations.d.ts.map +1 -1
  43. package/resources/simulations/card-balance-inquiries.d.mts +160 -0
  44. package/resources/simulations/card-balance-inquiries.d.mts.map +1 -0
  45. package/resources/simulations/card-balance-inquiries.d.ts +160 -0
  46. package/resources/simulations/card-balance-inquiries.d.ts.map +1 -0
  47. package/resources/simulations/card-balance-inquiries.js +21 -0
  48. package/resources/simulations/card-balance-inquiries.js.map +1 -0
  49. package/resources/simulations/card-balance-inquiries.mjs +17 -0
  50. package/resources/simulations/card-balance-inquiries.mjs.map +1 -0
  51. package/resources/simulations/index.d.mts +1 -0
  52. package/resources/simulations/index.d.mts.map +1 -1
  53. package/resources/simulations/index.d.ts +1 -0
  54. package/resources/simulations/index.d.ts.map +1 -1
  55. package/resources/simulations/index.js +3 -1
  56. package/resources/simulations/index.js.map +1 -1
  57. package/resources/simulations/index.mjs +1 -0
  58. package/resources/simulations/index.mjs.map +1 -1
  59. package/resources/simulations/simulations.d.mts +4 -0
  60. package/resources/simulations/simulations.d.mts.map +1 -1
  61. package/resources/simulations/simulations.d.ts +4 -0
  62. package/resources/simulations/simulations.d.ts.map +1 -1
  63. package/resources/simulations/simulations.js +4 -0
  64. package/resources/simulations/simulations.js.map +1 -1
  65. package/resources/simulations/simulations.mjs +4 -0
  66. package/resources/simulations/simulations.mjs.map +1 -1
  67. package/resources/transactions.d.mts +3 -1
  68. package/resources/transactions.d.mts.map +1 -1
  69. package/resources/transactions.d.ts +3 -1
  70. package/resources/transactions.d.ts.map +1 -1
  71. package/src/resources/card-payments.ts +652 -0
  72. package/src/resources/check-transfers.ts +16 -3
  73. package/src/resources/declined-transactions.ts +3 -0
  74. package/src/resources/entities.ts +23 -3
  75. package/src/resources/event-subscriptions.ts +6 -0
  76. package/src/resources/events.ts +4 -0
  77. package/src/resources/pending-transactions.ts +7 -3
  78. package/src/resources/real-time-decisions.ts +893 -177
  79. package/src/resources/simulations/card-authorizations.ts +4 -1
  80. package/src/resources/simulations/card-balance-inquiries.ts +212 -0
  81. package/src/resources/simulations/index.ts +1 -0
  82. package/src/resources/simulations/simulations.ts +10 -0
  83. package/src/resources/transactions.ts +3 -0
  84. package/src/version.ts +1 -1
  85. package/version.d.mts +1 -1
  86. package/version.d.ts +1 -1
  87. package/version.js +1 -1
  88. package/version.mjs +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,40 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.380.0 (2025-12-15)
4
+
5
+ Full Changelog: [v0.379.0...v0.380.0](https://github.com/Increase/increase-typescript/compare/v0.379.0...v0.380.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([f85b165](https://github.com/Increase/increase-typescript/commit/f85b1655e9d638d440aa10b1864d315ee29b180c))
10
+
11
+ ## 0.379.0 (2025-12-15)
12
+
13
+ Full Changelog: [v0.378.0...v0.379.0](https://github.com/Increase/increase-typescript/compare/v0.378.0...v0.379.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([82e6c04](https://github.com/Increase/increase-typescript/commit/82e6c04d01d3ba178f84d9fab9ac8b6ed1937c09))
18
+ * **api:** api update ([bb35122](https://github.com/Increase/increase-typescript/commit/bb35122bb1ecdb375112598b6d0793f06edf3363))
19
+ * **api:** api update ([6328f09](https://github.com/Increase/increase-typescript/commit/6328f0919980ef7f36b183043ff15a29dbe1f539))
20
+ * **api:** api update ([7d741de](https://github.com/Increase/increase-typescript/commit/7d741de4e772bab6075aa8a280c56edbae48be1a))
21
+ * **api:** api update ([a585de6](https://github.com/Increase/increase-typescript/commit/a585de64ff3d12a77bd7cb742846eddb3a82193b))
22
+ * **api:** api update ([e7d0b9d](https://github.com/Increase/increase-typescript/commit/e7d0b9d309eb7cb13a23d9364472c8166d980665))
23
+ * **api:** api update ([2b388c8](https://github.com/Increase/increase-typescript/commit/2b388c8e1e093a625caaf0bfaba1ee6abcd77e18))
24
+ * **api:** api update ([5027ab0](https://github.com/Increase/increase-typescript/commit/5027ab077918c230fc63337df8af95ab4794e789))
25
+
26
+
27
+ ### Bug Fixes
28
+
29
+ * **mcp:** correct code tool API endpoint ([9e259cd](https://github.com/Increase/increase-typescript/commit/9e259cda174b02e7b9708a4a529a0b99517a81a2))
30
+ * **mcp:** return correct lines on typescript errors ([c9710ad](https://github.com/Increase/increase-typescript/commit/c9710ad6735cca7ecf80eb0e77881b44bb2cb296))
31
+
32
+
33
+ ### Chores
34
+
35
+ * **internal:** codegen related update ([db1fc02](https://github.com/Increase/increase-typescript/commit/db1fc0214b7e4d6bdb8a4140da47c6c519f9a3bb))
36
+ * **internal:** codegen related update ([96fa26b](https://github.com/Increase/increase-typescript/commit/96fa26bb0175cab4cadbad7bfc0795fe62b64d98))
37
+
3
38
  ## 0.378.0 (2025-12-04)
4
39
 
5
40
  Full Changelog: [v0.1.0...v0.378.0](https://github.com/Increase/increase-typescript/compare/v0.1.0...v0.378.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "increase",
3
- "version": "0.378.0",
3
+ "version": "0.380.0",
4
4
  "description": "The official TypeScript library for the Increase API",
5
5
  "author": "Increase <dev-feedback@increase.com>",
6
6
  "types": "./index.d.ts",
@@ -94,6 +94,14 @@ export declare namespace CardPayment {
94
94
  * never settled by the acquirer.
95
95
  */
96
96
  card_authorization_expiration: Element.CardAuthorizationExpiration | null;
97
+ /**
98
+ * A Card Balance Inquiry object. This field will be present in the JSON response
99
+ * if and only if `category` is equal to `card_balance_inquiry`. Card Balance
100
+ * Inquiries are transactions that allow merchants to check the available balance
101
+ * on a card without placing a hold on funds, commonly used when a customer
102
+ * requests their balance at an ATM.
103
+ */
104
+ card_balance_inquiry: Element.CardBalanceInquiry | null;
97
105
  /**
98
106
  * A Card Decline object. This field will be present in the JSON response if and
99
107
  * only if `category` is equal to `card_decline`.
@@ -155,6 +163,8 @@ export declare namespace CardPayment {
155
163
  * `card_authorization` object.
156
164
  * - `card_authentication` - Card Authentication: details will be under the
157
165
  * `card_authentication` object.
166
+ * - `card_balance_inquiry` - Card Balance Inquiry: details will be under the
167
+ * `card_balance_inquiry` object.
158
168
  * - `card_validation` - Inbound Card Validation: details will be under the
159
169
  * `card_validation` object.
160
170
  * - `card_decline` - Card Decline: details will be under the `card_decline`
@@ -174,7 +184,7 @@ export declare namespace CardPayment {
174
184
  * object.
175
185
  * - `other` - Unknown card payment element.
176
186
  */
177
- category: 'card_authorization' | 'card_authentication' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'card_financial' | 'other';
187
+ category: 'card_authorization' | 'card_authentication' | 'card_balance_inquiry' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'card_financial' | 'other';
178
188
  /**
179
189
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
180
190
  * the card payment element was created.
@@ -494,9 +504,11 @@ export declare namespace CardPayment {
494
504
  * voucher authorization, where funds are credited to the cardholder.
495
505
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
496
506
  * from an ATM or a point of sale.
507
+ * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
508
+ * of an account associated with a card.
497
509
  * - `unknown` - The processing category is unknown.
498
510
  */
499
- processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
511
+ processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'balance_inquiry' | 'unknown';
500
512
  /**
501
513
  * The identifier of the Real-Time Decision sent to approve or decline this
502
514
  * transaction.
@@ -976,6 +988,533 @@ export declare namespace CardPayment {
976
988
  type: 'card_authorization_expiration';
977
989
  [k: string]: unknown;
978
990
  }
991
+ /**
992
+ * A Card Balance Inquiry object. This field will be present in the JSON response
993
+ * if and only if `category` is equal to `card_balance_inquiry`. Card Balance
994
+ * Inquiries are transactions that allow merchants to check the available balance
995
+ * on a card without placing a hold on funds, commonly used when a customer
996
+ * requests their balance at an ATM.
997
+ */
998
+ interface CardBalanceInquiry {
999
+ /**
1000
+ * The Card Balance Inquiry identifier.
1001
+ */
1002
+ id: string;
1003
+ /**
1004
+ * Additional amounts associated with the card authorization, such as ATM
1005
+ * surcharges fees. These are usually a subset of the `amount` field and are used
1006
+ * to provide more detailed information about the transaction.
1007
+ */
1008
+ additional_amounts: CardBalanceInquiry.AdditionalAmounts;
1009
+ /**
1010
+ * The balance amount in the minor unit of the account's currency. For dollars, for
1011
+ * example, this is cents.
1012
+ */
1013
+ balance: number;
1014
+ /**
1015
+ * The ID of the Card Payment this transaction belongs to.
1016
+ */
1017
+ card_payment_id: string;
1018
+ /**
1019
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's
1020
+ * currency.
1021
+ *
1022
+ * - `USD` - US Dollar (USD)
1023
+ */
1024
+ currency: 'USD';
1025
+ /**
1026
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
1027
+ * purchase), the identifier of the token that was used.
1028
+ */
1029
+ digital_wallet_token_id: string | null;
1030
+ /**
1031
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1032
+ * is transacting with.
1033
+ */
1034
+ merchant_acceptor_id: string;
1035
+ /**
1036
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1037
+ * card is transacting with.
1038
+ */
1039
+ merchant_category_code: string;
1040
+ /**
1041
+ * The city the merchant resides in.
1042
+ */
1043
+ merchant_city: string | null;
1044
+ /**
1045
+ * The country the merchant resides in.
1046
+ */
1047
+ merchant_country: string;
1048
+ /**
1049
+ * The merchant descriptor of the merchant the card is transacting with.
1050
+ */
1051
+ merchant_descriptor: string;
1052
+ /**
1053
+ * The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1054
+ * ZIP code, where the first 5 and last 4 are separated by a dash.
1055
+ */
1056
+ merchant_postal_code: string | null;
1057
+ /**
1058
+ * The state the merchant resides in.
1059
+ */
1060
+ merchant_state: string | null;
1061
+ /**
1062
+ * Fields specific to the `network`.
1063
+ */
1064
+ network_details: CardBalanceInquiry.NetworkDetails;
1065
+ /**
1066
+ * Network-specific identifiers for a specific request or transaction.
1067
+ */
1068
+ network_identifiers: CardBalanceInquiry.NetworkIdentifiers;
1069
+ /**
1070
+ * The risk score generated by the card network. For Visa this is the Visa Advanced
1071
+ * Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1072
+ * score is from 0 to 999, where 999 is the riskiest.
1073
+ */
1074
+ network_risk_score: number | null;
1075
+ /**
1076
+ * If the authorization was made in-person with a physical card, the Physical Card
1077
+ * that was used.
1078
+ */
1079
+ physical_card_id: string | null;
1080
+ /**
1081
+ * The identifier of the Real-Time Decision sent to approve or decline this
1082
+ * transaction.
1083
+ */
1084
+ real_time_decision_id: string | null;
1085
+ /**
1086
+ * The terminal identifier (commonly abbreviated as TID) of the terminal the card
1087
+ * is transacting with.
1088
+ */
1089
+ terminal_id: string | null;
1090
+ /**
1091
+ * A constant representing the object's type. For this resource it will always be
1092
+ * `card_balance_inquiry`.
1093
+ */
1094
+ type: 'card_balance_inquiry';
1095
+ /**
1096
+ * Fields related to verification of cardholder-provided values.
1097
+ */
1098
+ verification: CardBalanceInquiry.Verification;
1099
+ [k: string]: unknown;
1100
+ }
1101
+ namespace CardBalanceInquiry {
1102
+ /**
1103
+ * Additional amounts associated with the card authorization, such as ATM
1104
+ * surcharges fees. These are usually a subset of the `amount` field and are used
1105
+ * to provide more detailed information about the transaction.
1106
+ */
1107
+ interface AdditionalAmounts {
1108
+ /**
1109
+ * The part of this transaction amount that was for clinic-related services.
1110
+ */
1111
+ clinic: AdditionalAmounts.Clinic | null;
1112
+ /**
1113
+ * The part of this transaction amount that was for dental-related services.
1114
+ */
1115
+ dental: AdditionalAmounts.Dental | null;
1116
+ /**
1117
+ * The original pre-authorized amount.
1118
+ */
1119
+ original: AdditionalAmounts.Original | null;
1120
+ /**
1121
+ * The part of this transaction amount that was for healthcare prescriptions.
1122
+ */
1123
+ prescription: AdditionalAmounts.Prescription | null;
1124
+ /**
1125
+ * The surcharge amount charged for this transaction by the merchant.
1126
+ */
1127
+ surcharge: AdditionalAmounts.Surcharge | null;
1128
+ /**
1129
+ * The total amount of a series of incremental authorizations, optionally provided.
1130
+ */
1131
+ total_cumulative: AdditionalAmounts.TotalCumulative | null;
1132
+ /**
1133
+ * The total amount of healthcare-related additional amounts.
1134
+ */
1135
+ total_healthcare: AdditionalAmounts.TotalHealthcare | null;
1136
+ /**
1137
+ * The part of this transaction amount that was for transit-related services.
1138
+ */
1139
+ transit: AdditionalAmounts.Transit | null;
1140
+ /**
1141
+ * An unknown additional amount.
1142
+ */
1143
+ unknown: AdditionalAmounts.Unknown | null;
1144
+ /**
1145
+ * The part of this transaction amount that was for vision-related services.
1146
+ */
1147
+ vision: AdditionalAmounts.Vision | null;
1148
+ }
1149
+ namespace AdditionalAmounts {
1150
+ /**
1151
+ * The part of this transaction amount that was for clinic-related services.
1152
+ */
1153
+ interface Clinic {
1154
+ /**
1155
+ * The amount in minor units of the `currency` field. The amount is positive if it
1156
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1157
+ * subtracted from the amount (such as a discount).
1158
+ */
1159
+ amount: number;
1160
+ /**
1161
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1162
+ * amount's currency.
1163
+ */
1164
+ currency: string;
1165
+ }
1166
+ /**
1167
+ * The part of this transaction amount that was for dental-related services.
1168
+ */
1169
+ interface Dental {
1170
+ /**
1171
+ * The amount in minor units of the `currency` field. The amount is positive if it
1172
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1173
+ * subtracted from the amount (such as a discount).
1174
+ */
1175
+ amount: number;
1176
+ /**
1177
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1178
+ * amount's currency.
1179
+ */
1180
+ currency: string;
1181
+ }
1182
+ /**
1183
+ * The original pre-authorized amount.
1184
+ */
1185
+ interface Original {
1186
+ /**
1187
+ * The amount in minor units of the `currency` field. The amount is positive if it
1188
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1189
+ * subtracted from the amount (such as a discount).
1190
+ */
1191
+ amount: number;
1192
+ /**
1193
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1194
+ * amount's currency.
1195
+ */
1196
+ currency: string;
1197
+ }
1198
+ /**
1199
+ * The part of this transaction amount that was for healthcare prescriptions.
1200
+ */
1201
+ interface Prescription {
1202
+ /**
1203
+ * The amount in minor units of the `currency` field. The amount is positive if it
1204
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1205
+ * subtracted from the amount (such as a discount).
1206
+ */
1207
+ amount: number;
1208
+ /**
1209
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1210
+ * amount's currency.
1211
+ */
1212
+ currency: string;
1213
+ }
1214
+ /**
1215
+ * The surcharge amount charged for this transaction by the merchant.
1216
+ */
1217
+ interface Surcharge {
1218
+ /**
1219
+ * The amount in minor units of the `currency` field. The amount is positive if it
1220
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1221
+ * subtracted from the amount (such as a discount).
1222
+ */
1223
+ amount: number;
1224
+ /**
1225
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1226
+ * amount's currency.
1227
+ */
1228
+ currency: string;
1229
+ }
1230
+ /**
1231
+ * The total amount of a series of incremental authorizations, optionally provided.
1232
+ */
1233
+ interface TotalCumulative {
1234
+ /**
1235
+ * The amount in minor units of the `currency` field. The amount is positive if it
1236
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1237
+ * subtracted from the amount (such as a discount).
1238
+ */
1239
+ amount: number;
1240
+ /**
1241
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1242
+ * amount's currency.
1243
+ */
1244
+ currency: string;
1245
+ }
1246
+ /**
1247
+ * The total amount of healthcare-related additional amounts.
1248
+ */
1249
+ interface TotalHealthcare {
1250
+ /**
1251
+ * The amount in minor units of the `currency` field. The amount is positive if it
1252
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1253
+ * subtracted from the amount (such as a discount).
1254
+ */
1255
+ amount: number;
1256
+ /**
1257
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1258
+ * amount's currency.
1259
+ */
1260
+ currency: string;
1261
+ }
1262
+ /**
1263
+ * The part of this transaction amount that was for transit-related services.
1264
+ */
1265
+ interface Transit {
1266
+ /**
1267
+ * The amount in minor units of the `currency` field. The amount is positive if it
1268
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1269
+ * subtracted from the amount (such as a discount).
1270
+ */
1271
+ amount: number;
1272
+ /**
1273
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1274
+ * amount's currency.
1275
+ */
1276
+ currency: string;
1277
+ }
1278
+ /**
1279
+ * An unknown additional amount.
1280
+ */
1281
+ interface Unknown {
1282
+ /**
1283
+ * The amount in minor units of the `currency` field. The amount is positive if it
1284
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1285
+ * subtracted from the amount (such as a discount).
1286
+ */
1287
+ amount: number;
1288
+ /**
1289
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1290
+ * amount's currency.
1291
+ */
1292
+ currency: string;
1293
+ }
1294
+ /**
1295
+ * The part of this transaction amount that was for vision-related services.
1296
+ */
1297
+ interface Vision {
1298
+ /**
1299
+ * The amount in minor units of the `currency` field. The amount is positive if it
1300
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1301
+ * subtracted from the amount (such as a discount).
1302
+ */
1303
+ amount: number;
1304
+ /**
1305
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1306
+ * amount's currency.
1307
+ */
1308
+ currency: string;
1309
+ }
1310
+ }
1311
+ /**
1312
+ * Fields specific to the `network`.
1313
+ */
1314
+ interface NetworkDetails {
1315
+ /**
1316
+ * The payment network used to process this card authorization.
1317
+ *
1318
+ * - `visa` - Visa
1319
+ * - `pulse` - Pulse
1320
+ */
1321
+ category: 'visa' | 'pulse';
1322
+ /**
1323
+ * Fields specific to the `pulse` network.
1324
+ */
1325
+ pulse: NetworkDetails.Pulse | null;
1326
+ /**
1327
+ * Fields specific to the `visa` network.
1328
+ */
1329
+ visa: NetworkDetails.Visa | null;
1330
+ }
1331
+ namespace NetworkDetails {
1332
+ /**
1333
+ * Fields specific to the `pulse` network.
1334
+ */
1335
+ interface Pulse {
1336
+ }
1337
+ /**
1338
+ * Fields specific to the `visa` network.
1339
+ */
1340
+ interface Visa {
1341
+ /**
1342
+ * For electronic commerce transactions, this identifies the level of security used
1343
+ * in obtaining the customer's payment credential. For mail or telephone order
1344
+ * transactions, identifies the type of mail or telephone order.
1345
+ *
1346
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
1347
+ * that the transaction is a mail/phone order purchase, not a recurring
1348
+ * transaction or installment payment. For domestic transactions in the US
1349
+ * region, this value may also indicate one bill payment transaction in the
1350
+ * card-present or card-absent environments.
1351
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
1352
+ * recurring transaction that originates from an acquirer in the US region.
1353
+ * - `installment` - Installment payment: Payment indicator used to indicate one
1354
+ * purchase of goods or services that is billed to the account in multiple
1355
+ * charges over a period of time agreed upon by the cardholder and merchant from
1356
+ * transactions that originate from an acquirer in the US region.
1357
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
1358
+ * indicate that the type of mail/telephone order is unknown.
1359
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
1360
+ * indicate that the electronic commerce transaction has been authenticated using
1361
+ * e.g., 3-D Secure
1362
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
1363
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
1364
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
1365
+ * identify an electronic commerce transaction where the merchant attempted to
1366
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
1367
+ * authentication because the issuer or cardholder does not participate in the
1368
+ * 3-D Secure program.
1369
+ * - `non_authenticated_security_transaction` - Non-authenticated security
1370
+ * transaction: Use to identify an electronic commerce transaction that uses data
1371
+ * encryption for security however, cardholder authentication is not performed
1372
+ * using 3-D Secure.
1373
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
1374
+ * electronic commerce transaction that has no data protection.
1375
+ */
1376
+ electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
1377
+ /**
1378
+ * The method used to enter the cardholder's primary account number and card
1379
+ * expiration date.
1380
+ *
1381
+ * - `unknown` - Unknown
1382
+ * - `manual` - Manual key entry
1383
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
1384
+ * value
1385
+ * - `optical_code` - Optical code
1386
+ * - `integrated_circuit_card` - Contact chip card
1387
+ * - `contactless` - Contactless read of chip card
1388
+ * - `credential_on_file` - Transaction initiated using a credential that has
1389
+ * previously been stored on file
1390
+ * - `magnetic_stripe` - Magnetic stripe read
1391
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
1392
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
1393
+ * verification value
1394
+ */
1395
+ point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
1396
+ /**
1397
+ * Only present when `actioner: network`. Describes why a card authorization was
1398
+ * approved or declined by Visa through stand-in processing.
1399
+ *
1400
+ * - `issuer_error` - Increase failed to process the authorization in a timely
1401
+ * manner.
1402
+ * - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
1403
+ * authorization request cryptogram.
1404
+ * - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
1405
+ * authentication verification value was invalid.
1406
+ * - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
1407
+ * code for certain expected occurrences as well, such as Application Transaction
1408
+ * Counter (ATC) replays.
1409
+ * - `merchant_transaction_advisory_service_authentication_required` - The merchant
1410
+ * has enabled Visa's Transaction Advisory Service and requires further
1411
+ * authentication to perform the transaction. In practice this is often utilized
1412
+ * at fuel pumps to tell the cardholder to see the cashier.
1413
+ * - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
1414
+ * Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
1415
+ * such as card testing.
1416
+ * - `other` - An unspecific reason for stand-in processing.
1417
+ */
1418
+ stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
1419
+ }
1420
+ }
1421
+ /**
1422
+ * Network-specific identifiers for a specific request or transaction.
1423
+ */
1424
+ interface NetworkIdentifiers {
1425
+ /**
1426
+ * The randomly generated 6-character Authorization Identification Response code
1427
+ * sent back to the acquirer in an approved response.
1428
+ */
1429
+ authorization_identification_response: string | null;
1430
+ /**
1431
+ * A life-cycle identifier used across e.g., an authorization and a reversal.
1432
+ * Expected to be unique per acquirer within a window of time. For some card
1433
+ * networks the retrieval reference number includes the trace counter.
1434
+ */
1435
+ retrieval_reference_number: string | null;
1436
+ /**
1437
+ * A counter used to verify an individual authorization. Expected to be unique per
1438
+ * acquirer within a window of time.
1439
+ */
1440
+ trace_number: string | null;
1441
+ /**
1442
+ * A globally unique transaction identifier provided by the card network, used
1443
+ * across multiple life-cycle requests.
1444
+ */
1445
+ transaction_id: string | null;
1446
+ }
1447
+ /**
1448
+ * Fields related to verification of cardholder-provided values.
1449
+ */
1450
+ interface Verification {
1451
+ /**
1452
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1453
+ * the back of the card.
1454
+ */
1455
+ card_verification_code: Verification.CardVerificationCode;
1456
+ /**
1457
+ * Cardholder address provided in the authorization request and the address on file
1458
+ * we verified it against.
1459
+ */
1460
+ cardholder_address: Verification.CardholderAddress;
1461
+ }
1462
+ namespace Verification {
1463
+ /**
1464
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1465
+ * the back of the card.
1466
+ */
1467
+ interface CardVerificationCode {
1468
+ /**
1469
+ * The result of verifying the Card Verification Code.
1470
+ *
1471
+ * - `not_checked` - No card verification code was provided in the authorization
1472
+ * request.
1473
+ * - `match` - The card verification code matched the one on file.
1474
+ * - `no_match` - The card verification code did not match the one on file.
1475
+ */
1476
+ result: 'not_checked' | 'match' | 'no_match';
1477
+ }
1478
+ /**
1479
+ * Cardholder address provided in the authorization request and the address on file
1480
+ * we verified it against.
1481
+ */
1482
+ interface CardholderAddress {
1483
+ /**
1484
+ * Line 1 of the address on file for the cardholder.
1485
+ */
1486
+ actual_line1: string | null;
1487
+ /**
1488
+ * The postal code of the address on file for the cardholder.
1489
+ */
1490
+ actual_postal_code: string | null;
1491
+ /**
1492
+ * The cardholder address line 1 provided for verification in the authorization
1493
+ * request.
1494
+ */
1495
+ provided_line1: string | null;
1496
+ /**
1497
+ * The postal code provided for verification in the authorization request.
1498
+ */
1499
+ provided_postal_code: string | null;
1500
+ /**
1501
+ * The address verification result returned to the card network.
1502
+ *
1503
+ * - `not_checked` - No address information was provided in the authorization
1504
+ * request.
1505
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
1506
+ * address does not match or was not provided.
1507
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
1508
+ * street address matches or was not provided.
1509
+ * - `match` - Postal code and street address match.
1510
+ * - `no_match` - Postal code and street address do not match.
1511
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
1512
+ * address was not verified. (deprecated)
1513
+ */
1514
+ result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
1515
+ }
1516
+ }
1517
+ }
979
1518
  /**
980
1519
  * A Card Decline object. This field will be present in the JSON response if and
981
1520
  * only if `category` is equal to `card_decline`.
@@ -1120,9 +1659,11 @@ export declare namespace CardPayment {
1120
1659
  * voucher authorization, where funds are credited to the cardholder.
1121
1660
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
1122
1661
  * from an ATM or a point of sale.
1662
+ * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
1663
+ * of an account associated with a card.
1123
1664
  * - `unknown` - The processing category is unknown.
1124
1665
  */
1125
- processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
1666
+ processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'balance_inquiry' | 'unknown';
1126
1667
  /**
1127
1668
  * The identifier of the Real-Time Decision sent to approve or decline this
1128
1669
  * transaction.
@@ -1744,9 +2285,11 @@ export declare namespace CardPayment {
1744
2285
  * voucher authorization, where funds are credited to the cardholder.
1745
2286
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
1746
2287
  * from an ATM or a point of sale.
2288
+ * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
2289
+ * of an account associated with a card.
1747
2290
  * - `unknown` - The processing category is unknown.
1748
2291
  */
1749
- processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
2292
+ processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'balance_inquiry' | 'unknown';
1750
2293
  /**
1751
2294
  * The identifier of the Real-Time Decision sent to approve or decline this
1752
2295
  * transaction.