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
@@ -50,10 +50,15 @@ export interface RealTimeDecision {
50
50
  * Fields related to a card authorization.
51
51
  */
52
52
  card_authorization: RealTimeDecision.CardAuthorization | null;
53
+ /**
54
+ * Fields related to a card balance inquiry.
55
+ */
56
+ card_balance_inquiry: RealTimeDecision.CardBalanceInquiry | null;
53
57
  /**
54
58
  * The category of the Real-Time Decision.
55
59
  *
56
60
  * - `card_authorization_requested` - A card is being authorized.
61
+ * - `card_balance_inquiry_requested` - A balance inquiry is being made on a card.
57
62
  * - `card_authentication_requested` - 3DS authentication is requested.
58
63
  * - `card_authentication_challenge_requested` - 3DS authentication challenge
59
64
  * requires cardholder involvement.
@@ -62,7 +67,7 @@ export interface RealTimeDecision {
62
67
  * - `digital_wallet_authentication_requested` - A card is being loaded into a
63
68
  * digital wallet and requires cardholder authentication.
64
69
  */
65
- category: 'card_authorization_requested' | 'card_authentication_requested' | 'card_authentication_challenge_requested' | 'digital_wallet_token_requested' | 'digital_wallet_authentication_requested';
70
+ category: 'card_authorization_requested' | 'card_balance_inquiry_requested' | 'card_authentication_requested' | 'card_authentication_challenge_requested' | 'digital_wallet_token_requested' | 'digital_wallet_authentication_requested';
66
71
  /**
67
72
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
68
73
  * the Real-Time Decision was created.
@@ -168,6 +173,11 @@ export declare namespace RealTimeDecision {
168
173
  * to provide more detailed information about the transaction.
169
174
  */
170
175
  additional_amounts: CardAuthorization.AdditionalAmounts;
176
+ /**
177
+ * Present if and only if `decision` is `approve`. Contains information related to
178
+ * the approval of the authorization.
179
+ */
180
+ approval: CardAuthorization.Approval | null;
171
181
  /**
172
182
  * The identifier of the Card that is being authorized.
173
183
  */
@@ -244,6 +254,13 @@ export declare namespace RealTimeDecision {
244
254
  * score is from 0 to 999, where 999 is the riskiest.
245
255
  */
246
256
  network_risk_score: number | null;
257
+ /**
258
+ * Whether or not the authorization supports partial approvals.
259
+ *
260
+ * - `supported` - This transaction supports partial approvals.
261
+ * - `not_supported` - This transaction does not support partial approvals.
262
+ */
263
+ partial_approval_capability: 'supported' | 'not_supported';
247
264
  /**
248
265
  * If the authorization was made in-person with a physical card, the Physical Card
249
266
  * that was used.
@@ -280,9 +297,11 @@ export declare namespace RealTimeDecision {
280
297
  * voucher authorization, where funds are credited to the cardholder.
281
298
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
282
299
  * from an ATM or a point of sale.
300
+ * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
301
+ * of an account associated with a card.
283
302
  * - `unknown` - The processing category is unknown.
284
303
  */
285
- processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
304
+ processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'balance_inquiry' | 'unknown';
286
305
  /**
287
306
  * Fields specific to the type of request, such as an incremental authorization.
288
307
  */
@@ -523,6 +542,17 @@ export declare namespace RealTimeDecision {
523
542
  currency: string;
524
543
  }
525
544
  }
545
+ /**
546
+ * Present if and only if `decision` is `approve`. Contains information related to
547
+ * the approval of the authorization.
548
+ */
549
+ interface Approval {
550
+ /**
551
+ * If the authorization was partially approved, this field contains the approved
552
+ * amount in the minor unit of the settlement currency.
553
+ */
554
+ partial_amount: number | null;
555
+ }
526
556
  /**
527
557
  * Present if and only if `decision` is `decline`. Contains information related to
528
558
  * the reason the authorization was declined.
@@ -797,235 +827,776 @@ export declare namespace RealTimeDecision {
797
827
  }
798
828
  }
799
829
  /**
800
- * Fields related to a digital wallet authentication attempt.
830
+ * Fields related to a card balance inquiry.
801
831
  */
802
- interface DigitalWalletAuthentication {
832
+ interface CardBalanceInquiry {
803
833
  /**
804
- * The identifier of the Card that is being tokenized.
834
+ * The identifier of the Account the authorization will debit.
835
+ */
836
+ account_id: string;
837
+ /**
838
+ * Additional amounts associated with the card authorization, such as ATM
839
+ * surcharges fees. These are usually a subset of the `amount` field and are used
840
+ * to provide more detailed information about the transaction.
841
+ */
842
+ additional_amounts: CardBalanceInquiry.AdditionalAmounts;
843
+ /**
844
+ * Present if and only if `decision` is `approve`. Contains information related to
845
+ * the approval of the balance inquiry.
846
+ */
847
+ approval: CardBalanceInquiry.Approval | null;
848
+ /**
849
+ * The identifier of the Card that is being authorized.
805
850
  */
806
851
  card_id: string;
807
852
  /**
808
- * The channel to send the card user their one-time passcode.
853
+ * Whether or not the authorization was approved.
809
854
  *
810
- * - `sms` - Send one-time passcodes over SMS.
811
- * - `email` - Send one-time passcodes over email.
855
+ * - `approve` - Approve the authorization.
856
+ * - `decline` - Decline the authorization.
812
857
  */
813
- channel: 'sms' | 'email';
858
+ decision: 'approve' | 'decline' | null;
814
859
  /**
815
- * The digital wallet app being used.
816
- *
817
- * - `apple_pay` - Apple Pay
818
- * - `google_pay` - Google Pay
819
- * - `samsung_pay` - Samsung Pay
820
- * - `unknown` - Unknown
860
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
861
+ * purchase), the identifier of the token that was used.
821
862
  */
822
- digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
863
+ digital_wallet_token_id: string | null;
823
864
  /**
824
- * The email to send the one-time passcode to if `channel` is equal to `email`.
865
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
866
+ * is transacting with.
825
867
  */
826
- email: string | null;
868
+ merchant_acceptor_id: string;
827
869
  /**
828
- * The one-time passcode to send the card user.
870
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
871
+ * card is transacting with.
829
872
  */
830
- one_time_passcode: string;
873
+ merchant_category_code: string;
831
874
  /**
832
- * The phone number to send the one-time passcode to if `channel` is equal to
833
- * `sms`.
875
+ * The city the merchant resides in.
834
876
  */
835
- phone: string | null;
877
+ merchant_city: string | null;
836
878
  /**
837
- * Whether your application successfully delivered the one-time passcode.
838
- *
839
- * - `success` - Your application successfully delivered the one-time passcode to
840
- * the cardholder.
841
- * - `failure` - Your application failed to deliver the one-time passcode to the
842
- * cardholder.
879
+ * The country the merchant resides in.
843
880
  */
844
- result: 'success' | 'failure' | null;
845
- }
846
- /**
847
- * Fields related to a digital wallet token provisioning attempt.
848
- */
849
- interface DigitalWalletToken {
881
+ merchant_country: string;
850
882
  /**
851
- * The identifier of the Card that is being tokenized.
883
+ * The merchant descriptor of the merchant the card is transacting with.
852
884
  */
853
- card_id: string;
885
+ merchant_descriptor: string;
854
886
  /**
855
- * Whether or not the provisioning request was approved. This will be null until
856
- * the real time decision is responded to.
857
- *
858
- * - `approve` - Approve the provisioning request.
859
- * - `decline` - Decline the provisioning request.
887
+ * The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
888
+ * ZIP code, where the first 5 and last 4 are separated by a dash.
860
889
  */
861
- decision: 'approve' | 'decline' | null;
890
+ merchant_postal_code: string | null;
862
891
  /**
863
- * Device that is being used to provision the digital wallet token.
892
+ * The state the merchant resides in.
864
893
  */
865
- device: DigitalWalletToken.Device;
894
+ merchant_state: string | null;
866
895
  /**
867
- * The digital wallet app being used.
868
- *
869
- * - `apple_pay` - Apple Pay
870
- * - `google_pay` - Google Pay
871
- * - `samsung_pay` - Samsung Pay
872
- * - `unknown` - Unknown
896
+ * Fields specific to the `network`.
873
897
  */
874
- digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
875
- }
876
- namespace DigitalWalletToken {
898
+ network_details: CardBalanceInquiry.NetworkDetails;
877
899
  /**
878
- * Device that is being used to provision the digital wallet token.
900
+ * Network-specific identifiers for a specific request or transaction.
879
901
  */
880
- interface Device {
881
- /**
882
- * ID assigned to the device by the digital wallet provider.
883
- */
884
- identifier: string | null;
885
- }
886
- }
887
- }
888
- export interface RealTimeDecisionActionParams {
889
- /**
890
- * If the Real-Time Decision relates to a 3DS card authentication attempt, this
891
- * object contains your response to the authentication.
892
- */
893
- card_authentication?: RealTimeDecisionActionParams.CardAuthentication;
894
- /**
895
- * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
896
- * this object contains your response.
897
- */
898
- card_authentication_challenge?: RealTimeDecisionActionParams.CardAuthenticationChallenge;
899
- /**
900
- * If the Real-Time Decision relates to a card authorization attempt, this object
901
- * contains your response to the authorization.
902
- */
903
- card_authorization?: RealTimeDecisionActionParams.CardAuthorization;
904
- /**
905
- * If the Real-Time Decision relates to a digital wallet authentication attempt,
906
- * this object contains your response to the authentication.
907
- */
908
- digital_wallet_authentication?: RealTimeDecisionActionParams.DigitalWalletAuthentication;
909
- /**
910
- * If the Real-Time Decision relates to a digital wallet token provisioning
911
- * attempt, this object contains your response to the attempt.
912
- */
913
- digital_wallet_token?: RealTimeDecisionActionParams.DigitalWalletToken;
914
- }
915
- export declare namespace RealTimeDecisionActionParams {
916
- /**
917
- * If the Real-Time Decision relates to a 3DS card authentication attempt, this
918
- * object contains your response to the authentication.
919
- */
920
- interface CardAuthentication {
902
+ network_identifiers: CardBalanceInquiry.NetworkIdentifiers;
921
903
  /**
922
- * Whether the card authentication attempt should be approved or declined.
923
- *
924
- * - `approve` - Approve the authentication attempt without triggering a challenge.
925
- * - `challenge` - Request further validation before approving the authentication
926
- * attempt.
927
- * - `deny` - Deny the authentication attempt.
904
+ * The risk score generated by the card network. For Visa this is the Visa Advanced
905
+ * Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
906
+ * score is from 0 to 999, where 999 is the riskiest.
928
907
  */
929
- decision: 'approve' | 'challenge' | 'deny';
930
- }
931
- /**
932
- * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
933
- * this object contains your response.
934
- */
935
- interface CardAuthenticationChallenge {
908
+ network_risk_score: number | null;
936
909
  /**
937
- * Whether the card authentication challenge was successfully delivered to the
938
- * cardholder.
939
- *
940
- * - `success` - Your application successfully delivered the one-time code to the
941
- * cardholder.
942
- * - `failure` - Your application was unable to deliver the one-time code to the
943
- * cardholder.
910
+ * If the authorization was made in-person with a physical card, the Physical Card
911
+ * that was used.
944
912
  */
945
- result: 'success' | 'failure';
946
- }
947
- /**
948
- * If the Real-Time Decision relates to a card authorization attempt, this object
949
- * contains your response to the authorization.
950
- */
951
- interface CardAuthorization {
913
+ physical_card_id: string | null;
952
914
  /**
953
- * Whether the card authorization should be approved or declined.
954
- *
955
- * - `approve` - Approve the authorization.
956
- * - `decline` - Decline the authorization.
915
+ * The terminal identifier (commonly abbreviated as TID) of the terminal the card
916
+ * is transacting with.
957
917
  */
958
- decision: 'approve' | 'decline';
918
+ terminal_id: string | null;
959
919
  /**
960
- * If your application approves the authorization, this contains metadata about
961
- * your decision to approve. Your response here is advisory to the acquiring bank.
962
- * The bank may choose to reverse the authorization if you approve the transaction
963
- * but indicate the address does not match.
920
+ * The identifier of the Card Payment this authorization will belong to. Available
921
+ * in the API once the card authorization has completed.
964
922
  */
965
- approval?: CardAuthorization.Approval;
923
+ upcoming_card_payment_id: string;
966
924
  /**
967
- * If your application declines the authorization, this contains details about the
968
- * decline.
925
+ * Fields related to verification of cardholder-provided values.
969
926
  */
970
- decline?: CardAuthorization.Decline;
927
+ verification: CardBalanceInquiry.Verification;
971
928
  [k: string]: unknown;
972
929
  }
973
- namespace CardAuthorization {
930
+ namespace CardBalanceInquiry {
974
931
  /**
975
- * If your application approves the authorization, this contains metadata about
976
- * your decision to approve. Your response here is advisory to the acquiring bank.
977
- * The bank may choose to reverse the authorization if you approve the transaction
978
- * but indicate the address does not match.
932
+ * Additional amounts associated with the card authorization, such as ATM
933
+ * surcharges fees. These are usually a subset of the `amount` field and are used
934
+ * to provide more detailed information about the transaction.
979
935
  */
980
- interface Approval {
936
+ interface AdditionalAmounts {
981
937
  /**
982
- * Your decisions on whether or not each provided address component is a match.
983
- * Your response here is evaluated against the customer's provided `postal_code`
984
- * and `line1`, and an appropriate network response is generated. For more
985
- * information, see our
986
- * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
987
- * guide.
938
+ * The part of this transaction amount that was for clinic-related services.
988
939
  */
989
- cardholder_address_verification_result?: Approval.CardholderAddressVerificationResult;
990
- }
991
- namespace Approval {
940
+ clinic: AdditionalAmounts.Clinic | null;
992
941
  /**
993
- * Your decisions on whether or not each provided address component is a match.
994
- * Your response here is evaluated against the customer's provided `postal_code`
995
- * and `line1`, and an appropriate network response is generated. For more
996
- * information, see our
997
- * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
998
- * guide.
942
+ * The part of this transaction amount that was for dental-related services.
999
943
  */
1000
- interface CardholderAddressVerificationResult {
1001
- /**
1002
- * Your decision on the address line of the provided address.
1003
- *
1004
- * - `match` - The cardholder address verification result matches the address
1005
- * provided by the merchant.
1006
- * - `no_match` - The cardholder address verification result does not match the
1007
- * address provided by the merchant.
1008
- */
1009
- line1: 'match' | 'no_match';
1010
- /**
1011
- * Your decision on the postal code of the provided address.
1012
- *
1013
- * - `match` - The cardholder address verification result matches the address
1014
- * provided by the merchant.
1015
- * - `no_match` - The cardholder address verification result does not match the
1016
- * address provided by the merchant.
1017
- */
1018
- postal_code: 'match' | 'no_match';
1019
- }
1020
- }
1021
- /**
1022
- * If your application declines the authorization, this contains details about the
1023
- * decline.
1024
- */
1025
- interface Decline {
944
+ dental: AdditionalAmounts.Dental | null;
1026
945
  /**
1027
- * The reason the card authorization was declined. This translates to a specific
1028
- * decline code that is sent to the card network.
946
+ * The original pre-authorized amount.
947
+ */
948
+ original: AdditionalAmounts.Original | null;
949
+ /**
950
+ * The part of this transaction amount that was for healthcare prescriptions.
951
+ */
952
+ prescription: AdditionalAmounts.Prescription | null;
953
+ /**
954
+ * The surcharge amount charged for this transaction by the merchant.
955
+ */
956
+ surcharge: AdditionalAmounts.Surcharge | null;
957
+ /**
958
+ * The total amount of a series of incremental authorizations, optionally provided.
959
+ */
960
+ total_cumulative: AdditionalAmounts.TotalCumulative | null;
961
+ /**
962
+ * The total amount of healthcare-related additional amounts.
963
+ */
964
+ total_healthcare: AdditionalAmounts.TotalHealthcare | null;
965
+ /**
966
+ * The part of this transaction amount that was for transit-related services.
967
+ */
968
+ transit: AdditionalAmounts.Transit | null;
969
+ /**
970
+ * An unknown additional amount.
971
+ */
972
+ unknown: AdditionalAmounts.Unknown | null;
973
+ /**
974
+ * The part of this transaction amount that was for vision-related services.
975
+ */
976
+ vision: AdditionalAmounts.Vision | null;
977
+ }
978
+ namespace AdditionalAmounts {
979
+ /**
980
+ * The part of this transaction amount that was for clinic-related services.
981
+ */
982
+ interface Clinic {
983
+ /**
984
+ * The amount in minor units of the `currency` field. The amount is positive if it
985
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
986
+ * subtracted from the amount (such as a discount).
987
+ */
988
+ amount: number;
989
+ /**
990
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
991
+ * amount's currency.
992
+ */
993
+ currency: string;
994
+ }
995
+ /**
996
+ * The part of this transaction amount that was for dental-related services.
997
+ */
998
+ interface Dental {
999
+ /**
1000
+ * The amount in minor units of the `currency` field. The amount is positive if it
1001
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1002
+ * subtracted from the amount (such as a discount).
1003
+ */
1004
+ amount: number;
1005
+ /**
1006
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1007
+ * amount's currency.
1008
+ */
1009
+ currency: string;
1010
+ }
1011
+ /**
1012
+ * The original pre-authorized amount.
1013
+ */
1014
+ interface Original {
1015
+ /**
1016
+ * The amount in minor units of the `currency` field. The amount is positive if it
1017
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1018
+ * subtracted from the amount (such as a discount).
1019
+ */
1020
+ amount: number;
1021
+ /**
1022
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1023
+ * amount's currency.
1024
+ */
1025
+ currency: string;
1026
+ }
1027
+ /**
1028
+ * The part of this transaction amount that was for healthcare prescriptions.
1029
+ */
1030
+ interface Prescription {
1031
+ /**
1032
+ * The amount in minor units of the `currency` field. The amount is positive if it
1033
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1034
+ * subtracted from the amount (such as a discount).
1035
+ */
1036
+ amount: number;
1037
+ /**
1038
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1039
+ * amount's currency.
1040
+ */
1041
+ currency: string;
1042
+ }
1043
+ /**
1044
+ * The surcharge amount charged for this transaction by the merchant.
1045
+ */
1046
+ interface Surcharge {
1047
+ /**
1048
+ * The amount in minor units of the `currency` field. The amount is positive if it
1049
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1050
+ * subtracted from the amount (such as a discount).
1051
+ */
1052
+ amount: number;
1053
+ /**
1054
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1055
+ * amount's currency.
1056
+ */
1057
+ currency: string;
1058
+ }
1059
+ /**
1060
+ * The total amount of a series of incremental authorizations, optionally provided.
1061
+ */
1062
+ interface TotalCumulative {
1063
+ /**
1064
+ * The amount in minor units of the `currency` field. The amount is positive if it
1065
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1066
+ * subtracted from the amount (such as a discount).
1067
+ */
1068
+ amount: number;
1069
+ /**
1070
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1071
+ * amount's currency.
1072
+ */
1073
+ currency: string;
1074
+ }
1075
+ /**
1076
+ * The total amount of healthcare-related additional amounts.
1077
+ */
1078
+ interface TotalHealthcare {
1079
+ /**
1080
+ * The amount in minor units of the `currency` field. The amount is positive if it
1081
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1082
+ * subtracted from the amount (such as a discount).
1083
+ */
1084
+ amount: number;
1085
+ /**
1086
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1087
+ * amount's currency.
1088
+ */
1089
+ currency: string;
1090
+ }
1091
+ /**
1092
+ * The part of this transaction amount that was for transit-related services.
1093
+ */
1094
+ interface Transit {
1095
+ /**
1096
+ * The amount in minor units of the `currency` field. The amount is positive if it
1097
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1098
+ * subtracted from the amount (such as a discount).
1099
+ */
1100
+ amount: number;
1101
+ /**
1102
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1103
+ * amount's currency.
1104
+ */
1105
+ currency: string;
1106
+ }
1107
+ /**
1108
+ * An unknown additional amount.
1109
+ */
1110
+ interface Unknown {
1111
+ /**
1112
+ * The amount in minor units of the `currency` field. The amount is positive if it
1113
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1114
+ * subtracted from the amount (such as a discount).
1115
+ */
1116
+ amount: number;
1117
+ /**
1118
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1119
+ * amount's currency.
1120
+ */
1121
+ currency: string;
1122
+ }
1123
+ /**
1124
+ * The part of this transaction amount that was for vision-related services.
1125
+ */
1126
+ interface Vision {
1127
+ /**
1128
+ * The amount in minor units of the `currency` field. The amount is positive if it
1129
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1130
+ * subtracted from the amount (such as a discount).
1131
+ */
1132
+ amount: number;
1133
+ /**
1134
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1135
+ * amount's currency.
1136
+ */
1137
+ currency: string;
1138
+ }
1139
+ }
1140
+ /**
1141
+ * Present if and only if `decision` is `approve`. Contains information related to
1142
+ * the approval of the balance inquiry.
1143
+ */
1144
+ interface Approval {
1145
+ /**
1146
+ * If the balance inquiry was approved, this field contains the balance in the
1147
+ * minor unit of the settlement currency.
1148
+ */
1149
+ balance: number;
1150
+ }
1151
+ /**
1152
+ * Fields specific to the `network`.
1153
+ */
1154
+ interface NetworkDetails {
1155
+ /**
1156
+ * The payment network used to process this card authorization.
1157
+ *
1158
+ * - `visa` - Visa
1159
+ * - `pulse` - Pulse
1160
+ */
1161
+ category: 'visa' | 'pulse';
1162
+ /**
1163
+ * Fields specific to the `pulse` network.
1164
+ */
1165
+ pulse: NetworkDetails.Pulse | null;
1166
+ /**
1167
+ * Fields specific to the `visa` network.
1168
+ */
1169
+ visa: NetworkDetails.Visa | null;
1170
+ }
1171
+ namespace NetworkDetails {
1172
+ /**
1173
+ * Fields specific to the `pulse` network.
1174
+ */
1175
+ interface Pulse {
1176
+ }
1177
+ /**
1178
+ * Fields specific to the `visa` network.
1179
+ */
1180
+ interface Visa {
1181
+ /**
1182
+ * For electronic commerce transactions, this identifies the level of security used
1183
+ * in obtaining the customer's payment credential. For mail or telephone order
1184
+ * transactions, identifies the type of mail or telephone order.
1185
+ *
1186
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
1187
+ * that the transaction is a mail/phone order purchase, not a recurring
1188
+ * transaction or installment payment. For domestic transactions in the US
1189
+ * region, this value may also indicate one bill payment transaction in the
1190
+ * card-present or card-absent environments.
1191
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
1192
+ * recurring transaction that originates from an acquirer in the US region.
1193
+ * - `installment` - Installment payment: Payment indicator used to indicate one
1194
+ * purchase of goods or services that is billed to the account in multiple
1195
+ * charges over a period of time agreed upon by the cardholder and merchant from
1196
+ * transactions that originate from an acquirer in the US region.
1197
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
1198
+ * indicate that the type of mail/telephone order is unknown.
1199
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
1200
+ * indicate that the electronic commerce transaction has been authenticated using
1201
+ * e.g., 3-D Secure
1202
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
1203
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
1204
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
1205
+ * identify an electronic commerce transaction where the merchant attempted to
1206
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
1207
+ * authentication because the issuer or cardholder does not participate in the
1208
+ * 3-D Secure program.
1209
+ * - `non_authenticated_security_transaction` - Non-authenticated security
1210
+ * transaction: Use to identify an electronic commerce transaction that uses data
1211
+ * encryption for security however, cardholder authentication is not performed
1212
+ * using 3-D Secure.
1213
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
1214
+ * electronic commerce transaction that has no data protection.
1215
+ */
1216
+ 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;
1217
+ /**
1218
+ * The method used to enter the cardholder's primary account number and card
1219
+ * expiration date.
1220
+ *
1221
+ * - `unknown` - Unknown
1222
+ * - `manual` - Manual key entry
1223
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
1224
+ * value
1225
+ * - `optical_code` - Optical code
1226
+ * - `integrated_circuit_card` - Contact chip card
1227
+ * - `contactless` - Contactless read of chip card
1228
+ * - `credential_on_file` - Transaction initiated using a credential that has
1229
+ * previously been stored on file
1230
+ * - `magnetic_stripe` - Magnetic stripe read
1231
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
1232
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
1233
+ * verification value
1234
+ */
1235
+ 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;
1236
+ /**
1237
+ * Only present when `actioner: network`. Describes why a card authorization was
1238
+ * approved or declined by Visa through stand-in processing.
1239
+ *
1240
+ * - `issuer_error` - Increase failed to process the authorization in a timely
1241
+ * manner.
1242
+ * - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
1243
+ * authorization request cryptogram.
1244
+ * - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
1245
+ * authentication verification value was invalid.
1246
+ * - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
1247
+ * code for certain expected occurrences as well, such as Application Transaction
1248
+ * Counter (ATC) replays.
1249
+ * - `merchant_transaction_advisory_service_authentication_required` - The merchant
1250
+ * has enabled Visa's Transaction Advisory Service and requires further
1251
+ * authentication to perform the transaction. In practice this is often utilized
1252
+ * at fuel pumps to tell the cardholder to see the cashier.
1253
+ * - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
1254
+ * Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
1255
+ * such as card testing.
1256
+ * - `other` - An unspecific reason for stand-in processing.
1257
+ */
1258
+ 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;
1259
+ }
1260
+ }
1261
+ /**
1262
+ * Network-specific identifiers for a specific request or transaction.
1263
+ */
1264
+ interface NetworkIdentifiers {
1265
+ /**
1266
+ * The randomly generated 6-character Authorization Identification Response code
1267
+ * sent back to the acquirer in an approved response.
1268
+ */
1269
+ authorization_identification_response: string | null;
1270
+ /**
1271
+ * A life-cycle identifier used across e.g., an authorization and a reversal.
1272
+ * Expected to be unique per acquirer within a window of time. For some card
1273
+ * networks the retrieval reference number includes the trace counter.
1274
+ */
1275
+ retrieval_reference_number: string | null;
1276
+ /**
1277
+ * A counter used to verify an individual authorization. Expected to be unique per
1278
+ * acquirer within a window of time.
1279
+ */
1280
+ trace_number: string | null;
1281
+ /**
1282
+ * A globally unique transaction identifier provided by the card network, used
1283
+ * across multiple life-cycle requests.
1284
+ */
1285
+ transaction_id: string | null;
1286
+ }
1287
+ /**
1288
+ * Fields related to verification of cardholder-provided values.
1289
+ */
1290
+ interface Verification {
1291
+ /**
1292
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1293
+ * the back of the card.
1294
+ */
1295
+ card_verification_code: Verification.CardVerificationCode;
1296
+ /**
1297
+ * Cardholder address provided in the authorization request and the address on file
1298
+ * we verified it against.
1299
+ */
1300
+ cardholder_address: Verification.CardholderAddress;
1301
+ }
1302
+ namespace Verification {
1303
+ /**
1304
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1305
+ * the back of the card.
1306
+ */
1307
+ interface CardVerificationCode {
1308
+ /**
1309
+ * The result of verifying the Card Verification Code.
1310
+ *
1311
+ * - `not_checked` - No card verification code was provided in the authorization
1312
+ * request.
1313
+ * - `match` - The card verification code matched the one on file.
1314
+ * - `no_match` - The card verification code did not match the one on file.
1315
+ */
1316
+ result: 'not_checked' | 'match' | 'no_match';
1317
+ }
1318
+ /**
1319
+ * Cardholder address provided in the authorization request and the address on file
1320
+ * we verified it against.
1321
+ */
1322
+ interface CardholderAddress {
1323
+ /**
1324
+ * Line 1 of the address on file for the cardholder.
1325
+ */
1326
+ actual_line1: string | null;
1327
+ /**
1328
+ * The postal code of the address on file for the cardholder.
1329
+ */
1330
+ actual_postal_code: string | null;
1331
+ /**
1332
+ * The cardholder address line 1 provided for verification in the authorization
1333
+ * request.
1334
+ */
1335
+ provided_line1: string | null;
1336
+ /**
1337
+ * The postal code provided for verification in the authorization request.
1338
+ */
1339
+ provided_postal_code: string | null;
1340
+ /**
1341
+ * The address verification result returned to the card network.
1342
+ *
1343
+ * - `not_checked` - No address information was provided in the authorization
1344
+ * request.
1345
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
1346
+ * address does not match or was not provided.
1347
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
1348
+ * street address matches or was not provided.
1349
+ * - `match` - Postal code and street address match.
1350
+ * - `no_match` - Postal code and street address do not match.
1351
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
1352
+ * address was not verified. (deprecated)
1353
+ */
1354
+ result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
1355
+ }
1356
+ }
1357
+ }
1358
+ /**
1359
+ * Fields related to a digital wallet authentication attempt.
1360
+ */
1361
+ interface DigitalWalletAuthentication {
1362
+ /**
1363
+ * The identifier of the Card that is being tokenized.
1364
+ */
1365
+ card_id: string;
1366
+ /**
1367
+ * The channel to send the card user their one-time passcode.
1368
+ *
1369
+ * - `sms` - Send one-time passcodes over SMS.
1370
+ * - `email` - Send one-time passcodes over email.
1371
+ */
1372
+ channel: 'sms' | 'email';
1373
+ /**
1374
+ * The digital wallet app being used.
1375
+ *
1376
+ * - `apple_pay` - Apple Pay
1377
+ * - `google_pay` - Google Pay
1378
+ * - `samsung_pay` - Samsung Pay
1379
+ * - `unknown` - Unknown
1380
+ */
1381
+ digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
1382
+ /**
1383
+ * The email to send the one-time passcode to if `channel` is equal to `email`.
1384
+ */
1385
+ email: string | null;
1386
+ /**
1387
+ * The one-time passcode to send the card user.
1388
+ */
1389
+ one_time_passcode: string;
1390
+ /**
1391
+ * The phone number to send the one-time passcode to if `channel` is equal to
1392
+ * `sms`.
1393
+ */
1394
+ phone: string | null;
1395
+ /**
1396
+ * Whether your application successfully delivered the one-time passcode.
1397
+ *
1398
+ * - `success` - Your application successfully delivered the one-time passcode to
1399
+ * the cardholder.
1400
+ * - `failure` - Your application failed to deliver the one-time passcode to the
1401
+ * cardholder.
1402
+ */
1403
+ result: 'success' | 'failure' | null;
1404
+ }
1405
+ /**
1406
+ * Fields related to a digital wallet token provisioning attempt.
1407
+ */
1408
+ interface DigitalWalletToken {
1409
+ /**
1410
+ * The identifier of the Card that is being tokenized.
1411
+ */
1412
+ card_id: string;
1413
+ /**
1414
+ * Whether or not the provisioning request was approved. This will be null until
1415
+ * the real time decision is responded to.
1416
+ *
1417
+ * - `approve` - Approve the provisioning request.
1418
+ * - `decline` - Decline the provisioning request.
1419
+ */
1420
+ decision: 'approve' | 'decline' | null;
1421
+ /**
1422
+ * Device that is being used to provision the digital wallet token.
1423
+ */
1424
+ device: DigitalWalletToken.Device;
1425
+ /**
1426
+ * The digital wallet app being used.
1427
+ *
1428
+ * - `apple_pay` - Apple Pay
1429
+ * - `google_pay` - Google Pay
1430
+ * - `samsung_pay` - Samsung Pay
1431
+ * - `unknown` - Unknown
1432
+ */
1433
+ digital_wallet: 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
1434
+ }
1435
+ namespace DigitalWalletToken {
1436
+ /**
1437
+ * Device that is being used to provision the digital wallet token.
1438
+ */
1439
+ interface Device {
1440
+ /**
1441
+ * ID assigned to the device by the digital wallet provider.
1442
+ */
1443
+ identifier: string | null;
1444
+ }
1445
+ }
1446
+ }
1447
+ export interface RealTimeDecisionActionParams {
1448
+ /**
1449
+ * If the Real-Time Decision relates to a 3DS card authentication attempt, this
1450
+ * object contains your response to the authentication.
1451
+ */
1452
+ card_authentication?: RealTimeDecisionActionParams.CardAuthentication;
1453
+ /**
1454
+ * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
1455
+ * this object contains your response.
1456
+ */
1457
+ card_authentication_challenge?: RealTimeDecisionActionParams.CardAuthenticationChallenge;
1458
+ /**
1459
+ * If the Real-Time Decision relates to a card authorization attempt, this object
1460
+ * contains your response to the authorization.
1461
+ */
1462
+ card_authorization?: RealTimeDecisionActionParams.CardAuthorization;
1463
+ /**
1464
+ * If the Real-Time Decision relates to a card balance inquiry attempt, this object
1465
+ * contains your response to the inquiry.
1466
+ */
1467
+ card_balance_inquiry?: RealTimeDecisionActionParams.CardBalanceInquiry;
1468
+ /**
1469
+ * If the Real-Time Decision relates to a digital wallet authentication attempt,
1470
+ * this object contains your response to the authentication.
1471
+ */
1472
+ digital_wallet_authentication?: RealTimeDecisionActionParams.DigitalWalletAuthentication;
1473
+ /**
1474
+ * If the Real-Time Decision relates to a digital wallet token provisioning
1475
+ * attempt, this object contains your response to the attempt.
1476
+ */
1477
+ digital_wallet_token?: RealTimeDecisionActionParams.DigitalWalletToken;
1478
+ }
1479
+ export declare namespace RealTimeDecisionActionParams {
1480
+ /**
1481
+ * If the Real-Time Decision relates to a 3DS card authentication attempt, this
1482
+ * object contains your response to the authentication.
1483
+ */
1484
+ interface CardAuthentication {
1485
+ /**
1486
+ * Whether the card authentication attempt should be approved or declined.
1487
+ *
1488
+ * - `approve` - Approve the authentication attempt without triggering a challenge.
1489
+ * - `challenge` - Request further validation before approving the authentication
1490
+ * attempt.
1491
+ * - `deny` - Deny the authentication attempt.
1492
+ */
1493
+ decision: 'approve' | 'challenge' | 'deny';
1494
+ }
1495
+ /**
1496
+ * If the Real-Time Decision relates to 3DS card authentication challenge delivery,
1497
+ * this object contains your response.
1498
+ */
1499
+ interface CardAuthenticationChallenge {
1500
+ /**
1501
+ * Whether the card authentication challenge was successfully delivered to the
1502
+ * cardholder.
1503
+ *
1504
+ * - `success` - Your application successfully delivered the one-time code to the
1505
+ * cardholder.
1506
+ * - `failure` - Your application was unable to deliver the one-time code to the
1507
+ * cardholder.
1508
+ */
1509
+ result: 'success' | 'failure';
1510
+ }
1511
+ /**
1512
+ * If the Real-Time Decision relates to a card authorization attempt, this object
1513
+ * contains your response to the authorization.
1514
+ */
1515
+ interface CardAuthorization {
1516
+ /**
1517
+ * Whether the card authorization should be approved or declined.
1518
+ *
1519
+ * - `approve` - Approve the authorization.
1520
+ * - `decline` - Decline the authorization.
1521
+ */
1522
+ decision: 'approve' | 'decline';
1523
+ /**
1524
+ * If your application approves the authorization, this contains metadata about
1525
+ * your decision to approve. Your response here is advisory to the acquiring bank.
1526
+ * The bank may choose to reverse the authorization if you approve the transaction
1527
+ * but indicate the address does not match.
1528
+ */
1529
+ approval?: CardAuthorization.Approval;
1530
+ /**
1531
+ * If your application declines the authorization, this contains details about the
1532
+ * decline.
1533
+ */
1534
+ decline?: CardAuthorization.Decline;
1535
+ [k: string]: unknown;
1536
+ }
1537
+ namespace CardAuthorization {
1538
+ /**
1539
+ * If your application approves the authorization, this contains metadata about
1540
+ * your decision to approve. Your response here is advisory to the acquiring bank.
1541
+ * The bank may choose to reverse the authorization if you approve the transaction
1542
+ * but indicate the address does not match.
1543
+ */
1544
+ interface Approval {
1545
+ /**
1546
+ * Your decisions on whether or not each provided address component is a match.
1547
+ * Your response here is evaluated against the customer's provided `postal_code`
1548
+ * and `line1`, and an appropriate network response is generated. For more
1549
+ * information, see our
1550
+ * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
1551
+ * guide.
1552
+ */
1553
+ cardholder_address_verification_result?: Approval.CardholderAddressVerificationResult;
1554
+ /**
1555
+ * If the transaction supports partial approvals
1556
+ * (`partial_approval_capability: supported`) the `partial_amount` can be provided
1557
+ * in the transaction's settlement currency to approve a lower amount than was
1558
+ * requested.
1559
+ */
1560
+ partial_amount?: number;
1561
+ }
1562
+ namespace Approval {
1563
+ /**
1564
+ * Your decisions on whether or not each provided address component is a match.
1565
+ * Your response here is evaluated against the customer's provided `postal_code`
1566
+ * and `line1`, and an appropriate network response is generated. For more
1567
+ * information, see our
1568
+ * [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
1569
+ * guide.
1570
+ */
1571
+ interface CardholderAddressVerificationResult {
1572
+ /**
1573
+ * Your decision on the address line of the provided address.
1574
+ *
1575
+ * - `match` - The cardholder address verification result matches the address
1576
+ * provided by the merchant.
1577
+ * - `no_match` - The cardholder address verification result does not match the
1578
+ * address provided by the merchant.
1579
+ */
1580
+ line1: 'match' | 'no_match';
1581
+ /**
1582
+ * Your decision on the postal code of the provided address.
1583
+ *
1584
+ * - `match` - The cardholder address verification result matches the address
1585
+ * provided by the merchant.
1586
+ * - `no_match` - The cardholder address verification result does not match the
1587
+ * address provided by the merchant.
1588
+ */
1589
+ postal_code: 'match' | 'no_match';
1590
+ }
1591
+ }
1592
+ /**
1593
+ * If your application declines the authorization, this contains details about the
1594
+ * decline.
1595
+ */
1596
+ interface Decline {
1597
+ /**
1598
+ * The reason the card authorization was declined. This translates to a specific
1599
+ * decline code that is sent to the card network.
1029
1600
  *
1030
1601
  * - `insufficient_funds` - The cardholder does not have sufficient funds to cover
1031
1602
  * the transaction. The merchant may attempt to process the transaction again.
@@ -1043,6 +1614,36 @@ export declare namespace RealTimeDecisionActionParams {
1043
1614
  reason: 'insufficient_funds' | 'transaction_never_allowed' | 'exceeds_approval_limit' | 'card_temporarily_disabled' | 'suspected_fraud' | 'other';
1044
1615
  }
1045
1616
  }
1617
+ /**
1618
+ * If the Real-Time Decision relates to a card balance inquiry attempt, this object
1619
+ * contains your response to the inquiry.
1620
+ */
1621
+ interface CardBalanceInquiry {
1622
+ /**
1623
+ * Whether the card balance inquiry should be approved or declined.
1624
+ *
1625
+ * - `approve` - Approve the authorization.
1626
+ * - `decline` - Decline the authorization.
1627
+ */
1628
+ decision: 'approve' | 'decline';
1629
+ /**
1630
+ * If your application approves the balance inquiry, this contains metadata about
1631
+ * your decision to approve.
1632
+ */
1633
+ approval?: CardBalanceInquiry.Approval;
1634
+ }
1635
+ namespace CardBalanceInquiry {
1636
+ /**
1637
+ * If your application approves the balance inquiry, this contains metadata about
1638
+ * your decision to approve.
1639
+ */
1640
+ interface Approval {
1641
+ /**
1642
+ * The balance on the card in the settlement currency of the transaction.
1643
+ */
1644
+ balance: number;
1645
+ }
1646
+ }
1046
1647
  /**
1047
1648
  * If the Real-Time Decision relates to a digital wallet authentication attempt,
1048
1649
  * this object contains your response to the authentication.