increase 1.19.0 → 1.21.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.
@@ -643,6 +643,17 @@ module Increase
643
643
  # @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Actioner]
644
644
  required :actioner, enum: -> { Increase::CardPayment::Element::CardAuthorization::Actioner }
645
645
 
646
+ # @!attribute additional_amounts
647
+ # Additional amounts associated with the card authorization, such as ATM
648
+ # surcharges fees. These are usually a subset of the `amount` field and are used
649
+ # to provide more detailed information about the transaction.
650
+ #
651
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts]
652
+ required :additional_amounts,
653
+ -> {
654
+ Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts
655
+ }
656
+
646
657
  # @!attribute amount
647
658
  # The pending amount in the minor unit of the transaction's currency. For dollars,
648
659
  # for example, this is cents.
@@ -810,7 +821,7 @@ module Increase
810
821
  # @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification]
811
822
  required :verification, -> { Increase::CardPayment::Element::CardAuthorization::Verification }
812
823
 
813
- # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, type:, verification:)
824
+ # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, type:, verification:)
814
825
  # Some parameter documentations has been truncated, see
815
826
  # {Increase::Models::CardPayment::Element::CardAuthorization} for more details.
816
827
  #
@@ -823,6 +834,8 @@ module Increase
823
834
  #
824
835
  # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Actioner] Whether this authorization was approved by Increase, the card network through st
825
836
  #
837
+ # @param additional_amounts [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
838
+ #
826
839
  # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars,
827
840
  #
828
841
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
@@ -893,6 +906,357 @@ module Increase
893
906
  # @return [Array<Symbol>]
894
907
  end
895
908
 
909
+ # @see Increase::Models::CardPayment::Element::CardAuthorization#additional_amounts
910
+ class AdditionalAmounts < Increase::Internal::Type::BaseModel
911
+ # @!attribute clinic
912
+ # The part of this transaction amount that was for clinic-related services.
913
+ #
914
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Clinic, nil]
915
+ required :clinic,
916
+ -> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Clinic },
917
+ nil?: true
918
+
919
+ # @!attribute dental
920
+ # The part of this transaction amount that was for dental-related services.
921
+ #
922
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Dental, nil]
923
+ required :dental,
924
+ -> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Dental },
925
+ nil?: true
926
+
927
+ # @!attribute prescription
928
+ # The part of this transaction amount that was for healthcare prescriptions.
929
+ #
930
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Prescription, nil]
931
+ required :prescription,
932
+ -> {
933
+ Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Prescription
934
+ },
935
+ nil?: true
936
+
937
+ # @!attribute surcharge
938
+ # The surcharge amount charged for this transaction by the merchant.
939
+ #
940
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Surcharge, nil]
941
+ required :surcharge,
942
+ -> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Surcharge },
943
+ nil?: true
944
+
945
+ # @!attribute total_cumulative
946
+ # The total amount of a series of incremental authorizations, optionally provided.
947
+ #
948
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalCumulative, nil]
949
+ required :total_cumulative,
950
+ -> {
951
+ Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalCumulative
952
+ },
953
+ nil?: true
954
+
955
+ # @!attribute total_healthcare
956
+ # The total amount of healthcare-related additional amounts.
957
+ #
958
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalHealthcare, nil]
959
+ required :total_healthcare,
960
+ -> {
961
+ Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalHealthcare
962
+ },
963
+ nil?: true
964
+
965
+ # @!attribute transit
966
+ # The part of this transaction amount that was for transit-related services.
967
+ #
968
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Transit, nil]
969
+ required :transit,
970
+ -> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Transit },
971
+ nil?: true
972
+
973
+ # @!attribute unknown
974
+ # An unknown additional amount.
975
+ #
976
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown, nil]
977
+ required :unknown,
978
+ -> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown },
979
+ nil?: true
980
+
981
+ # @!attribute vision
982
+ # The part of this transaction amount that was for vision-related services.
983
+ #
984
+ # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision, nil]
985
+ required :vision,
986
+ -> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision },
987
+ nil?: true
988
+
989
+ # @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
990
+ # Some parameter documentations has been truncated, see
991
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts}
992
+ # for more details.
993
+ #
994
+ # Additional amounts associated with the card authorization, such as ATM
995
+ # surcharges fees. These are usually a subset of the `amount` field and are used
996
+ # to provide more detailed information about the transaction.
997
+ #
998
+ # @param clinic [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
999
+ #
1000
+ # @param dental [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
1001
+ #
1002
+ # @param prescription [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
1003
+ #
1004
+ # @param surcharge [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
1005
+ #
1006
+ # @param total_cumulative [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
1007
+ #
1008
+ # @param total_healthcare [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
1009
+ #
1010
+ # @param transit [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
1011
+ #
1012
+ # @param unknown [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown, nil] An unknown additional amount.
1013
+ #
1014
+ # @param vision [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
1015
+
1016
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#clinic
1017
+ class Clinic < Increase::Internal::Type::BaseModel
1018
+ # @!attribute amount
1019
+ # The amount in minor units of the `currency` field.
1020
+ #
1021
+ # @return [Integer]
1022
+ required :amount, Integer
1023
+
1024
+ # @!attribute currency
1025
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1026
+ # amount's currency.
1027
+ #
1028
+ # @return [String]
1029
+ required :currency, String
1030
+
1031
+ # @!method initialize(amount:, currency:)
1032
+ # Some parameter documentations has been truncated, see
1033
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Clinic}
1034
+ # for more details.
1035
+ #
1036
+ # The part of this transaction amount that was for clinic-related services.
1037
+ #
1038
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1039
+ #
1040
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1041
+ end
1042
+
1043
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#dental
1044
+ class Dental < Increase::Internal::Type::BaseModel
1045
+ # @!attribute amount
1046
+ # The amount in minor units of the `currency` field.
1047
+ #
1048
+ # @return [Integer]
1049
+ required :amount, Integer
1050
+
1051
+ # @!attribute currency
1052
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1053
+ # amount's currency.
1054
+ #
1055
+ # @return [String]
1056
+ required :currency, String
1057
+
1058
+ # @!method initialize(amount:, currency:)
1059
+ # Some parameter documentations has been truncated, see
1060
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Dental}
1061
+ # for more details.
1062
+ #
1063
+ # The part of this transaction amount that was for dental-related services.
1064
+ #
1065
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1066
+ #
1067
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1068
+ end
1069
+
1070
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#prescription
1071
+ class Prescription < Increase::Internal::Type::BaseModel
1072
+ # @!attribute amount
1073
+ # The amount in minor units of the `currency` field.
1074
+ #
1075
+ # @return [Integer]
1076
+ required :amount, Integer
1077
+
1078
+ # @!attribute currency
1079
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1080
+ # amount's currency.
1081
+ #
1082
+ # @return [String]
1083
+ required :currency, String
1084
+
1085
+ # @!method initialize(amount:, currency:)
1086
+ # Some parameter documentations has been truncated, see
1087
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Prescription}
1088
+ # for more details.
1089
+ #
1090
+ # The part of this transaction amount that was for healthcare prescriptions.
1091
+ #
1092
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1093
+ #
1094
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1095
+ end
1096
+
1097
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#surcharge
1098
+ class Surcharge < Increase::Internal::Type::BaseModel
1099
+ # @!attribute amount
1100
+ # The amount in minor units of the `currency` field.
1101
+ #
1102
+ # @return [Integer]
1103
+ required :amount, Integer
1104
+
1105
+ # @!attribute currency
1106
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1107
+ # amount's currency.
1108
+ #
1109
+ # @return [String]
1110
+ required :currency, String
1111
+
1112
+ # @!method initialize(amount:, currency:)
1113
+ # Some parameter documentations has been truncated, see
1114
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Surcharge}
1115
+ # for more details.
1116
+ #
1117
+ # The surcharge amount charged for this transaction by the merchant.
1118
+ #
1119
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1120
+ #
1121
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1122
+ end
1123
+
1124
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#total_cumulative
1125
+ class TotalCumulative < Increase::Internal::Type::BaseModel
1126
+ # @!attribute amount
1127
+ # The amount in minor units of the `currency` field.
1128
+ #
1129
+ # @return [Integer]
1130
+ required :amount, Integer
1131
+
1132
+ # @!attribute currency
1133
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1134
+ # amount's currency.
1135
+ #
1136
+ # @return [String]
1137
+ required :currency, String
1138
+
1139
+ # @!method initialize(amount:, currency:)
1140
+ # Some parameter documentations has been truncated, see
1141
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalCumulative}
1142
+ # for more details.
1143
+ #
1144
+ # The total amount of a series of incremental authorizations, optionally provided.
1145
+ #
1146
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1147
+ #
1148
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1149
+ end
1150
+
1151
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#total_healthcare
1152
+ class TotalHealthcare < Increase::Internal::Type::BaseModel
1153
+ # @!attribute amount
1154
+ # The amount in minor units of the `currency` field.
1155
+ #
1156
+ # @return [Integer]
1157
+ required :amount, Integer
1158
+
1159
+ # @!attribute currency
1160
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1161
+ # amount's currency.
1162
+ #
1163
+ # @return [String]
1164
+ required :currency, String
1165
+
1166
+ # @!method initialize(amount:, currency:)
1167
+ # Some parameter documentations has been truncated, see
1168
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::TotalHealthcare}
1169
+ # for more details.
1170
+ #
1171
+ # The total amount of healthcare-related additional amounts.
1172
+ #
1173
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1174
+ #
1175
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1176
+ end
1177
+
1178
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#transit
1179
+ class Transit < Increase::Internal::Type::BaseModel
1180
+ # @!attribute amount
1181
+ # The amount in minor units of the `currency` field.
1182
+ #
1183
+ # @return [Integer]
1184
+ required :amount, Integer
1185
+
1186
+ # @!attribute currency
1187
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1188
+ # amount's currency.
1189
+ #
1190
+ # @return [String]
1191
+ required :currency, String
1192
+
1193
+ # @!method initialize(amount:, currency:)
1194
+ # Some parameter documentations has been truncated, see
1195
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Transit}
1196
+ # for more details.
1197
+ #
1198
+ # The part of this transaction amount that was for transit-related services.
1199
+ #
1200
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1201
+ #
1202
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1203
+ end
1204
+
1205
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#unknown
1206
+ class Unknown < Increase::Internal::Type::BaseModel
1207
+ # @!attribute amount
1208
+ # The amount in minor units of the `currency` field.
1209
+ #
1210
+ # @return [Integer]
1211
+ required :amount, Integer
1212
+
1213
+ # @!attribute currency
1214
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1215
+ # amount's currency.
1216
+ #
1217
+ # @return [String]
1218
+ required :currency, String
1219
+
1220
+ # @!method initialize(amount:, currency:)
1221
+ # Some parameter documentations has been truncated, see
1222
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Unknown}
1223
+ # for more details.
1224
+ #
1225
+ # An unknown additional amount.
1226
+ #
1227
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1228
+ #
1229
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1230
+ end
1231
+
1232
+ # @see Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts#vision
1233
+ class Vision < Increase::Internal::Type::BaseModel
1234
+ # @!attribute amount
1235
+ # The amount in minor units of the `currency` field.
1236
+ #
1237
+ # @return [Integer]
1238
+ required :amount, Integer
1239
+
1240
+ # @!attribute currency
1241
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1242
+ # amount's currency.
1243
+ #
1244
+ # @return [String]
1245
+ required :currency, String
1246
+
1247
+ # @!method initialize(amount:, currency:)
1248
+ # Some parameter documentations has been truncated, see
1249
+ # {Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Vision}
1250
+ # for more details.
1251
+ #
1252
+ # The part of this transaction amount that was for vision-related services.
1253
+ #
1254
+ # @param amount [Integer] The amount in minor units of the `currency` field.
1255
+ #
1256
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1257
+ end
1258
+ end
1259
+
896
1260
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
897
1261
  # transaction's currency.
898
1262
  #
@@ -1520,6 +1884,14 @@ module Increase
1520
1884
  # @return [Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner]
1521
1885
  required :actioner, enum: -> { Increase::CardPayment::Element::CardDecline::Actioner }
1522
1886
 
1887
+ # @!attribute additional_amounts
1888
+ # Additional amounts associated with the card authorization, such as ATM
1889
+ # surcharges fees. These are usually a subset of the `amount` field and are used
1890
+ # to provide more detailed information about the transaction.
1891
+ #
1892
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts]
1893
+ required :additional_amounts, -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts }
1894
+
1523
1895
  # @!attribute amount
1524
1896
  # The declined amount in the minor unit of the destination account currency. For
1525
1897
  # dollars, for example, this is cents.
@@ -1560,6 +1932,13 @@ module Increase
1560
1932
  # @return [Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction]
1561
1933
  required :direction, enum: -> { Increase::CardPayment::Element::CardDecline::Direction }
1562
1934
 
1935
+ # @!attribute incremented_card_authorization_id
1936
+ # The identifier of the card authorization this request attempted to incrementally
1937
+ # authorize.
1938
+ #
1939
+ # @return [String, nil]
1940
+ required :incremented_card_authorization_id, String, nil?: true
1941
+
1563
1942
  # @!attribute merchant_acceptor_id
1564
1943
  # The merchant identifier (commonly abbreviated as MID) of the merchant the card
1565
1944
  # is transacting with.
@@ -1690,7 +2069,7 @@ module Increase
1690
2069
  # @return [Increase::Models::CardPayment::Element::CardDecline::Verification]
1691
2070
  required :verification, -> { Increase::CardPayment::Element::CardDecline::Verification }
1692
2071
 
1693
- # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, terminal_id:, verification:)
2072
+ # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, incremented_card_authorization_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, terminal_id:, verification:)
1694
2073
  # Some parameter documentations has been truncated, see
1695
2074
  # {Increase::Models::CardPayment::Element::CardDecline} for more details.
1696
2075
  #
@@ -1701,6 +2080,8 @@ module Increase
1701
2080
  #
1702
2081
  # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner] Whether this authorization was approved by Increase, the card network through st
1703
2082
  #
2083
+ # @param additional_amounts [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
2084
+ #
1704
2085
  # @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d
1705
2086
  #
1706
2087
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
@@ -1713,6 +2094,8 @@ module Increase
1713
2094
  #
1714
2095
  # @param direction [Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction] The direction describes the direction the funds will move, either from the cardh
1715
2096
  #
2097
+ # @param incremented_card_authorization_id [String, nil] The identifier of the card authorization this request attempted to incrementally
2098
+ #
1716
2099
  # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1717
2100
  #
1718
2101
  # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
@@ -1771,6 +2154,351 @@ module Increase
1771
2154
  # @return [Array<Symbol>]
1772
2155
  end
1773
2156
 
2157
+ # @see Increase::Models::CardPayment::Element::CardDecline#additional_amounts
2158
+ class AdditionalAmounts < Increase::Internal::Type::BaseModel
2159
+ # @!attribute clinic
2160
+ # The part of this transaction amount that was for clinic-related services.
2161
+ #
2162
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic, nil]
2163
+ required :clinic,
2164
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic },
2165
+ nil?: true
2166
+
2167
+ # @!attribute dental
2168
+ # The part of this transaction amount that was for dental-related services.
2169
+ #
2170
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Dental, nil]
2171
+ required :dental,
2172
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Dental },
2173
+ nil?: true
2174
+
2175
+ # @!attribute prescription
2176
+ # The part of this transaction amount that was for healthcare prescriptions.
2177
+ #
2178
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription, nil]
2179
+ required :prescription,
2180
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription },
2181
+ nil?: true
2182
+
2183
+ # @!attribute surcharge
2184
+ # The surcharge amount charged for this transaction by the merchant.
2185
+ #
2186
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge, nil]
2187
+ required :surcharge,
2188
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge },
2189
+ nil?: true
2190
+
2191
+ # @!attribute total_cumulative
2192
+ # The total amount of a series of incremental authorizations, optionally provided.
2193
+ #
2194
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative, nil]
2195
+ required :total_cumulative,
2196
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative },
2197
+ nil?: true
2198
+
2199
+ # @!attribute total_healthcare
2200
+ # The total amount of healthcare-related additional amounts.
2201
+ #
2202
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare, nil]
2203
+ required :total_healthcare,
2204
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare },
2205
+ nil?: true
2206
+
2207
+ # @!attribute transit
2208
+ # The part of this transaction amount that was for transit-related services.
2209
+ #
2210
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Transit, nil]
2211
+ required :transit,
2212
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Transit },
2213
+ nil?: true
2214
+
2215
+ # @!attribute unknown
2216
+ # An unknown additional amount.
2217
+ #
2218
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown, nil]
2219
+ required :unknown,
2220
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown },
2221
+ nil?: true
2222
+
2223
+ # @!attribute vision
2224
+ # The part of this transaction amount that was for vision-related services.
2225
+ #
2226
+ # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Vision, nil]
2227
+ required :vision,
2228
+ -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Vision },
2229
+ nil?: true
2230
+
2231
+ # @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
2232
+ # Some parameter documentations has been truncated, see
2233
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts} for
2234
+ # more details.
2235
+ #
2236
+ # Additional amounts associated with the card authorization, such as ATM
2237
+ # surcharges fees. These are usually a subset of the `amount` field and are used
2238
+ # to provide more detailed information about the transaction.
2239
+ #
2240
+ # @param clinic [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
2241
+ #
2242
+ # @param dental [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
2243
+ #
2244
+ # @param prescription [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
2245
+ #
2246
+ # @param surcharge [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
2247
+ #
2248
+ # @param total_cumulative [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
2249
+ #
2250
+ # @param total_healthcare [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
2251
+ #
2252
+ # @param transit [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
2253
+ #
2254
+ # @param unknown [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown, nil] An unknown additional amount.
2255
+ #
2256
+ # @param vision [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
2257
+
2258
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#clinic
2259
+ class Clinic < Increase::Internal::Type::BaseModel
2260
+ # @!attribute amount
2261
+ # The amount in minor units of the `currency` field.
2262
+ #
2263
+ # @return [Integer]
2264
+ required :amount, Integer
2265
+
2266
+ # @!attribute currency
2267
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2268
+ # amount's currency.
2269
+ #
2270
+ # @return [String]
2271
+ required :currency, String
2272
+
2273
+ # @!method initialize(amount:, currency:)
2274
+ # Some parameter documentations has been truncated, see
2275
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic}
2276
+ # for more details.
2277
+ #
2278
+ # The part of this transaction amount that was for clinic-related services.
2279
+ #
2280
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2281
+ #
2282
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2283
+ end
2284
+
2285
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#dental
2286
+ class Dental < Increase::Internal::Type::BaseModel
2287
+ # @!attribute amount
2288
+ # The amount in minor units of the `currency` field.
2289
+ #
2290
+ # @return [Integer]
2291
+ required :amount, Integer
2292
+
2293
+ # @!attribute currency
2294
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2295
+ # amount's currency.
2296
+ #
2297
+ # @return [String]
2298
+ required :currency, String
2299
+
2300
+ # @!method initialize(amount:, currency:)
2301
+ # Some parameter documentations has been truncated, see
2302
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Dental}
2303
+ # for more details.
2304
+ #
2305
+ # The part of this transaction amount that was for dental-related services.
2306
+ #
2307
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2308
+ #
2309
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2310
+ end
2311
+
2312
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#prescription
2313
+ class Prescription < Increase::Internal::Type::BaseModel
2314
+ # @!attribute amount
2315
+ # The amount in minor units of the `currency` field.
2316
+ #
2317
+ # @return [Integer]
2318
+ required :amount, Integer
2319
+
2320
+ # @!attribute currency
2321
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2322
+ # amount's currency.
2323
+ #
2324
+ # @return [String]
2325
+ required :currency, String
2326
+
2327
+ # @!method initialize(amount:, currency:)
2328
+ # Some parameter documentations has been truncated, see
2329
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription}
2330
+ # for more details.
2331
+ #
2332
+ # The part of this transaction amount that was for healthcare prescriptions.
2333
+ #
2334
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2335
+ #
2336
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2337
+ end
2338
+
2339
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#surcharge
2340
+ class Surcharge < Increase::Internal::Type::BaseModel
2341
+ # @!attribute amount
2342
+ # The amount in minor units of the `currency` field.
2343
+ #
2344
+ # @return [Integer]
2345
+ required :amount, Integer
2346
+
2347
+ # @!attribute currency
2348
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2349
+ # amount's currency.
2350
+ #
2351
+ # @return [String]
2352
+ required :currency, String
2353
+
2354
+ # @!method initialize(amount:, currency:)
2355
+ # Some parameter documentations has been truncated, see
2356
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge}
2357
+ # for more details.
2358
+ #
2359
+ # The surcharge amount charged for this transaction by the merchant.
2360
+ #
2361
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2362
+ #
2363
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2364
+ end
2365
+
2366
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#total_cumulative
2367
+ class TotalCumulative < Increase::Internal::Type::BaseModel
2368
+ # @!attribute amount
2369
+ # The amount in minor units of the `currency` field.
2370
+ #
2371
+ # @return [Integer]
2372
+ required :amount, Integer
2373
+
2374
+ # @!attribute currency
2375
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2376
+ # amount's currency.
2377
+ #
2378
+ # @return [String]
2379
+ required :currency, String
2380
+
2381
+ # @!method initialize(amount:, currency:)
2382
+ # Some parameter documentations has been truncated, see
2383
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative}
2384
+ # for more details.
2385
+ #
2386
+ # The total amount of a series of incremental authorizations, optionally provided.
2387
+ #
2388
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2389
+ #
2390
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2391
+ end
2392
+
2393
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#total_healthcare
2394
+ class TotalHealthcare < Increase::Internal::Type::BaseModel
2395
+ # @!attribute amount
2396
+ # The amount in minor units of the `currency` field.
2397
+ #
2398
+ # @return [Integer]
2399
+ required :amount, Integer
2400
+
2401
+ # @!attribute currency
2402
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2403
+ # amount's currency.
2404
+ #
2405
+ # @return [String]
2406
+ required :currency, String
2407
+
2408
+ # @!method initialize(amount:, currency:)
2409
+ # Some parameter documentations has been truncated, see
2410
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare}
2411
+ # for more details.
2412
+ #
2413
+ # The total amount of healthcare-related additional amounts.
2414
+ #
2415
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2416
+ #
2417
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2418
+ end
2419
+
2420
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#transit
2421
+ class Transit < Increase::Internal::Type::BaseModel
2422
+ # @!attribute amount
2423
+ # The amount in minor units of the `currency` field.
2424
+ #
2425
+ # @return [Integer]
2426
+ required :amount, Integer
2427
+
2428
+ # @!attribute currency
2429
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2430
+ # amount's currency.
2431
+ #
2432
+ # @return [String]
2433
+ required :currency, String
2434
+
2435
+ # @!method initialize(amount:, currency:)
2436
+ # Some parameter documentations has been truncated, see
2437
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Transit}
2438
+ # for more details.
2439
+ #
2440
+ # The part of this transaction amount that was for transit-related services.
2441
+ #
2442
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2443
+ #
2444
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2445
+ end
2446
+
2447
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#unknown
2448
+ class Unknown < Increase::Internal::Type::BaseModel
2449
+ # @!attribute amount
2450
+ # The amount in minor units of the `currency` field.
2451
+ #
2452
+ # @return [Integer]
2453
+ required :amount, Integer
2454
+
2455
+ # @!attribute currency
2456
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2457
+ # amount's currency.
2458
+ #
2459
+ # @return [String]
2460
+ required :currency, String
2461
+
2462
+ # @!method initialize(amount:, currency:)
2463
+ # Some parameter documentations has been truncated, see
2464
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown}
2465
+ # for more details.
2466
+ #
2467
+ # An unknown additional amount.
2468
+ #
2469
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2470
+ #
2471
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2472
+ end
2473
+
2474
+ # @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#vision
2475
+ class Vision < Increase::Internal::Type::BaseModel
2476
+ # @!attribute amount
2477
+ # The amount in minor units of the `currency` field.
2478
+ #
2479
+ # @return [Integer]
2480
+ required :amount, Integer
2481
+
2482
+ # @!attribute currency
2483
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2484
+ # amount's currency.
2485
+ #
2486
+ # @return [String]
2487
+ required :currency, String
2488
+
2489
+ # @!method initialize(amount:, currency:)
2490
+ # Some parameter documentations has been truncated, see
2491
+ # {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Vision}
2492
+ # for more details.
2493
+ #
2494
+ # The part of this transaction amount that was for vision-related services.
2495
+ #
2496
+ # @param amount [Integer] The amount in minor units of the `currency` field.
2497
+ #
2498
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2499
+ end
2500
+ end
2501
+
1774
2502
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1775
2503
  # account currency.
1776
2504
  #
@@ -2536,6 +3264,17 @@ module Increase
2536
3264
  # @return [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner]
2537
3265
  required :actioner, enum: -> { Increase::CardPayment::Element::CardIncrement::Actioner }
2538
3266
 
3267
+ # @!attribute additional_amounts
3268
+ # Additional amounts associated with the card authorization, such as ATM
3269
+ # surcharges fees. These are usually a subset of the `amount` field and are used
3270
+ # to provide more detailed information about the transaction.
3271
+ #
3272
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts]
3273
+ required :additional_amounts,
3274
+ -> {
3275
+ Increase::CardPayment::Element::CardIncrement::AdditionalAmounts
3276
+ }
3277
+
2539
3278
  # @!attribute amount
2540
3279
  # The amount of this increment in the minor unit of the transaction's currency.
2541
3280
  # For dollars, for example, this is cents.
@@ -2571,90 +3310,455 @@ module Increase
2571
3310
  Increase::CardPayment::Element::CardIncrement::NetworkIdentifiers
2572
3311
  }
2573
3312
 
2574
- # @!attribute network_risk_score
2575
- # The risk score generated by the card network. For Visa this is the Visa Advanced
2576
- # Authorization risk score, from 0 to 99, where 99 is the riskiest.
2577
- #
2578
- # @return [Integer, nil]
2579
- required :network_risk_score, Integer, nil?: true
3313
+ # @!attribute network_risk_score
3314
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
3315
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest.
3316
+ #
3317
+ # @return [Integer, nil]
3318
+ required :network_risk_score, Integer, nil?: true
3319
+
3320
+ # @!attribute pending_transaction_id
3321
+ # The identifier of the Pending Transaction associated with this Card Increment.
3322
+ #
3323
+ # @return [String, nil]
3324
+ required :pending_transaction_id, String, nil?: true
3325
+
3326
+ # @!attribute presentment_amount
3327
+ # The amount of this increment in the minor unit of the transaction's presentment
3328
+ # currency.
3329
+ #
3330
+ # @return [Integer]
3331
+ required :presentment_amount, Integer
3332
+
3333
+ # @!attribute presentment_currency
3334
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
3335
+ # transaction's presentment currency.
3336
+ #
3337
+ # @return [String]
3338
+ required :presentment_currency, String
3339
+
3340
+ # @!attribute real_time_decision_id
3341
+ # The identifier of the Real-Time Decision sent to approve or decline this
3342
+ # incremental authorization.
3343
+ #
3344
+ # @return [String, nil]
3345
+ required :real_time_decision_id, String, nil?: true
3346
+
3347
+ # @!attribute type
3348
+ # A constant representing the object's type. For this resource it will always be
3349
+ # `card_increment`.
3350
+ #
3351
+ # @return [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type]
3352
+ required :type, enum: -> { Increase::CardPayment::Element::CardIncrement::Type }
3353
+
3354
+ # @!attribute updated_authorization_amount
3355
+ # The updated authorization amount after this increment, in the minor unit of the
3356
+ # transaction's currency. For dollars, for example, this is cents.
3357
+ #
3358
+ # @return [Integer]
3359
+ required :updated_authorization_amount, Integer
3360
+
3361
+ # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_authorization_id:, currency:, network:, network_identifiers:, network_risk_score:, pending_transaction_id:, presentment_amount:, presentment_currency:, real_time_decision_id:, type:, updated_authorization_amount:)
3362
+ # Some parameter documentations has been truncated, see
3363
+ # {Increase::Models::CardPayment::Element::CardIncrement} for more details.
3364
+ #
3365
+ # A Card Increment object. This field will be present in the JSON response if and
3366
+ # only if `category` is equal to `card_increment`. Card Increments increase the
3367
+ # pending amount of an authorized transaction.
3368
+ #
3369
+ # @param id [String] The Card Increment identifier.
3370
+ #
3371
+ # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner] Whether this authorization was approved by Increase, the card network through st
3372
+ #
3373
+ # @param additional_amounts [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
3374
+ #
3375
+ # @param amount [Integer] The amount of this increment in the minor unit of the transaction's currency. Fo
3376
+ #
3377
+ # @param card_authorization_id [String] The identifier for the Card Authorization this increments.
3378
+ #
3379
+ # @param currency [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
3380
+ #
3381
+ # @param network [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network] The card network used to process this card authorization.
3382
+ #
3383
+ # @param network_identifiers [Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
3384
+ #
3385
+ # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
3386
+ #
3387
+ # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Card Increment.
3388
+ #
3389
+ # @param presentment_amount [Integer] The amount of this increment in the minor unit of the transaction's presentment
3390
+ #
3391
+ # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
3392
+ #
3393
+ # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this increme
3394
+ #
3395
+ # @param type [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type] A constant representing the object's type. For this resource it will always be `
3396
+ #
3397
+ # @param updated_authorization_amount [Integer] The updated authorization amount after this increment, in the minor unit of the
3398
+
3399
+ # Whether this authorization was approved by Increase, the card network through
3400
+ # stand-in processing, or the user through a real-time decision.
3401
+ #
3402
+ # @see Increase::Models::CardPayment::Element::CardIncrement#actioner
3403
+ module Actioner
3404
+ extend Increase::Internal::Type::Enum
3405
+
3406
+ # This object was actioned by the user through a real-time decision.
3407
+ USER = :user
3408
+
3409
+ # This object was actioned by Increase without user intervention.
3410
+ INCREASE = :increase
3411
+
3412
+ # This object was actioned by the network, through stand-in processing.
3413
+ NETWORK = :network
3414
+
3415
+ # @!method self.values
3416
+ # @return [Array<Symbol>]
3417
+ end
3418
+
3419
+ # @see Increase::Models::CardPayment::Element::CardIncrement#additional_amounts
3420
+ class AdditionalAmounts < Increase::Internal::Type::BaseModel
3421
+ # @!attribute clinic
3422
+ # The part of this transaction amount that was for clinic-related services.
3423
+ #
3424
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic, nil]
3425
+ required :clinic,
3426
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic },
3427
+ nil?: true
3428
+
3429
+ # @!attribute dental
3430
+ # The part of this transaction amount that was for dental-related services.
3431
+ #
3432
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental, nil]
3433
+ required :dental,
3434
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental },
3435
+ nil?: true
3436
+
3437
+ # @!attribute prescription
3438
+ # The part of this transaction amount that was for healthcare prescriptions.
3439
+ #
3440
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription, nil]
3441
+ required :prescription,
3442
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription },
3443
+ nil?: true
3444
+
3445
+ # @!attribute surcharge
3446
+ # The surcharge amount charged for this transaction by the merchant.
3447
+ #
3448
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge, nil]
3449
+ required :surcharge,
3450
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge },
3451
+ nil?: true
3452
+
3453
+ # @!attribute total_cumulative
3454
+ # The total amount of a series of incremental authorizations, optionally provided.
3455
+ #
3456
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative, nil]
3457
+ required :total_cumulative,
3458
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative },
3459
+ nil?: true
3460
+
3461
+ # @!attribute total_healthcare
3462
+ # The total amount of healthcare-related additional amounts.
3463
+ #
3464
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare, nil]
3465
+ required :total_healthcare,
3466
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare },
3467
+ nil?: true
3468
+
3469
+ # @!attribute transit
3470
+ # The part of this transaction amount that was for transit-related services.
3471
+ #
3472
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit, nil]
3473
+ required :transit,
3474
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit },
3475
+ nil?: true
3476
+
3477
+ # @!attribute unknown
3478
+ # An unknown additional amount.
3479
+ #
3480
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown, nil]
3481
+ required :unknown,
3482
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown },
3483
+ nil?: true
3484
+
3485
+ # @!attribute vision
3486
+ # The part of this transaction amount that was for vision-related services.
3487
+ #
3488
+ # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision, nil]
3489
+ required :vision,
3490
+ -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision },
3491
+ nil?: true
3492
+
3493
+ # @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
3494
+ # Some parameter documentations has been truncated, see
3495
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts} for
3496
+ # more details.
3497
+ #
3498
+ # Additional amounts associated with the card authorization, such as ATM
3499
+ # surcharges fees. These are usually a subset of the `amount` field and are used
3500
+ # to provide more detailed information about the transaction.
3501
+ #
3502
+ # @param clinic [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
3503
+ #
3504
+ # @param dental [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
3505
+ #
3506
+ # @param prescription [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
3507
+ #
3508
+ # @param surcharge [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
3509
+ #
3510
+ # @param total_cumulative [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
3511
+ #
3512
+ # @param total_healthcare [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
3513
+ #
3514
+ # @param transit [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
3515
+ #
3516
+ # @param unknown [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown, nil] An unknown additional amount.
3517
+ #
3518
+ # @param vision [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
3519
+
3520
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#clinic
3521
+ class Clinic < Increase::Internal::Type::BaseModel
3522
+ # @!attribute amount
3523
+ # The amount in minor units of the `currency` field.
3524
+ #
3525
+ # @return [Integer]
3526
+ required :amount, Integer
3527
+
3528
+ # @!attribute currency
3529
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3530
+ # amount's currency.
3531
+ #
3532
+ # @return [String]
3533
+ required :currency, String
3534
+
3535
+ # @!method initialize(amount:, currency:)
3536
+ # Some parameter documentations has been truncated, see
3537
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic}
3538
+ # for more details.
3539
+ #
3540
+ # The part of this transaction amount that was for clinic-related services.
3541
+ #
3542
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3543
+ #
3544
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3545
+ end
3546
+
3547
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#dental
3548
+ class Dental < Increase::Internal::Type::BaseModel
3549
+ # @!attribute amount
3550
+ # The amount in minor units of the `currency` field.
3551
+ #
3552
+ # @return [Integer]
3553
+ required :amount, Integer
3554
+
3555
+ # @!attribute currency
3556
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3557
+ # amount's currency.
3558
+ #
3559
+ # @return [String]
3560
+ required :currency, String
3561
+
3562
+ # @!method initialize(amount:, currency:)
3563
+ # Some parameter documentations has been truncated, see
3564
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental}
3565
+ # for more details.
3566
+ #
3567
+ # The part of this transaction amount that was for dental-related services.
3568
+ #
3569
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3570
+ #
3571
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3572
+ end
3573
+
3574
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#prescription
3575
+ class Prescription < Increase::Internal::Type::BaseModel
3576
+ # @!attribute amount
3577
+ # The amount in minor units of the `currency` field.
3578
+ #
3579
+ # @return [Integer]
3580
+ required :amount, Integer
3581
+
3582
+ # @!attribute currency
3583
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3584
+ # amount's currency.
3585
+ #
3586
+ # @return [String]
3587
+ required :currency, String
3588
+
3589
+ # @!method initialize(amount:, currency:)
3590
+ # Some parameter documentations has been truncated, see
3591
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription}
3592
+ # for more details.
3593
+ #
3594
+ # The part of this transaction amount that was for healthcare prescriptions.
3595
+ #
3596
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3597
+ #
3598
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3599
+ end
3600
+
3601
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#surcharge
3602
+ class Surcharge < Increase::Internal::Type::BaseModel
3603
+ # @!attribute amount
3604
+ # The amount in minor units of the `currency` field.
3605
+ #
3606
+ # @return [Integer]
3607
+ required :amount, Integer
3608
+
3609
+ # @!attribute currency
3610
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3611
+ # amount's currency.
3612
+ #
3613
+ # @return [String]
3614
+ required :currency, String
3615
+
3616
+ # @!method initialize(amount:, currency:)
3617
+ # Some parameter documentations has been truncated, see
3618
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge}
3619
+ # for more details.
3620
+ #
3621
+ # The surcharge amount charged for this transaction by the merchant.
3622
+ #
3623
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3624
+ #
3625
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3626
+ end
3627
+
3628
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#total_cumulative
3629
+ class TotalCumulative < Increase::Internal::Type::BaseModel
3630
+ # @!attribute amount
3631
+ # The amount in minor units of the `currency` field.
3632
+ #
3633
+ # @return [Integer]
3634
+ required :amount, Integer
3635
+
3636
+ # @!attribute currency
3637
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3638
+ # amount's currency.
3639
+ #
3640
+ # @return [String]
3641
+ required :currency, String
3642
+
3643
+ # @!method initialize(amount:, currency:)
3644
+ # Some parameter documentations has been truncated, see
3645
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative}
3646
+ # for more details.
3647
+ #
3648
+ # The total amount of a series of incremental authorizations, optionally provided.
3649
+ #
3650
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3651
+ #
3652
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3653
+ end
3654
+
3655
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#total_healthcare
3656
+ class TotalHealthcare < Increase::Internal::Type::BaseModel
3657
+ # @!attribute amount
3658
+ # The amount in minor units of the `currency` field.
3659
+ #
3660
+ # @return [Integer]
3661
+ required :amount, Integer
2580
3662
 
2581
- # @!attribute pending_transaction_id
2582
- # The identifier of the Pending Transaction associated with this Card Increment.
2583
- #
2584
- # @return [String, nil]
2585
- required :pending_transaction_id, String, nil?: true
3663
+ # @!attribute currency
3664
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3665
+ # amount's currency.
3666
+ #
3667
+ # @return [String]
3668
+ required :currency, String
2586
3669
 
2587
- # @!attribute real_time_decision_id
2588
- # The identifier of the Real-Time Decision sent to approve or decline this
2589
- # incremental authorization.
2590
- #
2591
- # @return [String, nil]
2592
- required :real_time_decision_id, String, nil?: true
3670
+ # @!method initialize(amount:, currency:)
3671
+ # Some parameter documentations has been truncated, see
3672
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare}
3673
+ # for more details.
3674
+ #
3675
+ # The total amount of healthcare-related additional amounts.
3676
+ #
3677
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3678
+ #
3679
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3680
+ end
2593
3681
 
2594
- # @!attribute type
2595
- # A constant representing the object's type. For this resource it will always be
2596
- # `card_increment`.
2597
- #
2598
- # @return [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type]
2599
- required :type, enum: -> { Increase::CardPayment::Element::CardIncrement::Type }
3682
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#transit
3683
+ class Transit < Increase::Internal::Type::BaseModel
3684
+ # @!attribute amount
3685
+ # The amount in minor units of the `currency` field.
3686
+ #
3687
+ # @return [Integer]
3688
+ required :amount, Integer
2600
3689
 
2601
- # @!attribute updated_authorization_amount
2602
- # The updated authorization amount after this increment, in the minor unit of the
2603
- # transaction's currency. For dollars, for example, this is cents.
2604
- #
2605
- # @return [Integer]
2606
- required :updated_authorization_amount, Integer
3690
+ # @!attribute currency
3691
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3692
+ # amount's currency.
3693
+ #
3694
+ # @return [String]
3695
+ required :currency, String
2607
3696
 
2608
- # @!method initialize(id:, actioner:, amount:, card_authorization_id:, currency:, network:, network_identifiers:, network_risk_score:, pending_transaction_id:, real_time_decision_id:, type:, updated_authorization_amount:)
2609
- # Some parameter documentations has been truncated, see
2610
- # {Increase::Models::CardPayment::Element::CardIncrement} for more details.
2611
- #
2612
- # A Card Increment object. This field will be present in the JSON response if and
2613
- # only if `category` is equal to `card_increment`. Card Increments increase the
2614
- # pending amount of an authorized transaction.
2615
- #
2616
- # @param id [String] The Card Increment identifier.
2617
- #
2618
- # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner] Whether this authorization was approved by Increase, the card network through st
2619
- #
2620
- # @param amount [Integer] The amount of this increment in the minor unit of the transaction's currency. Fo
2621
- #
2622
- # @param card_authorization_id [String] The identifier for the Card Authorization this increments.
2623
- #
2624
- # @param currency [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
2625
- #
2626
- # @param network [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network] The card network used to process this card authorization.
2627
- #
2628
- # @param network_identifiers [Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
2629
- #
2630
- # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
2631
- #
2632
- # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Card Increment.
2633
- #
2634
- # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this increme
2635
- #
2636
- # @param type [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type] A constant representing the object's type. For this resource it will always be `
2637
- #
2638
- # @param updated_authorization_amount [Integer] The updated authorization amount after this increment, in the minor unit of the
3697
+ # @!method initialize(amount:, currency:)
3698
+ # Some parameter documentations has been truncated, see
3699
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit}
3700
+ # for more details.
3701
+ #
3702
+ # The part of this transaction amount that was for transit-related services.
3703
+ #
3704
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3705
+ #
3706
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3707
+ end
2639
3708
 
2640
- # Whether this authorization was approved by Increase, the card network through
2641
- # stand-in processing, or the user through a real-time decision.
2642
- #
2643
- # @see Increase::Models::CardPayment::Element::CardIncrement#actioner
2644
- module Actioner
2645
- extend Increase::Internal::Type::Enum
3709
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#unknown
3710
+ class Unknown < Increase::Internal::Type::BaseModel
3711
+ # @!attribute amount
3712
+ # The amount in minor units of the `currency` field.
3713
+ #
3714
+ # @return [Integer]
3715
+ required :amount, Integer
2646
3716
 
2647
- # This object was actioned by the user through a real-time decision.
2648
- USER = :user
3717
+ # @!attribute currency
3718
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3719
+ # amount's currency.
3720
+ #
3721
+ # @return [String]
3722
+ required :currency, String
2649
3723
 
2650
- # This object was actioned by Increase without user intervention.
2651
- INCREASE = :increase
3724
+ # @!method initialize(amount:, currency:)
3725
+ # Some parameter documentations has been truncated, see
3726
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown}
3727
+ # for more details.
3728
+ #
3729
+ # An unknown additional amount.
3730
+ #
3731
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3732
+ #
3733
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3734
+ end
2652
3735
 
2653
- # This object was actioned by the network, through stand-in processing.
2654
- NETWORK = :network
3736
+ # @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#vision
3737
+ class Vision < Increase::Internal::Type::BaseModel
3738
+ # @!attribute amount
3739
+ # The amount in minor units of the `currency` field.
3740
+ #
3741
+ # @return [Integer]
3742
+ required :amount, Integer
2655
3743
 
2656
- # @!method self.values
2657
- # @return [Array<Symbol>]
3744
+ # @!attribute currency
3745
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3746
+ # amount's currency.
3747
+ #
3748
+ # @return [String]
3749
+ required :currency, String
3750
+
3751
+ # @!method initialize(amount:, currency:)
3752
+ # Some parameter documentations has been truncated, see
3753
+ # {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision}
3754
+ # for more details.
3755
+ #
3756
+ # The part of this transaction amount that was for vision-related services.
3757
+ #
3758
+ # @param amount [Integer] The amount in minor units of the `currency` field.
3759
+ #
3760
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3761
+ end
2658
3762
  end
2659
3763
 
2660
3764
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
@@ -5815,6 +6919,17 @@ module Increase
5815
6919
  # @return [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner]
5816
6920
  required :actioner, enum: -> { Increase::CardPayment::Element::CardValidation::Actioner }
5817
6921
 
6922
+ # @!attribute additional_amounts
6923
+ # Additional amounts associated with the card authorization, such as ATM
6924
+ # surcharges fees. These are usually a subset of the `amount` field and are used
6925
+ # to provide more detailed information about the transaction.
6926
+ #
6927
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts]
6928
+ required :additional_amounts,
6929
+ -> {
6930
+ Increase::CardPayment::Element::CardValidation::AdditionalAmounts
6931
+ }
6932
+
5818
6933
  # @!attribute card_payment_id
5819
6934
  # The ID of the Card Payment this transaction belongs to.
5820
6935
  #
@@ -5936,7 +7051,7 @@ module Increase
5936
7051
  # @return [Increase::Models::CardPayment::Element::CardValidation::Verification]
5937
7052
  required :verification, -> { Increase::CardPayment::Element::CardValidation::Verification }
5938
7053
 
5939
- # @!method initialize(id:, actioner:, card_payment_id:, currency:, digital_wallet_token_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, real_time_decision_id:, terminal_id:, type:, verification:)
7054
+ # @!method initialize(id:, actioner:, additional_amounts:, card_payment_id:, currency:, digital_wallet_token_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, real_time_decision_id:, terminal_id:, type:, verification:)
5940
7055
  # Some parameter documentations has been truncated, see
5941
7056
  # {Increase::Models::CardPayment::Element::CardValidation} for more details.
5942
7057
  #
@@ -5949,6 +7064,8 @@ module Increase
5949
7064
  #
5950
7065
  # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner] Whether this authorization was approved by Increase, the card network through st
5951
7066
  #
7067
+ # @param additional_amounts [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
7068
+ #
5952
7069
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
5953
7070
  #
5954
7071
  # @param currency [Symbol, Increase::Models::CardPayment::Element::CardValidation::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
@@ -6005,6 +7122,355 @@ module Increase
6005
7122
  # @return [Array<Symbol>]
6006
7123
  end
6007
7124
 
7125
+ # @see Increase::Models::CardPayment::Element::CardValidation#additional_amounts
7126
+ class AdditionalAmounts < Increase::Internal::Type::BaseModel
7127
+ # @!attribute clinic
7128
+ # The part of this transaction amount that was for clinic-related services.
7129
+ #
7130
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic, nil]
7131
+ required :clinic,
7132
+ -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic },
7133
+ nil?: true
7134
+
7135
+ # @!attribute dental
7136
+ # The part of this transaction amount that was for dental-related services.
7137
+ #
7138
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Dental, nil]
7139
+ required :dental,
7140
+ -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Dental },
7141
+ nil?: true
7142
+
7143
+ # @!attribute prescription
7144
+ # The part of this transaction amount that was for healthcare prescriptions.
7145
+ #
7146
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription, nil]
7147
+ required :prescription,
7148
+ -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription },
7149
+ nil?: true
7150
+
7151
+ # @!attribute surcharge
7152
+ # The surcharge amount charged for this transaction by the merchant.
7153
+ #
7154
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge, nil]
7155
+ required :surcharge,
7156
+ -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge },
7157
+ nil?: true
7158
+
7159
+ # @!attribute total_cumulative
7160
+ # The total amount of a series of incremental authorizations, optionally provided.
7161
+ #
7162
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative, nil]
7163
+ required :total_cumulative,
7164
+ -> {
7165
+ Increase::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative
7166
+ },
7167
+ nil?: true
7168
+
7169
+ # @!attribute total_healthcare
7170
+ # The total amount of healthcare-related additional amounts.
7171
+ #
7172
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare, nil]
7173
+ required :total_healthcare,
7174
+ -> {
7175
+ Increase::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare
7176
+ },
7177
+ nil?: true
7178
+
7179
+ # @!attribute transit
7180
+ # The part of this transaction amount that was for transit-related services.
7181
+ #
7182
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Transit, nil]
7183
+ required :transit,
7184
+ -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Transit },
7185
+ nil?: true
7186
+
7187
+ # @!attribute unknown
7188
+ # An unknown additional amount.
7189
+ #
7190
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown, nil]
7191
+ required :unknown,
7192
+ -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown },
7193
+ nil?: true
7194
+
7195
+ # @!attribute vision
7196
+ # The part of this transaction amount that was for vision-related services.
7197
+ #
7198
+ # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Vision, nil]
7199
+ required :vision,
7200
+ -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Vision },
7201
+ nil?: true
7202
+
7203
+ # @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
7204
+ # Some parameter documentations has been truncated, see
7205
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts} for
7206
+ # more details.
7207
+ #
7208
+ # Additional amounts associated with the card authorization, such as ATM
7209
+ # surcharges fees. These are usually a subset of the `amount` field and are used
7210
+ # to provide more detailed information about the transaction.
7211
+ #
7212
+ # @param clinic [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
7213
+ #
7214
+ # @param dental [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
7215
+ #
7216
+ # @param prescription [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
7217
+ #
7218
+ # @param surcharge [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
7219
+ #
7220
+ # @param total_cumulative [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
7221
+ #
7222
+ # @param total_healthcare [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
7223
+ #
7224
+ # @param transit [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
7225
+ #
7226
+ # @param unknown [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown, nil] An unknown additional amount.
7227
+ #
7228
+ # @param vision [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
7229
+
7230
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#clinic
7231
+ class Clinic < Increase::Internal::Type::BaseModel
7232
+ # @!attribute amount
7233
+ # The amount in minor units of the `currency` field.
7234
+ #
7235
+ # @return [Integer]
7236
+ required :amount, Integer
7237
+
7238
+ # @!attribute currency
7239
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7240
+ # amount's currency.
7241
+ #
7242
+ # @return [String]
7243
+ required :currency, String
7244
+
7245
+ # @!method initialize(amount:, currency:)
7246
+ # Some parameter documentations has been truncated, see
7247
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic}
7248
+ # for more details.
7249
+ #
7250
+ # The part of this transaction amount that was for clinic-related services.
7251
+ #
7252
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7253
+ #
7254
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7255
+ end
7256
+
7257
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#dental
7258
+ class Dental < Increase::Internal::Type::BaseModel
7259
+ # @!attribute amount
7260
+ # The amount in minor units of the `currency` field.
7261
+ #
7262
+ # @return [Integer]
7263
+ required :amount, Integer
7264
+
7265
+ # @!attribute currency
7266
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7267
+ # amount's currency.
7268
+ #
7269
+ # @return [String]
7270
+ required :currency, String
7271
+
7272
+ # @!method initialize(amount:, currency:)
7273
+ # Some parameter documentations has been truncated, see
7274
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Dental}
7275
+ # for more details.
7276
+ #
7277
+ # The part of this transaction amount that was for dental-related services.
7278
+ #
7279
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7280
+ #
7281
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7282
+ end
7283
+
7284
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#prescription
7285
+ class Prescription < Increase::Internal::Type::BaseModel
7286
+ # @!attribute amount
7287
+ # The amount in minor units of the `currency` field.
7288
+ #
7289
+ # @return [Integer]
7290
+ required :amount, Integer
7291
+
7292
+ # @!attribute currency
7293
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7294
+ # amount's currency.
7295
+ #
7296
+ # @return [String]
7297
+ required :currency, String
7298
+
7299
+ # @!method initialize(amount:, currency:)
7300
+ # Some parameter documentations has been truncated, see
7301
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription}
7302
+ # for more details.
7303
+ #
7304
+ # The part of this transaction amount that was for healthcare prescriptions.
7305
+ #
7306
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7307
+ #
7308
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7309
+ end
7310
+
7311
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#surcharge
7312
+ class Surcharge < Increase::Internal::Type::BaseModel
7313
+ # @!attribute amount
7314
+ # The amount in minor units of the `currency` field.
7315
+ #
7316
+ # @return [Integer]
7317
+ required :amount, Integer
7318
+
7319
+ # @!attribute currency
7320
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7321
+ # amount's currency.
7322
+ #
7323
+ # @return [String]
7324
+ required :currency, String
7325
+
7326
+ # @!method initialize(amount:, currency:)
7327
+ # Some parameter documentations has been truncated, see
7328
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge}
7329
+ # for more details.
7330
+ #
7331
+ # The surcharge amount charged for this transaction by the merchant.
7332
+ #
7333
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7334
+ #
7335
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7336
+ end
7337
+
7338
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#total_cumulative
7339
+ class TotalCumulative < Increase::Internal::Type::BaseModel
7340
+ # @!attribute amount
7341
+ # The amount in minor units of the `currency` field.
7342
+ #
7343
+ # @return [Integer]
7344
+ required :amount, Integer
7345
+
7346
+ # @!attribute currency
7347
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7348
+ # amount's currency.
7349
+ #
7350
+ # @return [String]
7351
+ required :currency, String
7352
+
7353
+ # @!method initialize(amount:, currency:)
7354
+ # Some parameter documentations has been truncated, see
7355
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative}
7356
+ # for more details.
7357
+ #
7358
+ # The total amount of a series of incremental authorizations, optionally provided.
7359
+ #
7360
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7361
+ #
7362
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7363
+ end
7364
+
7365
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#total_healthcare
7366
+ class TotalHealthcare < Increase::Internal::Type::BaseModel
7367
+ # @!attribute amount
7368
+ # The amount in minor units of the `currency` field.
7369
+ #
7370
+ # @return [Integer]
7371
+ required :amount, Integer
7372
+
7373
+ # @!attribute currency
7374
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7375
+ # amount's currency.
7376
+ #
7377
+ # @return [String]
7378
+ required :currency, String
7379
+
7380
+ # @!method initialize(amount:, currency:)
7381
+ # Some parameter documentations has been truncated, see
7382
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare}
7383
+ # for more details.
7384
+ #
7385
+ # The total amount of healthcare-related additional amounts.
7386
+ #
7387
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7388
+ #
7389
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7390
+ end
7391
+
7392
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#transit
7393
+ class Transit < Increase::Internal::Type::BaseModel
7394
+ # @!attribute amount
7395
+ # The amount in minor units of the `currency` field.
7396
+ #
7397
+ # @return [Integer]
7398
+ required :amount, Integer
7399
+
7400
+ # @!attribute currency
7401
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7402
+ # amount's currency.
7403
+ #
7404
+ # @return [String]
7405
+ required :currency, String
7406
+
7407
+ # @!method initialize(amount:, currency:)
7408
+ # Some parameter documentations has been truncated, see
7409
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Transit}
7410
+ # for more details.
7411
+ #
7412
+ # The part of this transaction amount that was for transit-related services.
7413
+ #
7414
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7415
+ #
7416
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7417
+ end
7418
+
7419
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#unknown
7420
+ class Unknown < Increase::Internal::Type::BaseModel
7421
+ # @!attribute amount
7422
+ # The amount in minor units of the `currency` field.
7423
+ #
7424
+ # @return [Integer]
7425
+ required :amount, Integer
7426
+
7427
+ # @!attribute currency
7428
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7429
+ # amount's currency.
7430
+ #
7431
+ # @return [String]
7432
+ required :currency, String
7433
+
7434
+ # @!method initialize(amount:, currency:)
7435
+ # Some parameter documentations has been truncated, see
7436
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown}
7437
+ # for more details.
7438
+ #
7439
+ # An unknown additional amount.
7440
+ #
7441
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7442
+ #
7443
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7444
+ end
7445
+
7446
+ # @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#vision
7447
+ class Vision < Increase::Internal::Type::BaseModel
7448
+ # @!attribute amount
7449
+ # The amount in minor units of the `currency` field.
7450
+ #
7451
+ # @return [Integer]
7452
+ required :amount, Integer
7453
+
7454
+ # @!attribute currency
7455
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
7456
+ # amount's currency.
7457
+ #
7458
+ # @return [String]
7459
+ required :currency, String
7460
+
7461
+ # @!method initialize(amount:, currency:)
7462
+ # Some parameter documentations has been truncated, see
7463
+ # {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Vision}
7464
+ # for more details.
7465
+ #
7466
+ # The part of this transaction amount that was for vision-related services.
7467
+ #
7468
+ # @param amount [Integer] The amount in minor units of the `currency` field.
7469
+ #
7470
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
7471
+ end
7472
+ end
7473
+
6008
7474
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
6009
7475
  # transaction's currency.
6010
7476
  #