oblodai 1.1.0

Официальный Rust SDK для платёжного шлюза Oblodai: приём платежей, выплаты, кошельки, вебхуки.
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
//! Модели объектов API.
//!
//! Суммы — строки в единицах валюты (`"25.00"`), не числа, — чтобы не терять точность. Все структуры
//! допускают отсутствие полей (`#[serde(default)]`), поэтому дополнительные или пропущенные поля не
//! ломают разбор.

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Объект платежа (инвойса).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Payment {
    #[serde(default)]
    pub uuid: String,
    #[serde(default)]
    pub order_id: String,
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub payment_amount: Option<String>,
    #[serde(default)]
    pub amount_paid: String,
    #[serde(default)]
    pub amount_remaining: String,
    #[serde(default)]
    pub payer_amount: String,
    #[serde(default)]
    pub payer_currency: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub address: String,
    #[serde(default)]
    pub address_qr_code: String,
    #[serde(default)]
    pub payment_status: String,
    #[serde(default)]
    pub is_multi: bool,
    #[serde(default)]
    pub url: String,
    #[serde(default)]
    pub expired_at: i64,
    #[serde(default)]
    pub is_final: bool,
    #[serde(default)]
    pub created_at: String,
    #[serde(default)]
    pub updated_at: String,
    #[serde(default)]
    pub additional_data: String,
    #[serde(default)]
    pub payer_email: String,
    #[serde(default)]
    pub url_return: String,
    #[serde(default)]
    pub url_success: String,
    #[serde(default)]
    pub rate_expires_at: i64,
    #[serde(default)]
    pub confirmations: i64,
    #[serde(default)]
    pub required_confirmations: i64,
    #[serde(default)]
    pub txid: String,
}

/// Пагинация в списковых ответах.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Paginate {
    #[serde(default)]
    pub count: i64,
    #[serde(default)]
    pub per_page: i64,
    #[serde(default)]
    pub offset: i64,
}

/// Страница списка платежей.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PaymentList {
    #[serde(default)]
    pub items: Vec<Payment>,
    #[serde(default)]
    pub paginate: Paginate,
}

/// Лимиты метода.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Limit {
    #[serde(default)]
    pub min_amount: String,
    #[serde(default)]
    pub max_amount: String,
}

/// Комиссия метода.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Commission {
    #[serde(default)]
    pub fee_amount: String,
    #[serde(default)]
    pub percent: String,
}

/// Доступный метод приёма/выплат.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct ServiceMethod {
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub is_available: bool,
    #[serde(default)]
    pub limit: Limit,
    #[serde(default)]
    pub commission: Commission,
}

/// Статический кошелёк.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Wallet {
    #[serde(default)]
    pub uuid: String,
    #[serde(default)]
    pub address: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub order_id: String,
    #[serde(default)]
    pub url: String,
}

/// Баланс по одной валюте.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct MerchantBalance {
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub balance: String,
}

/// Доступные балансы мерчанта.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Balance {
    #[serde(default)]
    pub merchant: Vec<MerchantBalance>,
}

/// Реферальная статистика.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct ReferralInfo {
    #[serde(default)]
    pub code: String,
    #[serde(default)]
    pub link: String,
    #[serde(default)]
    pub tier_bps: Vec<i64>,
    #[serde(default)]
    pub referred_count: i64,
    #[serde(default)]
    pub earnings_by_asset: HashMap<String, String>,
}

/// Данные конвертации (при `from_currency`).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PayoutConvert {
    #[serde(default)]
    pub from_currency: String,
    #[serde(default)]
    pub to_currency: String,
    #[serde(default)]
    pub from_amount: String,
    #[serde(default)]
    pub rate: String,
}

/// Объект выплаты.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Payout {
    #[serde(default)]
    pub uuid: String,
    #[serde(default)]
    pub order_id: String,
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub address: String,
    #[serde(default)]
    pub txid: String,
    #[serde(default)]
    pub status: String,
    #[serde(default)]
    pub is_final: bool,
    #[serde(default)]
    pub approval_required: bool,
    #[serde(default)]
    pub source: String,
    #[serde(default)]
    pub created_at: String,
    #[serde(default)]
    pub updated_at: String,
    #[serde(default)]
    pub convert: Option<PayoutConvert>,
}

/// Элемент результата массовой выплаты.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct MassPayoutItem {
    #[serde(default)]
    pub order_id: String,
    #[serde(default)]
    pub success: bool,
    #[serde(default)]
    pub uuid: String,
    #[serde(default)]
    pub status: String,
    #[serde(default)]
    pub is_final: bool,
    #[serde(default)]
    pub approval_required: bool,
    #[serde(default)]
    pub message: String,
}

/// Результат массовой выплаты.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct MassPayoutResult {
    #[serde(default)]
    pub items: Vec<MassPayoutItem>,
}

/// Страница истории выплат.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PayoutList {
    #[serde(default)]
    pub items: Vec<Payout>,
    #[serde(default)]
    pub paginate: Paginate,
}

/// Предрасчёт выплаты.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PayoutCalculation {
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub commission: String,
    #[serde(default)]
    pub merchant_amount: String,
    #[serde(default)]
    pub to_amount: String,
}

/// Котировка валюты к USDT.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct ExchangeRate {
    #[serde(default)]
    pub from: String,
    #[serde(default)]
    pub to: String,
    #[serde(default)]
    pub course: String,
}

/// Сеть в публичном каталоге `GET /v1/currencies`.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct CurrencyNetwork {
    #[serde(default)]
    pub network: String,
    /// `native` (монета сети) или `token`.
    #[serde(default)]
    pub kind: String,
    /// Адрес контракта токена (для `token`).
    #[serde(default)]
    pub contract: String,
    #[serde(default)]
    pub min_confirmations: u32,
    /// Доступен ли приём (синоним `deposit_available`).
    #[serde(default)]
    pub available: bool,
    #[serde(default)]
    pub deposit_available: bool,
    #[serde(default)]
    pub payout_available: bool,
}

/// Актив в публичном каталоге `GET /v1/currencies`.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Currency {
    #[serde(default)]
    pub symbol: String,
    #[serde(default)]
    pub decimals: u32,
    #[serde(default)]
    pub networks: Vec<CurrencyNetwork>,
}

/// Результат регистрации endpoint вебхуков.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct WebhookRegistration {
    #[serde(default)]
    pub endpoint_id: String,
    #[serde(default)]
    pub url: String,
    #[serde(default)]
    pub secret: String,
}

/// Запись журнала доставок.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Delivery {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub url: String,
    #[serde(default)]
    pub event_type: String,
    #[serde(default)]
    pub status: String,
    #[serde(default)]
    pub attempts: i64,
    #[serde(default)]
    pub last_error: String,
    #[serde(default)]
    pub created_at: String,
    #[serde(default)]
    pub updated_at: String,
}

/// Принимаемая пара валюта+сеть.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct AcceptedMethod {
    pub currency: String,
    pub network: String,
}

/// Правило автовывода.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct AutoWithdrawRule {
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub address: String,
    #[serde(default)]
    pub min_minor: String,
}

// ─────────────────────────── Массовые операции (v1.1.0) ───────────────────────────

/// Результат постановки пачки (`POST /v1/payment/batch`, `/v1/refund/batch`, `/v1/payout/batch`).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct BatchSubmission {
    #[serde(default)]
    pub batch_id: String,
    /// Вид пачки: `payment` / `refund` / `payout`.
    #[serde(default)]
    pub kind: String,
    #[serde(default)]
    pub count: i64,
    /// `pending` → `processing` → `completed`.
    #[serde(default)]
    pub status: String,
}

/// Элемент пачки в ответе `POST /v1/batch/info`.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct BatchItem {
    #[serde(default)]
    pub idx: i64,
    #[serde(default)]
    pub status: String,
    #[serde(default)]
    pub order_id: String,
    /// Байт-в-байт сохранённый `result` единичного эндпоинта (если элемент успешен).
    #[serde(default)]
    pub result: serde_json::Value,
    /// Ошибка элемента (если он неуспешен).
    #[serde(default)]
    pub error: serde_json::Value,
}

/// Состояние пачки и её элементы. `POST /v1/batch/info`
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct BatchInfo {
    #[serde(default)]
    pub batch_id: String,
    #[serde(default)]
    pub kind: String,
    #[serde(default)]
    pub status: String,
    #[serde(default)]
    pub on_error: String,
    #[serde(default)]
    pub total: i64,
    #[serde(default)]
    pub succeeded: i64,
    #[serde(default)]
    pub failed: i64,
    #[serde(default)]
    pub created_at: String,
    #[serde(default)]
    pub updated_at: String,
    #[serde(default)]
    pub items: Vec<BatchItem>,
}

// ─────────────────────────── Платёжные ссылки (v1.1.0) ───────────────────────────

/// Платёж, привязанный к платёжной ссылке (в ответе `info`).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PaymentLinkPayment {
    #[serde(default)]
    pub uuid: String,
    #[serde(default)]
    pub status: String,
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub created_at: String,
    #[serde(default)]
    pub order_id: String,
}

/// Платёжная ссылка (create/list/info/toggle).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PaymentLink {
    #[serde(default)]
    pub link_id: String,
    #[serde(default)]
    pub url: String,
    #[serde(default)]
    pub title: String,
    #[serde(default)]
    pub description: String,
    /// `fixed` / `open` / `range`.
    #[serde(default)]
    pub amount_mode: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub active: bool,
    #[serde(default)]
    pub created_at: String,
    #[serde(default)]
    pub amount_fixed: String,
    #[serde(default)]
    pub amount_min: String,
    #[serde(default)]
    pub amount_max: String,
    #[serde(default)]
    pub pinned_currency: String,
    #[serde(default)]
    pub pinned_network: String,
    #[serde(default)]
    pub expires_at: String,
    /// Платежи по ссылке — только в ответе `info`.
    #[serde(default)]
    pub payments: Vec<PaymentLinkPayment>,
}

// ─────────────────────────── Сплит-платежи (v1.1.0) ───────────────────────────

/// Правило сплита (create/list). Получатель — либо внешний `address`+`network`
/// (необратимо), либо `merchant_id` на платформе (обратимо при возврате).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct SplitRule {
    #[serde(default)]
    pub rule_id: String,
    /// Доля в процентах (шаг 0.01%).
    #[serde(default)]
    pub percent: f64,
    #[serde(default)]
    pub active: bool,
    #[serde(default)]
    pub note: String,
    #[serde(default)]
    pub address: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub merchant_id: String,
    /// `true` — доля отзывается при возврате (получатель-мерчант на платформе).
    #[serde(default)]
    pub reversible: bool,
}

/// Настройки сплитов. `POST /v1/split/config/get|set`
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct SplitConfig {
    /// Окно удержания (в часах) перед исходящей маршрутизацией долей после settle.
    #[serde(default)]
    pub refund_hold_hours: i64,
}

// ─────────────────────────── Payout-ссылки (v1.1.0) ───────────────────────────

/// Статус payout-ссылки («крипто-чека»).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum PayoutLinkStatus {
    /// Создана, резерв удержан, ждёт claim.
    #[default]
    Funded,
    /// Claim в процессе: адрес зафиксирован, порождается выплата (транзиентный).
    Claiming,
    /// Выплата порождена (`payout_id` установлен) — терминальный.
    Claimed,
    /// Дедлайн прошёл без claim, резерв возвращён — терминальный.
    Expired,
    /// Отменена мерчантом до claim, резерв возвращён — терминальный.
    Cancelled,
    /// Неизвестный статус (совместимость с будущими версиями API).
    #[serde(other)]
    Unknown,
}

impl PayoutLinkStatus {
    /// Строковое представление, как в API.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::Funded => "funded",
            Self::Claiming => "claiming",
            Self::Claimed => "claimed",
            Self::Expired => "expired",
            Self::Cancelled => "cancelled",
            Self::Unknown => "unknown",
        }
    }
}

/// Payout-ссылка («крипто-чек»). `claim_token`/`claim_url` приходят ТОЛЬКО в ответе create —
/// сохраните их сразу: в list/info их больше не будет.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PayoutLink {
    #[serde(default)]
    pub link_id: String,
    #[serde(default)]
    pub status: PayoutLinkStatus,
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub title: String,
    #[serde(default)]
    pub note: String,
    #[serde(default)]
    pub expires_at: String,
    #[serde(default)]
    pub created_at: String,
    /// Ваш ключ дедупликации (уникален per-merchant).
    #[serde(default)]
    pub reference: String,
    #[serde(default)]
    pub email: String,
    /// Секретный claim-токен — только в ответе create.
    #[serde(default)]
    pub claim_token: String,
    /// Публичная ссылка на страницу claim — только в ответе create.
    #[serde(default)]
    pub claim_url: String,
    /// Порождённая выплата (после claim).
    #[serde(default)]
    pub payout_id: String,
    /// Адрес получателя (после claim).
    #[serde(default)]
    pub claim_address: String,
    /// Общий id пачки (для ссылок из `create_batch`).
    #[serde(default)]
    pub batch_id: String,
}

/// Элемент результата пачки payout-ссылок (index-aligned с запросом).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PayoutLinkBatchItem {
    #[serde(default)]
    pub ok: bool,
    /// Созданная ссылка (при `ok == true`), с `claim_token`/`claim_url` и `batch_id`.
    #[serde(default)]
    pub link: Option<PayoutLink>,
    /// Код ошибки (при `ok == false`), напр. `payoutlink.insufficient_funds`.
    #[serde(default)]
    pub error: String,
    #[serde(default)]
    pub message: String,
}

/// Результат `POST /v1/payout/link/batch`.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct PayoutLinkBatch {
    #[serde(default)]
    pub created: i64,
    #[serde(default)]
    pub total: i64,
    #[serde(default)]
    pub results: Vec<PayoutLinkBatchItem>,
}

/// Публичные детали claim-страницы. `GET /v1/claim/{token}` (без подписи).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct ClaimInfo {
    #[serde(default)]
    pub status: PayoutLinkStatus,
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub title: String,
    #[serde(default)]
    pub note: String,
    #[serde(default)]
    pub expires_at: String,
    /// `true`, если ссылку ещё можно получить (`funded` и срок не истёк).
    #[serde(default)]
    pub claimable: bool,
}

/// Результат публичного claim. `POST /v1/claim/{token}` (без подписи).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct ClaimResult {
    #[serde(default)]
    pub status: PayoutLinkStatus,
    #[serde(default)]
    pub payout_id: String,
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub currency: String,
    #[serde(default)]
    pub network: String,
    #[serde(default)]
    pub address: String,
}

// ─────────────────────────── Resolve недоплаты (v1.1.0) ───────────────────────────

/// Действие над недоплаченным платежом для [`crate::resources::Payments::resolve`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ResolveAction {
    /// Оставить частичную оплату себе (глушит авто-возврат).
    Accept,
    /// Вернуть средства плательщику.
    Refund,
}

impl ResolveAction {
    /// Строковое представление, как в API (`accept` / `refund`).
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::Accept => "accept",
            Self::Refund => "refund",
        }
    }
}

/// Результат `POST /v1/payment/resolve`. При `resolution == "accepted"` заполнены
/// `amount_kept`/`currency`; при `"refunded"` — поля рефанд-выплаты (`uuid`, `amount`,
/// `address`, `status`, `is_final`).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Resolution {
    #[serde(default)]
    pub payment_uuid: String,
    #[serde(default)]
    pub order_id: String,
    /// `accepted` или `refunded`.
    #[serde(default)]
    pub resolution: String,
    #[serde(default)]
    pub amount_kept: String,
    #[serde(default)]
    pub currency: String,
    /// UUID рефанд-выплаты (только при `refunded`).
    #[serde(default)]
    pub uuid: String,
    #[serde(default)]
    pub amount: String,
    #[serde(default)]
    pub address: String,
    /// Статус рефанд-выплаты: `check`/`process`/`paid`/`fail`/`cancel`.
    #[serde(default)]
    pub status: String,
    #[serde(default)]
    pub is_final: bool,
}