-
Notifications
You must be signed in to change notification settings - Fork 3
/
payout.yaml
944 lines (916 loc) · 34.4 KB
/
payout.yaml
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
openapi: 3.0.0
info:
version: '1.0'
title: API интеграции выплат
contact:
email: ecom@raiffeisen.ru
name: Support e-mail
x-logo:
url: images/raifflogo.png
backgroundColor: '#FFFFFF'
altText: Raiff logo
description: |-
Свои предложения и идеи о документации можно оставить в репозитории по адресу: https://github.com/Raiffeisen-DGTL/ecom-API/blob/master/payout.yml
# Описание API
Bзаимодействие осуществляется по протоколу HTTP с использованием методов GET/POST (в описании каждого запроса явно указан требуемый метод и адрес).
POST-запросы используют JSON-аргументы, GET-запросы работают со строками запросов.
API всегда возвращает ответ в формате JSON, независимо от типа запроса.
Ответ любого метода содержит код сообщения (code). Если в процессе обработки любого запроса произойдет логическая ошибка, API вернет дополнительно описание ошибки (message).
# Общие схемы работы
## Одностадийная обработка
При получении запроса на выплату, банк сразу проводит все проверки и в случае возможности проведения операции, выполняет выплату.
<a href='images/subscriptions.png' target='_blank'><img src='images/Payout_scheme.png'></a>
## Двухстадийная обработка
При двухстадийной обработке создается заявка на выплату, банк делает проверку возможности проведения такой операции и возвращает результат. Далее ожидается подтверждение выплаты со стороны партнера.
<a href='images/subscriptions.png' target='_blank'><img src='images/Payout_2_scheme.png'></a>
# Авторизация
Авторизация производится посредством секретного ключа API (secretKey). Параметр авторизации указывается в заголовке Authorization, значение которого формируется как "Bearer secretKey".
Так же настраивается список IP с которых система будет пропускать запросы.
servers:
- url: 'https://test.ecom.raiffeisen.ru/api'
description: Sandbox
- url: 'https://e-commerce.raiffeisen.ru/api'
description: Production
tags:
- name: api-controller
x-displayName: Работа с выплатами
description: |
Для реализации взаимодействия с партнёром Райффайзенбанк предоставляет API из следующих запросов:
* получение списка банков, принимающих выплаты по СБП,
* запрос на проведение выплаты,
* получение статуса выплаты
Банки, подключенные к приему выплат по СБП вы сможете посмотреть на сайте https://sbp.nspk.ru/participants/ в разделе "Оплата по QR".
Мы автоматически поддерживаем актуальный список и возвращаем его для вас в запросе на получение банков частников.
- name: Callback
x-displayName: Уведомления
description: |
Для информирования ТСП о проведенных операциях могут использоваться HTTP-уведомления на адрес, указанный в его настройках.
Для партнёра уведомление представляет собой входящий POST-запрос, который использует JSON-структуру.
Уведомление считается принятым, если получатель ответил на запрос кодом HTTP 200.
Ответы с любыми другими HTTP-кодами будут считаться невалидными.
Повторные попытки отправки будут проводиться в течение суток с нарастающим интервалом.
Для проверки подлинности уведомления к данным добавляется подпись в заголовке X-Api-Signature-SHA256, полученная на основе общего секретного ключа и контрольной строки (amount|id|statusValue|statusDate) с помощью HMAC-SHA-256.
Уведомления отправляются с IP 193.28.44.23
- name: Registry
x-displayName: Реестр
description: |
Для подключения отправки реестров необходимо написать на ecom@raiffeisen.ru
Реестры по операциям отправляются на ежедневной основе.
В случае отсуствия операций за день, реестр на следующий день не отправляется.
Формат реестра:
Наименование колонки | Значение
--------|------------------
Мерчант | Идентификатор в системе СБП
Дата операции МСК | Дата и время проведения операции
Тип | Тип операции
id заказа | Id операции в системе партнера (id)
id возврата | Не используется
Комментарий | Комментарий к заказу
Способ оплаты | Instant Payment QR
Данные оплаты | PAYOUT
id клиента | Маскированный код получателя
Сумма | Сумма транзакции
Комиссия | Комиссия по транзакции
Дополнительные поля | Дополнительная информация (Пока не используется)
<a download='' target='_blank' href='images/SBPPayoutReport.csv'>Пример реестра</a>
- name: Statement
x-displayName: Выписка
description: |
Выписку может выгрузить в банк-клиенте в разных форматах.
<a download='' target='_blank' href='images/test_statement_payout.pdf'>Пример выписки</a>
В назначение платежа есть системиный префикс: номер проводки , тип операции , идентификатор мерчанта НСПК.
В примерах выписки указаны стандартные назначение платежа, вы можете его изменить, для этого необходимо при выплате передавать параметр paymentDetails с вашими данными, при этом ваше значение будет идти после системного префикса.
- name: 09.09.2021
x-displayName: 09.09.2021
description: |
* Исправлена длина параметра paymentDetails
x-tagGroups:
- name: API
tags:
- api-controller
- Callback
- name: Сверка
tags:
- Registry
- Statement
- name: История изменений
tags:
- 09.09.2021
paths:
/payout/v1/sbp/banks:
get:
summary: Получение списка банков
tags:
- api-controller
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/banksList'
examples:
Payload:
value:
- alias: RAIFFEISEN
name: Райффайзенбанк
- alias: TINKOFF
name: Тинькофф
- alias: VTB
name: ВТБ
operationId: get-payout-v1-sbp-banks
description: 'Получение списка банков, принимающих выплаты по СБП'
parameters:
- schema:
type: string
in: header
name: 'Authorization:'
required: true
description: '[secretKey](#section/Avtorizaciya)'
parameters: []
/payout/v1/payouts:
post:
tags:
- api-controller
operationId: post-payout-v1-payouts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/payoutResponse'
examples:
'200':
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
status:
value: IN_PROGRESS
date: '2019-07-11T17:45:13+03:00'
createDate: '2019-07-11T17:45:13+03:00'
description: Проведение выплаты
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/payoutRequest'
examples:
Payload:
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
paymentDetails: Выплата от страховой компании
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
description: ''
parameters:
- schema:
type: string
in: header
name: 'Content-type: '
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
required: true
description: '[secretKey](#section/Avtorizaciya)'
summary: Проведение выплаты
/payout/v1/payouts/draft:
post:
summary: Создание заявки на выплату
tags:
- api-controller
operationId: post-payout-v1-payouts-draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/payoutResponse'
examples:
'200':
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
status:
value: PENDING
date: '2019-07-11T17:45:13+03:00'
createDate: '2019-07-11T17:45:13+03:00'
x-internal: false
description: Метод позволяет создавать заявку на выплату для двухстадийного взаимодействия
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
required: true
description: '[secretKey](#section/Avtorizaciya)'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/payoutRequest'
examples:
Payload:
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
paymentDetails: Выплата от страховой компании
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
description: ''
'/payout/v1/payouts/{id}':
parameters:
- schema:
type: string
maxLength: 20
format: '^[Aa-Zz0-9_-]'
name: id
in: path
required: true
description: id выплаты
get:
summary: Получение информации по платежу
tags:
- api-controller
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/payoutResponse'
examples:
COMPLETED:
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
status:
value: COMPLETED
date: '2019-07-11T17:45:13+03:00'
createDate: '2019-07-11T17:45:13+03:00'
DECLINED:
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
status:
value: DECLINED
declineReason: RECEIVER_ACCOUNT_ERROR
date: '2019-07-11T17:45:13+03:00'
createDate: '2019-07-11T17:45:13+03:00'
operationId: get-payout-v1-payouts-id
description: Получение информации по платежу
parameters:
- schema:
type: string
in: header
name: 'Authorization:'
required: true
description: '[secretKey](#section/Avtorizaciya)'
put:
summary: Подтверждение выплаты
tags:
- api-controller
operationId: put-payout-v1-payouts-id
responses:
'200':
description: OK
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
required: true
description: '[secretKey](#section/Avtorizaciya)'
description: 'Подтверждение платежа , при двухстадийной выплате.'
/settings/v1/callback:
post:
summary: Настройка url для callback
operationId: post-settings-v1-callback
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/callbackSettings'
examples:
'200':
value:
callbackUrl: 'https://yoururl.ru'
description: Метод позволяет настроить url для получения уведомлений.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/callbackSettings'
examples:
Payload:
value:
callbackUrl: 'https://yoururl.ru'
description: ''
tags:
- Callback
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
required: true
description: '[secretKey](#section/Avtorizaciya)'
x-webhooks:
newPay:
post:
summary: Уведомление о платеже
operationId: сallbackTransaction
tags:
- Callback
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/paymentsNotification'
x-examples:
event:
event: payout
payout:
id: p210730t2WjboNkN0ft1
amount: 0.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79267016490'
bankAlias: RAIFFEISEN
firstName: Сергей
middleName: Сергеевич
lastName: Брюзгин
extra:
contract: 1234567/89012
status:
value: COMPLETED
date: '2021-07-30T14:16:32+03:00'
creationDate: '2021-07-30T14:16:31+03:00'
components:
schemas:
paymentsNotification:
description: Уведомление о выплате
type: object
x-examples:
event:
event: payout
payout:
id: p210730t2WjboNkN0ft1
amount: 0.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79267016490'
bankAlias: RAIFFEISEN
firstName: Сергей
middleName: Сергеевич
lastName: Брюзгин
extra:
contract: 1234567/89012
status:
value: COMPLETED
date: '2021-07-30T14:16:32+03:00'
creationDate: '2021-07-30T14:16:31+03:00'
value:
event: payout
payout:
id: p210730t2jboNkN0ft1
amount: 0.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
extra:
contract: 1234567/89012
status:
value: COMPLETED
date: '2021-07-30T14:16:32+03:00'
creationDate: '2021-07-30T14:16:31+03:00'
incomeTypeCode: '1'
title: paymentNotification
properties:
event:
type: string
description: Тип уведомления
example: payout
payout:
type: object
required:
- id
- amount
- currency
- payoutMethod
- payoutParams
- status
- creationDate
properties:
id:
type: string
description: Уникальныйидентификатор операции
format: Aa-Zz0-9_-
example: p210730t2jboNkN0ft1
amount:
type: number
description: Сумма в рублях
example: 0.01
currency:
type: string
description: Валюта платежа
enum:
- RUB
example: RUB
payoutMethod:
type: string
description: Тип выплаты
enum:
- SBP
example: SBP
payoutParams:
type: object
required:
- phone
- bankAlias
properties:
phone:
type: string
description: Номер телефона получателя
maxLength: 15
example: '79191234567'
bankAlias:
type: string
description: Код банка получателя из запроса списка банков
maxLength: 255
example: RAIFFEISEN
firstName:
type: string
description: Имя получателя
example: Петр
middleName:
type: string
description: Отчество получателя
example: Петрович
lastName:
type: string
description: Фамилия получателя
example: Петров
inn:
type: string
description: ИНН получателя
example: '123456789101'
extra:
type: object
description: Дополнительные данные
example: {"contract":"1234567/89012"}
status:
type: object
required:
- value
- date
properties:
value:
type: string
description: Статус
enum:
- COMPLETED
example: COMPLETED
date:
type: string
description: Дата проведения операции
example: '2021-07-30T14:16:32+03:00'
creationDate:
type: string
description: Дата создания заявки
example: '2021-07-30T14:16:31+03:00'
incomeTypeCode:
type: string
description: 'Код вида дохода<br/>[Значения описаны тут](http://www.consultant.ru/document/cons_doc_LAW_353568/527cf8edd2262cb7068cafd44ed596d9a05dd237/)'
example: '1'
required:
- event
- payout
payoutRequest:
description: ''
type: object
x-examples:
Payload:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
paymentDetails: Выплата от страховой компании
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: '12345678910'
incomeTypeCode: '1'
extra:
contract: 1234567/89012
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
paymentDetails: Выплата от страховой компании
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
title: payoutRequest
properties:
id:
type: string
minLength: 1
description: 'Уникальный идентификатор выплаты в вашей системе, используется как номер документа в выписке'
format: '^[Aa-Zz0-9_-]+'
account:
type: string
description: Счет с которого будет происходить списание
maxLength: 20
amount:
type: number
description: |-
Сумма в рублях.
Действует несколько лимитов от НСПК:
1. Ограничение до 600000 на одну операцию
2. Ограничение в 1000000 в сутки в пользу одного получателя.
Можно сделать 3 платежа на одинаковую сумму, например по 400000, главное что бы первые 2 платежа в общей сумме не превысили лимит в 1000000
currency:
type: string
description: Валюта платежа
maxLength: 3
minLength: 3
enum:
- RUB
paymentDetails:
type: string
minLength: 1
description: Назначение платежа
maxLength: 140
payoutMethod:
type: string
minLength: 1
description: Тип выплаты
enum:
- SBP
payoutParams:
type: object
required:
- phone
- bankAlias
properties:
phone:
type: string
minLength: 1
description: Номер телефона получателя
maxLength: 15
bankAlias:
type: string
minLength: 1
description: Код банка получателя из запроса списка банков
maxLength: 255
firstName:
type: string
minLength: 1
description: Имя получателя
maxLength: 140
middleName:
type: string
minLength: 1
description: Фамилия получателя
maxLength: 140
lastName:
type: string
minLength: 1
description: Отчество получателя
maxLength: 140
inn:
description: ИНН получателя
type: number
incomeTypeCode:
type: string
minLength: 1
description: 'Код вида дохода<br/>[Значения описаны тут](http://www.consultant.ru/document/cons_doc_LAW_353568/527cf8edd2262cb7068cafd44ed596d9a05dd237/)'
enum:
- '1'
- '2'
- '3'
extra:
type: object
description: Дополнительные данные
required:
- account
- amount
- currency
- payoutMethod
- payoutParams
payoutResponse:
description: ''
type: object
x-examples:
'200':
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
incomeTypeCode: '1'
extra:
contract: 1234567/89012
status:
value: IN_PROGRESS
date: '2019-07-11T17:45:13+03:00'
createDate: '2019-07-11T17:45:13+03:00'
value:
id: 1404fhr7i272a2
account: '40700000000000000000'
amount: 1110.01
currency: RUB
payoutMethod: SBP
payoutParams:
phone: '79191234567'
bankAlias: RAIFFEISEN
firstName: Петр
middleName: Петрович
lastName: Петров
inn: 123456789101
incomeTypeCode: '1'
extra:
contract: 1234567/89012
status:
value: PENDING
date: '2019-07-11T17:45:13+03:00'
createDate: '2019-07-11T17:45:13+03:00'
title: payoutResponse
properties:
id:
type: string
minLength: 1
description: 'Уникальный идентификатор выплаты в вашей системе, используется как номер документа в выписке'
account:
type: string
minLength: 1
description: Счет с которого будет происходить списание
amount:
type: number
description: Сумма в рублях
currency:
type: string
minLength: 3
description: Валюта платежа
maxLength: 3
enum:
- RUB
payoutMethod:
type: string
minLength: 1
description: Тип выплаты
enum:
- SBP
payoutParams:
type: object
required:
- phone
- bankAlias
properties:
phone:
type: string
minLength: 1
description: Номер телефона получателя
bankAlias:
type: string
minLength: 1
description: Код банка получателя из запроса списка банков
firstName:
type: string
minLength: 1
description: Имя получателя
middleName:
type: string
minLength: 1
description: Фамилия получателя
lastName:
type: string
minLength: 1
description: Отчество получателя
inn:
type: number
description: ИНН получателя
incomeTypeCode:
type: string
minLength: 1
description: 'Код вида дохода<br/>[Значения описаны тут](http://www.consultant.ru/document/cons_doc_LAW_353568/527cf8edd2262cb7068cafd44ed596d9a05dd237/)'
enum:
- '1'
- '2'
- '3'
extra:
type: object
description: Дополнительные данные
status:
type: object
required:
- value
- date
properties:
value:
type: string
minLength: 1
description: Статус
enum:
- COMPLETED
- DECLINED
- IN_PROGRESS
- PENDING
- WAITING_CONFIRMATION
date:
type: string
minLength: 1
description: Дата
declineReason:
type: string
description: Причина отклонения операции
enum:
- SYSTEM_ERROR
- TIMEOUT
- BANK_NOT_SUPPORTED
- RECEIVER_ACCOUNT_ERROR
- WRONG_RECIPIENT
createDate:
type: string
minLength: 1
description: Дата создания
required:
- id
- account
- amount
- currency
- payoutMethod
- payoutParams
- status
- createDate
callbackSettings:
description: ''
type: object
properties:
callbackUrl:
type: string
minLength: 1
required:
- callbackUrl
x-examples:
Payload:
callbackUrl: 'https://yoururl.ru'
value:
callbackUrl: 'https://yoururl.ru'
title: callBackSettings
banksList:
type: array
description: ''
minItems: 1
uniqueItems: true
x-examples:
'200':
- alias: RAIFFEISEN
name: Райффайзенбанк
- alias: TINKOFF
name: Тинькофф
- alias: VTB
name: ВТБ
items:
type: object
properties:
alias:
type: string
minLength: 1
description: Алиас банка
maxLength: 255
name:
type: string
minLength: 1
description: Наименование банка
maxLength: 255
required:
- alias
- name