tapsilat 2026.10.21

The Tapsilat SDK for Rust
Documentation
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
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// An order as returned by the order detail endpoints.
///
/// Every field is optional because the server omits empty values.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct Order {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub locale: Option<String>,

    // Amount fields are strings in JSON logs
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid_amount: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refunded_amount: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub customer_paid_amount: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>, // Relaxed from enum to avoid validation errors

    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<i32>, // Status is int in logs
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status_enum: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub buyer: Option<Buyer>,
    /// Deprecated: the API returns basket items in `basket_items`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub items: Option<Vec<OrderItem>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub basket_items: Option<Vec<BasketItemDTO>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub billing_address: Option<BillingAddressDTO>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shipping_address: Option<ShippingAddressDTO>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub checkout_design: Option<CheckoutDesignDTO>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payment_terms: Option<Vec<OrderPaymentTermDetail>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payment_requests: Option<Vec<OrderPaymentRequest>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refund_cancel_requests: Option<Vec<OrderRefundCancelRequest>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub conversation_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub external_reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payment_options: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payment_success_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payment_failure_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub redirect_success_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub redirect_failure_url: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub callback_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub checkout_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<Vec<MetadataDTO>>, // JSON metadata is array of key/value
}

/// The order detail returned by [`crate::TapsilatClient::get_order`] and
/// [`crate::TapsilatClient::get_order_by_conversation_id`].
pub type OrderDetail = Order;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OrderItem {
    pub name: String,
    pub price: f64,
    pub quantity: i32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum OrderStatus {
    #[serde(rename = "pending")]
    Pending,
    #[serde(rename = "processing")]
    Processing,
    #[serde(rename = "completed")]
    Completed,
    #[serde(rename = "failed")]
    Failed,
    #[serde(rename = "cancelled")]
    Cancelled,
    #[serde(rename = "refunded")]
    Refunded,
    #[serde(rename = "partially_refunded")]
    PartiallyRefunded,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Currency {
    #[serde(rename = "TRY")]
    TRY,
    #[serde(rename = "USD")]
    USD,
    #[serde(rename = "EUR")]
    EUR,
    #[serde(rename = "GBP")]
    GBP,
}

/// The order-create request. Required: `locale`, a non-zero `amount` and `currency`.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreateOrderRequest {
    pub amount: f64,
    pub currency: String,
    pub locale: String,
    pub buyer: CreateBuyerRequest,
    #[serde(rename = "basket_items", skip_serializing_if = "Option::is_none")]
    pub basket_items: Option<Vec<BasketItemDTO>>,
    #[serde(rename = "billing_address", skip_serializing_if = "Option::is_none")]
    pub billing_address: Option<BillingAddressDTO>,
    #[serde(rename = "checkout_design", skip_serializing_if = "Option::is_none")]
    pub checkout_design: Option<CheckoutDesignDTO>,
    #[serde(rename = "conversation_id", skip_serializing_if = "Option::is_none")]
    pub conversation_id: Option<String>,
    #[serde(
        rename = "enabled_installments",
        skip_serializing_if = "Option::is_none"
    )]
    pub enabled_installments: Option<Vec<i32>>,
    #[serde(
        rename = "external_reference_id",
        skip_serializing_if = "Option::is_none"
    )]
    pub external_reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<Vec<MetadataDTO>>,
    /// Saved cards to charge for the order.
    #[serde(rename = "order_cards", skip_serializing_if = "Option::is_none")]
    pub order_cards: Option<Vec<OrderCardDTO>>,
    /// The VPOS to process the order with.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_vpos_id: Option<String>,
    #[serde(rename = "paid_amount", skip_serializing_if = "Option::is_none")]
    pub paid_amount: Option<f64>,
    #[serde(rename = "partial_payment", skip_serializing_if = "Option::is_none")]
    pub partial_payment: Option<bool>,
    #[serde(
        rename = "payment_failure_url",
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_failure_url: Option<String>,
    #[serde(rename = "payment_methods", skip_serializing_if = "Option::is_none")]
    pub payment_methods: Option<bool>,
    /// "auth" (default) or "preauth".
    #[serde(rename = "payment_mode", skip_serializing_if = "Option::is_none")]
    pub payment_mode: Option<String>,
    #[serde(rename = "payment_options", skip_serializing_if = "Option::is_none")]
    pub payment_options: Option<Vec<String>>,
    #[serde(
        rename = "payment_success_url",
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_success_url: Option<String>,
    #[serde(rename = "payment_terms", skip_serializing_if = "Option::is_none")]
    pub payment_terms: Option<Vec<PaymentTermDTO>>,
    #[serde(rename = "pf_sub_merchant", skip_serializing_if = "Option::is_none")]
    pub pf_sub_merchant: Option<OrderPFSubMerchantDTO>,
    #[serde(
        rename = "redirect_failure_url",
        skip_serializing_if = "Option::is_none"
    )]
    pub redirect_failure_url: Option<String>,
    #[serde(
        rename = "redirect_success_url",
        skip_serializing_if = "Option::is_none"
    )]
    pub redirect_success_url: Option<String>,
    #[serde(rename = "shipping_address", skip_serializing_if = "Option::is_none")]
    pub shipping_address: Option<ShippingAddressDTO>,
    #[serde(rename = "sub_organization", skip_serializing_if = "Option::is_none")]
    pub sub_organization: Option<SubOrganizationDTO>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub submerchants: Option<Vec<SubmerchantDTO>>,
    #[serde(rename = "tax_amount", skip_serializing_if = "Option::is_none")]
    pub tax_amount: Option<f64>,
    #[serde(rename = "three_d_force", skip_serializing_if = "Option::is_none")]
    pub three_d_force: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub consents: Option<Vec<OrderConsent>>,
}

/// A consent text the buyer must accept on the checkout page.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderConsent {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateOrderItemRequest {
    pub name: String,
    pub price: f64,
    pub quantity: i32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderResponse {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub checkout_url: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct CreateOrderResponse {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub checkout_url: Option<String>,
}

/// Refunds an order. `order_item_id` and `order_item_payment_id` optionally limit the
/// refund to one basket item or item payment.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct RefundOrderRequest {
    pub amount: f64,
    #[serde(rename = "reference_id")]
    pub reference_id: String,
    #[serde(rename = "order_item_id", skip_serializing_if = "Option::is_none")]
    pub order_item_id: Option<String>,
    #[serde(
        rename = "order_item_payment_id",
        skip_serializing_if = "Option::is_none"
    )]
    pub order_item_payment_id: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RefundOrderResponse {
    pub order: Order,
    pub refund_amount: f64,
    pub refund_id: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct MetadataDTO {
    pub key: String,
    pub value: String,
}

/// A basket item. The response-only fields are filled when reading an order.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct BasketItemDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub category1: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub category2: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commission_amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coupon: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coupon_discount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub item_type: Option<String>,
    /// The item's merchant category code.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mcc: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid_amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payer: Option<BasketItemPayerDTO>,
    /// The earliest time the item's payout may be released (RFC3339).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payout_release_at: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub price: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantity: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantity_float: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantity_unit: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_merchant_key: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_merchant_price: Option<String>,
    /// Response only.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<u64>,
    /// Response only.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refunded_amount: Option<f64>,
    /// Response only.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refundable_amount: Option<f64>,
    /// Response only.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paidable_amount: Option<f64>,
    /// Response only.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub item_payments: Option<Vec<OrderItemPayment>>,
}

/// A payment made against a basket item.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderItemPayment {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub masked_bin: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub card_brand: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refunded_amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refundable_amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refunded_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refunded: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<u64>,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct BasketItemPayerDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_office: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vat: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub surname: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub identity_number: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct BillingAddressDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub billing_type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub citizenship: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contact_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contact_phone: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub district: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neighbourhood: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub street1: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub street2: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub street3: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_office: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vat_number: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub zip_code: Option<String>,
}

/// Customizes the checkout page branding for one order.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CheckoutDesignDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub input_background_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub input_text_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub label_text_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub left_background_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub logo: Option<String>,
    /// Deprecated: checkout no longer renders custom order detail HTML; the value is ignored.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_detail_html: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pay_button_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pay_button_text_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_background_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub border_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub input_border_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub accent_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub text_muted_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub surface_muted_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dark_mode_enabled: Option<bool>,
    /// Colors used in dark mode, keyed by the light-mode field name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dark_colors: Option<HashMap<String, String>>,
    /// Deprecated: checkout design no longer carries a redirect URL; the value is ignored.
    /// Use the order's `redirect_success_url` and `redirect_failure_url`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub redirect_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub right_background_color: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub text_color: Option<String>,
}

/// Selects a saved card for the order.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderCardDTO {
    pub card_id: String,
    pub card_sequence: i32,
}

/// A payment term sent with the order. `due_date` is required and, like `paid_date`,
/// must be an RFC3339 timestamp such as "2026-01-15T00:00:00Z".
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct PaymentTermDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub due_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub term_reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub term_sequence: Option<i32>,
}

/// A payment term as returned in the order detail.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderPaymentTermDetail {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hash_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub term_sequence: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub due_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub term_reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payments: Option<Vec<OrderItemPayment>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<String>,
}

/// A payment attempt recorded on an order.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderPaymentRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payment_mode: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub card_hash: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub masked_card: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid: Option<bool>,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
}

/// A refund or cancellation request recorded on an order.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderRefundCancelRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub type_: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub term_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub item_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderPFSubMerchantDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub country_iso_code: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mcc: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub national_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub org_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub postal_code: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub submerchant_nin: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub submerchant_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub switch_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub terminal_no: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ShippingAddressDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contact_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shipping_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tracking_code: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub zip_code: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SubOrganizationDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub acquirer: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contact_first_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contact_last_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gsm_number: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub iban: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub identity_number: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub legal_company_title: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub organization_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_merchant_external_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_merchant_key: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_merchant_type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_number: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_office: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SubmerchantDTO {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub merchant_reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_basket_item_id: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderAccountingRequest {
    #[serde(rename = "order_reference_id")]
    pub order_reference_id: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderPostAuthRequest {
    pub amount: f64,
    #[serde(rename = "reference_id")]
    pub reference_id: String,
}

/// Adds a payment term to an existing order. `due_date` and `paid_date` use the
/// YYYY-MM-DD format.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderPaymentTermCreateDTO {
    /// The order's ID (`CreateOrderResponse::order_id`), not its reference ID.
    pub order_id: String,
    pub term_reference_id: String,
    pub amount: f64,
    pub due_date: String,
    pub term_sequence: i32,
    pub required: bool,
    pub status: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid_date: Option<String>,
}

/// Replaces a payment term. The server stores every field as sent, so populate all of
/// them, not only the ones that change. Dates use the YYYY-MM-DD format.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderPaymentTermUpdateDTO {
    pub term_reference_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub due_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paid_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub term_sequence: Option<i32>,
}

/// Refunds a payment made against a payment term.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderTermRefundRequest {
    /// The payment term's ID (`OrderPaymentTermDetail::id`).
    pub term_id: String,
    pub amount: f64,
    /// The order's reference ID; the server requires it.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub term_payment_id: Option<String>,
}

/// Selects orders for [`crate::TapsilatClient::get_order_list_with_filter`]. The server
/// defaults `page` to 1 and `per_page` to 10 (at most 100) when they are zero.
#[derive(Debug, Clone, Default)]
pub struct OrderListFilter {
    pub page: u32,
    pub per_page: u32,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub organization_id: Option<String>,
    pub conversation_id: Option<String>,
    pub related_reference_id: Option<String>,
    pub buyer_id: Option<String>,
    /// Numeric order status.
    pub status: Option<i32>,
}

/// Selects the order whose payments to list; set at least one identifier.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct GetOrderPaymentsRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_reference_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub conversation_id: Option<String>,
}

/// A payment made against an order.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderPayment {
    pub id: String,
    pub date: String,
    pub payment_mode: String,
    pub amount: f64,
    pub card_id: String,
    pub masked_card: String,
    pub card_holder_name: String,
    pub card_type: String,
    pub card_brand: String,
    pub card_bank: String,
    pub card_network: String,
    pub paid: bool,
    #[serde(rename = "type")]
    pub type_: String,
    pub acquirer_response: String,
    pub vpos_commission_amount: f64,
    pub vpos_commission_rate: f64,
    pub vpos_commission_fee_type: String,
    pub organization_commission_amount: f64,
    pub organization_commission_rate: f64,
    pub organization_commission_fee_type: String,
    pub total_amount: f64,
    pub acquirer_commission_amount: f64,
    pub acquirer_commission_rate: f64,
    pub acquirer_commission_fee_type: String,
    pub acquirer_name: String,
    pub customer_paid_commission_amount: f64,
    pub merchant_paid_commission_amount: f64,
    pub merchant_net_amount: f64,
}

/// The payments made against an order, with totals.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct GetOrderPaymentsResponse {
    pub payments: Vec<OrderPayment>,
    pub total_amount: f64,
    pub total_customer_paid_commission_amount: f64,
    pub total_merchant_paid_commission_amount: f64,
    pub total_merchant_net_amount: f64,
    pub order_amount: f64,
}

/// A submerchant row returned by the order submerchant list.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderSubmerchantListItem {
    pub id: String,
    pub name: String,
    pub email: String,
    pub submerchant_type: String,
    pub submerchant_key: String,
    pub labels: String,
    pub status: String,
    pub acquirer: String,
}

/// A page of order submerchants; the rows come in the `row` key.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct OrderSubmerchantListResponse {
    pub page: i64,
    pub per_page: i64,
    pub total: i64,
    pub total_pages: i64,
    #[serde(rename = "row")]
    pub rows: Vec<OrderSubmerchantListItem>,
}

/// Charges an order, for example with its saved card.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrderChargeRequest {
    pub order_reference_id: String,
    #[serde(skip_serializing_if = "std::ops::Not::not")]
    pub retry: bool,
}

/// The charge result. The server sends these keys in camelCase, unlike most responses.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default, rename_all = "camelCase")]
pub struct OrderChargeResponse {
    pub is_success: bool,
    pub message: String,
    pub status_code: String,
    pub error_code: String,
}

// Re-export Buyer from buyer.rs
use crate::types::buyer::Buyer;
pub use crate::types::buyer::CreateBuyerRequest;