-
Notifications
You must be signed in to change notification settings - Fork 400
Expand file tree
/
Copy pathDispute.java
More file actions
1286 lines (1114 loc) · 47.2 KB
/
Dispute.java
File metadata and controls
1286 lines (1114 loc) · 47.2 KB
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.DisputeCloseParams;
import com.stripe.param.DisputeListParams;
import com.stripe.param.DisputeRetrieveParams;
import com.stripe.param.DisputeUpdateParams;
import java.util.List;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* A dispute occurs when a customer questions your charge with their card issuer. When this happens,
* you have the opportunity to respond to the dispute with evidence that shows that the charge is
* legitimate.
*
* <p>Related guide: <a href="https://docs.stripe.com/disputes">Disputes and fraud</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class Dispute extends ApiResource
implements MetadataStore<Dispute>, BalanceTransactionSource {
/**
* Disputed amount. Usually the amount of the charge, but it can differ (usually because of
* currency fluctuation or because only part of the order is disputed).
*/
@SerializedName("amount")
Long amount;
/**
* The amount you want to contest, in the dispute's currency. Setting this to less than the full
* dispute amount means accepting the loss on the remaining amount. If not specified, the entire
* disputed amount is contested.
*/
@SerializedName("amount_to_counter")
Long amountToCounter;
/**
* List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your
* Stripe account as a result of this dispute.
*/
@SerializedName("balance_transactions")
List<BalanceTransaction> balanceTransactions;
/** ID of the charge that's disputed. */
@SerializedName("charge")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<Charge> charge;
/** Time at which the object was created. Measured in seconds since the Unix epoch. */
@SerializedName("created")
Long created;
/**
* Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>,
* in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
*/
@SerializedName("currency")
String currency;
/** List of eligibility types that are included in {@code enhanced_evidence}. */
@SerializedName("enhanced_eligibility_types")
List<String> enhancedEligibilityTypes;
@SerializedName("evidence")
Evidence evidence;
@SerializedName("evidence_details")
EvidenceDetails evidenceDetails;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* Intended submission method for the dispute.
*
* <p>One of {@code manual}, {@code prefer_manual}, {@code prefer_smart_disputes}, or {@code
* smart_disputes}.
*/
@SerializedName("intended_submission_method")
String intendedSubmissionMethod;
/**
* If true, it's still possible to refund the disputed payment. After the payment has been fully
* refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
*/
@SerializedName("is_charge_refundable")
Boolean isChargeRefundable;
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@SerializedName("livemode")
Boolean livemode;
/**
* Set of <a href="https://docs.stripe.com/api/metadata">key-value pairs</a> that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("metadata")
Map<String, String> metadata;
/** Network-dependent reason code for the dispute. */
@SerializedName("network_reason_code")
String networkReasonCode;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* <p>Equal to {@code dispute}.
*/
@SerializedName("object")
String object;
/** ID of the PaymentIntent that's disputed. */
@SerializedName("payment_intent")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<PaymentIntent> paymentIntent;
@SerializedName("payment_method_details")
PaymentMethodDetails paymentMethodDetails;
/**
* Reason given by cardholder for dispute. Possible values are {@code bank_cannot_process}, {@code
* check_returned}, {@code credit_not_processed}, {@code customer_initiated}, {@code
* debit_not_authorized}, {@code duplicate}, {@code fraudulent}, {@code general}, {@code
* incorrect_account_details}, {@code insufficient_funds}, {@code noncompliant}, {@code
* product_not_received}, {@code product_unacceptable}, {@code subscription_canceled}, or {@code
* unrecognized}. Learn more about <a href="https://docs.stripe.com/disputes/categories">dispute
* reasons</a>.
*/
@SerializedName("reason")
String reason;
@SerializedName("smart_disputes")
SmartDisputes smartDisputes;
/**
* The current status of a dispute. Possible values include:{@code warning_needs_response}, {@code
* warning_under_review}, {@code warning_closed}, {@code needs_response}, {@code under_review},
* {@code won}, {@code lost}, or {@code prevented}.
*
* <p>One of {@code lost}, {@code needs_response}, {@code prevented}, {@code under_review}, {@code
* warning_closed}, {@code warning_needs_response}, {@code warning_under_review}, or {@code won}.
*/
@SerializedName("status")
String status;
/** Get ID of expandable {@code charge} object. */
public String getCharge() {
return (this.charge != null) ? this.charge.getId() : null;
}
public void setCharge(String id) {
this.charge = ApiResource.setExpandableFieldId(id, this.charge);
}
/** Get expanded {@code charge}. */
public Charge getChargeObject() {
return (this.charge != null) ? this.charge.getExpanded() : null;
}
public void setChargeObject(Charge expandableObject) {
this.charge = new ExpandableField<Charge>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code paymentIntent} object. */
public String getPaymentIntent() {
return (this.paymentIntent != null) ? this.paymentIntent.getId() : null;
}
public void setPaymentIntent(String id) {
this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent);
}
/** Get expanded {@code paymentIntent}. */
public PaymentIntent getPaymentIntentObject() {
return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null;
}
public void setPaymentIntentObject(PaymentIntent expandableObject) {
this.paymentIntent =
new ExpandableField<PaymentIntent>(expandableObject.getId(), expandableObject);
}
/**
* Closing the dispute for a charge indicates that you do not have any evidence to submit and are
* essentially dismissing the dispute, acknowledging it as lost.
*
* <p>The status of the dispute will change from {@code needs_response} to {@code lost}.
* <em>Closing a dispute is irreversible</em>.
*/
public Dispute close() throws StripeException {
return close((Map<String, Object>) null, (RequestOptions) null);
}
/**
* Closing the dispute for a charge indicates that you do not have any evidence to submit and are
* essentially dismissing the dispute, acknowledging it as lost.
*
* <p>The status of the dispute will change from {@code needs_response} to {@code lost}.
* <em>Closing a dispute is irreversible</em>.
*/
public Dispute close(RequestOptions options) throws StripeException {
return close((Map<String, Object>) null, options);
}
/**
* Closing the dispute for a charge indicates that you do not have any evidence to submit and are
* essentially dismissing the dispute, acknowledging it as lost.
*
* <p>The status of the dispute will change from {@code needs_response} to {@code lost}.
* <em>Closing a dispute is irreversible</em>.
*/
public Dispute close(Map<String, Object> params) throws StripeException {
return close(params, (RequestOptions) null);
}
/**
* Closing the dispute for a charge indicates that you do not have any evidence to submit and are
* essentially dismissing the dispute, acknowledging it as lost.
*
* <p>The status of the dispute will change from {@code needs_response} to {@code lost}.
* <em>Closing a dispute is irreversible</em>.
*/
public Dispute close(Map<String, Object> params, RequestOptions options) throws StripeException {
String path = String.format("/v1/disputes/%s/close", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Dispute.class);
}
/**
* Closing the dispute for a charge indicates that you do not have any evidence to submit and are
* essentially dismissing the dispute, acknowledging it as lost.
*
* <p>The status of the dispute will change from {@code needs_response} to {@code lost}.
* <em>Closing a dispute is irreversible</em>.
*/
public Dispute close(DisputeCloseParams params) throws StripeException {
return close(params, (RequestOptions) null);
}
/**
* Closing the dispute for a charge indicates that you do not have any evidence to submit and are
* essentially dismissing the dispute, acknowledging it as lost.
*
* <p>The status of the dispute will change from {@code needs_response} to {@code lost}.
* <em>Closing a dispute is irreversible</em>.
*/
public Dispute close(DisputeCloseParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/disputes/%s/close", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Dispute.class);
}
/** Returns a list of your disputes. */
public static DisputeCollection list(Map<String, Object> params) throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of your disputes. */
public static DisputeCollection list(Map<String, Object> params, RequestOptions options)
throws StripeException {
String path = "/v1/disputes";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, DisputeCollection.class);
}
/** Returns a list of your disputes. */
public static DisputeCollection list(DisputeListParams params) throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of your disputes. */
public static DisputeCollection list(DisputeListParams params, RequestOptions options)
throws StripeException {
String path = "/v1/disputes";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, DisputeCollection.class);
}
/** Retrieves the dispute with the given ID. */
public static Dispute retrieve(String dispute) throws StripeException {
return retrieve(dispute, (Map<String, Object>) null, (RequestOptions) null);
}
/** Retrieves the dispute with the given ID. */
public static Dispute retrieve(String dispute, RequestOptions options) throws StripeException {
return retrieve(dispute, (Map<String, Object>) null, options);
}
/** Retrieves the dispute with the given ID. */
public static Dispute retrieve(String dispute, Map<String, Object> params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/disputes/%s", ApiResource.urlEncodeId(dispute));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, Dispute.class);
}
/** Retrieves the dispute with the given ID. */
public static Dispute retrieve(
String dispute, DisputeRetrieveParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/disputes/%s", ApiResource.urlEncodeId(dispute));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Dispute.class);
}
/**
* When you get a dispute, contacting your customer is always the best first step. If that doesn’t
* work, you can submit evidence to help us resolve the dispute in your favor. You can do this in
* your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can
* use the API to submit evidence programmatically.
*
* <p>Depending on your dispute type, different evidence fields will give you a better chance of
* winning your dispute. To figure out which evidence fields to provide, see our <a
* href="https://stripe.com/docs/disputes/categories">guide to dispute types</a>.
*/
@Override
public Dispute update(Map<String, Object> params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* When you get a dispute, contacting your customer is always the best first step. If that doesn’t
* work, you can submit evidence to help us resolve the dispute in your favor. You can do this in
* your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can
* use the API to submit evidence programmatically.
*
* <p>Depending on your dispute type, different evidence fields will give you a better chance of
* winning your dispute. To figure out which evidence fields to provide, see our <a
* href="https://stripe.com/docs/disputes/categories">guide to dispute types</a>.
*/
@Override
public Dispute update(Map<String, Object> params, RequestOptions options) throws StripeException {
String path = String.format("/v1/disputes/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Dispute.class);
}
/**
* When you get a dispute, contacting your customer is always the best first step. If that doesn’t
* work, you can submit evidence to help us resolve the dispute in your favor. You can do this in
* your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can
* use the API to submit evidence programmatically.
*
* <p>Depending on your dispute type, different evidence fields will give you a better chance of
* winning your dispute. To figure out which evidence fields to provide, see our <a
* href="https://stripe.com/docs/disputes/categories">guide to dispute types</a>.
*/
public Dispute update(DisputeUpdateParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* When you get a dispute, contacting your customer is always the best first step. If that doesn’t
* work, you can submit evidence to help us resolve the dispute in your favor. You can do this in
* your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can
* use the API to submit evidence programmatically.
*
* <p>Depending on your dispute type, different evidence fields will give you a better chance of
* winning your dispute. To figure out which evidence fields to provide, see our <a
* href="https://stripe.com/docs/disputes/categories">guide to dispute types</a>.
*/
public Dispute update(DisputeUpdateParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/disputes/%s", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Dispute.class);
}
/**
* For more details about Evidence, please refer to the <a href="https://docs.stripe.com/api">API
* Reference.</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Evidence extends StripeObject {
/**
* Any server or activity logs showing proof that the customer accessed or downloaded the
* purchased digital product. This information should include IP addresses, corresponding
* timestamps, and any detailed recorded activity.
*/
@SerializedName("access_activity_log")
String accessActivityLog;
/** The billing address provided by the customer. */
@SerializedName("billing_address")
String billingAddress;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Your
* subscription cancellation policy, as shown to the customer.
*/
@SerializedName("cancellation_policy")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> cancellationPolicy;
/**
* An explanation of how and when the customer was shown your refund policy prior to purchase.
*/
@SerializedName("cancellation_policy_disclosure")
String cancellationPolicyDisclosure;
/** A justification for why the customer's subscription was not canceled. */
@SerializedName("cancellation_rebuttal")
String cancellationRebuttal;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Any
* communication with the customer that you feel is relevant to your case. Examples include
* emails proving that the customer received the product or service, or demonstrating their use
* of or satisfaction with the product or service.
*/
@SerializedName("customer_communication")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> customerCommunication;
/** The email address of the customer. */
@SerializedName("customer_email_address")
String customerEmailAddress;
/** The name of the customer. */
@SerializedName("customer_name")
String customerName;
/** The IP address that the customer used when making the purchase. */
@SerializedName("customer_purchase_ip")
String customerPurchaseIp;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) A relevant
* document or contract showing the customer's signature.
*/
@SerializedName("customer_signature")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> customerSignature;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Documentation
* for the prior charge that can uniquely identify the charge, such as a receipt, shipping
* label, work order, etc. This document should be paired with a similar document from the
* disputed payment that proves the two payments are separate.
*/
@SerializedName("duplicate_charge_documentation")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> duplicateChargeDocumentation;
/**
* An explanation of the difference between the disputed charge versus the prior charge that
* appears to be a duplicate.
*/
@SerializedName("duplicate_charge_explanation")
String duplicateChargeExplanation;
/**
* The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
*/
@SerializedName("duplicate_charge_id")
String duplicateChargeId;
@SerializedName("enhanced_evidence")
EnhancedEvidence enhancedEvidence;
/** A description of the product or service that was sold. */
@SerializedName("product_description")
String productDescription;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Any receipt or
* message sent to the customer notifying them of the charge.
*/
@SerializedName("receipt")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> receipt;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Your refund
* policy, as shown to the customer.
*/
@SerializedName("refund_policy")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> refundPolicy;
/**
* Documentation demonstrating that the customer was shown your refund policy prior to purchase.
*/
@SerializedName("refund_policy_disclosure")
String refundPolicyDisclosure;
/** A justification for why the customer is not entitled to a refund. */
@SerializedName("refund_refusal_explanation")
String refundRefusalExplanation;
/**
* The date on which the customer received or began receiving the purchased service, in a clear
* human-readable format.
*/
@SerializedName("service_date")
String serviceDate;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Documentation
* showing proof that a service was provided to the customer. This could include a copy of a
* signed contract, work order, or other form of written agreement.
*/
@SerializedName("service_documentation")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> serviceDocumentation;
/**
* The address to which a physical product was shipped. You should try to include as complete
* address information as possible.
*/
@SerializedName("shipping_address")
String shippingAddress;
/**
* The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If
* multiple carriers were used for this purchase, please separate them with commas.
*/
@SerializedName("shipping_carrier")
String shippingCarrier;
/**
* The date on which a physical product began its route to the shipping address, in a clear
* human-readable format.
*/
@SerializedName("shipping_date")
String shippingDate;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Documentation
* showing proof that a product was shipped to the customer at the same address the customer
* provided to you. This could include a copy of the shipment receipt, shipping label, etc. It
* should show the customer's full shipping address, if possible.
*/
@SerializedName("shipping_documentation")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> shippingDocumentation;
/**
* The tracking number for a physical product, obtained from the delivery service. If multiple
* tracking numbers were generated for this purchase, please separate them with commas.
*/
@SerializedName("shipping_tracking_number")
String shippingTrackingNumber;
/**
* (ID of a <a href="https://stripe.com/docs/guides/file-upload">file upload</a>) Any additional
* evidence or statements.
*/
@SerializedName("uncategorized_file")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<File> uncategorizedFile;
/** Any additional evidence or statements. */
@SerializedName("uncategorized_text")
String uncategorizedText;
/** Get ID of expandable {@code cancellationPolicy} object. */
public String getCancellationPolicy() {
return (this.cancellationPolicy != null) ? this.cancellationPolicy.getId() : null;
}
public void setCancellationPolicy(String id) {
this.cancellationPolicy = ApiResource.setExpandableFieldId(id, this.cancellationPolicy);
}
/** Get expanded {@code cancellationPolicy}. */
public File getCancellationPolicyObject() {
return (this.cancellationPolicy != null) ? this.cancellationPolicy.getExpanded() : null;
}
public void setCancellationPolicyObject(File expandableObject) {
this.cancellationPolicy =
new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code customerCommunication} object. */
public String getCustomerCommunication() {
return (this.customerCommunication != null) ? this.customerCommunication.getId() : null;
}
public void setCustomerCommunication(String id) {
this.customerCommunication = ApiResource.setExpandableFieldId(id, this.customerCommunication);
}
/** Get expanded {@code customerCommunication}. */
public File getCustomerCommunicationObject() {
return (this.customerCommunication != null) ? this.customerCommunication.getExpanded() : null;
}
public void setCustomerCommunicationObject(File expandableObject) {
this.customerCommunication =
new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code customerSignature} object. */
public String getCustomerSignature() {
return (this.customerSignature != null) ? this.customerSignature.getId() : null;
}
public void setCustomerSignature(String id) {
this.customerSignature = ApiResource.setExpandableFieldId(id, this.customerSignature);
}
/** Get expanded {@code customerSignature}. */
public File getCustomerSignatureObject() {
return (this.customerSignature != null) ? this.customerSignature.getExpanded() : null;
}
public void setCustomerSignatureObject(File expandableObject) {
this.customerSignature =
new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code duplicateChargeDocumentation} object. */
public String getDuplicateChargeDocumentation() {
return (this.duplicateChargeDocumentation != null)
? this.duplicateChargeDocumentation.getId()
: null;
}
public void setDuplicateChargeDocumentation(String id) {
this.duplicateChargeDocumentation =
ApiResource.setExpandableFieldId(id, this.duplicateChargeDocumentation);
}
/** Get expanded {@code duplicateChargeDocumentation}. */
public File getDuplicateChargeDocumentationObject() {
return (this.duplicateChargeDocumentation != null)
? this.duplicateChargeDocumentation.getExpanded()
: null;
}
public void setDuplicateChargeDocumentationObject(File expandableObject) {
this.duplicateChargeDocumentation =
new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code receipt} object. */
public String getReceipt() {
return (this.receipt != null) ? this.receipt.getId() : null;
}
public void setReceipt(String id) {
this.receipt = ApiResource.setExpandableFieldId(id, this.receipt);
}
/** Get expanded {@code receipt}. */
public File getReceiptObject() {
return (this.receipt != null) ? this.receipt.getExpanded() : null;
}
public void setReceiptObject(File expandableObject) {
this.receipt = new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code refundPolicy} object. */
public String getRefundPolicy() {
return (this.refundPolicy != null) ? this.refundPolicy.getId() : null;
}
public void setRefundPolicy(String id) {
this.refundPolicy = ApiResource.setExpandableFieldId(id, this.refundPolicy);
}
/** Get expanded {@code refundPolicy}. */
public File getRefundPolicyObject() {
return (this.refundPolicy != null) ? this.refundPolicy.getExpanded() : null;
}
public void setRefundPolicyObject(File expandableObject) {
this.refundPolicy = new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code serviceDocumentation} object. */
public String getServiceDocumentation() {
return (this.serviceDocumentation != null) ? this.serviceDocumentation.getId() : null;
}
public void setServiceDocumentation(String id) {
this.serviceDocumentation = ApiResource.setExpandableFieldId(id, this.serviceDocumentation);
}
/** Get expanded {@code serviceDocumentation}. */
public File getServiceDocumentationObject() {
return (this.serviceDocumentation != null) ? this.serviceDocumentation.getExpanded() : null;
}
public void setServiceDocumentationObject(File expandableObject) {
this.serviceDocumentation =
new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code shippingDocumentation} object. */
public String getShippingDocumentation() {
return (this.shippingDocumentation != null) ? this.shippingDocumentation.getId() : null;
}
public void setShippingDocumentation(String id) {
this.shippingDocumentation = ApiResource.setExpandableFieldId(id, this.shippingDocumentation);
}
/** Get expanded {@code shippingDocumentation}. */
public File getShippingDocumentationObject() {
return (this.shippingDocumentation != null) ? this.shippingDocumentation.getExpanded() : null;
}
public void setShippingDocumentationObject(File expandableObject) {
this.shippingDocumentation =
new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code uncategorizedFile} object. */
public String getUncategorizedFile() {
return (this.uncategorizedFile != null) ? this.uncategorizedFile.getId() : null;
}
public void setUncategorizedFile(String id) {
this.uncategorizedFile = ApiResource.setExpandableFieldId(id, this.uncategorizedFile);
}
/** Get expanded {@code uncategorizedFile}. */
public File getUncategorizedFileObject() {
return (this.uncategorizedFile != null) ? this.uncategorizedFile.getExpanded() : null;
}
public void setUncategorizedFileObject(File expandableObject) {
this.uncategorizedFile =
new ExpandableField<File>(expandableObject.getId(), expandableObject);
}
/**
* For more details about EnhancedEvidence, please refer to the <a
* href="https://docs.stripe.com/api">API Reference.</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class EnhancedEvidence extends StripeObject {
@SerializedName("visa_compelling_evidence_3")
VisaCompellingEvidence3 visaCompellingEvidence3;
@SerializedName("visa_compliance")
VisaCompliance visaCompliance;
/**
* For more details about VisaCompellingEvidence3, please refer to the <a
* href="https://docs.stripe.com/api">API Reference.</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class VisaCompellingEvidence3 extends StripeObject {
/** Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. */
@SerializedName("disputed_transaction")
DisputedTransaction disputedTransaction;
/**
* List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0
* evidence submission.
*/
@SerializedName("prior_undisputed_transactions")
List<Dispute.Evidence.EnhancedEvidence.VisaCompellingEvidence3.PriorUndisputedTransaction>
priorUndisputedTransactions;
/**
* For more details about DisputedTransaction, please refer to the <a
* href="https://docs.stripe.com/api">API Reference.</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class DisputedTransaction extends StripeObject {
/**
* User Account ID used to log into business platform. Must be recognizable by the user.
*/
@SerializedName("customer_account_id")
String customerAccountId;
/**
* Unique identifier of the cardholder’s device derived from a combination of at least two
* hardware and software attributes. Must be at least 20 characters.
*/
@SerializedName("customer_device_fingerprint")
String customerDeviceFingerprint;
/**
* Unique identifier of the cardholder’s device such as a device serial number (e.g.,
* International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
*/
@SerializedName("customer_device_id")
String customerDeviceId;
/** The email address of the customer. */
@SerializedName("customer_email_address")
String customerEmailAddress;
/** The IP address that the customer used when making the purchase. */
@SerializedName("customer_purchase_ip")
String customerPurchaseIp;
/**
* Categorization of disputed payment.
*
* <p>One of {@code merchandise}, or {@code services}.
*/
@SerializedName("merchandise_or_services")
String merchandiseOrServices;
/** A description of the product or service that was sold. */
@SerializedName("product_description")
String productDescription;
/**
* The address to which a physical product was shipped. All fields are required for Visa
* Compelling Evidence 3.0 evidence submission.
*/
@SerializedName("shipping_address")
ShippingAddress shippingAddress;
/**
* For more details about ShippingAddress, please refer to the <a
* href="https://docs.stripe.com/api">API Reference.</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ShippingAddress extends StripeObject {
/** City, district, suburb, town, or village. */
@SerializedName("city")
String city;
/**
* Two-letter country code (<a
* href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a>).
*/
@SerializedName("country")
String country;
/** Address line 1, such as the street, PO Box, or company name. */
@SerializedName("line1")
String line1;
/** Address line 2, such as the apartment, suite, unit, or building. */
@SerializedName("line2")
String line2;
/** ZIP or postal code. */
@SerializedName("postal_code")
String postalCode;
/**
* State, county, province, or region (<a
* href="https://en.wikipedia.org/wiki/ISO_3166-2">ISO 3166-2</a>).
*/
@SerializedName("state")
String state;
}
}
/**
* For more details about PriorUndisputedTransaction, please refer to the <a
* href="https://docs.stripe.com/api">API Reference.</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class PriorUndisputedTransaction extends StripeObject {
/** Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge. */
@SerializedName("charge")
String charge;
/**
* User Account ID used to log into business platform. Must be recognizable by the user.
*/
@SerializedName("customer_account_id")
String customerAccountId;
/**
* Unique identifier of the cardholder’s device derived from a combination of at least two
* hardware and software attributes. Must be at least 20 characters.
*/
@SerializedName("customer_device_fingerprint")
String customerDeviceFingerprint;
/**
* Unique identifier of the cardholder’s device such as a device serial number (e.g.,
* International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
*/
@SerializedName("customer_device_id")
String customerDeviceId;
/** The email address of the customer. */
@SerializedName("customer_email_address")
String customerEmailAddress;
/** The IP address that the customer used when making the purchase. */
@SerializedName("customer_purchase_ip")
String customerPurchaseIp;
/** A description of the product or service that was sold. */
@SerializedName("product_description")
String productDescription;
/**
* The address to which a physical product was shipped. All fields are required for Visa
* Compelling Evidence 3.0 evidence submission.
*/
@SerializedName("shipping_address")
ShippingAddress shippingAddress;
/**
* For more details about ShippingAddress, please refer to the <a
* href="https://docs.stripe.com/api">API Reference.</a>
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ShippingAddress extends StripeObject {
/** City, district, suburb, town, or village. */
@SerializedName("city")
String city;
/**
* Two-letter country code (<a
* href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a>).
*/
@SerializedName("country")
String country;
/** Address line 1, such as the street, PO Box, or company name. */
@SerializedName("line1")
String line1;
/** Address line 2, such as the apartment, suite, unit, or building. */
@SerializedName("line2")
String line2;
/** ZIP or postal code. */