lithic 0.1.0.pre.alpha.55 → 0.1.0.pre.alpha.56
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 +20 -0
- data/README.md +1 -1
- data/lib/lithic/client.rb +4 -0
- data/lib/lithic/models/account_activity_list_response.rb +60 -148
- data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +60 -151
- data/lib/lithic/models/auth_rules/auth_rule_condition.rb +8 -51
- data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -51
- data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +260 -0
- data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +8 -53
- data/lib/lithic/models/auth_rules/conditional_operation.rb +26 -0
- data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +254 -0
- data/lib/lithic/models/auth_rules/conditional_value.rb +27 -0
- data/lib/lithic/models/auth_rules/v2_create_params.rb +14 -5
- data/lib/lithic/models/auth_rules/v2_create_response.rb +21 -8
- data/lib/lithic/models/auth_rules/v2_draft_params.rb +7 -3
- data/lib/lithic/models/auth_rules/v2_draft_response.rb +21 -8
- data/lib/lithic/models/auth_rules/v2_list_params.rb +3 -0
- data/lib/lithic/models/auth_rules/v2_list_response.rb +21 -8
- data/lib/lithic/models/auth_rules/v2_promote_response.rb +21 -8
- data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +21 -8
- data/lib/lithic/models/auth_rules/v2_update_response.rb +21 -8
- data/lib/lithic/models/book_transfer_response.rb +1 -0
- data/lib/lithic/models/category_details.rb +27 -0
- data/lib/lithic/models/dispute.rb +242 -510
- data/lib/lithic/models/dispute_v2.rb +555 -0
- data/lib/lithic/models/disputes_v2_list_params.rb +84 -0
- data/lib/lithic/models/disputes_v2_retrieve_params.rb +14 -0
- data/lib/lithic/models/external_bank_account_address.rb +2 -2
- data/lib/lithic/models/external_bank_account_create_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_list_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_retrieve_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_unpause_params.rb +14 -0
- data/lib/lithic/models/external_bank_account_unpause_response.rb +242 -0
- data/lib/lithic/models/external_bank_account_update_response.rb +18 -18
- data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +18 -18
- data/lib/lithic/models/external_payment.rb +3 -2
- data/lib/lithic/models/external_payment_list_params.rb +1 -0
- data/lib/lithic/models/financial_account.rb +4 -3
- data/lib/lithic/models/financial_accounts/category_balances.rb +29 -0
- data/lib/lithic/models/financial_accounts/loan_tape.rb +35 -520
- data/lib/lithic/models/financial_accounts/statement.rb +73 -275
- data/lib/lithic/models/financial_event.rb +148 -0
- data/lib/lithic/models/financial_transaction.rb +3 -146
- data/lib/lithic/models/management_operation_list_params.rb +1 -0
- data/lib/lithic/models/management_operation_transaction.rb +5 -4
- data/lib/lithic/models/merchant.rb +70 -0
- data/lib/lithic/models/payment.rb +7 -5
- data/lib/lithic/models/payment_return_params.rb +62 -0
- data/lib/lithic/models/statement_totals.rb +100 -0
- data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +9 -9
- data/lib/lithic/models/transaction.rb +3 -69
- data/lib/lithic/models/transactions/events/enhanced_data.rb +49 -40
- data/lib/lithic/models/transfer.rb +3 -146
- data/lib/lithic/models.rb +18 -0
- data/lib/lithic/resources/auth_rules/v2.rb +2 -2
- data/lib/lithic/resources/disputes.rb +10 -10
- data/lib/lithic/resources/disputes_v2.rb +74 -0
- data/lib/lithic/resources/external_bank_accounts.rb +19 -0
- data/lib/lithic/resources/payments.rb +48 -0
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +16 -5
- data/rbi/lithic/client.rbi +3 -0
- data/rbi/lithic/models/account_activity_list_response.rbi +121 -544
- data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +121 -544
- data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +13 -139
- data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +13 -153
- data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +789 -0
- data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +13 -153
- data/rbi/lithic/models/auth_rules/conditional_operation.rbi +74 -0
- data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +674 -0
- data/rbi/lithic/models/auth_rules/conditional_value.rbi +28 -0
- data/rbi/lithic/models/auth_rules/v2_create_params.rbi +33 -7
- data/rbi/lithic/models/auth_rules/v2_create_response.rbi +33 -7
- data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +12 -4
- data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +33 -7
- data/rbi/lithic/models/auth_rules/v2_list_params.rbi +15 -0
- data/rbi/lithic/models/auth_rules/v2_list_response.rbi +33 -7
- data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +33 -7
- data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +33 -7
- data/rbi/lithic/models/auth_rules/v2_update_response.rbi +33 -7
- data/rbi/lithic/models/book_transfer_response.rbi +2 -0
- data/rbi/lithic/models/category_details.rbi +43 -0
- data/rbi/lithic/models/dispute.rbi +395 -942
- data/rbi/lithic/models/dispute_v2.rbi +965 -0
- data/rbi/lithic/models/disputes_v2_list_params.rbi +129 -0
- data/rbi/lithic/models/disputes_v2_retrieve_params.rbi +27 -0
- data/rbi/lithic/models/external_bank_account_address.rbi +3 -6
- data/rbi/lithic/models/external_bank_account_create_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_list_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_retrieve_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_unpause_params.rbi +30 -0
- data/rbi/lithic/models/external_bank_account_unpause_response.rbi +375 -0
- data/rbi/lithic/models/external_bank_account_update_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +31 -51
- data/rbi/lithic/models/external_payment.rbi +5 -6
- data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
- data/rbi/lithic/models/financial_account.rbi +12 -4
- data/rbi/lithic/models/financial_accounts/category_balances.rbi +42 -0
- data/rbi/lithic/models/financial_accounts/loan_tape.rbi +47 -802
- data/rbi/lithic/models/financial_accounts/statement.rbi +118 -430
- data/rbi/lithic/models/financial_event.rbi +409 -0
- data/rbi/lithic/models/financial_transaction.rbi +3 -509
- data/rbi/lithic/models/management_operation_list_params.rbi +5 -0
- data/rbi/lithic/models/management_operation_transaction.rbi +11 -12
- data/rbi/lithic/models/merchant.rbi +89 -0
- data/rbi/lithic/models/payment.rbi +16 -7
- data/rbi/lithic/models/payment_return_params.rbi +85 -0
- data/rbi/lithic/models/statement_totals.rbi +128 -0
- data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +12 -12
- data/rbi/lithic/models/transaction.rbi +4 -90
- data/rbi/lithic/models/transactions/events/enhanced_data.rbi +74 -133
- data/rbi/lithic/models/transfer.rbi +4 -436
- data/rbi/lithic/models.rbi +19 -0
- data/rbi/lithic/resources/auth_rules/v2.rbi +8 -3
- data/rbi/lithic/resources/disputes.rbi +5 -7
- data/rbi/lithic/resources/disputes_v2.rbi +64 -0
- data/rbi/lithic/resources/external_bank_accounts.rbi +10 -0
- data/rbi/lithic/resources/payments.rbi +46 -0
- data/sig/lithic/client.rbs +2 -0
- data/sig/lithic/models/account_activity_list_response.rbs +67 -221
- data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +67 -221
- data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +10 -61
- data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -61
- data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +293 -0
- data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +10 -61
- data/sig/lithic/models/auth_rules/conditional_operation.rbs +34 -0
- data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +237 -0
- data/sig/lithic/models/auth_rules/conditional_value.rbs +15 -0
- data/sig/lithic/models/auth_rules/v2_create_params.rbs +11 -1
- data/sig/lithic/models/auth_rules/v2_create_response.rbs +13 -1
- data/sig/lithic/models/auth_rules/v2_draft_params.rbs +2 -0
- data/sig/lithic/models/auth_rules/v2_draft_response.rbs +13 -1
- data/sig/lithic/models/auth_rules/v2_list_params.rbs +9 -1
- data/sig/lithic/models/auth_rules/v2_list_response.rbs +13 -1
- data/sig/lithic/models/auth_rules/v2_promote_response.rbs +13 -1
- data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +13 -1
- data/sig/lithic/models/auth_rules/v2_update_response.rbs +13 -1
- data/sig/lithic/models/book_transfer_response.rbs +3 -1
- data/sig/lithic/models/category_details.rbs +26 -0
- data/sig/lithic/models/dispute.rbs +157 -417
- data/sig/lithic/models/dispute_v2.rbs +438 -0
- data/sig/lithic/models/disputes_v2_list_params.rbs +77 -0
- data/sig/lithic/models/disputes_v2_retrieve_params.rbs +15 -0
- data/sig/lithic/models/external_bank_account_address.rbs +4 -6
- data/sig/lithic/models/external_bank_account_create_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_list_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_retrieve_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_retry_prenote_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_unpause_params.rbs +15 -0
- data/sig/lithic/models/external_bank_account_unpause_response.rbs +162 -0
- data/sig/lithic/models/external_bank_account_update_response.rbs +36 -56
- data/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs +36 -56
- data/sig/lithic/models/external_payment.rbs +7 -7
- data/sig/lithic/models/external_payment_list_params.rbs +3 -1
- data/sig/lithic/models/financial_account.rbs +4 -4
- data/sig/lithic/models/financial_accounts/category_balances.rbs +24 -0
- data/sig/lithic/models/financial_accounts/loan_tape.rbs +48 -464
- data/sig/lithic/models/financial_accounts/statement.rbs +59 -244
- data/sig/lithic/models/financial_event.rbs +216 -0
- data/sig/lithic/models/financial_transaction.rbs +4 -217
- data/sig/lithic/models/management_operation_list_params.rbs +3 -1
- data/sig/lithic/models/management_operation_transaction.rbs +11 -13
- data/sig/lithic/models/merchant.rbs +50 -0
- data/sig/lithic/models/payment.rbs +9 -5
- data/sig/lithic/models/payment_return_params.rbs +46 -0
- data/sig/lithic/models/statement_totals.rbs +76 -0
- data/sig/lithic/models/transaction.rbs +4 -51
- data/sig/lithic/models/transactions/events/enhanced_data.rbs +78 -124
- data/sig/lithic/models/transfer.rbs +6 -219
- data/sig/lithic/models.rbs +18 -0
- data/sig/lithic/resources/disputes.rbs +5 -5
- data/sig/lithic/resources/disputes_v2.rbs +24 -0
- data/sig/lithic/resources/external_bank_accounts.rbs +5 -0
- data/sig/lithic/resources/payments.rbs +10 -0
- metadata +50 -17
- data/lib/lithic/models/dispute_create_response.rb +0 -326
- data/lib/lithic/models/dispute_delete_response.rb +0 -326
- data/lib/lithic/models/dispute_list_response.rb +0 -326
- data/lib/lithic/models/dispute_retrieve_response.rb +0 -326
- data/lib/lithic/models/dispute_update_response.rb +0 -326
- data/rbi/lithic/models/dispute_create_response.rbi +0 -599
- data/rbi/lithic/models/dispute_delete_response.rbi +0 -599
- data/rbi/lithic/models/dispute_list_response.rbi +0 -582
- data/rbi/lithic/models/dispute_retrieve_response.rbi +0 -601
- data/rbi/lithic/models/dispute_update_response.rbi +0 -599
- data/sig/lithic/models/dispute_create_response.rbs +0 -210
- data/sig/lithic/models/dispute_delete_response.rbs +0 -210
- data/sig/lithic/models/dispute_list_response.rbs +0 -210
- data/sig/lithic/models/dispute_retrieve_response.rbs +0 -210
- data/sig/lithic/models/dispute_update_response.rbs +0 -210
|
@@ -2,591 +2,323 @@
|
|
|
2
2
|
|
|
3
3
|
module Lithic
|
|
4
4
|
module Models
|
|
5
|
+
# @see Lithic::Resources::Disputes#create
|
|
5
6
|
class Dispute < Lithic::Internal::Type::BaseModel
|
|
6
7
|
# @!attribute token
|
|
7
|
-
#
|
|
8
|
+
# Globally unique identifier.
|
|
8
9
|
#
|
|
9
10
|
# @return [String]
|
|
10
11
|
required :token, String
|
|
11
12
|
|
|
12
|
-
# @!attribute
|
|
13
|
-
#
|
|
13
|
+
# @!attribute amount
|
|
14
|
+
# Amount under dispute. May be different from the original transaction amount.
|
|
14
15
|
#
|
|
15
|
-
# @return [
|
|
16
|
-
required :
|
|
17
|
-
|
|
18
|
-
# @!attribute card_token
|
|
19
|
-
# Token for the card used in the dispute, in UUID format.
|
|
20
|
-
#
|
|
21
|
-
# @return [String]
|
|
22
|
-
required :card_token, String
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :amount, Integer
|
|
23
18
|
|
|
24
|
-
# @!attribute
|
|
25
|
-
#
|
|
19
|
+
# @!attribute arbitration_date
|
|
20
|
+
# Date dispute entered arbitration.
|
|
26
21
|
#
|
|
27
|
-
# @return [
|
|
28
|
-
required :
|
|
22
|
+
# @return [Time, nil]
|
|
23
|
+
required :arbitration_date, Time, nil?: true
|
|
29
24
|
|
|
30
25
|
# @!attribute created
|
|
31
|
-
#
|
|
26
|
+
# Timestamp of when first Dispute was reported.
|
|
32
27
|
#
|
|
33
28
|
# @return [Time]
|
|
34
29
|
required :created, Time
|
|
35
30
|
|
|
36
|
-
# @!attribute
|
|
37
|
-
#
|
|
31
|
+
# @!attribute customer_filed_date
|
|
32
|
+
# Date that the dispute was filed by the customer making the dispute.
|
|
38
33
|
#
|
|
39
|
-
# @return [
|
|
40
|
-
required :
|
|
34
|
+
# @return [Time, nil]
|
|
35
|
+
required :customer_filed_date, Time, nil?: true
|
|
41
36
|
|
|
42
|
-
# @!attribute
|
|
43
|
-
#
|
|
37
|
+
# @!attribute customer_note
|
|
38
|
+
# End customer description of the reason for the dispute.
|
|
44
39
|
#
|
|
45
|
-
# @return [
|
|
46
|
-
required :
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
required :customer_note, String, nil?: true
|
|
47
42
|
|
|
48
|
-
# @!attribute
|
|
49
|
-
#
|
|
43
|
+
# @!attribute network_claim_ids
|
|
44
|
+
# Unique identifiers for the dispute from the network.
|
|
50
45
|
#
|
|
51
|
-
# @return [Array<
|
|
52
|
-
required :
|
|
46
|
+
# @return [Array<String>, nil]
|
|
47
|
+
required :network_claim_ids, Lithic::Internal::Type::ArrayOf[String], nil?: true
|
|
53
48
|
|
|
54
|
-
# @!attribute
|
|
55
|
-
#
|
|
49
|
+
# @!attribute network_filed_date
|
|
50
|
+
# Date that the dispute was submitted to the network.
|
|
56
51
|
#
|
|
57
|
-
# @return [
|
|
58
|
-
required :
|
|
52
|
+
# @return [Time, nil]
|
|
53
|
+
required :network_filed_date, Time, nil?: true
|
|
59
54
|
|
|
60
|
-
# @!attribute
|
|
55
|
+
# @!attribute network_reason_code
|
|
56
|
+
# Network reason code used to file the dispute.
|
|
61
57
|
#
|
|
62
|
-
# @return [
|
|
63
|
-
required :
|
|
58
|
+
# @return [String, nil]
|
|
59
|
+
required :network_reason_code, String, nil?: true
|
|
64
60
|
|
|
65
|
-
# @!attribute
|
|
66
|
-
#
|
|
61
|
+
# @!attribute prearbitration_date
|
|
62
|
+
# Date dispute entered pre-arbitration.
|
|
67
63
|
#
|
|
68
|
-
# @return [
|
|
69
|
-
required :
|
|
64
|
+
# @return [Time, nil]
|
|
65
|
+
required :prearbitration_date, Time, nil?: true
|
|
70
66
|
|
|
71
|
-
# @!attribute
|
|
72
|
-
#
|
|
67
|
+
# @!attribute primary_claim_id
|
|
68
|
+
# Unique identifier for the dispute from the network. If there are multiple, this
|
|
69
|
+
# will be the first claim id set by the network
|
|
73
70
|
#
|
|
74
|
-
# @return [
|
|
75
|
-
required :
|
|
71
|
+
# @return [String, nil]
|
|
72
|
+
required :primary_claim_id, String, nil?: true
|
|
73
|
+
|
|
74
|
+
# @!attribute reason
|
|
75
|
+
# Dispute reason:
|
|
76
|
+
#
|
|
77
|
+
# - `ATM_CASH_MISDISPENSE`: ATM cash misdispense.
|
|
78
|
+
# - `CANCELLED`: Transaction was cancelled by the customer.
|
|
79
|
+
# - `DUPLICATED`: The transaction was a duplicate.
|
|
80
|
+
# - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present.
|
|
81
|
+
# - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present.
|
|
82
|
+
# - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable
|
|
83
|
+
# merchant activity.
|
|
84
|
+
# - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as
|
|
85
|
+
# described.
|
|
86
|
+
# - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received.
|
|
87
|
+
# - `INCORRECT_AMOUNT`: The transaction amount was incorrect.
|
|
88
|
+
# - `MISSING_AUTH`: The transaction was missing authorization.
|
|
89
|
+
# - `OTHER`: Other reason.
|
|
90
|
+
# - `PROCESSING_ERROR`: Processing error.
|
|
91
|
+
# - `REFUND_NOT_PROCESSED`: The refund was not processed.
|
|
92
|
+
# - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not
|
|
93
|
+
# cancelled.
|
|
94
|
+
#
|
|
95
|
+
# @return [Symbol, Lithic::Models::Dispute::Reason]
|
|
96
|
+
required :reason, enum: -> { Lithic::Dispute::Reason }
|
|
97
|
+
|
|
98
|
+
# @!attribute representment_date
|
|
99
|
+
# Date the representment was received.
|
|
100
|
+
#
|
|
101
|
+
# @return [Time, nil]
|
|
102
|
+
required :representment_date, Time, nil?: true
|
|
103
|
+
|
|
104
|
+
# @!attribute resolution_date
|
|
105
|
+
# Date that the dispute was resolved.
|
|
106
|
+
#
|
|
107
|
+
# @return [Time, nil]
|
|
108
|
+
required :resolution_date, Time, nil?: true
|
|
109
|
+
|
|
110
|
+
# @!attribute resolution_note
|
|
111
|
+
# Note by Dispute team on the case resolution.
|
|
112
|
+
#
|
|
113
|
+
# @return [String, nil]
|
|
114
|
+
required :resolution_note, String, nil?: true
|
|
115
|
+
|
|
116
|
+
# @!attribute resolution_reason
|
|
117
|
+
# Reason for the dispute resolution:
|
|
118
|
+
#
|
|
119
|
+
# - `CASE_LOST`: This case was lost at final arbitration.
|
|
120
|
+
# - `NETWORK_REJECTED`: Network rejected.
|
|
121
|
+
# - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS.
|
|
122
|
+
# - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold.
|
|
123
|
+
# - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless.
|
|
124
|
+
# - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid.
|
|
125
|
+
# - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks.
|
|
126
|
+
# - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other.
|
|
127
|
+
# - `PAST_FILING_DATE`: Past filing date.
|
|
128
|
+
# - `PREARBITRATION_REJECTED`: Prearbitration rejected.
|
|
129
|
+
# - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other.
|
|
130
|
+
# - `REFUNDED`: Refunded.
|
|
131
|
+
# - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback.
|
|
132
|
+
# - `WITHDRAWN`: Withdrawn.
|
|
133
|
+
# - `WON_ARBITRATION`: Won arbitration.
|
|
134
|
+
# - `WON_FIRST_CHARGEBACK`: Won first chargeback.
|
|
135
|
+
# - `WON_PREARBITRATION`: Won prearbitration.
|
|
136
|
+
#
|
|
137
|
+
# @return [Symbol, Lithic::Models::Dispute::ResolutionReason, nil]
|
|
138
|
+
required :resolution_reason, enum: -> { Lithic::Dispute::ResolutionReason }, nil?: true
|
|
76
139
|
|
|
77
|
-
# @!attribute
|
|
78
|
-
#
|
|
79
|
-
#
|
|
140
|
+
# @!attribute status
|
|
141
|
+
# Status types:
|
|
142
|
+
#
|
|
143
|
+
# - `NEW` - New dispute case is opened.
|
|
144
|
+
# - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more
|
|
145
|
+
# information.
|
|
146
|
+
# - `SUBMITTED` - Dispute is submitted to the card network.
|
|
147
|
+
# - `REPRESENTMENT` - Case has entered second presentment.
|
|
148
|
+
# - `PREARBITRATION` - Case has entered prearbitration.
|
|
149
|
+
# - `ARBITRATION` - Case has entered arbitration.
|
|
150
|
+
# - `CASE_WON` - Case was won and credit will be issued.
|
|
151
|
+
# - `CASE_CLOSED` - Case was lost or withdrawn.
|
|
80
152
|
#
|
|
81
|
-
# @return [Lithic::Models::Dispute::
|
|
82
|
-
required :
|
|
153
|
+
# @return [Symbol, Lithic::Models::Dispute::Status]
|
|
154
|
+
required :status, enum: -> { Lithic::Dispute::Status }
|
|
83
155
|
|
|
84
|
-
# @!attribute
|
|
85
|
-
#
|
|
156
|
+
# @!attribute transaction_token
|
|
157
|
+
# The transaction that is being disputed. A transaction can only be disputed once
|
|
158
|
+
# but may have multiple dispute cases.
|
|
86
159
|
#
|
|
87
|
-
# @return [
|
|
88
|
-
required :
|
|
160
|
+
# @return [String]
|
|
161
|
+
required :transaction_token, String
|
|
89
162
|
|
|
90
|
-
# @!method initialize(token:,
|
|
163
|
+
# @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:)
|
|
91
164
|
# Some parameter documentations has been truncated, see {Lithic::Models::Dispute}
|
|
92
165
|
# for more details.
|
|
93
166
|
#
|
|
94
|
-
#
|
|
167
|
+
# Dispute.
|
|
168
|
+
#
|
|
169
|
+
# @param token [String] Globally unique identifier.
|
|
170
|
+
#
|
|
171
|
+
# @param amount [Integer] Amount under dispute. May be different from the original transaction amount.
|
|
95
172
|
#
|
|
96
|
-
# @param
|
|
173
|
+
# @param arbitration_date [Time, nil] Date dispute entered arbitration.
|
|
97
174
|
#
|
|
98
|
-
# @param
|
|
175
|
+
# @param created [Time] Timestamp of when first Dispute was reported.
|
|
99
176
|
#
|
|
100
|
-
# @param
|
|
177
|
+
# @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute.
|
|
101
178
|
#
|
|
102
|
-
# @param
|
|
179
|
+
# @param customer_note [String, nil] End customer description of the reason for the dispute.
|
|
103
180
|
#
|
|
104
|
-
# @param
|
|
181
|
+
# @param network_claim_ids [Array<String>, nil] Unique identifiers for the dispute from the network.
|
|
105
182
|
#
|
|
106
|
-
# @param
|
|
183
|
+
# @param network_filed_date [Time, nil] Date that the dispute was submitted to the network.
|
|
107
184
|
#
|
|
108
|
-
# @param
|
|
185
|
+
# @param network_reason_code [String, nil] Network reason code used to file the dispute.
|
|
109
186
|
#
|
|
110
|
-
# @param
|
|
187
|
+
# @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration.
|
|
111
188
|
#
|
|
112
|
-
# @param
|
|
189
|
+
# @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this
|
|
113
190
|
#
|
|
114
|
-
# @param
|
|
191
|
+
# @param reason [Symbol, Lithic::Models::Dispute::Reason] Dispute reason:
|
|
115
192
|
#
|
|
116
|
-
# @param
|
|
193
|
+
# @param representment_date [Time, nil] Date the representment was received.
|
|
117
194
|
#
|
|
118
|
-
# @param
|
|
195
|
+
# @param resolution_date [Time, nil] Date that the dispute was resolved.
|
|
119
196
|
#
|
|
120
|
-
# @param
|
|
197
|
+
# @param resolution_note [String, nil] Note by Dispute team on the case resolution.
|
|
121
198
|
#
|
|
122
|
-
# @param
|
|
199
|
+
# @param resolution_reason [Symbol, Lithic::Models::Dispute::ResolutionReason, nil] Reason for the dispute resolution:
|
|
200
|
+
#
|
|
201
|
+
# @param status [Symbol, Lithic::Models::Dispute::Status] Status types:
|
|
202
|
+
#
|
|
203
|
+
# @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once
|
|
123
204
|
|
|
124
|
-
# Dispute
|
|
205
|
+
# Dispute reason:
|
|
206
|
+
#
|
|
207
|
+
# - `ATM_CASH_MISDISPENSE`: ATM cash misdispense.
|
|
208
|
+
# - `CANCELLED`: Transaction was cancelled by the customer.
|
|
209
|
+
# - `DUPLICATED`: The transaction was a duplicate.
|
|
210
|
+
# - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present.
|
|
211
|
+
# - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present.
|
|
212
|
+
# - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable
|
|
213
|
+
# merchant activity.
|
|
214
|
+
# - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as
|
|
215
|
+
# described.
|
|
216
|
+
# - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received.
|
|
217
|
+
# - `INCORRECT_AMOUNT`: The transaction amount was incorrect.
|
|
218
|
+
# - `MISSING_AUTH`: The transaction was missing authorization.
|
|
219
|
+
# - `OTHER`: Other reason.
|
|
220
|
+
# - `PROCESSING_ERROR`: Processing error.
|
|
221
|
+
# - `REFUND_NOT_PROCESSED`: The refund was not processed.
|
|
222
|
+
# - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not
|
|
223
|
+
# cancelled.
|
|
125
224
|
#
|
|
126
|
-
# @see Lithic::Models::Dispute#
|
|
127
|
-
module
|
|
225
|
+
# @see Lithic::Models::Dispute#reason
|
|
226
|
+
module Reason
|
|
128
227
|
extend Lithic::Internal::Type::Enum
|
|
129
228
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
229
|
+
ATM_CASH_MISDISPENSE = :ATM_CASH_MISDISPENSE
|
|
230
|
+
CANCELLED = :CANCELLED
|
|
231
|
+
DUPLICATED = :DUPLICATED
|
|
232
|
+
FRAUD_CARD_NOT_PRESENT = :FRAUD_CARD_NOT_PRESENT
|
|
233
|
+
FRAUD_CARD_PRESENT = :FRAUD_CARD_PRESENT
|
|
234
|
+
FRAUD_OTHER = :FRAUD_OTHER
|
|
235
|
+
GOODS_SERVICES_NOT_AS_DESCRIBED = :GOODS_SERVICES_NOT_AS_DESCRIBED
|
|
236
|
+
GOODS_SERVICES_NOT_RECEIVED = :GOODS_SERVICES_NOT_RECEIVED
|
|
237
|
+
INCORRECT_AMOUNT = :INCORRECT_AMOUNT
|
|
238
|
+
MISSING_AUTH = :MISSING_AUTH
|
|
239
|
+
OTHER = :OTHER
|
|
240
|
+
PROCESSING_ERROR = :PROCESSING_ERROR
|
|
241
|
+
RECURRING_TRANSACTION_NOT_CANCELLED = :RECURRING_TRANSACTION_NOT_CANCELLED
|
|
242
|
+
REFUND_NOT_PROCESSED = :REFUND_NOT_PROCESSED
|
|
135
243
|
|
|
136
244
|
# @!method self.values
|
|
137
245
|
# @return [Array<Symbol>]
|
|
138
246
|
end
|
|
139
247
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
# @return [Symbol, Lithic::Models::Dispute::Event::Type]
|
|
163
|
-
required :type, enum: -> { Lithic::Dispute::Event::Type }
|
|
164
|
-
|
|
165
|
-
# @!method initialize(token:, created:, data:, type:)
|
|
166
|
-
# Event that occurred in the dispute lifecycle
|
|
167
|
-
#
|
|
168
|
-
# @param token [String] Unique identifier for the event, in UUID format
|
|
169
|
-
#
|
|
170
|
-
# @param created [Time] When the event occurred
|
|
171
|
-
#
|
|
172
|
-
# @param data [Lithic::Models::Dispute::Event::Data::WorkflowEventData, Lithic::Models::Dispute::Event::Data::FinancialEventData, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData] Details specific to the event type
|
|
173
|
-
#
|
|
174
|
-
# @param type [Symbol, Lithic::Models::Dispute::Event::Type] Type of event
|
|
175
|
-
|
|
176
|
-
# Details specific to the event type
|
|
177
|
-
#
|
|
178
|
-
# @see Lithic::Models::Dispute::Event#data
|
|
179
|
-
module Data
|
|
180
|
-
extend Lithic::Internal::Type::Union
|
|
181
|
-
|
|
182
|
-
# Details specific to workflow events
|
|
183
|
-
variant -> { Lithic::Dispute::Event::Data::WorkflowEventData }
|
|
184
|
-
|
|
185
|
-
# Details specific to financial events
|
|
186
|
-
variant -> { Lithic::Dispute::Event::Data::FinancialEventData }
|
|
187
|
-
|
|
188
|
-
# Details specific to cardholder liability events
|
|
189
|
-
variant -> { Lithic::Dispute::Event::Data::CardholderLiabilityEventData }
|
|
190
|
-
|
|
191
|
-
class WorkflowEventData < Lithic::Internal::Type::BaseModel
|
|
192
|
-
# @!attribute action
|
|
193
|
-
# Action taken in this stage
|
|
194
|
-
#
|
|
195
|
-
# @return [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Action]
|
|
196
|
-
required :action, enum: -> { Lithic::Dispute::Event::Data::WorkflowEventData::Action }
|
|
197
|
-
|
|
198
|
-
# @!attribute amount
|
|
199
|
-
# Amount in minor units
|
|
200
|
-
#
|
|
201
|
-
# @return [Integer, nil]
|
|
202
|
-
required :amount, Integer, nil?: true
|
|
203
|
-
|
|
204
|
-
# @!attribute disposition
|
|
205
|
-
# Dispute resolution outcome
|
|
206
|
-
#
|
|
207
|
-
# @return [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Disposition, nil]
|
|
208
|
-
required :disposition,
|
|
209
|
-
enum: -> { Lithic::Dispute::Event::Data::WorkflowEventData::Disposition },
|
|
210
|
-
nil?: true
|
|
211
|
-
|
|
212
|
-
# @!attribute reason
|
|
213
|
-
# Reason for the action
|
|
214
|
-
#
|
|
215
|
-
# @return [String, nil]
|
|
216
|
-
required :reason, String, nil?: true
|
|
217
|
-
|
|
218
|
-
# @!attribute stage
|
|
219
|
-
# Current stage of the dispute workflow
|
|
220
|
-
#
|
|
221
|
-
# @return [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Stage]
|
|
222
|
-
required :stage, enum: -> { Lithic::Dispute::Event::Data::WorkflowEventData::Stage }
|
|
223
|
-
|
|
224
|
-
# @!method initialize(action:, amount:, disposition:, reason:, stage:)
|
|
225
|
-
# Details specific to workflow events
|
|
226
|
-
#
|
|
227
|
-
# @param action [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Action] Action taken in this stage
|
|
228
|
-
#
|
|
229
|
-
# @param amount [Integer, nil] Amount in minor units
|
|
230
|
-
#
|
|
231
|
-
# @param disposition [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Disposition, nil] Dispute resolution outcome
|
|
232
|
-
#
|
|
233
|
-
# @param reason [String, nil] Reason for the action
|
|
234
|
-
#
|
|
235
|
-
# @param stage [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Stage] Current stage of the dispute workflow
|
|
236
|
-
|
|
237
|
-
# Action taken in this stage
|
|
238
|
-
#
|
|
239
|
-
# @see Lithic::Models::Dispute::Event::Data::WorkflowEventData#action
|
|
240
|
-
module Action
|
|
241
|
-
extend Lithic::Internal::Type::Enum
|
|
242
|
-
|
|
243
|
-
OPENED = :OPENED
|
|
244
|
-
CLOSED = :CLOSED
|
|
245
|
-
REOPENED = :REOPENED
|
|
246
|
-
|
|
247
|
-
# @!method self.values
|
|
248
|
-
# @return [Array<Symbol>]
|
|
249
|
-
end
|
|
250
|
-
|
|
251
|
-
# Dispute resolution outcome
|
|
252
|
-
#
|
|
253
|
-
# @see Lithic::Models::Dispute::Event::Data::WorkflowEventData#disposition
|
|
254
|
-
module Disposition
|
|
255
|
-
extend Lithic::Internal::Type::Enum
|
|
256
|
-
|
|
257
|
-
WON = :WON
|
|
258
|
-
LOST = :LOST
|
|
259
|
-
PARTIALLY_WON = :PARTIALLY_WON
|
|
260
|
-
WITHDRAWN = :WITHDRAWN
|
|
261
|
-
DENIED = :DENIED
|
|
262
|
-
|
|
263
|
-
# @!method self.values
|
|
264
|
-
# @return [Array<Symbol>]
|
|
265
|
-
end
|
|
266
|
-
|
|
267
|
-
# Current stage of the dispute workflow
|
|
268
|
-
#
|
|
269
|
-
# @see Lithic::Models::Dispute::Event::Data::WorkflowEventData#stage
|
|
270
|
-
module Stage
|
|
271
|
-
extend Lithic::Internal::Type::Enum
|
|
272
|
-
|
|
273
|
-
CLAIM = :CLAIM
|
|
274
|
-
|
|
275
|
-
# @!method self.values
|
|
276
|
-
# @return [Array<Symbol>]
|
|
277
|
-
end
|
|
278
|
-
end
|
|
279
|
-
|
|
280
|
-
class FinancialEventData < Lithic::Internal::Type::BaseModel
|
|
281
|
-
# @!attribute amount
|
|
282
|
-
# Amount in minor units
|
|
283
|
-
#
|
|
284
|
-
# @return [Integer]
|
|
285
|
-
required :amount, Integer
|
|
286
|
-
|
|
287
|
-
# @!attribute polarity
|
|
288
|
-
# Direction of funds flow
|
|
289
|
-
#
|
|
290
|
-
# @return [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Polarity]
|
|
291
|
-
required :polarity, enum: -> { Lithic::Dispute::Event::Data::FinancialEventData::Polarity }
|
|
292
|
-
|
|
293
|
-
# @!attribute stage
|
|
294
|
-
# Stage at which the financial event occurred
|
|
295
|
-
#
|
|
296
|
-
# @return [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Stage]
|
|
297
|
-
required :stage, enum: -> { Lithic::Dispute::Event::Data::FinancialEventData::Stage }
|
|
298
|
-
|
|
299
|
-
# @!method initialize(amount:, polarity:, stage:)
|
|
300
|
-
# Details specific to financial events
|
|
301
|
-
#
|
|
302
|
-
# @param amount [Integer] Amount in minor units
|
|
303
|
-
#
|
|
304
|
-
# @param polarity [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Polarity] Direction of funds flow
|
|
305
|
-
#
|
|
306
|
-
# @param stage [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Stage] Stage at which the financial event occurred
|
|
307
|
-
|
|
308
|
-
# Direction of funds flow
|
|
309
|
-
#
|
|
310
|
-
# @see Lithic::Models::Dispute::Event::Data::FinancialEventData#polarity
|
|
311
|
-
module Polarity
|
|
312
|
-
extend Lithic::Internal::Type::Enum
|
|
313
|
-
|
|
314
|
-
CREDIT = :CREDIT
|
|
315
|
-
DEBIT = :DEBIT
|
|
316
|
-
|
|
317
|
-
# @!method self.values
|
|
318
|
-
# @return [Array<Symbol>]
|
|
319
|
-
end
|
|
320
|
-
|
|
321
|
-
# Stage at which the financial event occurred
|
|
322
|
-
#
|
|
323
|
-
# @see Lithic::Models::Dispute::Event::Data::FinancialEventData#stage
|
|
324
|
-
module Stage
|
|
325
|
-
extend Lithic::Internal::Type::Enum
|
|
326
|
-
|
|
327
|
-
CHARGEBACK = :CHARGEBACK
|
|
328
|
-
REPRESENTMENT = :REPRESENTMENT
|
|
329
|
-
PREARBITRATION = :PREARBITRATION
|
|
330
|
-
ARBITRATION = :ARBITRATION
|
|
331
|
-
COLLABORATION = :COLLABORATION
|
|
332
|
-
|
|
333
|
-
# @!method self.values
|
|
334
|
-
# @return [Array<Symbol>]
|
|
335
|
-
end
|
|
336
|
-
end
|
|
337
|
-
|
|
338
|
-
class CardholderLiabilityEventData < Lithic::Internal::Type::BaseModel
|
|
339
|
-
# @!attribute action
|
|
340
|
-
# Action taken regarding cardholder liability
|
|
341
|
-
#
|
|
342
|
-
# @return [Symbol, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::Action]
|
|
343
|
-
required :action, enum: -> { Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action }
|
|
344
|
-
|
|
345
|
-
# @!attribute amount
|
|
346
|
-
# Amount in minor units
|
|
347
|
-
#
|
|
348
|
-
# @return [Integer]
|
|
349
|
-
required :amount, Integer
|
|
350
|
-
|
|
351
|
-
# @!attribute reason
|
|
352
|
-
# Reason for the action
|
|
353
|
-
#
|
|
354
|
-
# @return [String]
|
|
355
|
-
required :reason, String
|
|
356
|
-
|
|
357
|
-
# @!method initialize(action:, amount:, reason:)
|
|
358
|
-
# Details specific to cardholder liability events
|
|
359
|
-
#
|
|
360
|
-
# @param action [Symbol, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::Action] Action taken regarding cardholder liability
|
|
361
|
-
#
|
|
362
|
-
# @param amount [Integer] Amount in minor units
|
|
363
|
-
#
|
|
364
|
-
# @param reason [String] Reason for the action
|
|
365
|
-
|
|
366
|
-
# Action taken regarding cardholder liability
|
|
367
|
-
#
|
|
368
|
-
# @see Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData#action
|
|
369
|
-
module Action
|
|
370
|
-
extend Lithic::Internal::Type::Enum
|
|
371
|
-
|
|
372
|
-
PROVISIONAL_CREDIT_GRANTED = :PROVISIONAL_CREDIT_GRANTED
|
|
373
|
-
PROVISIONAL_CREDIT_REVERSED = :PROVISIONAL_CREDIT_REVERSED
|
|
374
|
-
WRITTEN_OFF = :WRITTEN_OFF
|
|
375
|
-
|
|
376
|
-
# @!method self.values
|
|
377
|
-
# @return [Array<Symbol>]
|
|
378
|
-
end
|
|
379
|
-
end
|
|
380
|
-
|
|
381
|
-
# @!method self.variants
|
|
382
|
-
# @return [Array(Lithic::Models::Dispute::Event::Data::WorkflowEventData, Lithic::Models::Dispute::Event::Data::FinancialEventData, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData)]
|
|
383
|
-
end
|
|
384
|
-
|
|
385
|
-
# Type of event
|
|
386
|
-
#
|
|
387
|
-
# @see Lithic::Models::Dispute::Event#type
|
|
388
|
-
module Type
|
|
389
|
-
extend Lithic::Internal::Type::Enum
|
|
390
|
-
|
|
391
|
-
WORKFLOW = :WORKFLOW
|
|
392
|
-
FINANCIAL = :FINANCIAL
|
|
393
|
-
CARDHOLDER_LIABILITY = :CARDHOLDER_LIABILITY
|
|
394
|
-
|
|
395
|
-
# @!method self.values
|
|
396
|
-
# @return [Array<Symbol>]
|
|
397
|
-
end
|
|
398
|
-
end
|
|
399
|
-
|
|
400
|
-
# @see Lithic::Models::Dispute#liability_allocation
|
|
401
|
-
class LiabilityAllocation < Lithic::Internal::Type::BaseModel
|
|
402
|
-
# @!attribute denied_amount
|
|
403
|
-
# The amount that has been denied to the cardholder
|
|
404
|
-
#
|
|
405
|
-
# @return [Integer]
|
|
406
|
-
required :denied_amount, Integer
|
|
407
|
-
|
|
408
|
-
# @!attribute original_amount
|
|
409
|
-
# The initial amount disputed
|
|
410
|
-
#
|
|
411
|
-
# @return [Integer]
|
|
412
|
-
required :original_amount, Integer
|
|
413
|
-
|
|
414
|
-
# @!attribute recovered_amount
|
|
415
|
-
# The amount that has been recovered from the merchant through the dispute process
|
|
416
|
-
#
|
|
417
|
-
# @return [Integer]
|
|
418
|
-
required :recovered_amount, Integer
|
|
419
|
-
|
|
420
|
-
# @!attribute remaining_amount
|
|
421
|
-
# Any disputed amount that is still outstanding, i.e. has not been recovered,
|
|
422
|
-
# written off, or denied
|
|
423
|
-
#
|
|
424
|
-
# @return [Integer]
|
|
425
|
-
required :remaining_amount, Integer
|
|
426
|
-
|
|
427
|
-
# @!attribute written_off_amount
|
|
428
|
-
# The amount the issuer has chosen to write off
|
|
429
|
-
#
|
|
430
|
-
# @return [Integer]
|
|
431
|
-
required :written_off_amount, Integer
|
|
432
|
-
|
|
433
|
-
# @!method initialize(denied_amount:, original_amount:, recovered_amount:, remaining_amount:, written_off_amount:)
|
|
434
|
-
# Some parameter documentations has been truncated, see
|
|
435
|
-
# {Lithic::Models::Dispute::LiabilityAllocation} for more details.
|
|
436
|
-
#
|
|
437
|
-
# Current breakdown of how liability is allocated for the disputed amount
|
|
438
|
-
#
|
|
439
|
-
# @param denied_amount [Integer] The amount that has been denied to the cardholder
|
|
440
|
-
#
|
|
441
|
-
# @param original_amount [Integer] The initial amount disputed
|
|
442
|
-
#
|
|
443
|
-
# @param recovered_amount [Integer] The amount that has been recovered from the merchant through the dispute process
|
|
444
|
-
#
|
|
445
|
-
# @param remaining_amount [Integer] Any disputed amount that is still outstanding, i.e. has not been recovered, writ
|
|
446
|
-
#
|
|
447
|
-
# @param written_off_amount [Integer] The amount the issuer has chosen to write off
|
|
448
|
-
end
|
|
449
|
-
|
|
450
|
-
# @see Lithic::Models::Dispute#merchant
|
|
451
|
-
class Merchant < Lithic::Internal::Type::BaseModel
|
|
452
|
-
# @!attribute acceptor_id
|
|
453
|
-
# Unique alphanumeric identifier for the payment card acceptor (merchant).
|
|
454
|
-
#
|
|
455
|
-
# @return [String]
|
|
456
|
-
required :acceptor_id, String
|
|
457
|
-
|
|
458
|
-
# @!attribute acquiring_institution_id
|
|
459
|
-
# Unique numeric identifier of the acquiring institution.
|
|
460
|
-
#
|
|
461
|
-
# @return [String]
|
|
462
|
-
required :acquiring_institution_id, String
|
|
463
|
-
|
|
464
|
-
# @!attribute city
|
|
465
|
-
# City of card acceptor. Note that in many cases, particularly in card-not-present
|
|
466
|
-
# transactions, merchants may send through a phone number or URL in this field.
|
|
467
|
-
#
|
|
468
|
-
# @return [String]
|
|
469
|
-
required :city, String
|
|
470
|
-
|
|
471
|
-
# @!attribute country
|
|
472
|
-
# Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
|
|
473
|
-
# alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
|
|
474
|
-
#
|
|
475
|
-
# @return [String]
|
|
476
|
-
required :country, String
|
|
477
|
-
|
|
478
|
-
# @!attribute descriptor
|
|
479
|
-
# Short description of card acceptor.
|
|
480
|
-
#
|
|
481
|
-
# @return [String]
|
|
482
|
-
required :descriptor, String
|
|
483
|
-
|
|
484
|
-
# @!attribute mcc
|
|
485
|
-
# Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
|
|
486
|
-
# used to classify a business by the types of goods or services it provides.
|
|
487
|
-
#
|
|
488
|
-
# @return [String]
|
|
489
|
-
required :mcc, String
|
|
490
|
-
|
|
491
|
-
# @!attribute state
|
|
492
|
-
# Geographic state of card acceptor.
|
|
493
|
-
#
|
|
494
|
-
# @return [String]
|
|
495
|
-
required :state, String
|
|
496
|
-
|
|
497
|
-
# @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:)
|
|
498
|
-
# Some parameter documentations has been truncated, see
|
|
499
|
-
# {Lithic::Models::Dispute::Merchant} for more details.
|
|
500
|
-
#
|
|
501
|
-
# @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant).
|
|
502
|
-
#
|
|
503
|
-
# @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution.
|
|
504
|
-
#
|
|
505
|
-
# @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present
|
|
506
|
-
#
|
|
507
|
-
# @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph
|
|
508
|
-
#
|
|
509
|
-
# @param descriptor [String] Short description of card acceptor.
|
|
510
|
-
#
|
|
511
|
-
# @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
|
|
512
|
-
#
|
|
513
|
-
# @param state [String] Geographic state of card acceptor.
|
|
514
|
-
end
|
|
515
|
-
|
|
516
|
-
# Card network handling the dispute.
|
|
517
|
-
#
|
|
518
|
-
# @see Lithic::Models::Dispute#network
|
|
519
|
-
module Network
|
|
248
|
+
# Reason for the dispute resolution:
|
|
249
|
+
#
|
|
250
|
+
# - `CASE_LOST`: This case was lost at final arbitration.
|
|
251
|
+
# - `NETWORK_REJECTED`: Network rejected.
|
|
252
|
+
# - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS.
|
|
253
|
+
# - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold.
|
|
254
|
+
# - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless.
|
|
255
|
+
# - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid.
|
|
256
|
+
# - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks.
|
|
257
|
+
# - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other.
|
|
258
|
+
# - `PAST_FILING_DATE`: Past filing date.
|
|
259
|
+
# - `PREARBITRATION_REJECTED`: Prearbitration rejected.
|
|
260
|
+
# - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other.
|
|
261
|
+
# - `REFUNDED`: Refunded.
|
|
262
|
+
# - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback.
|
|
263
|
+
# - `WITHDRAWN`: Withdrawn.
|
|
264
|
+
# - `WON_ARBITRATION`: Won arbitration.
|
|
265
|
+
# - `WON_FIRST_CHARGEBACK`: Won first chargeback.
|
|
266
|
+
# - `WON_PREARBITRATION`: Won prearbitration.
|
|
267
|
+
#
|
|
268
|
+
# @see Lithic::Models::Dispute#resolution_reason
|
|
269
|
+
module ResolutionReason
|
|
520
270
|
extend Lithic::Internal::Type::Enum
|
|
521
271
|
|
|
522
|
-
|
|
523
|
-
|
|
272
|
+
CASE_LOST = :CASE_LOST
|
|
273
|
+
NETWORK_REJECTED = :NETWORK_REJECTED
|
|
274
|
+
NO_DISPUTE_RIGHTS_3DS = :NO_DISPUTE_RIGHTS_3DS
|
|
275
|
+
NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD
|
|
276
|
+
NO_DISPUTE_RIGHTS_CONTACTLESS = :NO_DISPUTE_RIGHTS_CONTACTLESS
|
|
277
|
+
NO_DISPUTE_RIGHTS_HYBRID = :NO_DISPUTE_RIGHTS_HYBRID
|
|
278
|
+
NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS
|
|
279
|
+
NO_DISPUTE_RIGHTS_OTHER = :NO_DISPUTE_RIGHTS_OTHER
|
|
280
|
+
PAST_FILING_DATE = :PAST_FILING_DATE
|
|
281
|
+
PREARBITRATION_REJECTED = :PREARBITRATION_REJECTED
|
|
282
|
+
PROCESSOR_REJECTED_OTHER = :PROCESSOR_REJECTED_OTHER
|
|
283
|
+
REFUNDED = :REFUNDED
|
|
284
|
+
REFUNDED_AFTER_CHARGEBACK = :REFUNDED_AFTER_CHARGEBACK
|
|
285
|
+
WITHDRAWN = :WITHDRAWN
|
|
286
|
+
WON_ARBITRATION = :WON_ARBITRATION
|
|
287
|
+
WON_FIRST_CHARGEBACK = :WON_FIRST_CHARGEBACK
|
|
288
|
+
WON_PREARBITRATION = :WON_PREARBITRATION
|
|
524
289
|
|
|
525
290
|
# @!method self.values
|
|
526
291
|
# @return [Array<Symbol>]
|
|
527
292
|
end
|
|
528
293
|
|
|
529
|
-
#
|
|
294
|
+
# Status types:
|
|
295
|
+
#
|
|
296
|
+
# - `NEW` - New dispute case is opened.
|
|
297
|
+
# - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more
|
|
298
|
+
# information.
|
|
299
|
+
# - `SUBMITTED` - Dispute is submitted to the card network.
|
|
300
|
+
# - `REPRESENTMENT` - Case has entered second presentment.
|
|
301
|
+
# - `PREARBITRATION` - Case has entered prearbitration.
|
|
302
|
+
# - `ARBITRATION` - Case has entered arbitration.
|
|
303
|
+
# - `CASE_WON` - Case was won and credit will be issued.
|
|
304
|
+
# - `CASE_CLOSED` - Case was lost or withdrawn.
|
|
530
305
|
#
|
|
531
306
|
# @see Lithic::Models::Dispute#status
|
|
532
307
|
module Status
|
|
533
308
|
extend Lithic::Internal::Type::Enum
|
|
534
309
|
|
|
535
|
-
|
|
536
|
-
|
|
310
|
+
ARBITRATION = :ARBITRATION
|
|
311
|
+
CASE_CLOSED = :CASE_CLOSED
|
|
312
|
+
CASE_WON = :CASE_WON
|
|
313
|
+
NEW = :NEW
|
|
314
|
+
PENDING_CUSTOMER = :PENDING_CUSTOMER
|
|
315
|
+
PREARBITRATION = :PREARBITRATION
|
|
316
|
+
REPRESENTMENT = :REPRESENTMENT
|
|
317
|
+
SUBMITTED = :SUBMITTED
|
|
537
318
|
|
|
538
319
|
# @!method self.values
|
|
539
320
|
# @return [Array<Symbol>]
|
|
540
321
|
end
|
|
541
|
-
|
|
542
|
-
# @see Lithic::Models::Dispute#transaction_series
|
|
543
|
-
class TransactionSeries < Lithic::Internal::Type::BaseModel
|
|
544
|
-
# @!attribute related_transaction_event_token
|
|
545
|
-
# Token of the specific event in the original transaction being disputed, in UUID
|
|
546
|
-
# format; null if no event can be identified
|
|
547
|
-
#
|
|
548
|
-
# @return [String, nil]
|
|
549
|
-
required :related_transaction_event_token, String, nil?: true
|
|
550
|
-
|
|
551
|
-
# @!attribute related_transaction_token
|
|
552
|
-
# Token of the original transaction being disputed, in UUID format
|
|
553
|
-
#
|
|
554
|
-
# @return [String]
|
|
555
|
-
required :related_transaction_token, String
|
|
556
|
-
|
|
557
|
-
# @!attribute type
|
|
558
|
-
# The type of transaction series associating the dispute and the original
|
|
559
|
-
# transaction. Always set to DISPUTE
|
|
560
|
-
#
|
|
561
|
-
# @return [Symbol, Lithic::Models::Dispute::TransactionSeries::Type]
|
|
562
|
-
required :type, enum: -> { Lithic::Dispute::TransactionSeries::Type }
|
|
563
|
-
|
|
564
|
-
# @!method initialize(related_transaction_event_token:, related_transaction_token:, type:)
|
|
565
|
-
# Some parameter documentations has been truncated, see
|
|
566
|
-
# {Lithic::Models::Dispute::TransactionSeries} for more details.
|
|
567
|
-
#
|
|
568
|
-
# Contains identifiers for the transaction and specific event within being
|
|
569
|
-
# disputed; null if no transaction can be identified
|
|
570
|
-
#
|
|
571
|
-
# @param related_transaction_event_token [String, nil] Token of the specific event in the original transaction being disputed, in UUID
|
|
572
|
-
#
|
|
573
|
-
# @param related_transaction_token [String] Token of the original transaction being disputed, in UUID format
|
|
574
|
-
#
|
|
575
|
-
# @param type [Symbol, Lithic::Models::Dispute::TransactionSeries::Type] The type of transaction series associating the dispute and the original transact
|
|
576
|
-
|
|
577
|
-
# The type of transaction series associating the dispute and the original
|
|
578
|
-
# transaction. Always set to DISPUTE
|
|
579
|
-
#
|
|
580
|
-
# @see Lithic::Models::Dispute::TransactionSeries#type
|
|
581
|
-
module Type
|
|
582
|
-
extend Lithic::Internal::Type::Enum
|
|
583
|
-
|
|
584
|
-
DISPUTE = :DISPUTE
|
|
585
|
-
|
|
586
|
-
# @!method self.values
|
|
587
|
-
# @return [Array<Symbol>]
|
|
588
|
-
end
|
|
589
|
-
end
|
|
590
322
|
end
|
|
591
323
|
end
|
|
592
324
|
end
|