increase 1.18.1 → 1.20.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 +17 -0
- data/README.md +1 -1
- data/lib/increase/models/card_payment.rb +1551 -67
- data/lib/increase/models/declined_transaction.rb +365 -1
- data/lib/increase/models/pending_transaction.rb +375 -1
- data/lib/increase/models/real_time_decision.rb +356 -1
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/card_payment.rbi +10207 -7485
- data/rbi/increase/models/declined_transaction.rbi +668 -0
- data/rbi/increase/models/pending_transaction.rbi +668 -0
- data/rbi/increase/models/real_time_decision.rbi +668 -0
- data/sig/increase/models/card_payment.rbs +708 -3
- data/sig/increase/models/declined_transaction.rbs +170 -0
- data/sig/increase/models/pending_transaction.rbs +170 -0
- data/sig/increase/models/real_time_decision.rbs +170 -0
- metadata +2 -2
@@ -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.
|
@@ -1690,7 +2062,7 @@ module Increase
|
|
1690
2062
|
# @return [Increase::Models::CardPayment::Element::CardDecline::Verification]
|
1691
2063
|
required :verification, -> { Increase::CardPayment::Element::CardDecline::Verification }
|
1692
2064
|
|
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:)
|
2065
|
+
# @!method initialize(id:, actioner:, additional_amounts:, 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:)
|
1694
2066
|
# Some parameter documentations has been truncated, see
|
1695
2067
|
# {Increase::Models::CardPayment::Element::CardDecline} for more details.
|
1696
2068
|
#
|
@@ -1701,6 +2073,8 @@ module Increase
|
|
1701
2073
|
#
|
1702
2074
|
# @param actioner [Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner] Whether this authorization was approved by Increase, the card network through st
|
1703
2075
|
#
|
2076
|
+
# @param additional_amounts [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
|
2077
|
+
#
|
1704
2078
|
# @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d
|
1705
2079
|
#
|
1706
2080
|
# @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
|
@@ -1771,6 +2145,351 @@ module Increase
|
|
1771
2145
|
# @return [Array<Symbol>]
|
1772
2146
|
end
|
1773
2147
|
|
2148
|
+
# @see Increase::Models::CardPayment::Element::CardDecline#additional_amounts
|
2149
|
+
class AdditionalAmounts < Increase::Internal::Type::BaseModel
|
2150
|
+
# @!attribute clinic
|
2151
|
+
# The part of this transaction amount that was for clinic-related services.
|
2152
|
+
#
|
2153
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic, nil]
|
2154
|
+
required :clinic,
|
2155
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic },
|
2156
|
+
nil?: true
|
2157
|
+
|
2158
|
+
# @!attribute dental
|
2159
|
+
# The part of this transaction amount that was for dental-related services.
|
2160
|
+
#
|
2161
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Dental, nil]
|
2162
|
+
required :dental,
|
2163
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Dental },
|
2164
|
+
nil?: true
|
2165
|
+
|
2166
|
+
# @!attribute prescription
|
2167
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
2168
|
+
#
|
2169
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription, nil]
|
2170
|
+
required :prescription,
|
2171
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription },
|
2172
|
+
nil?: true
|
2173
|
+
|
2174
|
+
# @!attribute surcharge
|
2175
|
+
# The surcharge amount charged for this transaction by the merchant.
|
2176
|
+
#
|
2177
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge, nil]
|
2178
|
+
required :surcharge,
|
2179
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge },
|
2180
|
+
nil?: true
|
2181
|
+
|
2182
|
+
# @!attribute total_cumulative
|
2183
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
2184
|
+
#
|
2185
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative, nil]
|
2186
|
+
required :total_cumulative,
|
2187
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative },
|
2188
|
+
nil?: true
|
2189
|
+
|
2190
|
+
# @!attribute total_healthcare
|
2191
|
+
# The total amount of healthcare-related additional amounts.
|
2192
|
+
#
|
2193
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare, nil]
|
2194
|
+
required :total_healthcare,
|
2195
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare },
|
2196
|
+
nil?: true
|
2197
|
+
|
2198
|
+
# @!attribute transit
|
2199
|
+
# The part of this transaction amount that was for transit-related services.
|
2200
|
+
#
|
2201
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Transit, nil]
|
2202
|
+
required :transit,
|
2203
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Transit },
|
2204
|
+
nil?: true
|
2205
|
+
|
2206
|
+
# @!attribute unknown
|
2207
|
+
# An unknown additional amount.
|
2208
|
+
#
|
2209
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown, nil]
|
2210
|
+
required :unknown,
|
2211
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown },
|
2212
|
+
nil?: true
|
2213
|
+
|
2214
|
+
# @!attribute vision
|
2215
|
+
# The part of this transaction amount that was for vision-related services.
|
2216
|
+
#
|
2217
|
+
# @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Vision, nil]
|
2218
|
+
required :vision,
|
2219
|
+
-> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts::Vision },
|
2220
|
+
nil?: true
|
2221
|
+
|
2222
|
+
# @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
|
2223
|
+
# Some parameter documentations has been truncated, see
|
2224
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts} for
|
2225
|
+
# more details.
|
2226
|
+
#
|
2227
|
+
# Additional amounts associated with the card authorization, such as ATM
|
2228
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
2229
|
+
# to provide more detailed information about the transaction.
|
2230
|
+
#
|
2231
|
+
# @param clinic [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
|
2232
|
+
#
|
2233
|
+
# @param dental [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
|
2234
|
+
#
|
2235
|
+
# @param prescription [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
|
2236
|
+
#
|
2237
|
+
# @param surcharge [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
|
2238
|
+
#
|
2239
|
+
# @param total_cumulative [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
|
2240
|
+
#
|
2241
|
+
# @param total_healthcare [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
|
2242
|
+
#
|
2243
|
+
# @param transit [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
|
2244
|
+
#
|
2245
|
+
# @param unknown [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown, nil] An unknown additional amount.
|
2246
|
+
#
|
2247
|
+
# @param vision [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
|
2248
|
+
|
2249
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#clinic
|
2250
|
+
class Clinic < Increase::Internal::Type::BaseModel
|
2251
|
+
# @!attribute amount
|
2252
|
+
# The amount in minor units of the `currency` field.
|
2253
|
+
#
|
2254
|
+
# @return [Integer]
|
2255
|
+
required :amount, Integer
|
2256
|
+
|
2257
|
+
# @!attribute currency
|
2258
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2259
|
+
# amount's currency.
|
2260
|
+
#
|
2261
|
+
# @return [String]
|
2262
|
+
required :currency, String
|
2263
|
+
|
2264
|
+
# @!method initialize(amount:, currency:)
|
2265
|
+
# Some parameter documentations has been truncated, see
|
2266
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic}
|
2267
|
+
# for more details.
|
2268
|
+
#
|
2269
|
+
# The part of this transaction amount that was for clinic-related services.
|
2270
|
+
#
|
2271
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2272
|
+
#
|
2273
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2274
|
+
end
|
2275
|
+
|
2276
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#dental
|
2277
|
+
class Dental < Increase::Internal::Type::BaseModel
|
2278
|
+
# @!attribute amount
|
2279
|
+
# The amount in minor units of the `currency` field.
|
2280
|
+
#
|
2281
|
+
# @return [Integer]
|
2282
|
+
required :amount, Integer
|
2283
|
+
|
2284
|
+
# @!attribute currency
|
2285
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2286
|
+
# amount's currency.
|
2287
|
+
#
|
2288
|
+
# @return [String]
|
2289
|
+
required :currency, String
|
2290
|
+
|
2291
|
+
# @!method initialize(amount:, currency:)
|
2292
|
+
# Some parameter documentations has been truncated, see
|
2293
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Dental}
|
2294
|
+
# for more details.
|
2295
|
+
#
|
2296
|
+
# The part of this transaction amount that was for dental-related services.
|
2297
|
+
#
|
2298
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2299
|
+
#
|
2300
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2301
|
+
end
|
2302
|
+
|
2303
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#prescription
|
2304
|
+
class Prescription < Increase::Internal::Type::BaseModel
|
2305
|
+
# @!attribute amount
|
2306
|
+
# The amount in minor units of the `currency` field.
|
2307
|
+
#
|
2308
|
+
# @return [Integer]
|
2309
|
+
required :amount, Integer
|
2310
|
+
|
2311
|
+
# @!attribute currency
|
2312
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2313
|
+
# amount's currency.
|
2314
|
+
#
|
2315
|
+
# @return [String]
|
2316
|
+
required :currency, String
|
2317
|
+
|
2318
|
+
# @!method initialize(amount:, currency:)
|
2319
|
+
# Some parameter documentations has been truncated, see
|
2320
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Prescription}
|
2321
|
+
# for more details.
|
2322
|
+
#
|
2323
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
2324
|
+
#
|
2325
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2326
|
+
#
|
2327
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2328
|
+
end
|
2329
|
+
|
2330
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#surcharge
|
2331
|
+
class Surcharge < Increase::Internal::Type::BaseModel
|
2332
|
+
# @!attribute amount
|
2333
|
+
# The amount in minor units of the `currency` field.
|
2334
|
+
#
|
2335
|
+
# @return [Integer]
|
2336
|
+
required :amount, Integer
|
2337
|
+
|
2338
|
+
# @!attribute currency
|
2339
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2340
|
+
# amount's currency.
|
2341
|
+
#
|
2342
|
+
# @return [String]
|
2343
|
+
required :currency, String
|
2344
|
+
|
2345
|
+
# @!method initialize(amount:, currency:)
|
2346
|
+
# Some parameter documentations has been truncated, see
|
2347
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Surcharge}
|
2348
|
+
# for more details.
|
2349
|
+
#
|
2350
|
+
# The surcharge amount charged for this transaction by the merchant.
|
2351
|
+
#
|
2352
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2353
|
+
#
|
2354
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2355
|
+
end
|
2356
|
+
|
2357
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#total_cumulative
|
2358
|
+
class TotalCumulative < Increase::Internal::Type::BaseModel
|
2359
|
+
# @!attribute amount
|
2360
|
+
# The amount in minor units of the `currency` field.
|
2361
|
+
#
|
2362
|
+
# @return [Integer]
|
2363
|
+
required :amount, Integer
|
2364
|
+
|
2365
|
+
# @!attribute currency
|
2366
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2367
|
+
# amount's currency.
|
2368
|
+
#
|
2369
|
+
# @return [String]
|
2370
|
+
required :currency, String
|
2371
|
+
|
2372
|
+
# @!method initialize(amount:, currency:)
|
2373
|
+
# Some parameter documentations has been truncated, see
|
2374
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalCumulative}
|
2375
|
+
# for more details.
|
2376
|
+
#
|
2377
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
2378
|
+
#
|
2379
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2380
|
+
#
|
2381
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2382
|
+
end
|
2383
|
+
|
2384
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#total_healthcare
|
2385
|
+
class TotalHealthcare < Increase::Internal::Type::BaseModel
|
2386
|
+
# @!attribute amount
|
2387
|
+
# The amount in minor units of the `currency` field.
|
2388
|
+
#
|
2389
|
+
# @return [Integer]
|
2390
|
+
required :amount, Integer
|
2391
|
+
|
2392
|
+
# @!attribute currency
|
2393
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2394
|
+
# amount's currency.
|
2395
|
+
#
|
2396
|
+
# @return [String]
|
2397
|
+
required :currency, String
|
2398
|
+
|
2399
|
+
# @!method initialize(amount:, currency:)
|
2400
|
+
# Some parameter documentations has been truncated, see
|
2401
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::TotalHealthcare}
|
2402
|
+
# for more details.
|
2403
|
+
#
|
2404
|
+
# The total amount of healthcare-related additional amounts.
|
2405
|
+
#
|
2406
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2407
|
+
#
|
2408
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2409
|
+
end
|
2410
|
+
|
2411
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#transit
|
2412
|
+
class Transit < Increase::Internal::Type::BaseModel
|
2413
|
+
# @!attribute amount
|
2414
|
+
# The amount in minor units of the `currency` field.
|
2415
|
+
#
|
2416
|
+
# @return [Integer]
|
2417
|
+
required :amount, Integer
|
2418
|
+
|
2419
|
+
# @!attribute currency
|
2420
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2421
|
+
# amount's currency.
|
2422
|
+
#
|
2423
|
+
# @return [String]
|
2424
|
+
required :currency, String
|
2425
|
+
|
2426
|
+
# @!method initialize(amount:, currency:)
|
2427
|
+
# Some parameter documentations has been truncated, see
|
2428
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Transit}
|
2429
|
+
# for more details.
|
2430
|
+
#
|
2431
|
+
# The part of this transaction amount that was for transit-related services.
|
2432
|
+
#
|
2433
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2434
|
+
#
|
2435
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2436
|
+
end
|
2437
|
+
|
2438
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#unknown
|
2439
|
+
class Unknown < Increase::Internal::Type::BaseModel
|
2440
|
+
# @!attribute amount
|
2441
|
+
# The amount in minor units of the `currency` field.
|
2442
|
+
#
|
2443
|
+
# @return [Integer]
|
2444
|
+
required :amount, Integer
|
2445
|
+
|
2446
|
+
# @!attribute currency
|
2447
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2448
|
+
# amount's currency.
|
2449
|
+
#
|
2450
|
+
# @return [String]
|
2451
|
+
required :currency, String
|
2452
|
+
|
2453
|
+
# @!method initialize(amount:, currency:)
|
2454
|
+
# Some parameter documentations has been truncated, see
|
2455
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Unknown}
|
2456
|
+
# for more details.
|
2457
|
+
#
|
2458
|
+
# An unknown additional amount.
|
2459
|
+
#
|
2460
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2461
|
+
#
|
2462
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2463
|
+
end
|
2464
|
+
|
2465
|
+
# @see Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts#vision
|
2466
|
+
class Vision < Increase::Internal::Type::BaseModel
|
2467
|
+
# @!attribute amount
|
2468
|
+
# The amount in minor units of the `currency` field.
|
2469
|
+
#
|
2470
|
+
# @return [Integer]
|
2471
|
+
required :amount, Integer
|
2472
|
+
|
2473
|
+
# @!attribute currency
|
2474
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
2475
|
+
# amount's currency.
|
2476
|
+
#
|
2477
|
+
# @return [String]
|
2478
|
+
required :currency, String
|
2479
|
+
|
2480
|
+
# @!method initialize(amount:, currency:)
|
2481
|
+
# Some parameter documentations has been truncated, see
|
2482
|
+
# {Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Vision}
|
2483
|
+
# for more details.
|
2484
|
+
#
|
2485
|
+
# The part of this transaction amount that was for vision-related services.
|
2486
|
+
#
|
2487
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
2488
|
+
#
|
2489
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
2490
|
+
end
|
2491
|
+
end
|
2492
|
+
|
1774
2493
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
|
1775
2494
|
# account currency.
|
1776
2495
|
#
|
@@ -2536,6 +3255,17 @@ module Increase
|
|
2536
3255
|
# @return [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner]
|
2537
3256
|
required :actioner, enum: -> { Increase::CardPayment::Element::CardIncrement::Actioner }
|
2538
3257
|
|
3258
|
+
# @!attribute additional_amounts
|
3259
|
+
# Additional amounts associated with the card authorization, such as ATM
|
3260
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
3261
|
+
# to provide more detailed information about the transaction.
|
3262
|
+
#
|
3263
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts]
|
3264
|
+
required :additional_amounts,
|
3265
|
+
-> {
|
3266
|
+
Increase::CardPayment::Element::CardIncrement::AdditionalAmounts
|
3267
|
+
}
|
3268
|
+
|
2539
3269
|
# @!attribute amount
|
2540
3270
|
# The amount of this increment in the minor unit of the transaction's currency.
|
2541
3271
|
# For dollars, for example, this is cents.
|
@@ -2584,77 +3314,442 @@ module Increase
|
|
2584
3314
|
# @return [String, nil]
|
2585
3315
|
required :pending_transaction_id, String, nil?: true
|
2586
3316
|
|
2587
|
-
# @!attribute
|
2588
|
-
# The
|
2589
|
-
#
|
2590
|
-
#
|
2591
|
-
# @return [
|
2592
|
-
required :
|
3317
|
+
# @!attribute presentment_amount
|
3318
|
+
# The amount of this increment in the minor unit of the transaction's presentment
|
3319
|
+
# currency.
|
3320
|
+
#
|
3321
|
+
# @return [Integer]
|
3322
|
+
required :presentment_amount, Integer
|
3323
|
+
|
3324
|
+
# @!attribute presentment_currency
|
3325
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
3326
|
+
# transaction's presentment currency.
|
3327
|
+
#
|
3328
|
+
# @return [String]
|
3329
|
+
required :presentment_currency, String
|
3330
|
+
|
3331
|
+
# @!attribute real_time_decision_id
|
3332
|
+
# The identifier of the Real-Time Decision sent to approve or decline this
|
3333
|
+
# incremental authorization.
|
3334
|
+
#
|
3335
|
+
# @return [String, nil]
|
3336
|
+
required :real_time_decision_id, String, nil?: true
|
3337
|
+
|
3338
|
+
# @!attribute type
|
3339
|
+
# A constant representing the object's type. For this resource it will always be
|
3340
|
+
# `card_increment`.
|
3341
|
+
#
|
3342
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type]
|
3343
|
+
required :type, enum: -> { Increase::CardPayment::Element::CardIncrement::Type }
|
3344
|
+
|
3345
|
+
# @!attribute updated_authorization_amount
|
3346
|
+
# The updated authorization amount after this increment, in the minor unit of the
|
3347
|
+
# transaction's currency. For dollars, for example, this is cents.
|
3348
|
+
#
|
3349
|
+
# @return [Integer]
|
3350
|
+
required :updated_authorization_amount, Integer
|
3351
|
+
|
3352
|
+
# @!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:)
|
3353
|
+
# Some parameter documentations has been truncated, see
|
3354
|
+
# {Increase::Models::CardPayment::Element::CardIncrement} for more details.
|
3355
|
+
#
|
3356
|
+
# A Card Increment object. This field will be present in the JSON response if and
|
3357
|
+
# only if `category` is equal to `card_increment`. Card Increments increase the
|
3358
|
+
# pending amount of an authorized transaction.
|
3359
|
+
#
|
3360
|
+
# @param id [String] The Card Increment identifier.
|
3361
|
+
#
|
3362
|
+
# @param actioner [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner] Whether this authorization was approved by Increase, the card network through st
|
3363
|
+
#
|
3364
|
+
# @param additional_amounts [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
|
3365
|
+
#
|
3366
|
+
# @param amount [Integer] The amount of this increment in the minor unit of the transaction's currency. Fo
|
3367
|
+
#
|
3368
|
+
# @param card_authorization_id [String] The identifier for the Card Authorization this increments.
|
3369
|
+
#
|
3370
|
+
# @param currency [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
|
3371
|
+
#
|
3372
|
+
# @param network [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network] The card network used to process this card authorization.
|
3373
|
+
#
|
3374
|
+
# @param network_identifiers [Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
|
3375
|
+
#
|
3376
|
+
# @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
|
3377
|
+
#
|
3378
|
+
# @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Card Increment.
|
3379
|
+
#
|
3380
|
+
# @param presentment_amount [Integer] The amount of this increment in the minor unit of the transaction's presentment
|
3381
|
+
#
|
3382
|
+
# @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
|
3383
|
+
#
|
3384
|
+
# @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this increme
|
3385
|
+
#
|
3386
|
+
# @param type [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type] A constant representing the object's type. For this resource it will always be `
|
3387
|
+
#
|
3388
|
+
# @param updated_authorization_amount [Integer] The updated authorization amount after this increment, in the minor unit of the
|
3389
|
+
|
3390
|
+
# Whether this authorization was approved by Increase, the card network through
|
3391
|
+
# stand-in processing, or the user through a real-time decision.
|
3392
|
+
#
|
3393
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement#actioner
|
3394
|
+
module Actioner
|
3395
|
+
extend Increase::Internal::Type::Enum
|
3396
|
+
|
3397
|
+
# This object was actioned by the user through a real-time decision.
|
3398
|
+
USER = :user
|
3399
|
+
|
3400
|
+
# This object was actioned by Increase without user intervention.
|
3401
|
+
INCREASE = :increase
|
3402
|
+
|
3403
|
+
# This object was actioned by the network, through stand-in processing.
|
3404
|
+
NETWORK = :network
|
3405
|
+
|
3406
|
+
# @!method self.values
|
3407
|
+
# @return [Array<Symbol>]
|
3408
|
+
end
|
3409
|
+
|
3410
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement#additional_amounts
|
3411
|
+
class AdditionalAmounts < Increase::Internal::Type::BaseModel
|
3412
|
+
# @!attribute clinic
|
3413
|
+
# The part of this transaction amount that was for clinic-related services.
|
3414
|
+
#
|
3415
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic, nil]
|
3416
|
+
required :clinic,
|
3417
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic },
|
3418
|
+
nil?: true
|
3419
|
+
|
3420
|
+
# @!attribute dental
|
3421
|
+
# The part of this transaction amount that was for dental-related services.
|
3422
|
+
#
|
3423
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental, nil]
|
3424
|
+
required :dental,
|
3425
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental },
|
3426
|
+
nil?: true
|
3427
|
+
|
3428
|
+
# @!attribute prescription
|
3429
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
3430
|
+
#
|
3431
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription, nil]
|
3432
|
+
required :prescription,
|
3433
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription },
|
3434
|
+
nil?: true
|
3435
|
+
|
3436
|
+
# @!attribute surcharge
|
3437
|
+
# The surcharge amount charged for this transaction by the merchant.
|
3438
|
+
#
|
3439
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge, nil]
|
3440
|
+
required :surcharge,
|
3441
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge },
|
3442
|
+
nil?: true
|
3443
|
+
|
3444
|
+
# @!attribute total_cumulative
|
3445
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
3446
|
+
#
|
3447
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative, nil]
|
3448
|
+
required :total_cumulative,
|
3449
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative },
|
3450
|
+
nil?: true
|
3451
|
+
|
3452
|
+
# @!attribute total_healthcare
|
3453
|
+
# The total amount of healthcare-related additional amounts.
|
3454
|
+
#
|
3455
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare, nil]
|
3456
|
+
required :total_healthcare,
|
3457
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare },
|
3458
|
+
nil?: true
|
3459
|
+
|
3460
|
+
# @!attribute transit
|
3461
|
+
# The part of this transaction amount that was for transit-related services.
|
3462
|
+
#
|
3463
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit, nil]
|
3464
|
+
required :transit,
|
3465
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit },
|
3466
|
+
nil?: true
|
3467
|
+
|
3468
|
+
# @!attribute unknown
|
3469
|
+
# An unknown additional amount.
|
3470
|
+
#
|
3471
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown, nil]
|
3472
|
+
required :unknown,
|
3473
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown },
|
3474
|
+
nil?: true
|
3475
|
+
|
3476
|
+
# @!attribute vision
|
3477
|
+
# The part of this transaction amount that was for vision-related services.
|
3478
|
+
#
|
3479
|
+
# @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision, nil]
|
3480
|
+
required :vision,
|
3481
|
+
-> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision },
|
3482
|
+
nil?: true
|
3483
|
+
|
3484
|
+
# @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
|
3485
|
+
# Some parameter documentations has been truncated, see
|
3486
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts} for
|
3487
|
+
# more details.
|
3488
|
+
#
|
3489
|
+
# Additional amounts associated with the card authorization, such as ATM
|
3490
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
3491
|
+
# to provide more detailed information about the transaction.
|
3492
|
+
#
|
3493
|
+
# @param clinic [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
|
3494
|
+
#
|
3495
|
+
# @param dental [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
|
3496
|
+
#
|
3497
|
+
# @param prescription [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
|
3498
|
+
#
|
3499
|
+
# @param surcharge [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
|
3500
|
+
#
|
3501
|
+
# @param total_cumulative [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
|
3502
|
+
#
|
3503
|
+
# @param total_healthcare [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
|
3504
|
+
#
|
3505
|
+
# @param transit [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
|
3506
|
+
#
|
3507
|
+
# @param unknown [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown, nil] An unknown additional amount.
|
3508
|
+
#
|
3509
|
+
# @param vision [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
|
3510
|
+
|
3511
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#clinic
|
3512
|
+
class Clinic < Increase::Internal::Type::BaseModel
|
3513
|
+
# @!attribute amount
|
3514
|
+
# The amount in minor units of the `currency` field.
|
3515
|
+
#
|
3516
|
+
# @return [Integer]
|
3517
|
+
required :amount, Integer
|
3518
|
+
|
3519
|
+
# @!attribute currency
|
3520
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3521
|
+
# amount's currency.
|
3522
|
+
#
|
3523
|
+
# @return [String]
|
3524
|
+
required :currency, String
|
3525
|
+
|
3526
|
+
# @!method initialize(amount:, currency:)
|
3527
|
+
# Some parameter documentations has been truncated, see
|
3528
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic}
|
3529
|
+
# for more details.
|
3530
|
+
#
|
3531
|
+
# The part of this transaction amount that was for clinic-related services.
|
3532
|
+
#
|
3533
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3534
|
+
#
|
3535
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3536
|
+
end
|
3537
|
+
|
3538
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#dental
|
3539
|
+
class Dental < Increase::Internal::Type::BaseModel
|
3540
|
+
# @!attribute amount
|
3541
|
+
# The amount in minor units of the `currency` field.
|
3542
|
+
#
|
3543
|
+
# @return [Integer]
|
3544
|
+
required :amount, Integer
|
3545
|
+
|
3546
|
+
# @!attribute currency
|
3547
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3548
|
+
# amount's currency.
|
3549
|
+
#
|
3550
|
+
# @return [String]
|
3551
|
+
required :currency, String
|
3552
|
+
|
3553
|
+
# @!method initialize(amount:, currency:)
|
3554
|
+
# Some parameter documentations has been truncated, see
|
3555
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Dental}
|
3556
|
+
# for more details.
|
3557
|
+
#
|
3558
|
+
# The part of this transaction amount that was for dental-related services.
|
3559
|
+
#
|
3560
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3561
|
+
#
|
3562
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3563
|
+
end
|
3564
|
+
|
3565
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#prescription
|
3566
|
+
class Prescription < Increase::Internal::Type::BaseModel
|
3567
|
+
# @!attribute amount
|
3568
|
+
# The amount in minor units of the `currency` field.
|
3569
|
+
#
|
3570
|
+
# @return [Integer]
|
3571
|
+
required :amount, Integer
|
3572
|
+
|
3573
|
+
# @!attribute currency
|
3574
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3575
|
+
# amount's currency.
|
3576
|
+
#
|
3577
|
+
# @return [String]
|
3578
|
+
required :currency, String
|
3579
|
+
|
3580
|
+
# @!method initialize(amount:, currency:)
|
3581
|
+
# Some parameter documentations has been truncated, see
|
3582
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Prescription}
|
3583
|
+
# for more details.
|
3584
|
+
#
|
3585
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
3586
|
+
#
|
3587
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3588
|
+
#
|
3589
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3590
|
+
end
|
3591
|
+
|
3592
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#surcharge
|
3593
|
+
class Surcharge < Increase::Internal::Type::BaseModel
|
3594
|
+
# @!attribute amount
|
3595
|
+
# The amount in minor units of the `currency` field.
|
3596
|
+
#
|
3597
|
+
# @return [Integer]
|
3598
|
+
required :amount, Integer
|
3599
|
+
|
3600
|
+
# @!attribute currency
|
3601
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3602
|
+
# amount's currency.
|
3603
|
+
#
|
3604
|
+
# @return [String]
|
3605
|
+
required :currency, String
|
3606
|
+
|
3607
|
+
# @!method initialize(amount:, currency:)
|
3608
|
+
# Some parameter documentations has been truncated, see
|
3609
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Surcharge}
|
3610
|
+
# for more details.
|
3611
|
+
#
|
3612
|
+
# The surcharge amount charged for this transaction by the merchant.
|
3613
|
+
#
|
3614
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3615
|
+
#
|
3616
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3617
|
+
end
|
3618
|
+
|
3619
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#total_cumulative
|
3620
|
+
class TotalCumulative < Increase::Internal::Type::BaseModel
|
3621
|
+
# @!attribute amount
|
3622
|
+
# The amount in minor units of the `currency` field.
|
3623
|
+
#
|
3624
|
+
# @return [Integer]
|
3625
|
+
required :amount, Integer
|
3626
|
+
|
3627
|
+
# @!attribute currency
|
3628
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3629
|
+
# amount's currency.
|
3630
|
+
#
|
3631
|
+
# @return [String]
|
3632
|
+
required :currency, String
|
3633
|
+
|
3634
|
+
# @!method initialize(amount:, currency:)
|
3635
|
+
# Some parameter documentations has been truncated, see
|
3636
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalCumulative}
|
3637
|
+
# for more details.
|
3638
|
+
#
|
3639
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
3640
|
+
#
|
3641
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3642
|
+
#
|
3643
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3644
|
+
end
|
3645
|
+
|
3646
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#total_healthcare
|
3647
|
+
class TotalHealthcare < Increase::Internal::Type::BaseModel
|
3648
|
+
# @!attribute amount
|
3649
|
+
# The amount in minor units of the `currency` field.
|
3650
|
+
#
|
3651
|
+
# @return [Integer]
|
3652
|
+
required :amount, Integer
|
3653
|
+
|
3654
|
+
# @!attribute currency
|
3655
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3656
|
+
# amount's currency.
|
3657
|
+
#
|
3658
|
+
# @return [String]
|
3659
|
+
required :currency, String
|
3660
|
+
|
3661
|
+
# @!method initialize(amount:, currency:)
|
3662
|
+
# Some parameter documentations has been truncated, see
|
3663
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::TotalHealthcare}
|
3664
|
+
# for more details.
|
3665
|
+
#
|
3666
|
+
# The total amount of healthcare-related additional amounts.
|
3667
|
+
#
|
3668
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3669
|
+
#
|
3670
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3671
|
+
end
|
3672
|
+
|
3673
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#transit
|
3674
|
+
class Transit < Increase::Internal::Type::BaseModel
|
3675
|
+
# @!attribute amount
|
3676
|
+
# The amount in minor units of the `currency` field.
|
3677
|
+
#
|
3678
|
+
# @return [Integer]
|
3679
|
+
required :amount, Integer
|
2593
3680
|
|
2594
|
-
|
2595
|
-
|
2596
|
-
|
2597
|
-
|
2598
|
-
|
2599
|
-
|
3681
|
+
# @!attribute currency
|
3682
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3683
|
+
# amount's currency.
|
3684
|
+
#
|
3685
|
+
# @return [String]
|
3686
|
+
required :currency, String
|
2600
3687
|
|
2601
|
-
|
2602
|
-
|
2603
|
-
|
2604
|
-
|
2605
|
-
|
2606
|
-
|
3688
|
+
# @!method initialize(amount:, currency:)
|
3689
|
+
# Some parameter documentations has been truncated, see
|
3690
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Transit}
|
3691
|
+
# for more details.
|
3692
|
+
#
|
3693
|
+
# The part of this transaction amount that was for transit-related services.
|
3694
|
+
#
|
3695
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3696
|
+
#
|
3697
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3698
|
+
end
|
2607
3699
|
|
2608
|
-
|
2609
|
-
|
2610
|
-
|
2611
|
-
|
2612
|
-
|
2613
|
-
|
2614
|
-
|
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
|
3700
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#unknown
|
3701
|
+
class Unknown < Increase::Internal::Type::BaseModel
|
3702
|
+
# @!attribute amount
|
3703
|
+
# The amount in minor units of the `currency` field.
|
3704
|
+
#
|
3705
|
+
# @return [Integer]
|
3706
|
+
required :amount, Integer
|
2639
3707
|
|
2640
|
-
|
2641
|
-
|
2642
|
-
|
2643
|
-
|
2644
|
-
|
2645
|
-
|
3708
|
+
# @!attribute currency
|
3709
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3710
|
+
# amount's currency.
|
3711
|
+
#
|
3712
|
+
# @return [String]
|
3713
|
+
required :currency, String
|
2646
3714
|
|
2647
|
-
|
2648
|
-
|
3715
|
+
# @!method initialize(amount:, currency:)
|
3716
|
+
# Some parameter documentations has been truncated, see
|
3717
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Unknown}
|
3718
|
+
# for more details.
|
3719
|
+
#
|
3720
|
+
# An unknown additional amount.
|
3721
|
+
#
|
3722
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3723
|
+
#
|
3724
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3725
|
+
end
|
2649
3726
|
|
2650
|
-
#
|
2651
|
-
|
3727
|
+
# @see Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts#vision
|
3728
|
+
class Vision < Increase::Internal::Type::BaseModel
|
3729
|
+
# @!attribute amount
|
3730
|
+
# The amount in minor units of the `currency` field.
|
3731
|
+
#
|
3732
|
+
# @return [Integer]
|
3733
|
+
required :amount, Integer
|
2652
3734
|
|
2653
|
-
|
2654
|
-
|
3735
|
+
# @!attribute currency
|
3736
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
3737
|
+
# amount's currency.
|
3738
|
+
#
|
3739
|
+
# @return [String]
|
3740
|
+
required :currency, String
|
2655
3741
|
|
2656
|
-
|
2657
|
-
|
3742
|
+
# @!method initialize(amount:, currency:)
|
3743
|
+
# Some parameter documentations has been truncated, see
|
3744
|
+
# {Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Vision}
|
3745
|
+
# for more details.
|
3746
|
+
#
|
3747
|
+
# The part of this transaction amount that was for vision-related services.
|
3748
|
+
#
|
3749
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
3750
|
+
#
|
3751
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
3752
|
+
end
|
2658
3753
|
end
|
2659
3754
|
|
2660
3755
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
|
@@ -4194,6 +5289,13 @@ module Increase
|
|
4194
5289
|
# @return [String, nil]
|
4195
5290
|
required :pending_transaction_id, String, nil?: true
|
4196
5291
|
|
5292
|
+
# @!attribute presentment_currency
|
5293
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
5294
|
+
# presentment currency.
|
5295
|
+
#
|
5296
|
+
# @return [String]
|
5297
|
+
required :presentment_currency, String
|
5298
|
+
|
4197
5299
|
# @!attribute reversal_amount
|
4198
5300
|
# The amount of this reversal in the minor unit of the transaction's currency. For
|
4199
5301
|
# dollars, for example, this is cents.
|
@@ -4201,6 +5303,13 @@ module Increase
|
|
4201
5303
|
# @return [Integer]
|
4202
5304
|
required :reversal_amount, Integer
|
4203
5305
|
|
5306
|
+
# @!attribute reversal_presentment_amount
|
5307
|
+
# The amount of this reversal in the minor unit of the transaction's presentment
|
5308
|
+
# currency. For dollars, for example, this is cents.
|
5309
|
+
#
|
5310
|
+
# @return [Integer]
|
5311
|
+
required :reversal_presentment_amount, Integer
|
5312
|
+
|
4204
5313
|
# @!attribute reversal_reason
|
4205
5314
|
# Why this reversal was initiated.
|
4206
5315
|
#
|
@@ -4230,7 +5339,14 @@ module Increase
|
|
4230
5339
|
# @return [Integer]
|
4231
5340
|
required :updated_authorization_amount, Integer
|
4232
5341
|
|
4233
|
-
# @!
|
5342
|
+
# @!attribute updated_authorization_presentment_amount
|
5343
|
+
# The amount left pending on the Card Authorization in the minor unit of the
|
5344
|
+
# transaction's presentment currency. For dollars, for example, this is cents.
|
5345
|
+
#
|
5346
|
+
# @return [Integer]
|
5347
|
+
required :updated_authorization_presentment_amount, Integer
|
5348
|
+
|
5349
|
+
# @!method initialize(id:, card_authorization_id:, currency:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network:, network_identifiers:, pending_transaction_id:, presentment_currency:, reversal_amount:, reversal_presentment_amount:, reversal_reason:, terminal_id:, type:, updated_authorization_amount:, updated_authorization_presentment_amount:)
|
4234
5350
|
# Some parameter documentations has been truncated, see
|
4235
5351
|
# {Increase::Models::CardPayment::Element::CardReversal} for more details.
|
4236
5352
|
#
|
@@ -4264,8 +5380,12 @@ module Increase
|
|
4264
5380
|
#
|
4265
5381
|
# @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Card Reversal.
|
4266
5382
|
#
|
5383
|
+
# @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's p
|
5384
|
+
#
|
4267
5385
|
# @param reversal_amount [Integer] The amount of this reversal in the minor unit of the transaction's currency. For
|
4268
5386
|
#
|
5387
|
+
# @param reversal_presentment_amount [Integer] The amount of this reversal in the minor unit of the transaction's presentment c
|
5388
|
+
#
|
4269
5389
|
# @param reversal_reason [Symbol, Increase::Models::CardPayment::Element::CardReversal::ReversalReason, nil] Why this reversal was initiated.
|
4270
5390
|
#
|
4271
5391
|
# @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
|
@@ -4273,6 +5393,8 @@ module Increase
|
|
4273
5393
|
# @param type [Symbol, Increase::Models::CardPayment::Element::CardReversal::Type] A constant representing the object's type. For this resource it will always be `
|
4274
5394
|
#
|
4275
5395
|
# @param updated_authorization_amount [Integer] The amount left pending on the Card Authorization in the minor unit of the trans
|
5396
|
+
#
|
5397
|
+
# @param updated_authorization_presentment_amount [Integer] The amount left pending on the Card Authorization in the minor unit of the trans
|
4276
5398
|
|
4277
5399
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
4278
5400
|
# currency.
|
@@ -5788,6 +6910,17 @@ module Increase
|
|
5788
6910
|
# @return [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner]
|
5789
6911
|
required :actioner, enum: -> { Increase::CardPayment::Element::CardValidation::Actioner }
|
5790
6912
|
|
6913
|
+
# @!attribute additional_amounts
|
6914
|
+
# Additional amounts associated with the card authorization, such as ATM
|
6915
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
6916
|
+
# to provide more detailed information about the transaction.
|
6917
|
+
#
|
6918
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts]
|
6919
|
+
required :additional_amounts,
|
6920
|
+
-> {
|
6921
|
+
Increase::CardPayment::Element::CardValidation::AdditionalAmounts
|
6922
|
+
}
|
6923
|
+
|
5791
6924
|
# @!attribute card_payment_id
|
5792
6925
|
# The ID of the Card Payment this transaction belongs to.
|
5793
6926
|
#
|
@@ -5909,7 +7042,7 @@ module Increase
|
|
5909
7042
|
# @return [Increase::Models::CardPayment::Element::CardValidation::Verification]
|
5910
7043
|
required :verification, -> { Increase::CardPayment::Element::CardValidation::Verification }
|
5911
7044
|
|
5912
|
-
# @!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:)
|
7045
|
+
# @!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:)
|
5913
7046
|
# Some parameter documentations has been truncated, see
|
5914
7047
|
# {Increase::Models::CardPayment::Element::CardValidation} for more details.
|
5915
7048
|
#
|
@@ -5922,6 +7055,8 @@ module Increase
|
|
5922
7055
|
#
|
5923
7056
|
# @param actioner [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner] Whether this authorization was approved by Increase, the card network through st
|
5924
7057
|
#
|
7058
|
+
# @param additional_amounts [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
|
7059
|
+
#
|
5925
7060
|
# @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
|
5926
7061
|
#
|
5927
7062
|
# @param currency [Symbol, Increase::Models::CardPayment::Element::CardValidation::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
|
@@ -5978,6 +7113,355 @@ module Increase
|
|
5978
7113
|
# @return [Array<Symbol>]
|
5979
7114
|
end
|
5980
7115
|
|
7116
|
+
# @see Increase::Models::CardPayment::Element::CardValidation#additional_amounts
|
7117
|
+
class AdditionalAmounts < Increase::Internal::Type::BaseModel
|
7118
|
+
# @!attribute clinic
|
7119
|
+
# The part of this transaction amount that was for clinic-related services.
|
7120
|
+
#
|
7121
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic, nil]
|
7122
|
+
required :clinic,
|
7123
|
+
-> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic },
|
7124
|
+
nil?: true
|
7125
|
+
|
7126
|
+
# @!attribute dental
|
7127
|
+
# The part of this transaction amount that was for dental-related services.
|
7128
|
+
#
|
7129
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Dental, nil]
|
7130
|
+
required :dental,
|
7131
|
+
-> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Dental },
|
7132
|
+
nil?: true
|
7133
|
+
|
7134
|
+
# @!attribute prescription
|
7135
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
7136
|
+
#
|
7137
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription, nil]
|
7138
|
+
required :prescription,
|
7139
|
+
-> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription },
|
7140
|
+
nil?: true
|
7141
|
+
|
7142
|
+
# @!attribute surcharge
|
7143
|
+
# The surcharge amount charged for this transaction by the merchant.
|
7144
|
+
#
|
7145
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge, nil]
|
7146
|
+
required :surcharge,
|
7147
|
+
-> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge },
|
7148
|
+
nil?: true
|
7149
|
+
|
7150
|
+
# @!attribute total_cumulative
|
7151
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
7152
|
+
#
|
7153
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative, nil]
|
7154
|
+
required :total_cumulative,
|
7155
|
+
-> {
|
7156
|
+
Increase::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative
|
7157
|
+
},
|
7158
|
+
nil?: true
|
7159
|
+
|
7160
|
+
# @!attribute total_healthcare
|
7161
|
+
# The total amount of healthcare-related additional amounts.
|
7162
|
+
#
|
7163
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare, nil]
|
7164
|
+
required :total_healthcare,
|
7165
|
+
-> {
|
7166
|
+
Increase::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare
|
7167
|
+
},
|
7168
|
+
nil?: true
|
7169
|
+
|
7170
|
+
# @!attribute transit
|
7171
|
+
# The part of this transaction amount that was for transit-related services.
|
7172
|
+
#
|
7173
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Transit, nil]
|
7174
|
+
required :transit,
|
7175
|
+
-> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Transit },
|
7176
|
+
nil?: true
|
7177
|
+
|
7178
|
+
# @!attribute unknown
|
7179
|
+
# An unknown additional amount.
|
7180
|
+
#
|
7181
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown, nil]
|
7182
|
+
required :unknown,
|
7183
|
+
-> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown },
|
7184
|
+
nil?: true
|
7185
|
+
|
7186
|
+
# @!attribute vision
|
7187
|
+
# The part of this transaction amount that was for vision-related services.
|
7188
|
+
#
|
7189
|
+
# @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Vision, nil]
|
7190
|
+
required :vision,
|
7191
|
+
-> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts::Vision },
|
7192
|
+
nil?: true
|
7193
|
+
|
7194
|
+
# @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
|
7195
|
+
# Some parameter documentations has been truncated, see
|
7196
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts} for
|
7197
|
+
# more details.
|
7198
|
+
#
|
7199
|
+
# Additional amounts associated with the card authorization, such as ATM
|
7200
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
7201
|
+
# to provide more detailed information about the transaction.
|
7202
|
+
#
|
7203
|
+
# @param clinic [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
|
7204
|
+
#
|
7205
|
+
# @param dental [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
|
7206
|
+
#
|
7207
|
+
# @param prescription [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
|
7208
|
+
#
|
7209
|
+
# @param surcharge [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
|
7210
|
+
#
|
7211
|
+
# @param total_cumulative [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
|
7212
|
+
#
|
7213
|
+
# @param total_healthcare [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
|
7214
|
+
#
|
7215
|
+
# @param transit [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
|
7216
|
+
#
|
7217
|
+
# @param unknown [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown, nil] An unknown additional amount.
|
7218
|
+
#
|
7219
|
+
# @param vision [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
|
7220
|
+
|
7221
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#clinic
|
7222
|
+
class Clinic < Increase::Internal::Type::BaseModel
|
7223
|
+
# @!attribute amount
|
7224
|
+
# The amount in minor units of the `currency` field.
|
7225
|
+
#
|
7226
|
+
# @return [Integer]
|
7227
|
+
required :amount, Integer
|
7228
|
+
|
7229
|
+
# @!attribute currency
|
7230
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7231
|
+
# amount's currency.
|
7232
|
+
#
|
7233
|
+
# @return [String]
|
7234
|
+
required :currency, String
|
7235
|
+
|
7236
|
+
# @!method initialize(amount:, currency:)
|
7237
|
+
# Some parameter documentations has been truncated, see
|
7238
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic}
|
7239
|
+
# for more details.
|
7240
|
+
#
|
7241
|
+
# The part of this transaction amount that was for clinic-related services.
|
7242
|
+
#
|
7243
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7244
|
+
#
|
7245
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7246
|
+
end
|
7247
|
+
|
7248
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#dental
|
7249
|
+
class Dental < Increase::Internal::Type::BaseModel
|
7250
|
+
# @!attribute amount
|
7251
|
+
# The amount in minor units of the `currency` field.
|
7252
|
+
#
|
7253
|
+
# @return [Integer]
|
7254
|
+
required :amount, Integer
|
7255
|
+
|
7256
|
+
# @!attribute currency
|
7257
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7258
|
+
# amount's currency.
|
7259
|
+
#
|
7260
|
+
# @return [String]
|
7261
|
+
required :currency, String
|
7262
|
+
|
7263
|
+
# @!method initialize(amount:, currency:)
|
7264
|
+
# Some parameter documentations has been truncated, see
|
7265
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Dental}
|
7266
|
+
# for more details.
|
7267
|
+
#
|
7268
|
+
# The part of this transaction amount that was for dental-related services.
|
7269
|
+
#
|
7270
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7271
|
+
#
|
7272
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7273
|
+
end
|
7274
|
+
|
7275
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#prescription
|
7276
|
+
class Prescription < Increase::Internal::Type::BaseModel
|
7277
|
+
# @!attribute amount
|
7278
|
+
# The amount in minor units of the `currency` field.
|
7279
|
+
#
|
7280
|
+
# @return [Integer]
|
7281
|
+
required :amount, Integer
|
7282
|
+
|
7283
|
+
# @!attribute currency
|
7284
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7285
|
+
# amount's currency.
|
7286
|
+
#
|
7287
|
+
# @return [String]
|
7288
|
+
required :currency, String
|
7289
|
+
|
7290
|
+
# @!method initialize(amount:, currency:)
|
7291
|
+
# Some parameter documentations has been truncated, see
|
7292
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Prescription}
|
7293
|
+
# for more details.
|
7294
|
+
#
|
7295
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
7296
|
+
#
|
7297
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7298
|
+
#
|
7299
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7300
|
+
end
|
7301
|
+
|
7302
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#surcharge
|
7303
|
+
class Surcharge < Increase::Internal::Type::BaseModel
|
7304
|
+
# @!attribute amount
|
7305
|
+
# The amount in minor units of the `currency` field.
|
7306
|
+
#
|
7307
|
+
# @return [Integer]
|
7308
|
+
required :amount, Integer
|
7309
|
+
|
7310
|
+
# @!attribute currency
|
7311
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7312
|
+
# amount's currency.
|
7313
|
+
#
|
7314
|
+
# @return [String]
|
7315
|
+
required :currency, String
|
7316
|
+
|
7317
|
+
# @!method initialize(amount:, currency:)
|
7318
|
+
# Some parameter documentations has been truncated, see
|
7319
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Surcharge}
|
7320
|
+
# for more details.
|
7321
|
+
#
|
7322
|
+
# The surcharge amount charged for this transaction by the merchant.
|
7323
|
+
#
|
7324
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7325
|
+
#
|
7326
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7327
|
+
end
|
7328
|
+
|
7329
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#total_cumulative
|
7330
|
+
class TotalCumulative < Increase::Internal::Type::BaseModel
|
7331
|
+
# @!attribute amount
|
7332
|
+
# The amount in minor units of the `currency` field.
|
7333
|
+
#
|
7334
|
+
# @return [Integer]
|
7335
|
+
required :amount, Integer
|
7336
|
+
|
7337
|
+
# @!attribute currency
|
7338
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7339
|
+
# amount's currency.
|
7340
|
+
#
|
7341
|
+
# @return [String]
|
7342
|
+
required :currency, String
|
7343
|
+
|
7344
|
+
# @!method initialize(amount:, currency:)
|
7345
|
+
# Some parameter documentations has been truncated, see
|
7346
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalCumulative}
|
7347
|
+
# for more details.
|
7348
|
+
#
|
7349
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
7350
|
+
#
|
7351
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7352
|
+
#
|
7353
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7354
|
+
end
|
7355
|
+
|
7356
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#total_healthcare
|
7357
|
+
class TotalHealthcare < Increase::Internal::Type::BaseModel
|
7358
|
+
# @!attribute amount
|
7359
|
+
# The amount in minor units of the `currency` field.
|
7360
|
+
#
|
7361
|
+
# @return [Integer]
|
7362
|
+
required :amount, Integer
|
7363
|
+
|
7364
|
+
# @!attribute currency
|
7365
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7366
|
+
# amount's currency.
|
7367
|
+
#
|
7368
|
+
# @return [String]
|
7369
|
+
required :currency, String
|
7370
|
+
|
7371
|
+
# @!method initialize(amount:, currency:)
|
7372
|
+
# Some parameter documentations has been truncated, see
|
7373
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::TotalHealthcare}
|
7374
|
+
# for more details.
|
7375
|
+
#
|
7376
|
+
# The total amount of healthcare-related additional amounts.
|
7377
|
+
#
|
7378
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7379
|
+
#
|
7380
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7381
|
+
end
|
7382
|
+
|
7383
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#transit
|
7384
|
+
class Transit < Increase::Internal::Type::BaseModel
|
7385
|
+
# @!attribute amount
|
7386
|
+
# The amount in minor units of the `currency` field.
|
7387
|
+
#
|
7388
|
+
# @return [Integer]
|
7389
|
+
required :amount, Integer
|
7390
|
+
|
7391
|
+
# @!attribute currency
|
7392
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7393
|
+
# amount's currency.
|
7394
|
+
#
|
7395
|
+
# @return [String]
|
7396
|
+
required :currency, String
|
7397
|
+
|
7398
|
+
# @!method initialize(amount:, currency:)
|
7399
|
+
# Some parameter documentations has been truncated, see
|
7400
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Transit}
|
7401
|
+
# for more details.
|
7402
|
+
#
|
7403
|
+
# The part of this transaction amount that was for transit-related services.
|
7404
|
+
#
|
7405
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7406
|
+
#
|
7407
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7408
|
+
end
|
7409
|
+
|
7410
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#unknown
|
7411
|
+
class Unknown < Increase::Internal::Type::BaseModel
|
7412
|
+
# @!attribute amount
|
7413
|
+
# The amount in minor units of the `currency` field.
|
7414
|
+
#
|
7415
|
+
# @return [Integer]
|
7416
|
+
required :amount, Integer
|
7417
|
+
|
7418
|
+
# @!attribute currency
|
7419
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7420
|
+
# amount's currency.
|
7421
|
+
#
|
7422
|
+
# @return [String]
|
7423
|
+
required :currency, String
|
7424
|
+
|
7425
|
+
# @!method initialize(amount:, currency:)
|
7426
|
+
# Some parameter documentations has been truncated, see
|
7427
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Unknown}
|
7428
|
+
# for more details.
|
7429
|
+
#
|
7430
|
+
# An unknown additional amount.
|
7431
|
+
#
|
7432
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7433
|
+
#
|
7434
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7435
|
+
end
|
7436
|
+
|
7437
|
+
# @see Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts#vision
|
7438
|
+
class Vision < Increase::Internal::Type::BaseModel
|
7439
|
+
# @!attribute amount
|
7440
|
+
# The amount in minor units of the `currency` field.
|
7441
|
+
#
|
7442
|
+
# @return [Integer]
|
7443
|
+
required :amount, Integer
|
7444
|
+
|
7445
|
+
# @!attribute currency
|
7446
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
7447
|
+
# amount's currency.
|
7448
|
+
#
|
7449
|
+
# @return [String]
|
7450
|
+
required :currency, String
|
7451
|
+
|
7452
|
+
# @!method initialize(amount:, currency:)
|
7453
|
+
# Some parameter documentations has been truncated, see
|
7454
|
+
# {Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Vision}
|
7455
|
+
# for more details.
|
7456
|
+
#
|
7457
|
+
# The part of this transaction amount that was for vision-related services.
|
7458
|
+
#
|
7459
|
+
# @param amount [Integer] The amount in minor units of the `currency` field.
|
7460
|
+
#
|
7461
|
+
# @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
|
7462
|
+
end
|
7463
|
+
end
|
7464
|
+
|
5981
7465
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
5982
7466
|
# transaction's currency.
|
5983
7467
|
#
|