increase 1.237.0 → 1.238.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/increase/models/card_payment.rb +139 -90
- data/lib/increase/models/real_time_decision.rb +138 -86
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/card_payment.rbi +316 -165
- data/rbi/increase/models/real_time_decision.rbi +316 -165
- data/sig/increase/models/card_payment.rbs +115 -67
- data/sig/increase/models/real_time_decision.rbs +114 -67
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8cd452b5f692eb289cabcbf215f22fbf75d71debe34aae6cb3c66d6638354e20
|
|
4
|
+
data.tar.gz: 78b3d39e88f1062a7e8124f27d0aa430f81486c28bd69b463a1e65a9abaca851
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 632012f4711e028e15acf41c224dd6ccef2502093f2182df7d95b86990fed70819515679f2e25b1fc7e2e4074c723b804856b20ae76ac1466f468364ad7781a5
|
|
7
|
+
data.tar.gz: 53b5abc0a2762b7ed248208ebb5ea0b686a24a8a9e141cc27c1172071803333573f687305b6fd5f28c510aa378ae6de7512f7bfc81e00a9c386770c7256eba90
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.238.0 (2026-03-09)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.237.0...v1.238.0](https://github.com/Increase/increase-ruby/compare/v1.237.0...v1.238.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([1836a3f](https://github.com/Increase/increase-ruby/commit/1836a3ff6323ab99707b78598cb3762cf558c409))
|
|
10
|
+
|
|
3
11
|
## 1.237.0 (2026-03-09)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v1.236.0...v1.237.0](https://github.com/Increase/increase-ruby/compare/v1.236.0...v1.237.0)
|
data/README.md
CHANGED
|
@@ -398,16 +398,6 @@ module Increase
|
|
|
398
398
|
# @return [String, nil]
|
|
399
399
|
required :cardholder_name, String, nil?: true
|
|
400
400
|
|
|
401
|
-
# @!attribute category
|
|
402
|
-
# The category of the card authentication attempt.
|
|
403
|
-
#
|
|
404
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil]
|
|
405
|
-
required :category,
|
|
406
|
-
enum: -> {
|
|
407
|
-
Increase::CardPayment::Element::CardAuthentication::Category
|
|
408
|
-
},
|
|
409
|
-
nil?: true
|
|
410
|
-
|
|
411
401
|
# @!attribute challenge
|
|
412
402
|
# Details about the challenge, if one was requested.
|
|
413
403
|
#
|
|
@@ -472,6 +462,12 @@ module Increase
|
|
|
472
462
|
# @return [String, nil]
|
|
473
463
|
required :merchant_name, String, nil?: true
|
|
474
464
|
|
|
465
|
+
# @!attribute message_category
|
|
466
|
+
# The message category of the card authentication attempt.
|
|
467
|
+
#
|
|
468
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory]
|
|
469
|
+
required :message_category, -> { Increase::CardPayment::Element::CardAuthentication::MessageCategory }
|
|
470
|
+
|
|
475
471
|
# @!attribute prior_authenticated_card_payment_id
|
|
476
472
|
# The ID of a prior Card Authentication that the requestor used to authenticate
|
|
477
473
|
# this cardholder for a previous transaction.
|
|
@@ -479,26 +475,6 @@ module Increase
|
|
|
479
475
|
# @return [String, nil]
|
|
480
476
|
required :prior_authenticated_card_payment_id, String, nil?: true
|
|
481
477
|
|
|
482
|
-
# @!attribute purchase_amount
|
|
483
|
-
# The purchase amount in minor units.
|
|
484
|
-
#
|
|
485
|
-
# @return [Integer, nil]
|
|
486
|
-
required :purchase_amount, Integer, nil?: true
|
|
487
|
-
|
|
488
|
-
# @!attribute purchase_amount_cardholder_estimated
|
|
489
|
-
# The purchase amount in the cardholder's currency (i.e., USD) estimated using
|
|
490
|
-
# daily conversion rates from the card network.
|
|
491
|
-
#
|
|
492
|
-
# @return [Integer, nil]
|
|
493
|
-
required :purchase_amount_cardholder_estimated, Integer, nil?: true
|
|
494
|
-
|
|
495
|
-
# @!attribute purchase_currency
|
|
496
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
497
|
-
# authentication attempt's purchase currency.
|
|
498
|
-
#
|
|
499
|
-
# @return [String, nil]
|
|
500
|
-
required :purchase_currency, String, nil?: true
|
|
501
|
-
|
|
502
478
|
# @!attribute real_time_decision_id
|
|
503
479
|
# The identifier of the Real-Time Decision sent to approve or decline this
|
|
504
480
|
# authentication attempt.
|
|
@@ -594,14 +570,6 @@ module Increase
|
|
|
594
570
|
# @return [String]
|
|
595
571
|
required :three_d_secure_server_transaction_id, String
|
|
596
572
|
|
|
597
|
-
# @!attribute transaction_type
|
|
598
|
-
# The type of transaction being authenticated.
|
|
599
|
-
#
|
|
600
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::TransactionType, nil]
|
|
601
|
-
required :transaction_type,
|
|
602
|
-
enum: -> { Increase::CardPayment::Element::CardAuthentication::TransactionType },
|
|
603
|
-
nil?: true
|
|
604
|
-
|
|
605
573
|
# @!attribute type
|
|
606
574
|
# A constant representing the object's type. For this resource it will always be
|
|
607
575
|
# `card_authentication`.
|
|
@@ -609,7 +577,7 @@ module Increase
|
|
|
609
577
|
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type]
|
|
610
578
|
required :type, enum: -> { Increase::CardPayment::Element::CardAuthentication::Type }
|
|
611
579
|
|
|
612
|
-
# @!method initialize(id:, access_control_server_transaction_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, card_payment_id:, cardholder_email:, cardholder_name:,
|
|
580
|
+
# @!method initialize(id:, access_control_server_transaction_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, card_payment_id:, cardholder_email:, cardholder_name:, challenge:, created_at:, deny_reason:, device_channel:, directory_server_transaction_id:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, message_category:, prior_authenticated_card_payment_id:, real_time_decision_id:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, shipping_address_city:, shipping_address_country:, shipping_address_line1:, shipping_address_line2:, shipping_address_line3:, shipping_address_postal_code:, shipping_address_state:, status:, three_d_secure_server_transaction_id:, type:)
|
|
613
581
|
# Some parameter documentations has been truncated, see
|
|
614
582
|
# {Increase::Models::CardPayment::Element::CardAuthentication} for more details.
|
|
615
583
|
#
|
|
@@ -643,8 +611,6 @@ module Increase
|
|
|
643
611
|
#
|
|
644
612
|
# @param cardholder_name [String, nil] The name of the cardholder.
|
|
645
613
|
#
|
|
646
|
-
# @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil] The category of the card authentication attempt.
|
|
647
|
-
#
|
|
648
614
|
# @param challenge [Increase::Models::CardPayment::Element::CardAuthentication::Challenge, nil] Details about the challenge, if one was requested.
|
|
649
615
|
#
|
|
650
616
|
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Au
|
|
@@ -663,13 +629,9 @@ module Increase
|
|
|
663
629
|
#
|
|
664
630
|
# @param merchant_name [String, nil] The name of the merchant.
|
|
665
631
|
#
|
|
666
|
-
# @param
|
|
667
|
-
#
|
|
668
|
-
# @param purchase_amount [Integer, nil] The purchase amount in minor units.
|
|
632
|
+
# @param message_category [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory] The message category of the card authentication attempt.
|
|
669
633
|
#
|
|
670
|
-
# @param
|
|
671
|
-
#
|
|
672
|
-
# @param purchase_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
|
|
634
|
+
# @param prior_authenticated_card_payment_id [String, nil] The ID of a prior Card Authentication that the requestor used to authenticate th
|
|
673
635
|
#
|
|
674
636
|
# @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this authent
|
|
675
637
|
#
|
|
@@ -699,26 +661,8 @@ module Increase
|
|
|
699
661
|
#
|
|
700
662
|
# @param three_d_secure_server_transaction_id [String] A unique identifier assigned by the 3DS Server initiating the authentication att
|
|
701
663
|
#
|
|
702
|
-
# @param transaction_type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::TransactionType, nil] The type of transaction being authenticated.
|
|
703
|
-
#
|
|
704
664
|
# @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] A constant representing the object's type. For this resource it will always be `
|
|
705
665
|
|
|
706
|
-
# The category of the card authentication attempt.
|
|
707
|
-
#
|
|
708
|
-
# @see Increase::Models::CardPayment::Element::CardAuthentication#category
|
|
709
|
-
module Category
|
|
710
|
-
extend Increase::Internal::Type::Enum
|
|
711
|
-
|
|
712
|
-
# The authentication attempt is for a payment.
|
|
713
|
-
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
714
|
-
|
|
715
|
-
# The authentication attempt is not for a payment.
|
|
716
|
-
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
717
|
-
|
|
718
|
-
# @!method self.values
|
|
719
|
-
# @return [Array<Symbol>]
|
|
720
|
-
end
|
|
721
|
-
|
|
722
666
|
# @see Increase::Models::CardPayment::Element::CardAuthentication#challenge
|
|
723
667
|
class Challenge < Increase::Internal::Type::BaseModel
|
|
724
668
|
# @!attribute attempts
|
|
@@ -1065,6 +1009,136 @@ module Increase
|
|
|
1065
1009
|
end
|
|
1066
1010
|
end
|
|
1067
1011
|
|
|
1012
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication#message_category
|
|
1013
|
+
class MessageCategory < Increase::Internal::Type::BaseModel
|
|
1014
|
+
# @!attribute category
|
|
1015
|
+
# The category of the card authentication attempt.
|
|
1016
|
+
#
|
|
1017
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Category]
|
|
1018
|
+
required :category,
|
|
1019
|
+
enum: -> { Increase::CardPayment::Element::CardAuthentication::MessageCategory::Category }
|
|
1020
|
+
|
|
1021
|
+
# @!attribute non_payment
|
|
1022
|
+
# Fields specific to non-payment authentication attempts.
|
|
1023
|
+
#
|
|
1024
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::NonPayment, nil]
|
|
1025
|
+
required :non_payment,
|
|
1026
|
+
-> { Increase::CardPayment::Element::CardAuthentication::MessageCategory::NonPayment },
|
|
1027
|
+
nil?: true
|
|
1028
|
+
|
|
1029
|
+
# @!attribute payment
|
|
1030
|
+
# Fields specific to payment authentication attempts.
|
|
1031
|
+
#
|
|
1032
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment, nil]
|
|
1033
|
+
required :payment,
|
|
1034
|
+
-> { Increase::CardPayment::Element::CardAuthentication::MessageCategory::Payment },
|
|
1035
|
+
nil?: true
|
|
1036
|
+
|
|
1037
|
+
# @!method initialize(category:, non_payment:, payment:)
|
|
1038
|
+
# The message category of the card authentication attempt.
|
|
1039
|
+
#
|
|
1040
|
+
# @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Category] The category of the card authentication attempt.
|
|
1041
|
+
#
|
|
1042
|
+
# @param non_payment [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::NonPayment, nil] Fields specific to non-payment authentication attempts.
|
|
1043
|
+
#
|
|
1044
|
+
# @param payment [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment, nil] Fields specific to payment authentication attempts.
|
|
1045
|
+
|
|
1046
|
+
# The category of the card authentication attempt.
|
|
1047
|
+
#
|
|
1048
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory#category
|
|
1049
|
+
module Category
|
|
1050
|
+
extend Increase::Internal::Type::Enum
|
|
1051
|
+
|
|
1052
|
+
# The authentication attempt is for a payment.
|
|
1053
|
+
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
1054
|
+
|
|
1055
|
+
# The authentication attempt is not for a payment.
|
|
1056
|
+
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
1057
|
+
|
|
1058
|
+
# @!method self.values
|
|
1059
|
+
# @return [Array<Symbol>]
|
|
1060
|
+
end
|
|
1061
|
+
|
|
1062
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory#non_payment
|
|
1063
|
+
class NonPayment < Increase::Internal::Type::BaseModel
|
|
1064
|
+
# @!method initialize
|
|
1065
|
+
# Fields specific to non-payment authentication attempts.
|
|
1066
|
+
end
|
|
1067
|
+
|
|
1068
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory#payment
|
|
1069
|
+
class Payment < Increase::Internal::Type::BaseModel
|
|
1070
|
+
# @!attribute purchase_amount
|
|
1071
|
+
# The purchase amount in minor units.
|
|
1072
|
+
#
|
|
1073
|
+
# @return [Integer]
|
|
1074
|
+
required :purchase_amount, Integer
|
|
1075
|
+
|
|
1076
|
+
# @!attribute purchase_amount_cardholder_estimated
|
|
1077
|
+
# The purchase amount in the cardholder's currency (i.e., USD) estimated using
|
|
1078
|
+
# daily conversion rates from the card network.
|
|
1079
|
+
#
|
|
1080
|
+
# @return [Integer, nil]
|
|
1081
|
+
required :purchase_amount_cardholder_estimated, Integer, nil?: true
|
|
1082
|
+
|
|
1083
|
+
# @!attribute purchase_currency
|
|
1084
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1085
|
+
# authentication attempt's purchase currency.
|
|
1086
|
+
#
|
|
1087
|
+
# @return [String]
|
|
1088
|
+
required :purchase_currency, String
|
|
1089
|
+
|
|
1090
|
+
# @!attribute transaction_type
|
|
1091
|
+
# The type of transaction being authenticated.
|
|
1092
|
+
#
|
|
1093
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment::TransactionType, nil]
|
|
1094
|
+
required :transaction_type,
|
|
1095
|
+
enum: -> {
|
|
1096
|
+
Increase::CardPayment::Element::CardAuthentication::MessageCategory::Payment::TransactionType
|
|
1097
|
+
},
|
|
1098
|
+
nil?: true
|
|
1099
|
+
|
|
1100
|
+
# @!method initialize(purchase_amount:, purchase_amount_cardholder_estimated:, purchase_currency:, transaction_type:)
|
|
1101
|
+
# Some parameter documentations has been truncated, see
|
|
1102
|
+
# {Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment}
|
|
1103
|
+
# for more details.
|
|
1104
|
+
#
|
|
1105
|
+
# Fields specific to payment authentication attempts.
|
|
1106
|
+
#
|
|
1107
|
+
# @param purchase_amount [Integer] The purchase amount in minor units.
|
|
1108
|
+
#
|
|
1109
|
+
# @param purchase_amount_cardholder_estimated [Integer, nil] The purchase amount in the cardholder's currency (i.e., USD) estimated using dai
|
|
1110
|
+
#
|
|
1111
|
+
# @param purchase_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
|
|
1112
|
+
#
|
|
1113
|
+
# @param transaction_type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment::TransactionType, nil] The type of transaction being authenticated.
|
|
1114
|
+
|
|
1115
|
+
# The type of transaction being authenticated.
|
|
1116
|
+
#
|
|
1117
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment#transaction_type
|
|
1118
|
+
module TransactionType
|
|
1119
|
+
extend Increase::Internal::Type::Enum
|
|
1120
|
+
|
|
1121
|
+
# Purchase of goods or services.
|
|
1122
|
+
GOODS_SERVICE_PURCHASE = :goods_service_purchase
|
|
1123
|
+
|
|
1124
|
+
# Check acceptance.
|
|
1125
|
+
CHECK_ACCEPTANCE = :check_acceptance
|
|
1126
|
+
|
|
1127
|
+
# Account funding.
|
|
1128
|
+
ACCOUNT_FUNDING = :account_funding
|
|
1129
|
+
|
|
1130
|
+
# Quasi-cash transaction.
|
|
1131
|
+
QUASI_CASH_TRANSACTION = :quasi_cash_transaction
|
|
1132
|
+
|
|
1133
|
+
# Prepaid activation and load.
|
|
1134
|
+
PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
|
|
1135
|
+
|
|
1136
|
+
# @!method self.values
|
|
1137
|
+
# @return [Array<Symbol>]
|
|
1138
|
+
end
|
|
1139
|
+
end
|
|
1140
|
+
end
|
|
1141
|
+
|
|
1068
1142
|
# The 3DS requestor authentication indicator describes why the authentication
|
|
1069
1143
|
# attempt is performed, such as for a recurring transaction.
|
|
1070
1144
|
#
|
|
@@ -1175,31 +1249,6 @@ module Increase
|
|
|
1175
1249
|
# @return [Array<Symbol>]
|
|
1176
1250
|
end
|
|
1177
1251
|
|
|
1178
|
-
# The type of transaction being authenticated.
|
|
1179
|
-
#
|
|
1180
|
-
# @see Increase::Models::CardPayment::Element::CardAuthentication#transaction_type
|
|
1181
|
-
module TransactionType
|
|
1182
|
-
extend Increase::Internal::Type::Enum
|
|
1183
|
-
|
|
1184
|
-
# Purchase of goods or services.
|
|
1185
|
-
GOODS_SERVICE_PURCHASE = :goods_service_purchase
|
|
1186
|
-
|
|
1187
|
-
# Check acceptance.
|
|
1188
|
-
CHECK_ACCEPTANCE = :check_acceptance
|
|
1189
|
-
|
|
1190
|
-
# Account funding.
|
|
1191
|
-
ACCOUNT_FUNDING = :account_funding
|
|
1192
|
-
|
|
1193
|
-
# Quasi-cash transaction.
|
|
1194
|
-
QUASI_CASH_TRANSACTION = :quasi_cash_transaction
|
|
1195
|
-
|
|
1196
|
-
# Prepaid activation and load.
|
|
1197
|
-
PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
|
|
1198
|
-
|
|
1199
|
-
# @!method self.values
|
|
1200
|
-
# @return [Array<Symbol>]
|
|
1201
|
-
end
|
|
1202
|
-
|
|
1203
1252
|
# A constant representing the object's type. For this resource it will always be
|
|
1204
1253
|
# `card_authentication`.
|
|
1205
1254
|
#
|
|
@@ -198,12 +198,6 @@ module Increase
|
|
|
198
198
|
# @return [String, nil]
|
|
199
199
|
required :cardholder_name, String, nil?: true
|
|
200
200
|
|
|
201
|
-
# @!attribute category
|
|
202
|
-
# The category of the card authentication attempt.
|
|
203
|
-
#
|
|
204
|
-
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Category, nil]
|
|
205
|
-
required :category, enum: -> { Increase::RealTimeDecision::CardAuthentication::Category }, nil?: true
|
|
206
|
-
|
|
207
201
|
# @!attribute decision
|
|
208
202
|
# Whether or not the authentication attempt was approved.
|
|
209
203
|
#
|
|
@@ -249,6 +243,12 @@ module Increase
|
|
|
249
243
|
# @return [String, nil]
|
|
250
244
|
required :merchant_name, String, nil?: true
|
|
251
245
|
|
|
246
|
+
# @!attribute message_category
|
|
247
|
+
# The message category of the card authentication attempt.
|
|
248
|
+
#
|
|
249
|
+
# @return [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory]
|
|
250
|
+
required :message_category, -> { Increase::RealTimeDecision::CardAuthentication::MessageCategory }
|
|
251
|
+
|
|
252
252
|
# @!attribute prior_authenticated_card_payment_id
|
|
253
253
|
# The ID of a prior Card Authentication that the requestor used to authenticate
|
|
254
254
|
# this cardholder for a previous transaction.
|
|
@@ -256,26 +256,6 @@ module Increase
|
|
|
256
256
|
# @return [String, nil]
|
|
257
257
|
required :prior_authenticated_card_payment_id, String, nil?: true
|
|
258
258
|
|
|
259
|
-
# @!attribute purchase_amount
|
|
260
|
-
# The purchase amount in minor units.
|
|
261
|
-
#
|
|
262
|
-
# @return [Integer, nil]
|
|
263
|
-
required :purchase_amount, Integer, nil?: true
|
|
264
|
-
|
|
265
|
-
# @!attribute purchase_amount_cardholder_estimated
|
|
266
|
-
# The purchase amount in the cardholder's currency (i.e., USD) estimated using
|
|
267
|
-
# daily conversion rates from the card network.
|
|
268
|
-
#
|
|
269
|
-
# @return [Integer, nil]
|
|
270
|
-
required :purchase_amount_cardholder_estimated, Integer, nil?: true
|
|
271
|
-
|
|
272
|
-
# @!attribute purchase_currency
|
|
273
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
274
|
-
# authentication attempt's purchase currency.
|
|
275
|
-
#
|
|
276
|
-
# @return [String, nil]
|
|
277
|
-
required :purchase_currency, String, nil?: true
|
|
278
|
-
|
|
279
259
|
# @!attribute requestor_authentication_indicator
|
|
280
260
|
# The 3DS requestor authentication indicator describes why the authentication
|
|
281
261
|
# attempt is performed, such as for a recurring transaction.
|
|
@@ -356,14 +336,6 @@ module Increase
|
|
|
356
336
|
# @return [String]
|
|
357
337
|
required :three_d_secure_server_transaction_id, String
|
|
358
338
|
|
|
359
|
-
# @!attribute transaction_type
|
|
360
|
-
# The type of transaction being authenticated.
|
|
361
|
-
#
|
|
362
|
-
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::TransactionType, nil]
|
|
363
|
-
required :transaction_type,
|
|
364
|
-
enum: -> { Increase::RealTimeDecision::CardAuthentication::TransactionType },
|
|
365
|
-
nil?: true
|
|
366
|
-
|
|
367
339
|
# @!attribute upcoming_card_payment_id
|
|
368
340
|
# The identifier of the Card Payment this authentication attempt will belong to.
|
|
369
341
|
# Available in the API once the card authentication has completed.
|
|
@@ -371,7 +343,7 @@ module Increase
|
|
|
371
343
|
# @return [String]
|
|
372
344
|
required :upcoming_card_payment_id, String
|
|
373
345
|
|
|
374
|
-
# @!method initialize(access_control_server_transaction_id:, account_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, cardholder_email:, cardholder_name:,
|
|
346
|
+
# @!method initialize(access_control_server_transaction_id:, account_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, cardholder_email:, cardholder_name:, decision:, device_channel:, directory_server_transaction_id:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, message_category:, prior_authenticated_card_payment_id:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, shipping_address_city:, shipping_address_country:, shipping_address_line1:, shipping_address_line2:, shipping_address_line3:, shipping_address_postal_code:, shipping_address_state:, three_d_secure_server_transaction_id:, upcoming_card_payment_id:)
|
|
375
347
|
# Some parameter documentations has been truncated, see
|
|
376
348
|
# {Increase::Models::RealTimeDecision::CardAuthentication} for more details.
|
|
377
349
|
#
|
|
@@ -401,8 +373,6 @@ module Increase
|
|
|
401
373
|
#
|
|
402
374
|
# @param cardholder_name [String, nil] The name of the cardholder.
|
|
403
375
|
#
|
|
404
|
-
# @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Category, nil] The category of the card authentication attempt.
|
|
405
|
-
#
|
|
406
376
|
# @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] Whether or not the authentication attempt was approved.
|
|
407
377
|
#
|
|
408
378
|
# @param device_channel [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel] The device channel of the card authentication attempt.
|
|
@@ -417,13 +387,9 @@ module Increase
|
|
|
417
387
|
#
|
|
418
388
|
# @param merchant_name [String, nil] The name of the merchant.
|
|
419
389
|
#
|
|
420
|
-
# @param
|
|
390
|
+
# @param message_category [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory] The message category of the card authentication attempt.
|
|
421
391
|
#
|
|
422
|
-
# @param
|
|
423
|
-
#
|
|
424
|
-
# @param purchase_amount_cardholder_estimated [Integer, nil] The purchase amount in the cardholder's currency (i.e., USD) estimated using dai
|
|
425
|
-
#
|
|
426
|
-
# @param purchase_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
|
|
392
|
+
# @param prior_authenticated_card_payment_id [String, nil] The ID of a prior Card Authentication that the requestor used to authenticate th
|
|
427
393
|
#
|
|
428
394
|
# @param requestor_authentication_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator, nil] The 3DS requestor authentication indicator describes why the authentication atte
|
|
429
395
|
#
|
|
@@ -449,26 +415,8 @@ module Increase
|
|
|
449
415
|
#
|
|
450
416
|
# @param three_d_secure_server_transaction_id [String] A unique identifier assigned by the 3DS Server initiating the authentication att
|
|
451
417
|
#
|
|
452
|
-
# @param transaction_type [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::TransactionType, nil] The type of transaction being authenticated.
|
|
453
|
-
#
|
|
454
418
|
# @param upcoming_card_payment_id [String] The identifier of the Card Payment this authentication attempt will belong to. A
|
|
455
419
|
|
|
456
|
-
# The category of the card authentication attempt.
|
|
457
|
-
#
|
|
458
|
-
# @see Increase::Models::RealTimeDecision::CardAuthentication#category
|
|
459
|
-
module Category
|
|
460
|
-
extend Increase::Internal::Type::Enum
|
|
461
|
-
|
|
462
|
-
# The authentication attempt is for a payment.
|
|
463
|
-
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
464
|
-
|
|
465
|
-
# The authentication attempt is not for a payment.
|
|
466
|
-
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
467
|
-
|
|
468
|
-
# @!method self.values
|
|
469
|
-
# @return [Array<Symbol>]
|
|
470
|
-
end
|
|
471
|
-
|
|
472
420
|
# Whether or not the authentication attempt was approved.
|
|
473
421
|
#
|
|
474
422
|
# @see Increase::Models::RealTimeDecision::CardAuthentication#decision
|
|
@@ -689,6 +637,135 @@ module Increase
|
|
|
689
637
|
end
|
|
690
638
|
end
|
|
691
639
|
|
|
640
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication#message_category
|
|
641
|
+
class MessageCategory < Increase::Internal::Type::BaseModel
|
|
642
|
+
# @!attribute category
|
|
643
|
+
# The category of the card authentication attempt.
|
|
644
|
+
#
|
|
645
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Category]
|
|
646
|
+
required :category, enum: -> { Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category }
|
|
647
|
+
|
|
648
|
+
# @!attribute non_payment
|
|
649
|
+
# Fields specific to non-payment authentication attempts.
|
|
650
|
+
#
|
|
651
|
+
# @return [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment, nil]
|
|
652
|
+
required :non_payment,
|
|
653
|
+
-> { Increase::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment },
|
|
654
|
+
nil?: true
|
|
655
|
+
|
|
656
|
+
# @!attribute payment
|
|
657
|
+
# Fields specific to payment authentication attempts.
|
|
658
|
+
#
|
|
659
|
+
# @return [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment, nil]
|
|
660
|
+
required :payment,
|
|
661
|
+
-> { Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment },
|
|
662
|
+
nil?: true
|
|
663
|
+
|
|
664
|
+
# @!method initialize(category:, non_payment:, payment:)
|
|
665
|
+
# The message category of the card authentication attempt.
|
|
666
|
+
#
|
|
667
|
+
# @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Category] The category of the card authentication attempt.
|
|
668
|
+
#
|
|
669
|
+
# @param non_payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment, nil] Fields specific to non-payment authentication attempts.
|
|
670
|
+
#
|
|
671
|
+
# @param payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment, nil] Fields specific to payment authentication attempts.
|
|
672
|
+
|
|
673
|
+
# The category of the card authentication attempt.
|
|
674
|
+
#
|
|
675
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory#category
|
|
676
|
+
module Category
|
|
677
|
+
extend Increase::Internal::Type::Enum
|
|
678
|
+
|
|
679
|
+
# The authentication attempt is for a payment.
|
|
680
|
+
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
681
|
+
|
|
682
|
+
# The authentication attempt is not for a payment.
|
|
683
|
+
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
684
|
+
|
|
685
|
+
# @!method self.values
|
|
686
|
+
# @return [Array<Symbol>]
|
|
687
|
+
end
|
|
688
|
+
|
|
689
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory#non_payment
|
|
690
|
+
class NonPayment < Increase::Internal::Type::BaseModel
|
|
691
|
+
# @!method initialize
|
|
692
|
+
# Fields specific to non-payment authentication attempts.
|
|
693
|
+
end
|
|
694
|
+
|
|
695
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory#payment
|
|
696
|
+
class Payment < Increase::Internal::Type::BaseModel
|
|
697
|
+
# @!attribute purchase_amount
|
|
698
|
+
# The purchase amount in minor units.
|
|
699
|
+
#
|
|
700
|
+
# @return [Integer]
|
|
701
|
+
required :purchase_amount, Integer
|
|
702
|
+
|
|
703
|
+
# @!attribute purchase_amount_cardholder_estimated
|
|
704
|
+
# The purchase amount in the cardholder's currency (i.e., USD) estimated using
|
|
705
|
+
# daily conversion rates from the card network.
|
|
706
|
+
#
|
|
707
|
+
# @return [Integer, nil]
|
|
708
|
+
required :purchase_amount_cardholder_estimated, Integer, nil?: true
|
|
709
|
+
|
|
710
|
+
# @!attribute purchase_currency
|
|
711
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
712
|
+
# authentication attempt's purchase currency.
|
|
713
|
+
#
|
|
714
|
+
# @return [String]
|
|
715
|
+
required :purchase_currency, String
|
|
716
|
+
|
|
717
|
+
# @!attribute transaction_type
|
|
718
|
+
# The type of transaction being authenticated.
|
|
719
|
+
#
|
|
720
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType, nil]
|
|
721
|
+
required :transaction_type,
|
|
722
|
+
enum: -> {
|
|
723
|
+
Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType
|
|
724
|
+
},
|
|
725
|
+
nil?: true
|
|
726
|
+
|
|
727
|
+
# @!method initialize(purchase_amount:, purchase_amount_cardholder_estimated:, purchase_currency:, transaction_type:)
|
|
728
|
+
# Some parameter documentations has been truncated, see
|
|
729
|
+
# {Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment}
|
|
730
|
+
# for more details.
|
|
731
|
+
#
|
|
732
|
+
# Fields specific to payment authentication attempts.
|
|
733
|
+
#
|
|
734
|
+
# @param purchase_amount [Integer] The purchase amount in minor units.
|
|
735
|
+
#
|
|
736
|
+
# @param purchase_amount_cardholder_estimated [Integer, nil] The purchase amount in the cardholder's currency (i.e., USD) estimated using dai
|
|
737
|
+
#
|
|
738
|
+
# @param purchase_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
|
|
739
|
+
#
|
|
740
|
+
# @param transaction_type [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType, nil] The type of transaction being authenticated.
|
|
741
|
+
|
|
742
|
+
# The type of transaction being authenticated.
|
|
743
|
+
#
|
|
744
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment#transaction_type
|
|
745
|
+
module TransactionType
|
|
746
|
+
extend Increase::Internal::Type::Enum
|
|
747
|
+
|
|
748
|
+
# Purchase of goods or services.
|
|
749
|
+
GOODS_SERVICE_PURCHASE = :goods_service_purchase
|
|
750
|
+
|
|
751
|
+
# Check acceptance.
|
|
752
|
+
CHECK_ACCEPTANCE = :check_acceptance
|
|
753
|
+
|
|
754
|
+
# Account funding.
|
|
755
|
+
ACCOUNT_FUNDING = :account_funding
|
|
756
|
+
|
|
757
|
+
# Quasi-cash transaction.
|
|
758
|
+
QUASI_CASH_TRANSACTION = :quasi_cash_transaction
|
|
759
|
+
|
|
760
|
+
# Prepaid activation and load.
|
|
761
|
+
PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
|
|
762
|
+
|
|
763
|
+
# @!method self.values
|
|
764
|
+
# @return [Array<Symbol>]
|
|
765
|
+
end
|
|
766
|
+
end
|
|
767
|
+
end
|
|
768
|
+
|
|
692
769
|
# The 3DS requestor authentication indicator describes why the authentication
|
|
693
770
|
# attempt is performed, such as for a recurring transaction.
|
|
694
771
|
#
|
|
@@ -761,31 +838,6 @@ module Increase
|
|
|
761
838
|
# @!method self.values
|
|
762
839
|
# @return [Array<Symbol>]
|
|
763
840
|
end
|
|
764
|
-
|
|
765
|
-
# The type of transaction being authenticated.
|
|
766
|
-
#
|
|
767
|
-
# @see Increase::Models::RealTimeDecision::CardAuthentication#transaction_type
|
|
768
|
-
module TransactionType
|
|
769
|
-
extend Increase::Internal::Type::Enum
|
|
770
|
-
|
|
771
|
-
# Purchase of goods or services.
|
|
772
|
-
GOODS_SERVICE_PURCHASE = :goods_service_purchase
|
|
773
|
-
|
|
774
|
-
# Check acceptance.
|
|
775
|
-
CHECK_ACCEPTANCE = :check_acceptance
|
|
776
|
-
|
|
777
|
-
# Account funding.
|
|
778
|
-
ACCOUNT_FUNDING = :account_funding
|
|
779
|
-
|
|
780
|
-
# Quasi-cash transaction.
|
|
781
|
-
QUASI_CASH_TRANSACTION = :quasi_cash_transaction
|
|
782
|
-
|
|
783
|
-
# Prepaid activation and load.
|
|
784
|
-
PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
|
|
785
|
-
|
|
786
|
-
# @!method self.values
|
|
787
|
-
# @return [Array<Symbol>]
|
|
788
|
-
end
|
|
789
841
|
end
|
|
790
842
|
|
|
791
843
|
# @see Increase::Models::RealTimeDecision#card_authentication_challenge
|
data/lib/increase/version.rb
CHANGED