forked from stripe/stripe-go
/
dispute.go
176 lines (161 loc) · 7.51 KB
/
dispute.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
package stripe
import (
"encoding/json"
)
// DisputeReason is the list of allowed values for a discount's reason.
// Allowed values are "duplicate", "fraudulent", "subscription_canceled",
// "product_unacceptable", "product_not_received", "unrecognized",
// "credit_not_processed", "general".
type DisputeReason string
// DisputeStatus is the list of allowed values for a discount's status.
// Allowed values are "won", "lost", "needs_response", "under_review",
// "warning_needs_response", "warning_under_review", "charge_refunded",
// "warning_closed".
type DisputeStatus string
// DisputeParams is the set of parameters that can be used when updating a dispute.
// For more details see https://stripe.com/docs/api#update_dispute.
type DisputeParams struct {
Params `form:"*"`
Evidence *DisputeEvidenceParams `form:"evidence"`
NoSubmit bool `form:"submit,invert"`
}
// DisputeEvidenceParams is the set of parameters that can be used when submitting
// evidence for disputes.
type DisputeEvidenceParams struct {
ActivityLog string `form:"access_activity_log"`
BillingAddress string `form:"billing_address"`
CancellationPolicy string `form:"cancellation_policy"`
CancellationPolicyDisclsoure string `form:"cancellation_policy_disclosure"`
CancellationRebuttal string `form:"cancellation_rebuttal"`
CustomerComm string `form:"customer_communication"`
CustomerEmail string `form:"customer_email_address"`
CustomerIP string `form:"customer_purchase_ip"`
CustomerName string `form:"customer_name"`
CustomerSig string `form:"customer_signature"`
DuplicateCharge string `form:"duplicate_charge_id"`
DuplicateChargeDoc string `form:"duplicate_charge_documentation"`
DuplicateChargeReason string `form:"duplicate_charge_explanation"`
ProductDesc string `form:"product_description"`
Receipt string `form:"receipt"`
RefundPolicy string `form:"refund_policy"`
RefundPolicyDisclosure string `form:"refund_policy_disclosure"`
RefundRefusalReason string `form:"refund_refusal_explanation"`
ServiceDate string `form:"service_date"`
ServiceDoc string `form:"service_documentation"`
ShippingAddress string `form:"shipping_address"`
ShippingCarrier string `form:"shipping_carrier"`
ShippingDate string `form:"shipping_date"`
ShippingDoc string `form:"shipping_documentation"`
ShippingTracking string `form:"shipping_tracking_number"`
UncategorizedFile string `form:"uncategorized_file"`
UncategorizedText string `form:"uncategorized_text"`
}
// DisputeListParams is the set of parameters that can be used when listing disputes.
// For more details see https://stripe.com/docs/api#list_disputes.
type DisputeListParams struct {
ListParams `form:"*"`
Created int64 `form:"created"`
CreatedRange *RangeQueryParams `form:"created"`
}
// Dispute is the resource representing a Stripe dispute.
// For more details see https://stripe.com/docs/api#disputes.
type Dispute struct {
Amount uint64 `json:"amount"`
Charge string `json:"charge"`
Created int64 `json:"created"`
Currency Currency `json:"currency"`
Evidence *DisputeEvidence `json:"evidence"`
EvidenceDetails *EvidenceDetails `json:"evidence_details"`
ID string `json:"id"`
Live bool `json:"livemode"`
Meta map[string]string `json:"metadata"`
Reason DisputeReason `json:"reason"`
Refundable bool `json:"is_charge_refundable"`
Status DisputeStatus `json:"status"`
Transactions []*Transaction `json:"balance_transactions"`
}
// DisputeList is a list of disputes as retrieved from a list endpoint.
type DisputeList struct {
ListMeta
Values []*Dispute `json:"data"`
}
// EvidenceDetails is the structure representing more details about
// the dispute.
type EvidenceDetails struct {
Count int `json:"submission_count"`
DueDate int64 `json:"due_by"`
HasEvidence bool `json:"has_evidence"`
PastDue bool `json:"past_due"`
}
// DisputeEvidence is the structure that contains various details about
// the evidence submitted for the dispute.
// Almost all fields are strings since there structures (i.e. address)
// do not typically get parsed by anyone and are thus presented as-received.
type DisputeEvidence struct {
ActivityLog string `json:"access_activity_log"`
BillingAddress string `json:"billing_address"`
CancellationPolicy *File `json:"cancellation_policy"`
CancellationPolicyDisclosure string `json:"cancellation_policy_disclosure"`
CancellationRebuttal string `json:"cancellation_rebuttal"`
CustomerComm *File `json:"customer_communication"`
CustomerEmail string `json:"customer_email_address"`
CustomerIP string `json:"customer_purchase_ip"`
CustomerName string `json:"customer_name"`
CustomerSig *File `json:"customer_signature"`
DuplicateCharge string `json:"duplicate_charge_id"`
DuplicateChargeDoc *File `json:"duplicate_charge_documentation"`
DuplicateChargeReason string `json:"duplicate_charge_explanation"`
ProductDesc string `json:"product_description"`
Receipt *File `json:"receipt"`
RefundPolicy *File `json:"refund_policy"`
RefundPolicyDisclosure string `json:"refund_policy_disclosure"`
RefundRefusalReason string `json:"refund_refusal_explanation"`
ServiceDate string `json:"service_date"`
ServiceDoc *File `json:"service_documentation"`
ShippingAddress string `json:"shipping_address"`
ShippingCarrier string `json:"shipping_carrier"`
ShippingDate string `json:"shipping_date"`
ShippingDoc *File `json:"shipping_documentation"`
ShippingTracking string `json:"shipping_tracking_number"`
UncategorizedFile *File `json:"uncategorized_file"`
UncategorizedText string `json:"uncategorized_text"`
}
// File represents a link to downloadable content.
type File struct {
Created int64 `json:"created"`
ID string `json:"id"`
Mime string `json:"mime_type"`
Purpose string `json:"purpose"`
Size int `json:"size"`
URL string `json:"url"`
}
// UnmarshalJSON handles deserialization of a Dispute.
// This custom unmarshaling is needed because the resulting
// property may be an id or the full struct if it was expanded.
func (t *Dispute) UnmarshalJSON(data []byte) error {
type dispute Dispute
var dd dispute
err := json.Unmarshal(data, &dd)
if err == nil {
*t = Dispute(dd)
} else {
// the id is surrounded by "\" characters, so strip them
t.ID = string(data[1 : len(data)-1])
}
return nil
}
// UnmarshalJSON handles deserialization of a File.
// This custom unmarshaling is needed because the resulting
// property may be an id or the full struct if it was expanded.
func (f *File) UnmarshalJSON(data []byte) error {
type file File
var ff file
err := json.Unmarshal(data, &ff)
if err == nil {
*f = File(ff)
} else {
// the id is surrounded by "\" characters, so strip them
f.ID = string(data[1 : len(data)-1])
}
return nil
}