increase 0.378.0 → 0.379.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 (83) hide show
  1. package/CHANGELOG.md +27 -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/declined-transactions.d.mts +3 -1
  8. package/resources/declined-transactions.d.mts.map +1 -1
  9. package/resources/declined-transactions.d.ts +3 -1
  10. package/resources/declined-transactions.d.ts.map +1 -1
  11. package/resources/entities.d.mts +20 -3
  12. package/resources/entities.d.mts.map +1 -1
  13. package/resources/entities.d.ts +20 -3
  14. package/resources/entities.d.ts.map +1 -1
  15. package/resources/event-subscriptions.d.mts +6 -2
  16. package/resources/event-subscriptions.d.mts.map +1 -1
  17. package/resources/event-subscriptions.d.ts +6 -2
  18. package/resources/event-subscriptions.d.ts.map +1 -1
  19. package/resources/events.d.mts +4 -2
  20. package/resources/events.d.mts.map +1 -1
  21. package/resources/events.d.ts +4 -2
  22. package/resources/events.d.ts.map +1 -1
  23. package/resources/pending-transactions.d.mts +7 -4
  24. package/resources/pending-transactions.d.mts.map +1 -1
  25. package/resources/pending-transactions.d.ts +7 -4
  26. package/resources/pending-transactions.d.ts.map +1 -1
  27. package/resources/pending-transactions.js +4 -3
  28. package/resources/pending-transactions.js.map +1 -1
  29. package/resources/pending-transactions.mjs +4 -3
  30. package/resources/pending-transactions.mjs.map +1 -1
  31. package/resources/real-time-decisions.d.mts +786 -185
  32. package/resources/real-time-decisions.d.mts.map +1 -1
  33. package/resources/real-time-decisions.d.ts +786 -185
  34. package/resources/real-time-decisions.d.ts.map +1 -1
  35. package/resources/simulations/card-authorizations.d.mts +3 -1
  36. package/resources/simulations/card-authorizations.d.mts.map +1 -1
  37. package/resources/simulations/card-authorizations.d.ts +3 -1
  38. package/resources/simulations/card-authorizations.d.ts.map +1 -1
  39. package/resources/simulations/card-balance-inquiries.d.mts +160 -0
  40. package/resources/simulations/card-balance-inquiries.d.mts.map +1 -0
  41. package/resources/simulations/card-balance-inquiries.d.ts +160 -0
  42. package/resources/simulations/card-balance-inquiries.d.ts.map +1 -0
  43. package/resources/simulations/card-balance-inquiries.js +21 -0
  44. package/resources/simulations/card-balance-inquiries.js.map +1 -0
  45. package/resources/simulations/card-balance-inquiries.mjs +17 -0
  46. package/resources/simulations/card-balance-inquiries.mjs.map +1 -0
  47. package/resources/simulations/index.d.mts +1 -0
  48. package/resources/simulations/index.d.mts.map +1 -1
  49. package/resources/simulations/index.d.ts +1 -0
  50. package/resources/simulations/index.d.ts.map +1 -1
  51. package/resources/simulations/index.js +3 -1
  52. package/resources/simulations/index.js.map +1 -1
  53. package/resources/simulations/index.mjs +1 -0
  54. package/resources/simulations/index.mjs.map +1 -1
  55. package/resources/simulations/simulations.d.mts +4 -0
  56. package/resources/simulations/simulations.d.mts.map +1 -1
  57. package/resources/simulations/simulations.d.ts +4 -0
  58. package/resources/simulations/simulations.d.ts.map +1 -1
  59. package/resources/simulations/simulations.js +4 -0
  60. package/resources/simulations/simulations.js.map +1 -1
  61. package/resources/simulations/simulations.mjs +4 -0
  62. package/resources/simulations/simulations.mjs.map +1 -1
  63. package/resources/transactions.d.mts +3 -1
  64. package/resources/transactions.d.mts.map +1 -1
  65. package/resources/transactions.d.ts +3 -1
  66. package/resources/transactions.d.ts.map +1 -1
  67. package/src/resources/card-payments.ts +652 -0
  68. package/src/resources/declined-transactions.ts +3 -0
  69. package/src/resources/entities.ts +23 -3
  70. package/src/resources/event-subscriptions.ts +6 -0
  71. package/src/resources/events.ts +4 -0
  72. package/src/resources/pending-transactions.ts +7 -3
  73. package/src/resources/real-time-decisions.ts +893 -177
  74. package/src/resources/simulations/card-authorizations.ts +4 -1
  75. package/src/resources/simulations/card-balance-inquiries.ts +212 -0
  76. package/src/resources/simulations/index.ts +1 -0
  77. package/src/resources/simulations/simulations.ts +10 -0
  78. package/src/resources/transactions.ts +3 -0
  79. package/src/version.ts +1 -1
  80. package/version.d.mts +1 -1
  81. package/version.d.ts +1 -1
  82. package/version.js +1 -1
  83. package/version.mjs +1 -1
@@ -68,10 +68,16 @@ export interface RealTimeDecision {
68
68
  */
69
69
  card_authorization: RealTimeDecision.CardAuthorization | null;
70
70
 
71
+ /**
72
+ * Fields related to a card balance inquiry.
73
+ */
74
+ card_balance_inquiry: RealTimeDecision.CardBalanceInquiry | null;
75
+
71
76
  /**
72
77
  * The category of the Real-Time Decision.
73
78
  *
74
79
  * - `card_authorization_requested` - A card is being authorized.
80
+ * - `card_balance_inquiry_requested` - A balance inquiry is being made on a card.
75
81
  * - `card_authentication_requested` - 3DS authentication is requested.
76
82
  * - `card_authentication_challenge_requested` - 3DS authentication challenge
77
83
  * requires cardholder involvement.
@@ -82,6 +88,7 @@ export interface RealTimeDecision {
82
88
  */
83
89
  category:
84
90
  | 'card_authorization_requested'
91
+ | 'card_balance_inquiry_requested'
85
92
  | 'card_authentication_requested'
86
93
  | 'card_authentication_challenge_requested'
87
94
  | 'digital_wallet_token_requested'
@@ -209,6 +216,12 @@ export namespace RealTimeDecision {
209
216
  */
210
217
  additional_amounts: CardAuthorization.AdditionalAmounts;
211
218
 
219
+ /**
220
+ * Present if and only if `decision` is `approve`. Contains information related to
221
+ * the approval of the authorization.
222
+ */
223
+ approval: CardAuthorization.Approval | null;
224
+
212
225
  /**
213
226
  * The identifier of the Card that is being authorized.
214
227
  */
@@ -300,6 +313,14 @@ export namespace RealTimeDecision {
300
313
  */
301
314
  network_risk_score: number | null;
302
315
 
316
+ /**
317
+ * Whether or not the authorization supports partial approvals.
318
+ *
319
+ * - `supported` - This transaction supports partial approvals.
320
+ * - `not_supported` - This transaction does not support partial approvals.
321
+ */
322
+ partial_approval_capability: 'supported' | 'not_supported';
323
+
303
324
  /**
304
325
  * If the authorization was made in-person with a physical card, the Physical Card
305
326
  * that was used.
@@ -339,6 +360,8 @@ export namespace RealTimeDecision {
339
360
  * voucher authorization, where funds are credited to the cardholder.
340
361
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
341
362
  * from an ATM or a point of sale.
363
+ * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
364
+ * of an account associated with a card.
342
365
  * - `unknown` - The processing category is unknown.
343
366
  */
344
367
  processing_category:
@@ -350,6 +373,7 @@ export namespace RealTimeDecision {
350
373
  | 'quasi_cash'
351
374
  | 'refund'
352
375
  | 'cash_disbursement'
376
+ | 'balance_inquiry'
353
377
  | 'unknown';
354
378
 
355
379
  /**
@@ -629,6 +653,18 @@ export namespace RealTimeDecision {
629
653
  }
630
654
  }
631
655
 
656
+ /**
657
+ * Present if and only if `decision` is `approve`. Contains information related to
658
+ * the approval of the authorization.
659
+ */
660
+ export interface Approval {
661
+ /**
662
+ * If the authorization was partially approved, this field contains the approved
663
+ * amount in the minor unit of the settlement currency.
664
+ */
665
+ partial_amount: number | null;
666
+ }
667
+
632
668
  /**
633
669
  * Present if and only if `decision` is `decline`. Contains information related to
634
670
  * the reason the authorization was declined.
@@ -967,249 +1003,896 @@ export namespace RealTimeDecision {
967
1003
  }
968
1004
 
969
1005
  /**
970
- * Fields related to a digital wallet authentication attempt.
1006
+ * Fields related to a card balance inquiry.
971
1007
  */
972
- export interface DigitalWalletAuthentication {
1008
+ export interface CardBalanceInquiry {
973
1009
  /**
974
- * The identifier of the Card that is being tokenized.
1010
+ * The identifier of the Account the authorization will debit.
975
1011
  */
976
- card_id: string;
1012
+ account_id: string;
977
1013
 
978
1014
  /**
979
- * The channel to send the card user their one-time passcode.
980
- *
981
- * - `sms` - Send one-time passcodes over SMS.
982
- * - `email` - Send one-time passcodes over email.
1015
+ * Additional amounts associated with the card authorization, such as ATM
1016
+ * surcharges fees. These are usually a subset of the `amount` field and are used
1017
+ * to provide more detailed information about the transaction.
983
1018
  */
984
- channel: 'sms' | 'email';
1019
+ additional_amounts: CardBalanceInquiry.AdditionalAmounts;
985
1020
 
986
1021
  /**
987
- * The digital wallet app being used.
988
- *
989
- * - `apple_pay` - Apple Pay
990
- * - `google_pay` - Google Pay
991
- * - `samsung_pay` - Samsung Pay
992
- * - `unknown` - Unknown
1022
+ * Present if and only if `decision` is `approve`. Contains information related to
1023
+ * the approval of the balance inquiry.
993
1024
  */
994
- digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
1025
+ approval: CardBalanceInquiry.Approval | null;
995
1026
 
996
1027
  /**
997
- * The email to send the one-time passcode to if `channel` is equal to `email`.
1028
+ * The identifier of the Card that is being authorized.
998
1029
  */
999
- email: string | null;
1030
+ card_id: string;
1000
1031
 
1001
1032
  /**
1002
- * The one-time passcode to send the card user.
1033
+ * Whether or not the authorization was approved.
1034
+ *
1035
+ * - `approve` - Approve the authorization.
1036
+ * - `decline` - Decline the authorization.
1003
1037
  */
1004
- one_time_passcode: string;
1038
+ decision: 'approve' | 'decline' | null;
1005
1039
 
1006
1040
  /**
1007
- * The phone number to send the one-time passcode to if `channel` is equal to
1008
- * `sms`.
1041
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
1042
+ * purchase), the identifier of the token that was used.
1009
1043
  */
1010
- phone: string | null;
1044
+ digital_wallet_token_id: string | null;
1011
1045
 
1012
1046
  /**
1013
- * Whether your application successfully delivered the one-time passcode.
1014
- *
1015
- * - `success` - Your application successfully delivered the one-time passcode to
1016
- * the cardholder.
1017
- * - `failure` - Your application failed to deliver the one-time passcode to the
1018
- * cardholder.
1047
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1048
+ * is transacting with.
1019
1049
  */
1020
- result: 'success' | 'failure' | null;
1021
- }
1050
+ merchant_acceptor_id: string;
1022
1051
 
1023
- /**
1024
- * Fields related to a digital wallet token provisioning attempt.
1025
- */
1026
- export interface DigitalWalletToken {
1027
1052
  /**
1028
- * The identifier of the Card that is being tokenized.
1053
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1054
+ * card is transacting with.
1029
1055
  */
1030
- card_id: string;
1056
+ merchant_category_code: string;
1031
1057
 
1032
1058
  /**
1033
- * Whether or not the provisioning request was approved. This will be null until
1034
- * the real time decision is responded to.
1035
- *
1036
- * - `approve` - Approve the provisioning request.
1037
- * - `decline` - Decline the provisioning request.
1059
+ * The city the merchant resides in.
1038
1060
  */
1039
- decision: 'approve' | 'decline' | null;
1061
+ merchant_city: string | null;
1040
1062
 
1041
1063
  /**
1042
- * Device that is being used to provision the digital wallet token.
1064
+ * The country the merchant resides in.
1043
1065
  */
1044
- device: DigitalWalletToken.Device;
1066
+ merchant_country: string;
1045
1067
 
1046
1068
  /**
1047
- * The digital wallet app being used.
1048
- *
1049
- * - `apple_pay` - Apple Pay
1050
- * - `google_pay` - Google Pay
1051
- * - `samsung_pay` - Samsung Pay
1052
- * - `unknown` - Unknown
1069
+ * The merchant descriptor of the merchant the card is transacting with.
1053
1070
  */
1054
- digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
1055
- }
1071
+ merchant_descriptor: string;
1056
1072
 
1057
- export namespace DigitalWalletToken {
1058
1073
  /**
1059
- * Device that is being used to provision the digital wallet token.
1074
+ * The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1075
+ * ZIP code, where the first 5 and last 4 are separated by a dash.
1060
1076
  */
1061
- export interface Device {
1062
- /**
1063
- * ID assigned to the device by the digital wallet provider.
1064
- */
1065
- identifier: string | null;
1066
- }
1067
- }
1068
- }
1069
-
1070
- export interface RealTimeDecisionActionParams {
1071
- /**
1072
- * If the Real-Time Decision relates to a 3DS card authentication attempt, this
1073
- * object contains your response to the authentication.
1074
- */
1075
- card_authentication?: RealTimeDecisionActionParams.CardAuthentication;
1076
-
1077
- /**
1078
- * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
1079
- * this object contains your response.
1080
- */
1081
- card_authentication_challenge?: RealTimeDecisionActionParams.CardAuthenticationChallenge;
1077
+ merchant_postal_code: string | null;
1082
1078
 
1083
- /**
1084
- * If the Real-Time Decision relates to a card authorization attempt, this object
1085
- * contains your response to the authorization.
1086
- */
1087
- card_authorization?: RealTimeDecisionActionParams.CardAuthorization;
1079
+ /**
1080
+ * The state the merchant resides in.
1081
+ */
1082
+ merchant_state: string | null;
1088
1083
 
1089
- /**
1090
- * If the Real-Time Decision relates to a digital wallet authentication attempt,
1091
- * this object contains your response to the authentication.
1092
- */
1093
- digital_wallet_authentication?: RealTimeDecisionActionParams.DigitalWalletAuthentication;
1084
+ /**
1085
+ * Fields specific to the `network`.
1086
+ */
1087
+ network_details: CardBalanceInquiry.NetworkDetails;
1094
1088
 
1095
- /**
1096
- * If the Real-Time Decision relates to a digital wallet token provisioning
1097
- * attempt, this object contains your response to the attempt.
1098
- */
1099
- digital_wallet_token?: RealTimeDecisionActionParams.DigitalWalletToken;
1100
- }
1089
+ /**
1090
+ * Network-specific identifiers for a specific request or transaction.
1091
+ */
1092
+ network_identifiers: CardBalanceInquiry.NetworkIdentifiers;
1101
1093
 
1102
- export namespace RealTimeDecisionActionParams {
1103
- /**
1104
- * If the Real-Time Decision relates to a 3DS card authentication attempt, this
1105
- * object contains your response to the authentication.
1106
- */
1107
- export interface CardAuthentication {
1108
1094
  /**
1109
- * Whether the card authentication attempt should be approved or declined.
1110
- *
1111
- * - `approve` - Approve the authentication attempt without triggering a challenge.
1112
- * - `challenge` - Request further validation before approving the authentication
1113
- * attempt.
1114
- * - `deny` - Deny the authentication attempt.
1095
+ * The risk score generated by the card network. For Visa this is the Visa Advanced
1096
+ * Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1097
+ * score is from 0 to 999, where 999 is the riskiest.
1115
1098
  */
1116
- decision: 'approve' | 'challenge' | 'deny';
1117
- }
1099
+ network_risk_score: number | null;
1118
1100
 
1119
- /**
1120
- * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
1121
- * this object contains your response.
1122
- */
1123
- export interface CardAuthenticationChallenge {
1124
1101
  /**
1125
- * Whether the card authentication challenge was successfully delivered to the
1126
- * cardholder.
1127
- *
1128
- * - `success` - Your application successfully delivered the one-time code to the
1129
- * cardholder.
1130
- * - `failure` - Your application was unable to deliver the one-time code to the
1131
- * cardholder.
1102
+ * If the authorization was made in-person with a physical card, the Physical Card
1103
+ * that was used.
1132
1104
  */
1133
- result: 'success' | 'failure';
1134
- }
1105
+ physical_card_id: string | null;
1135
1106
 
1136
- /**
1137
- * If the Real-Time Decision relates to a card authorization attempt, this object
1138
- * contains your response to the authorization.
1139
- */
1140
- export interface CardAuthorization {
1141
1107
  /**
1142
- * Whether the card authorization should be approved or declined.
1143
- *
1144
- * - `approve` - Approve the authorization.
1145
- * - `decline` - Decline the authorization.
1108
+ * The terminal identifier (commonly abbreviated as TID) of the terminal the card
1109
+ * is transacting with.
1146
1110
  */
1147
- decision: 'approve' | 'decline';
1111
+ terminal_id: string | null;
1148
1112
 
1149
1113
  /**
1150
- * If your application approves the authorization, this contains metadata about
1151
- * your decision to approve. Your response here is advisory to the acquiring bank.
1152
- * The bank may choose to reverse the authorization if you approve the transaction
1153
- * but indicate the address does not match.
1114
+ * The identifier of the Card Payment this authorization will belong to. Available
1115
+ * in the API once the card authorization has completed.
1154
1116
  */
1155
- approval?: CardAuthorization.Approval;
1117
+ upcoming_card_payment_id: string;
1156
1118
 
1157
1119
  /**
1158
- * If your application declines the authorization, this contains details about the
1159
- * decline.
1120
+ * Fields related to verification of cardholder-provided values.
1160
1121
  */
1161
- decline?: CardAuthorization.Decline;
1122
+ verification: CardBalanceInquiry.Verification;
1162
1123
 
1163
1124
  [k: string]: unknown;
1164
1125
  }
1165
1126
 
1166
- export namespace CardAuthorization {
1127
+ export namespace CardBalanceInquiry {
1167
1128
  /**
1168
- * If your application approves the authorization, this contains metadata about
1169
- * your decision to approve. Your response here is advisory to the acquiring bank.
1170
- * The bank may choose to reverse the authorization if you approve the transaction
1171
- * but indicate the address does not match.
1129
+ * Additional amounts associated with the card authorization, such as ATM
1130
+ * surcharges fees. These are usually a subset of the `amount` field and are used
1131
+ * to provide more detailed information about the transaction.
1172
1132
  */
1173
- export interface Approval {
1133
+ export interface AdditionalAmounts {
1174
1134
  /**
1175
- * Your decisions on whether or not each provided address component is a match.
1176
- * Your response here is evaluated against the customer's provided `postal_code`
1177
- * and `line1`, and an appropriate network response is generated. For more
1178
- * information, see our
1179
- * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
1180
- * guide.
1135
+ * The part of this transaction amount that was for clinic-related services.
1181
1136
  */
1182
- cardholder_address_verification_result?: Approval.CardholderAddressVerificationResult;
1183
- }
1137
+ clinic: AdditionalAmounts.Clinic | null;
1184
1138
 
1185
- export namespace Approval {
1186
1139
  /**
1187
- * Your decisions on whether or not each provided address component is a match.
1188
- * Your response here is evaluated against the customer's provided `postal_code`
1189
- * and `line1`, and an appropriate network response is generated. For more
1190
- * information, see our
1191
- * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
1192
- * guide.
1140
+ * The part of this transaction amount that was for dental-related services.
1193
1141
  */
1194
- export interface CardholderAddressVerificationResult {
1195
- /**
1196
- * Your decision on the address line of the provided address.
1197
- *
1198
- * - `match` - The cardholder address verification result matches the address
1199
- * provided by the merchant.
1200
- * - `no_match` - The cardholder address verification result does not match the
1201
- * address provided by the merchant.
1202
- */
1203
- line1: 'match' | 'no_match';
1142
+ dental: AdditionalAmounts.Dental | null;
1204
1143
 
1205
- /**
1206
- * Your decision on the postal code of the provided address.
1207
- *
1208
- * - `match` - The cardholder address verification result matches the address
1209
- * provided by the merchant.
1210
- * - `no_match` - The cardholder address verification result does not match the
1211
- * address provided by the merchant.
1212
- */
1144
+ /**
1145
+ * The original pre-authorized amount.
1146
+ */
1147
+ original: AdditionalAmounts.Original | null;
1148
+
1149
+ /**
1150
+ * The part of this transaction amount that was for healthcare prescriptions.
1151
+ */
1152
+ prescription: AdditionalAmounts.Prescription | null;
1153
+
1154
+ /**
1155
+ * The surcharge amount charged for this transaction by the merchant.
1156
+ */
1157
+ surcharge: AdditionalAmounts.Surcharge | null;
1158
+
1159
+ /**
1160
+ * The total amount of a series of incremental authorizations, optionally provided.
1161
+ */
1162
+ total_cumulative: AdditionalAmounts.TotalCumulative | null;
1163
+
1164
+ /**
1165
+ * The total amount of healthcare-related additional amounts.
1166
+ */
1167
+ total_healthcare: AdditionalAmounts.TotalHealthcare | null;
1168
+
1169
+ /**
1170
+ * The part of this transaction amount that was for transit-related services.
1171
+ */
1172
+ transit: AdditionalAmounts.Transit | null;
1173
+
1174
+ /**
1175
+ * An unknown additional amount.
1176
+ */
1177
+ unknown: AdditionalAmounts.Unknown | null;
1178
+
1179
+ /**
1180
+ * The part of this transaction amount that was for vision-related services.
1181
+ */
1182
+ vision: AdditionalAmounts.Vision | null;
1183
+ }
1184
+
1185
+ export namespace AdditionalAmounts {
1186
+ /**
1187
+ * The part of this transaction amount that was for clinic-related services.
1188
+ */
1189
+ export interface Clinic {
1190
+ /**
1191
+ * The amount in minor units of the `currency` field. The amount is positive if it
1192
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1193
+ * subtracted from the amount (such as a discount).
1194
+ */
1195
+ amount: number;
1196
+
1197
+ /**
1198
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1199
+ * amount's currency.
1200
+ */
1201
+ currency: string;
1202
+ }
1203
+
1204
+ /**
1205
+ * The part of this transaction amount that was for dental-related services.
1206
+ */
1207
+ export interface Dental {
1208
+ /**
1209
+ * The amount in minor units of the `currency` field. The amount is positive if it
1210
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1211
+ * subtracted from the amount (such as a discount).
1212
+ */
1213
+ amount: number;
1214
+
1215
+ /**
1216
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1217
+ * amount's currency.
1218
+ */
1219
+ currency: string;
1220
+ }
1221
+
1222
+ /**
1223
+ * The original pre-authorized amount.
1224
+ */
1225
+ export interface Original {
1226
+ /**
1227
+ * The amount in minor units of the `currency` field. The amount is positive if it
1228
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1229
+ * subtracted from the amount (such as a discount).
1230
+ */
1231
+ amount: number;
1232
+
1233
+ /**
1234
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1235
+ * amount's currency.
1236
+ */
1237
+ currency: string;
1238
+ }
1239
+
1240
+ /**
1241
+ * The part of this transaction amount that was for healthcare prescriptions.
1242
+ */
1243
+ export interface Prescription {
1244
+ /**
1245
+ * The amount in minor units of the `currency` field. The amount is positive if it
1246
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1247
+ * subtracted from the amount (such as a discount).
1248
+ */
1249
+ amount: number;
1250
+
1251
+ /**
1252
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1253
+ * amount's currency.
1254
+ */
1255
+ currency: string;
1256
+ }
1257
+
1258
+ /**
1259
+ * The surcharge amount charged for this transaction by the merchant.
1260
+ */
1261
+ export interface Surcharge {
1262
+ /**
1263
+ * The amount in minor units of the `currency` field. The amount is positive if it
1264
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1265
+ * subtracted from the amount (such as a discount).
1266
+ */
1267
+ amount: number;
1268
+
1269
+ /**
1270
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1271
+ * amount's currency.
1272
+ */
1273
+ currency: string;
1274
+ }
1275
+
1276
+ /**
1277
+ * The total amount of a series of incremental authorizations, optionally provided.
1278
+ */
1279
+ export interface TotalCumulative {
1280
+ /**
1281
+ * The amount in minor units of the `currency` field. The amount is positive if it
1282
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1283
+ * subtracted from the amount (such as a discount).
1284
+ */
1285
+ amount: number;
1286
+
1287
+ /**
1288
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1289
+ * amount's currency.
1290
+ */
1291
+ currency: string;
1292
+ }
1293
+
1294
+ /**
1295
+ * The total amount of healthcare-related additional amounts.
1296
+ */
1297
+ export interface TotalHealthcare {
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
+ /**
1306
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1307
+ * amount's currency.
1308
+ */
1309
+ currency: string;
1310
+ }
1311
+
1312
+ /**
1313
+ * The part of this transaction amount that was for transit-related services.
1314
+ */
1315
+ export interface Transit {
1316
+ /**
1317
+ * The amount in minor units of the `currency` field. The amount is positive if it
1318
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1319
+ * subtracted from the amount (such as a discount).
1320
+ */
1321
+ amount: number;
1322
+
1323
+ /**
1324
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1325
+ * amount's currency.
1326
+ */
1327
+ currency: string;
1328
+ }
1329
+
1330
+ /**
1331
+ * An unknown additional amount.
1332
+ */
1333
+ export interface Unknown {
1334
+ /**
1335
+ * The amount in minor units of the `currency` field. The amount is positive if it
1336
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1337
+ * subtracted from the amount (such as a discount).
1338
+ */
1339
+ amount: number;
1340
+
1341
+ /**
1342
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1343
+ * amount's currency.
1344
+ */
1345
+ currency: string;
1346
+ }
1347
+
1348
+ /**
1349
+ * The part of this transaction amount that was for vision-related services.
1350
+ */
1351
+ export interface Vision {
1352
+ /**
1353
+ * The amount in minor units of the `currency` field. The amount is positive if it
1354
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1355
+ * subtracted from the amount (such as a discount).
1356
+ */
1357
+ amount: number;
1358
+
1359
+ /**
1360
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1361
+ * amount's currency.
1362
+ */
1363
+ currency: string;
1364
+ }
1365
+ }
1366
+
1367
+ /**
1368
+ * Present if and only if `decision` is `approve`. Contains information related to
1369
+ * the approval of the balance inquiry.
1370
+ */
1371
+ export interface Approval {
1372
+ /**
1373
+ * If the balance inquiry was approved, this field contains the balance in the
1374
+ * minor unit of the settlement currency.
1375
+ */
1376
+ balance: number;
1377
+ }
1378
+
1379
+ /**
1380
+ * Fields specific to the `network`.
1381
+ */
1382
+ export interface NetworkDetails {
1383
+ /**
1384
+ * The payment network used to process this card authorization.
1385
+ *
1386
+ * - `visa` - Visa
1387
+ * - `pulse` - Pulse
1388
+ */
1389
+ category: 'visa' | 'pulse';
1390
+
1391
+ /**
1392
+ * Fields specific to the `pulse` network.
1393
+ */
1394
+ pulse: NetworkDetails.Pulse | null;
1395
+
1396
+ /**
1397
+ * Fields specific to the `visa` network.
1398
+ */
1399
+ visa: NetworkDetails.Visa | null;
1400
+ }
1401
+
1402
+ export namespace NetworkDetails {
1403
+ /**
1404
+ * Fields specific to the `pulse` network.
1405
+ */
1406
+ export interface Pulse {}
1407
+
1408
+ /**
1409
+ * Fields specific to the `visa` network.
1410
+ */
1411
+ export interface Visa {
1412
+ /**
1413
+ * For electronic commerce transactions, this identifies the level of security used
1414
+ * in obtaining the customer's payment credential. For mail or telephone order
1415
+ * transactions, identifies the type of mail or telephone order.
1416
+ *
1417
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
1418
+ * that the transaction is a mail/phone order purchase, not a recurring
1419
+ * transaction or installment payment. For domestic transactions in the US
1420
+ * region, this value may also indicate one bill payment transaction in the
1421
+ * card-present or card-absent environments.
1422
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
1423
+ * recurring transaction that originates from an acquirer in the US region.
1424
+ * - `installment` - Installment payment: Payment indicator used to indicate one
1425
+ * purchase of goods or services that is billed to the account in multiple
1426
+ * charges over a period of time agreed upon by the cardholder and merchant from
1427
+ * transactions that originate from an acquirer in the US region.
1428
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
1429
+ * indicate that the type of mail/telephone order is unknown.
1430
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
1431
+ * indicate that the electronic commerce transaction has been authenticated using
1432
+ * e.g., 3-D Secure
1433
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
1434
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
1435
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
1436
+ * identify an electronic commerce transaction where the merchant attempted to
1437
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
1438
+ * authentication because the issuer or cardholder does not participate in the
1439
+ * 3-D Secure program.
1440
+ * - `non_authenticated_security_transaction` - Non-authenticated security
1441
+ * transaction: Use to identify an electronic commerce transaction that uses data
1442
+ * encryption for security however, cardholder authentication is not performed
1443
+ * using 3-D Secure.
1444
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
1445
+ * electronic commerce transaction that has no data protection.
1446
+ */
1447
+ electronic_commerce_indicator:
1448
+ | 'mail_phone_order'
1449
+ | 'recurring'
1450
+ | 'installment'
1451
+ | 'unknown_mail_phone_order'
1452
+ | 'secure_electronic_commerce'
1453
+ | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
1454
+ | 'non_authenticated_security_transaction'
1455
+ | 'non_secure_transaction'
1456
+ | null;
1457
+
1458
+ /**
1459
+ * The method used to enter the cardholder's primary account number and card
1460
+ * expiration date.
1461
+ *
1462
+ * - `unknown` - Unknown
1463
+ * - `manual` - Manual key entry
1464
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
1465
+ * value
1466
+ * - `optical_code` - Optical code
1467
+ * - `integrated_circuit_card` - Contact chip card
1468
+ * - `contactless` - Contactless read of chip card
1469
+ * - `credential_on_file` - Transaction initiated using a credential that has
1470
+ * previously been stored on file
1471
+ * - `magnetic_stripe` - Magnetic stripe read
1472
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
1473
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
1474
+ * verification value
1475
+ */
1476
+ point_of_service_entry_mode:
1477
+ | 'unknown'
1478
+ | 'manual'
1479
+ | 'magnetic_stripe_no_cvv'
1480
+ | 'optical_code'
1481
+ | 'integrated_circuit_card'
1482
+ | 'contactless'
1483
+ | 'credential_on_file'
1484
+ | 'magnetic_stripe'
1485
+ | 'contactless_magnetic_stripe'
1486
+ | 'integrated_circuit_card_no_cvv'
1487
+ | null;
1488
+
1489
+ /**
1490
+ * Only present when `actioner: network`. Describes why a card authorization was
1491
+ * approved or declined by Visa through stand-in processing.
1492
+ *
1493
+ * - `issuer_error` - Increase failed to process the authorization in a timely
1494
+ * manner.
1495
+ * - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
1496
+ * authorization request cryptogram.
1497
+ * - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
1498
+ * authentication verification value was invalid.
1499
+ * - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
1500
+ * code for certain expected occurrences as well, such as Application Transaction
1501
+ * Counter (ATC) replays.
1502
+ * - `merchant_transaction_advisory_service_authentication_required` - The merchant
1503
+ * has enabled Visa's Transaction Advisory Service and requires further
1504
+ * authentication to perform the transaction. In practice this is often utilized
1505
+ * at fuel pumps to tell the cardholder to see the cashier.
1506
+ * - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
1507
+ * Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
1508
+ * such as card testing.
1509
+ * - `other` - An unspecific reason for stand-in processing.
1510
+ */
1511
+ stand_in_processing_reason:
1512
+ | 'issuer_error'
1513
+ | 'invalid_physical_card'
1514
+ | 'invalid_cardholder_authentication_verification_value'
1515
+ | 'internal_visa_error'
1516
+ | 'merchant_transaction_advisory_service_authentication_required'
1517
+ | 'payment_fraud_disruption_acquirer_block'
1518
+ | 'other'
1519
+ | null;
1520
+ }
1521
+ }
1522
+
1523
+ /**
1524
+ * Network-specific identifiers for a specific request or transaction.
1525
+ */
1526
+ export interface NetworkIdentifiers {
1527
+ /**
1528
+ * The randomly generated 6-character Authorization Identification Response code
1529
+ * sent back to the acquirer in an approved response.
1530
+ */
1531
+ authorization_identification_response: string | null;
1532
+
1533
+ /**
1534
+ * A life-cycle identifier used across e.g., an authorization and a reversal.
1535
+ * Expected to be unique per acquirer within a window of time. For some card
1536
+ * networks the retrieval reference number includes the trace counter.
1537
+ */
1538
+ retrieval_reference_number: string | null;
1539
+
1540
+ /**
1541
+ * A counter used to verify an individual authorization. Expected to be unique per
1542
+ * acquirer within a window of time.
1543
+ */
1544
+ trace_number: string | null;
1545
+
1546
+ /**
1547
+ * A globally unique transaction identifier provided by the card network, used
1548
+ * across multiple life-cycle requests.
1549
+ */
1550
+ transaction_id: string | null;
1551
+ }
1552
+
1553
+ /**
1554
+ * Fields related to verification of cardholder-provided values.
1555
+ */
1556
+ export interface Verification {
1557
+ /**
1558
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1559
+ * the back of the card.
1560
+ */
1561
+ card_verification_code: Verification.CardVerificationCode;
1562
+
1563
+ /**
1564
+ * Cardholder address provided in the authorization request and the address on file
1565
+ * we verified it against.
1566
+ */
1567
+ cardholder_address: Verification.CardholderAddress;
1568
+ }
1569
+
1570
+ export namespace Verification {
1571
+ /**
1572
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1573
+ * the back of the card.
1574
+ */
1575
+ export interface CardVerificationCode {
1576
+ /**
1577
+ * The result of verifying the Card Verification Code.
1578
+ *
1579
+ * - `not_checked` - No card verification code was provided in the authorization
1580
+ * request.
1581
+ * - `match` - The card verification code matched the one on file.
1582
+ * - `no_match` - The card verification code did not match the one on file.
1583
+ */
1584
+ result: 'not_checked' | 'match' | 'no_match';
1585
+ }
1586
+
1587
+ /**
1588
+ * Cardholder address provided in the authorization request and the address on file
1589
+ * we verified it against.
1590
+ */
1591
+ export interface CardholderAddress {
1592
+ /**
1593
+ * Line 1 of the address on file for the cardholder.
1594
+ */
1595
+ actual_line1: string | null;
1596
+
1597
+ /**
1598
+ * The postal code of the address on file for the cardholder.
1599
+ */
1600
+ actual_postal_code: string | null;
1601
+
1602
+ /**
1603
+ * The cardholder address line 1 provided for verification in the authorization
1604
+ * request.
1605
+ */
1606
+ provided_line1: string | null;
1607
+
1608
+ /**
1609
+ * The postal code provided for verification in the authorization request.
1610
+ */
1611
+ provided_postal_code: string | null;
1612
+
1613
+ /**
1614
+ * The address verification result returned to the card network.
1615
+ *
1616
+ * - `not_checked` - No address information was provided in the authorization
1617
+ * request.
1618
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
1619
+ * address does not match or was not provided.
1620
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
1621
+ * street address matches or was not provided.
1622
+ * - `match` - Postal code and street address match.
1623
+ * - `no_match` - Postal code and street address do not match.
1624
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
1625
+ * address was not verified. (deprecated)
1626
+ */
1627
+ result:
1628
+ | 'not_checked'
1629
+ | 'postal_code_match_address_no_match'
1630
+ | 'postal_code_no_match_address_match'
1631
+ | 'match'
1632
+ | 'no_match'
1633
+ | 'postal_code_match_address_not_checked';
1634
+ }
1635
+ }
1636
+ }
1637
+
1638
+ /**
1639
+ * Fields related to a digital wallet authentication attempt.
1640
+ */
1641
+ export interface DigitalWalletAuthentication {
1642
+ /**
1643
+ * The identifier of the Card that is being tokenized.
1644
+ */
1645
+ card_id: string;
1646
+
1647
+ /**
1648
+ * The channel to send the card user their one-time passcode.
1649
+ *
1650
+ * - `sms` - Send one-time passcodes over SMS.
1651
+ * - `email` - Send one-time passcodes over email.
1652
+ */
1653
+ channel: 'sms' | 'email';
1654
+
1655
+ /**
1656
+ * The digital wallet app being used.
1657
+ *
1658
+ * - `apple_pay` - Apple Pay
1659
+ * - `google_pay` - Google Pay
1660
+ * - `samsung_pay` - Samsung Pay
1661
+ * - `unknown` - Unknown
1662
+ */
1663
+ digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
1664
+
1665
+ /**
1666
+ * The email to send the one-time passcode to if `channel` is equal to `email`.
1667
+ */
1668
+ email: string | null;
1669
+
1670
+ /**
1671
+ * The one-time passcode to send the card user.
1672
+ */
1673
+ one_time_passcode: string;
1674
+
1675
+ /**
1676
+ * The phone number to send the one-time passcode to if `channel` is equal to
1677
+ * `sms`.
1678
+ */
1679
+ phone: string | null;
1680
+
1681
+ /**
1682
+ * Whether your application successfully delivered the one-time passcode.
1683
+ *
1684
+ * - `success` - Your application successfully delivered the one-time passcode to
1685
+ * the cardholder.
1686
+ * - `failure` - Your application failed to deliver the one-time passcode to the
1687
+ * cardholder.
1688
+ */
1689
+ result: 'success' | 'failure' | null;
1690
+ }
1691
+
1692
+ /**
1693
+ * Fields related to a digital wallet token provisioning attempt.
1694
+ */
1695
+ export interface DigitalWalletToken {
1696
+ /**
1697
+ * The identifier of the Card that is being tokenized.
1698
+ */
1699
+ card_id: string;
1700
+
1701
+ /**
1702
+ * Whether or not the provisioning request was approved. This will be null until
1703
+ * the real time decision is responded to.
1704
+ *
1705
+ * - `approve` - Approve the provisioning request.
1706
+ * - `decline` - Decline the provisioning request.
1707
+ */
1708
+ decision: 'approve' | 'decline' | null;
1709
+
1710
+ /**
1711
+ * Device that is being used to provision the digital wallet token.
1712
+ */
1713
+ device: DigitalWalletToken.Device;
1714
+
1715
+ /**
1716
+ * The digital wallet app being used.
1717
+ *
1718
+ * - `apple_pay` - Apple Pay
1719
+ * - `google_pay` - Google Pay
1720
+ * - `samsung_pay` - Samsung Pay
1721
+ * - `unknown` - Unknown
1722
+ */
1723
+ digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
1724
+ }
1725
+
1726
+ export namespace DigitalWalletToken {
1727
+ /**
1728
+ * Device that is being used to provision the digital wallet token.
1729
+ */
1730
+ export interface Device {
1731
+ /**
1732
+ * ID assigned to the device by the digital wallet provider.
1733
+ */
1734
+ identifier: string | null;
1735
+ }
1736
+ }
1737
+ }
1738
+
1739
+ export interface RealTimeDecisionActionParams {
1740
+ /**
1741
+ * If the Real-Time Decision relates to a 3DS card authentication attempt, this
1742
+ * object contains your response to the authentication.
1743
+ */
1744
+ card_authentication?: RealTimeDecisionActionParams.CardAuthentication;
1745
+
1746
+ /**
1747
+ * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
1748
+ * this object contains your response.
1749
+ */
1750
+ card_authentication_challenge?: RealTimeDecisionActionParams.CardAuthenticationChallenge;
1751
+
1752
+ /**
1753
+ * If the Real-Time Decision relates to a card authorization attempt, this object
1754
+ * contains your response to the authorization.
1755
+ */
1756
+ card_authorization?: RealTimeDecisionActionParams.CardAuthorization;
1757
+
1758
+ /**
1759
+ * If the Real-Time Decision relates to a card balance inquiry attempt, this object
1760
+ * contains your response to the inquiry.
1761
+ */
1762
+ card_balance_inquiry?: RealTimeDecisionActionParams.CardBalanceInquiry;
1763
+
1764
+ /**
1765
+ * If the Real-Time Decision relates to a digital wallet authentication attempt,
1766
+ * this object contains your response to the authentication.
1767
+ */
1768
+ digital_wallet_authentication?: RealTimeDecisionActionParams.DigitalWalletAuthentication;
1769
+
1770
+ /**
1771
+ * If the Real-Time Decision relates to a digital wallet token provisioning
1772
+ * attempt, this object contains your response to the attempt.
1773
+ */
1774
+ digital_wallet_token?: RealTimeDecisionActionParams.DigitalWalletToken;
1775
+ }
1776
+
1777
+ export namespace RealTimeDecisionActionParams {
1778
+ /**
1779
+ * If the Real-Time Decision relates to a 3DS card authentication attempt, this
1780
+ * object contains your response to the authentication.
1781
+ */
1782
+ export interface CardAuthentication {
1783
+ /**
1784
+ * Whether the card authentication attempt should be approved or declined.
1785
+ *
1786
+ * - `approve` - Approve the authentication attempt without triggering a challenge.
1787
+ * - `challenge` - Request further validation before approving the authentication
1788
+ * attempt.
1789
+ * - `deny` - Deny the authentication attempt.
1790
+ */
1791
+ decision: 'approve' | 'challenge' | 'deny';
1792
+ }
1793
+
1794
+ /**
1795
+ * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
1796
+ * this object contains your response.
1797
+ */
1798
+ export interface CardAuthenticationChallenge {
1799
+ /**
1800
+ * Whether the card authentication challenge was successfully delivered to the
1801
+ * cardholder.
1802
+ *
1803
+ * - `success` - Your application successfully delivered the one-time code to the
1804
+ * cardholder.
1805
+ * - `failure` - Your application was unable to deliver the one-time code to the
1806
+ * cardholder.
1807
+ */
1808
+ result: 'success' | 'failure';
1809
+ }
1810
+
1811
+ /**
1812
+ * If the Real-Time Decision relates to a card authorization attempt, this object
1813
+ * contains your response to the authorization.
1814
+ */
1815
+ export interface CardAuthorization {
1816
+ /**
1817
+ * Whether the card authorization should be approved or declined.
1818
+ *
1819
+ * - `approve` - Approve the authorization.
1820
+ * - `decline` - Decline the authorization.
1821
+ */
1822
+ decision: 'approve' | 'decline';
1823
+
1824
+ /**
1825
+ * If your application approves the authorization, this contains metadata about
1826
+ * your decision to approve. Your response here is advisory to the acquiring bank.
1827
+ * The bank may choose to reverse the authorization if you approve the transaction
1828
+ * but indicate the address does not match.
1829
+ */
1830
+ approval?: CardAuthorization.Approval;
1831
+
1832
+ /**
1833
+ * If your application declines the authorization, this contains details about the
1834
+ * decline.
1835
+ */
1836
+ decline?: CardAuthorization.Decline;
1837
+
1838
+ [k: string]: unknown;
1839
+ }
1840
+
1841
+ export namespace CardAuthorization {
1842
+ /**
1843
+ * If your application approves the authorization, this contains metadata about
1844
+ * your decision to approve. Your response here is advisory to the acquiring bank.
1845
+ * The bank may choose to reverse the authorization if you approve the transaction
1846
+ * but indicate the address does not match.
1847
+ */
1848
+ export interface Approval {
1849
+ /**
1850
+ * Your decisions on whether or not each provided address component is a match.
1851
+ * Your response here is evaluated against the customer's provided `postal_code`
1852
+ * and `line1`, and an appropriate network response is generated. For more
1853
+ * information, see our
1854
+ * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
1855
+ * guide.
1856
+ */
1857
+ cardholder_address_verification_result?: Approval.CardholderAddressVerificationResult;
1858
+
1859
+ /**
1860
+ * If the transaction supports partial approvals
1861
+ * (`partial_approval_capability: supported`) the `partial_amount` can be provided
1862
+ * in the transaction's settlement currency to approve a lower amount than was
1863
+ * requested.
1864
+ */
1865
+ partial_amount?: number;
1866
+ }
1867
+
1868
+ export namespace Approval {
1869
+ /**
1870
+ * Your decisions on whether or not each provided address component is a match.
1871
+ * Your response here is evaluated against the customer's provided `postal_code`
1872
+ * and `line1`, and an appropriate network response is generated. For more
1873
+ * information, see our
1874
+ * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
1875
+ * guide.
1876
+ */
1877
+ export interface CardholderAddressVerificationResult {
1878
+ /**
1879
+ * Your decision on the address line of the provided address.
1880
+ *
1881
+ * - `match` - The cardholder address verification result matches the address
1882
+ * provided by the merchant.
1883
+ * - `no_match` - The cardholder address verification result does not match the
1884
+ * address provided by the merchant.
1885
+ */
1886
+ line1: 'match' | 'no_match';
1887
+
1888
+ /**
1889
+ * Your decision on the postal code of the provided address.
1890
+ *
1891
+ * - `match` - The cardholder address verification result matches the address
1892
+ * provided by the merchant.
1893
+ * - `no_match` - The cardholder address verification result does not match the
1894
+ * address provided by the merchant.
1895
+ */
1213
1896
  postal_code: 'match' | 'no_match';
1214
1897
  }
1215
1898
  }
@@ -1246,6 +1929,39 @@ export namespace RealTimeDecisionActionParams {
1246
1929
  }
1247
1930
  }
1248
1931
 
1932
+ /**
1933
+ * If the Real-Time Decision relates to a card balance inquiry attempt, this object
1934
+ * contains your response to the inquiry.
1935
+ */
1936
+ export interface CardBalanceInquiry {
1937
+ /**
1938
+ * Whether the card balance inquiry should be approved or declined.
1939
+ *
1940
+ * - `approve` - Approve the authorization.
1941
+ * - `decline` - Decline the authorization.
1942
+ */
1943
+ decision: 'approve' | 'decline';
1944
+
1945
+ /**
1946
+ * If your application approves the balance inquiry, this contains metadata about
1947
+ * your decision to approve.
1948
+ */
1949
+ approval?: CardBalanceInquiry.Approval;
1950
+ }
1951
+
1952
+ export namespace CardBalanceInquiry {
1953
+ /**
1954
+ * If your application approves the balance inquiry, this contains metadata about
1955
+ * your decision to approve.
1956
+ */
1957
+ export interface Approval {
1958
+ /**
1959
+ * The balance on the card in the settlement currency of the transaction.
1960
+ */
1961
+ balance: number;
1962
+ }
1963
+ }
1964
+
1249
1965
  /**
1250
1966
  * If the Real-Time Decision relates to a digital wallet authentication attempt,
1251
1967
  * this object contains your response to the authentication.