-
Notifications
You must be signed in to change notification settings - Fork 3
/
sbp.yaml
1577 lines (1505 loc) · 71.4 KB
/
sbp.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
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
openapi: 3.0.0
info:
title: API интеграции Системы Быстрых Платежей (СБП)
version: '1.0'
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/sbp.yml
# Подключение к СБП
Для приема СБП-платежей оставьте заявку на [сайте.](https://www.raiffeisen.ru/corporate/management/sbp/)
Райффайзенбанк выполнит регистрацию.
После завершения процесса вы будете оповещены на электронную почту.
## Участники СБП
### Покупатель
* выбирает в ПО партнёра услуги/товары и пункт «Оплата через СБП» (опционально)
* сканирует QR-код, предоставленный партнёром, и подтверждает платеж в приложении своего банка
* получает результат платежа и оплаченную услуги/товары
### Партнёр
* запрашивает формирование QR-кода для выбранных товаров/услуг (корзины)
* отображает QR-код клиенту для сканирования и произведения оплаты
* обрабатывает уведомления о результатах СБП-операций
* запрашивает данные по платежу (опционально)
* обеспечивает выдачу товаров/услуг покупателю по факту платежа
### Райффайзенбанк
* предоставляет интерфейс для запроса QR-кода со стороны партнёра
* обеспечивает перевод денежных средств на счет партнёра по факту расчетов в СБП
* определяет формат уведомления о факте СБП-платежа
* предоставляет интерфейс для получения данных по платежу
## Поддержка 54-ФЗ
По закону от 22.05.2003 № 54–ФЗ "О применении контрольно-кассовой техники при осуществлении расчетов в Российской Федерации"
при оплате товаров, работ или услуг необходимо формировать фискальный чек и отправлять его в налоговую с помощью кассы.
Райффайзенбанк предоставляет возможность фискализировать чеки через [API](https://e-commerce.raiffeisen.ru/api/doc/fiscal.html) банка.
# Общие схемы работы
## Схема работы с формой
B случае если прием платежей планируется на сайте или в мобильном приложение рекомендуем использовать [протокол с отображением QR на нашей форме.](https://e-commerce.raiffeisen.ru/api/doc/ecom.html)
<a href='images/E-commerce Raiffeisenbank scheme.png' target='_blank'><img src='images/E-commerce Raiffeisenbank scheme.png'></a>
## Схема работы по прямому протоколу СБП
Если прием платежей реализуется в физических точках или по каким либо причинам вам не подходит решение с нашей формой , можете использовать протокол описанный ниже.
На рисунке изображена схема информационного обмена c партнёром при реализации платежа по QR-коду.
<a href='images/SBP API Raiffeisenbank scheme.png' target='_blank'><img src='images/SBP API Raiffeisenbank scheme.png'></a>
## Схема работы с подписками
Вы можете предлагать клиенту привязать оплату по СБП к программе лояльности или к аккаунту в вашем сервисе. Для этого вы можете сгенерировать QR и отобразить его клиенту, либо перенаправить его на специальную ссылку, которая есть в ответе на запрос генерации QR на подписку.
После по уникальному идентификатору подписки вы можете обращаться за безакцептным списание средств с клиента за ваши товары и услуги.
<a href='images/subscriptions.png' target='_blank'><img src='images/subscriptions.png'></a>
## Схема работа по подпискам с оплатой
Так же есть схема когда одним запросом получается QR на получение оплаты и заведения подписки.
В данном случае клиент проводит оплату и после ему отображается окно с предложением подключения подписки.
Клиент может провести оплату, но отказаться от подписки. Так же клиент может провести оплату с приложения банка, который не подклбчен к сервису подписок.
<a href='images/subscriptionsandpayment.png' target='_blank'><img src='images/subscriptionsandpayment.png'></a>
# Готовые решения
Для более быстрой интеграции вы можете вопоспользоваться нашими SDK:
* [Java](https://github.com/Raiffeisen-DGTL/sbp-sdk-java)
Так же список готовых решений вы можете посмотреть [тут.](https://e-commerce.raiffeisen.ru/api/doc/solutions.html)
# Описание API
Bзаимодействие осуществляется по протоколу HTTP с использованием методов GET/POST (в описании каждого запроса явно указан требуемый метод и адрес).
POST-запросы используют JSON-аргументы, GET-запросы работают со строками запросов.
API всегда возвращает ответ в формате JSON, независимо от типа запроса.
Ответ любого метода содержит код сообщения (code). Если в процессе обработки любого запроса произойдет логическая ошибка, API вернет дополнительно описание ошибки (message).
## Авторизация
Запросы связанные с получением данных по платежу и управлением платежами авторизуются посредством секретного ключа API (sercretKey). Параметр авторизации указывается в заголовке Authorization, значение которого формируется как "Bearer secretKey".
Для получения тестовых данных для интеграции необходимо заполнить анкету на [pay.raif.ru](https://corp-request.rbo.raiffeisen.ru/?product=pay_raif&preselect=6|28)
Посмотреть боевой sbpMerchantId и сгенерировать ключи можно в [личном кабинете](https://www.rbo.raiffeisen.ru/acquiring/mcp#/) во вкладке "Прием платежей"
<div align=center><a href='images/createKey.png' target='_blank'><img src='images/createKey.png'></a></div>
# Мобильная версия и приложение
При работе в мобильной версии сайта или приложении необходимо перенаправлять клиента по url из параметра payload.
У клиента откроется мобильное приложение банка или список выбора банка.
# Тестирование
Для полного цикла тестирования оплаты Райффайзенбанк предоставляет возможность использования демо-приложения для сканирования QRC от имени покупателя по адресу:
https://pay.raif.ru/pay/rfuture/
Указанный адрес можно открыть в браузере любого устройства, где есть камера. Никакого дополнительного софта/плагинов устанавливать не нужно. Далее нажать на значок СБП (при необходимости разрешить браузеру доступ к камере) и поднести к ней изображение QR-кода.
Если камера не открылась, проверьте что в адресе указан проткол https.
### Пример экранов демо-приложения
<div align=center><a href='images/example-sbp-1.png' target='_blank'><img src='images/example-sbp-1.png'></a></div>
servers:
- url: 'https://e-commerce.raiffeisen.ru/api'
description: Production
- url: 'https://test.ecom.raiffeisen.ru/api'
description: Sandbox
tags:
- name: qr-controller
x-displayName: Работа с QR-кодом
description: |
Для реализации взаимодействия с партнёром Райффайзенбанк предоставляет API из следующих запросов:
* регистрация QR-кода,
* получение данных по зарегистрированному ранее QR-коду,
* получение данных по платежу,
* возврат денежных средств - может быть выполнен в любое время после проведения оплаты на полную сумму платежа или частичную. Однако сумма частичных запросов на возврат не должна превышать общую сумму заказа.
* получение информации по возврату.
[Схема взаимодействия.](#section/Obshie-shemy-raboty/Shema-raboty-po-pryamomu-protokolu-SBP)
- name: qr-subscription
x-displayName: Подписки
description: |
Для включения функционала подписок необходима дополнительная настройка со стороны банка.
Выполняется при обращении в тех. поддержку.
Для реализации возможны два сценария:
* отдельно подписка с последующими платежами
[Схема взаимодействия.](#section/Obshie-shemy-raboty/Shema-raboty-s-podpiskami)
* подписка с оплатой
[Схема взаимодействия.](#section/Obshie-shemy-raboty/Shema-rabota-po-podpiskam-s-oplatoj)
- name: Callback
x-displayName: Уведомления
description: |
Для информирования ТСП о проведенных платежах могут использоваться HTTP-уведомления на адрес, указанный в его настройках.
Боевой адрес можно указать в [личном кабинете](https://www.rbo.raiffeisen.ru/acquiring/mcp#/) во вкладке "Прием платежей"
<div align=center><a href='images/callback.png' target='_blank'><img src='images/callback.png'></a></div>
Так же адрес для тестовой и боевой среды можно указать с помощью [метода в API](#operation/post-settings-v1-callback).
Для партнёра уведомление представляет собой входящий POST-запрос, который использует JSON-структуру.
Уведомление считается принятым, если получатель ответил на запрос кодом HTTP 200.
Ответы с любыми другими HTTP-кодами будут считаться невалидными.
Повторные попытки отправки будут проводиться в течение суток с нарастающим интервалом.
Для проверки подлинности уведомления к данным добавляется подпись в заголовке X-Api-Signature-SHA256, полученная на основе общего секретного ключа и контрольной строки (amount|sbpMerchantId|order|paymentStatus|transactionDate) с помощью HMAC-SHA-256.
Уведомления отправляются с IP 193.28.44.23
- name: Registry
x-displayName: Реестр
description: |
Для подключения отправки реестров необходимо написать на ecom@raiffeisen.ru
Реестры по платежам отправляются на ежедневной основе.
В случае отсуствия операций за день, реестр на следующий день не отправляется.
Формат реестра:
Наименование колонки | Значение
--------|------------------
Мерчант | Идентификатор в системе СБП
Дата операции МСК | Дата и время проведения операции
Тип | Тип операции
id заказа | Id заказа в системе партнера (order)
id возврата | Id возврата в системе партнера (refundId)
Комментарий | Комментарий к заказу
Способ оплаты | Instant Payment QR
Данные оплаты | QR id
id клиента | Маскированный код плательщика
Сумма | Сумма транзакции
Комиссия | Комиссия по транзакции
Дополнительные поля | Дополнительная информация (Пока не используется)
<a download='' target='_blank' href='images/SBPreport.csv'>Пример реестра</a>
- name: Statement
x-displayName: Выписка
description: |
Выписку может выгрузить в банк-клиенте в следующих форматах:
* <a download='' target='_blank' href='images/test_statement.pdf'>PDF</a>
* <a download='' target='_blank' href='images/test_statement_1C.txt'>1C txt</a>
* <a download='' target='_blank' href='images/test_statement.xml'>XML</a>
В назначение платежа есть системиный префикс: номер проводки , тип операции , идентификатор мерчанта НСПК.
В примерах выписки указаны стандартные назначение платежа, вы можете его изменить, для этого необходимо при генерации QR и возвратах передавать параметр paymentDetails с вашими данными, при этом ваше значение будет идти после системного префикса.
- name: Errors
x-displayName: Справочник ошибок
description: |
Ответ любого метода содержит код сообщения (code). Если в процессе обработки любого запроса произойдет логическая ошибка, API вернет описание ошибки (message).
Описание основных ошибок:
code | message
------------|------
ERROR.ACCOUNT_IS_NOT_REGISTERED | Указан неверный счет. Проверьте его или удалите. Параметр является необязательным
ERROR.INVALID_REQUEST | Не передан обязательный параметр
ERROR.QR_EXPIRATION_DATE_NOT_VALID | Неверная дата истечения QR-кода
ERROR.MERCHANT_NOT_REGISTERED | Партнер с ID MA0000000552 не зарегистрирован
ERROR.ORDER_NUMBER_ALREADY_REGISTERED | QR-код с номером заказа ***, партнера MA0000000552 и успешными платежами уже зарегистрирован
ERROR.INVALID_REQUEST | Передана некорректная сумма платежа
ERROR.SBP_MERCHANT_ID_IS_MISSING | SbpMerchantId партнера не указан
ERROR.DYNAMIC_QR_WITHOUT_AMOUNT | Не передана сумма для динамического QR-кода
ERROR.INVALID_ORDER | В номере заказа поддерживаются A-z09_-.
ERROR.NOT_FOUND | QR-код не найден у данного партнера
ERROR.REFUND_INSUFFICIENT_FUNDS | Сумма возврата больше суммы остатка по платежу
ERROR.INVALID_REQUEST | Сумма возврата не может быть меньше 1 копейки
ERROR.REFUND_NOT_FOUND | Возврат с refundId *** не найден
- name: 02.06.2021
x-displayName: 02.06.2021
description: |
* Добавили [новый метод отмены QR-кода](#operation/delete-sbp-v2-qrs-qrId)
* Появилась [новая версия запроса на получения данных по QR-коду](#operation/get-sbp-v2-qrs-qrId)
- name: 06.07.2021
x-displayName: 06.07.2021
description: |
* Реализовали [сервис подписок](#tag/qr-subscription)
- name: 09.09.2021
x-displayName: 09.09.2021
description: |
* Исправлена длина параметра paymentDetails при операциях возвратах
x-tagGroups:
- name: API
tags:
- qr-controller
- qr-subscription
- Callback
- name: Сверка
tags:
- Registry
- Statement
- name: Справочник
tags:
- Errors
- name: История изменений
tags:
- 02.06.2021
- 06.07.2021
- 09.09.2021
paths:
/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'
tags:
- Callback
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/callbackSettings'
examples:
Payload:
value:
callbackUrl: 'https://yoururl.ru'
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
description: Для подписи уведомлений будет использоваться ключ из заголовка авторизации.
/sbp/v1/qr/register:
post:
summary: Регистрация QR
operationId: post-sbp-v1-qr-register
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/qrStatus'
examples:
QRDynamic subscription:
value:
code: SUCCESS
qrId: AD1F2CD7212E48FA919AB52EF0AEFB33
payload: 'https://qr.nspk.ru/AD1F2CD7212E48FA919AB52EF0AEFB33?type=02&bank=10000001&sum=111000&cur=RUB&crc=C08B'
qrUrl: 'https://test.ecom.raiffeisen.ru/api/sbp/v1/qr/AD1F2CD7212E48FA919AB52EF0AEFB33/image'
subscriptionId: '120059'
QRDynamic/QRStatic:
value:
code: SUCCESS
qrId: AD100004BAL7227F9BNP6KNE007J9B3K
payload: 'https://qr.nspk.ru/AD100004BAL7227F9BNP6KNE007J9B3K?type=02&bank=100000000007&sum=1&cur=RUB&crc=AB75'
qrUrl: 'https://e-commerce.raiffeisen.ru/api/sbp/v1/qr/AD100004BAL7227F9BNP6KNE007J9B3K/image'
description: |-
Регистрация QR кода выполяется без авторизации, что позволяет сгенерировать его на сайте или приложении. Данный метод позволяет генерировать как статический QR кода , так и динамечкие QR кода. Так же с помощью данного метода вы можете сгенерировать QR код для оплаты с подпиской.
Тестовые QR можно оплатить только нашим [тестовым приложением.](#section/Testirovanie)
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/reqPayQR'
examples:
QRDynamic:
value:
account: 40700000000000000000
additionalInfo: Доп информация
amount: 1110.11
currency: RUB
order: 1-22-333
paymentDetails: Назначение платежа
qrType: QRDynamic
qrExpirationDate: '2023-07-22T09:14:38+03:00'
sbpMerchantId: MA0000000552
QRDynamic subscription:
value:
account: 40700000000000000000
additionalInfo: Доп информация
amount: 1110.11
currency: RUB
order: 1-22-333
paymentDetails: Назначение платежа
qrType: QRDynamic
qrExpirationDate: '2023-07-22T09:14:38+03:00'
sbpMerchantId: MA0000000552
subscription:
id: '120059'
subscriptionPurpose: Подписка на услуги
QRStatic:
value:
order: 1-22-333
qrType: QRStatic
sbpMerchantId: MA0000000552
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
tags:
- qr-controller
x-codeSamples:
- lang: cURL
source: |
curl --location --request POST 'https://test.ecom.raiffeisen.ru/api/sbp/v1/qr/register' \
--header 'Content-Type: application/json' \
--data-raw '{
"account": 40700000000000000000,
"additionalInfo": "Доп информация",
"amount": 1110,
"currency": "RUB",
"order": "1-22-333",
"paymentDetails": "Назначение платежа",
"qrType": "QRDynamic",
"qrExpirationDate": "2023-07-22T09:14:38+03:00",
"sbpMerchantId": "MA0000000552"
}'
- lang: Java
source: |
String order = QRUtils.generateOrderNumber();
QRDynamic qrCode = new QRDynamic(order, new BigDecimal(100));
qrCode.setAccount("40700000000000000000");
qrCode.setAdditionalInfo("Доп информация");
qrCode.setPaymentDetails("Назначение платежа");
qrCode.setQrExpirationDate("2023-07-22T09:14:38.107227+03:00");
QRUrl response = client.registerQR(qrCode);
'/sbp/v2/qrs/{qrId}':
parameters:
- schema:
type: string
name: qrId
in: path
required: true
description: Уникальный идентификатор QR
delete:
summary: Отмена QR-кода
operationId: delete-sbp-v2-qrs-qrId
responses:
'200':
description: OK
tags:
- qr-controller
description: 'Метод позволяет оменить ранее созданный QR , до момента его оплаты'
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
x-codeSamples:
- lang: cURL
source: |
curl --location --request DELETE 'https://test.ecom.raiffeisen.ru/api/sbp/v2/qrs/ADAC306DDBF443CA94EBE3FA85CA4872' \
--header 'Authorization: Bearer eyJ0eXA***'
get:
summary: Получение данных по зарегистрированному ранее QR-коду
operationId: get-sbp-v2-qrs-qrId
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/qrInfov2'
examples:
'200':
value:
qrId: AD100004BAL7227F9BNP6KNE007J9B3K
qrStatus: NEW
qrExpirationDate: '2023-07-22T09:14:38+03:00'
payload: 'https://qr.nspk.ru/AD100004BAL7227F9BNP6KNE007J9B3K?type=02&bank=100000000007&sum=1&cur=RUB&crc=AB75'
qrUrl: 'https://e-commerce.raiffeisen.ru/api/sbp/v1/qr/AD100004BAL7227F9BNP6KNE007J9B3K/image'
description: Метод позволяет получить данные по зарегистрированному ранее QR-коду
tags:
- qr-controller
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
x-codeSamples:
- lang: cURL
source: |
curl --location --request GET 'https://test.ecom.raiffeisen.ru/api/sbp/v2/qrs/ADAC306DDBF443CA94EBE3FA85CA4872' \
--header 'Authorization: Bearer eyJ0eXA***'
'/sbp/v1/qr/{qrId}/info':
parameters:
- schema:
type: string
name: qrId
in: path
required: true
description: Уникальный идентификатор QR
get:
summary: Получение данных по зарегистрированному ранее QR-коду
tags:
- qr-controller
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/qrStatus'
examples:
'200':
value:
code: SUCCESS
qrId: AD100004BAL7227F9BNP6KNE007J9B3K
payload: 'https://qr.nspk.ru/AD100004BAL7227F9BNP6KNE007J9B3K?type=02&bank=100000000007&sum=1&cur=RUB&crc=AB75'
qrUrl: 'https://e-commerce.raiffeisen.ru/api/sbp/v1/qr/AD100004BAL7227F9BNP6KNE007J9B3K/image'
operationId: get-sbp-v1-qr-qrId-info
deprecated: true
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
x-codeSamples:
- lang: cURL
source: |
curl --location --request GET 'https://test.ecom.raiffeisen.ru/api/sbp/v1/qr/AS6E5A7F9E3A4E648C536EC930AECDF6/info' \
--header 'Authorization: Bearer eyJ0eXA***'
- lang: Java
source: |
String qrIdString = "...";
QRId id = new QRId(qrIdString);
QRUrl response = client.getQRInfo(id);
description: Метод позволяет получить данные по зарегистрированному ранее QR-коду
'/sbp/v1/qr/{qrId}/payment-info':
parameters:
- schema:
type: string
name: qrId
in: path
required: true
description: Уникальный идентификатор QR
get:
summary: Получение информации по платежу
tags:
- qr-controller
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/paymentInfo'
examples:
'200':
value:
additionalInfo: Доп информация
paymentPurpose: Назначение платежа
amount: 1110.11
code: SUCCESS
createDate: '2020-01-31T09:14:38.107227+03:00'
currency: RUB
merchantId: 123
order: 282a60f8-dd75-4286-bde0-af321dd081b3
paymentStatus: SUCCESS
qrId: AD100051KNSNR64I98CRUJUASC9M72QT
sbpMerchantId: MA0000000552
transactionDate: '2019-07-11T17:45:13.109227+03:00'
transactionId: 23
qrExpirationDate: '2020-01-15T13:00:40+03:00'
operationId: get-sbp-v1-qr-qrId-payment-info
description: Метод позволяет получить данные по платежу по QR
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
name: 'Authorization:'
required: true
x-codeSamples:
- lang: cURL
source: |
curl --location --request GET 'https://test.ecom.raiffeisen.ru/api/sbp/v1/qr/AS6E5A7F9E3A4E648C536EC930AECDF6/payment-info' \
--header 'Authorization: Bearer eyJ0eXA***'
- lang: Java
source: |
String qrIdString = "...";
QRId id = new QRId(qrIdString);
PaymentInfo response = client.getPaymentInfo(id);
/sbp/v1/refund:
post:
summary: Оформление возврата по платежу
operationId: post-sbp-v1-refund
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responeRefund'
examples:
'200':
value:
code: SUCCESS
amount: 150
refundStatus: IN_PROGRESS
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/refundQR'
examples:
QRDynamic:
value:
amount: 150
order: test_order_007
paymentDetails: Test
refundId: test_refundId_007
QRStatic:
value:
amount: 150
order: test_order_007
paymentDetails: Test
refundId: test_refundId_007
transactionId: 41
tags:
- qr-controller
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
x-codeSamples:
- lang: cURL
source: |
curl --location --request POST 'https://test.ecom.raiffeisen.ru/api/sbp/v1/refund' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXA***' \
--data-raw '{
"amount": 150,
"order": "test_order_007",
"paymentDetails": "Test",
"refundId": "test_refundId_007",
"transactionId": 41
}'
- lang: Java
source: |
BigDecimal moneyAmount = new BigDecimal(150);
String orderInfo = "...";
String refundId = "...";
long transactionId = ...;
RefundInfo refundInfo = new RefundInfo(moneyAmount, orderInfo, refundId);
RefundStatus response = client.refundPayment(refundInfo);
description: Метод позволяет осуществлять полный и частичный возврат по QR
'/sbp/v1/refund/{refundId}':
parameters:
- schema:
type: string
name: refundId
in: path
required: true
description: Уникальный идентификатор запроса на возврат в системе партнера
get:
summary: Получение информации по возврату
tags:
- qr-controller
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responeRefund'
examples:
'200':
value:
code: SUCCESS
amount: 150
refundStatus: COMPLETED
operationId: get-sbp-v1-refund-refundId
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
x-codeSamples:
- lang: cURL
source: |
curl --location --request GET 'https://test.ecom.raiffeisen.ru/api/sbp/v1/refund/111112222200046' \
--header 'Authorization: Bearer eyJ0eXA***'
- lang: Java
source: |
String refundIdString = "...";
RefundId refundId = new RefundId(refundIdString);
RefundStatus response = client.getRefundInfo(refundId);
description: Получение информации по возврату
/sbp/v1/subscriptions:
post:
summary: Создание QR для подписки
operationId: post-sbp-v1-subscriptions
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptionRespones'
examples:
'200':
value:
id: '120059'
createDate: '2020-01-31T09:14:38.107227+03:00'
status: INACTIVE
qr:
id: AD100004BAL7227F9BNP6KNE007J9B3K
payload: 'https://sub.nspk.ru/AS3D33FC7B034DEEA8A365142E1DE737?type=03&bank=10000001&crc=C08B'
url: 'https://test.ecom.raiffeisen.ru/api/sbp/v1/qr/AS3D33FC7B034DEEA8A365142E1DE737/image'
description: 'Метод позволяет зарегистрировать QR для последующей привязки счета клиента в выбранном банке. Для мобильного интерфейса используется диплинк, который возвращается в qr.payload. Создание подписки выполняется без авторизации, что позволяет использовать метод на сайте и в мобильном приложении.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createSubscription'
examples:
Payload:
value:
id: '120059'
subscriptionPurpose: Подписка на услуги
sbpMerchantId: MA0000000552
tags:
- qr-subscription
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
'/sbp/v1/subscriptions/{subscriptionId}':
parameters:
- schema:
type: string
name: subscriptionId
in: path
required: true
description: Идентификатор подписки.
get:
summary: Получение информации по подписке
tags:
- qr-subscription
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptionStatus'
examples:
'200':
value:
id: '120059'
bank: someBank
createDate: '2020-01-31T09:14:38.107227+03:00'
status: INACTIVE
qr:
id: AD100004BAL7227F9BNP6KNE007J9B3K
payload: 'https://sub.nspk.ru/AS3D33FC7B034DEEA8A365142E1DE737?type=03&bank=10000001&crc=C08B'
url: 'https://test.ecom.raiffeisen.ru/api/sbp/v1/qr/AS3D33FC7B034DEEA8A365142E1DE737/image'
operationId: get-sbp-v1-subscriptions-subscriptionId
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
description: Метод позволяет получить данные по ранее созданной подписки
'/sbp/v1/subscriptions/{subscriptionId}/orders':
parameters:
- schema:
type: string
name: subscriptionId
in: path
required: true
description: Идентификатор подписки.
post:
summary: Запрос на совершение платежа по подписке
operationId: post-sbp-v1-subscriptions-subscriptionId-orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/paymentStatus'
examples:
'200':
value:
additionalInfo: Доп информация
paymentDetails: Назначение платежа
amount: 12399
currency: RUB
order: 282a60f8-dd75-4286-bde0-af321dd081b3
paymentStatus: SUCCESS
qrId: AD100051KNSNR64I98CRUJUASC9M72QT
sbpMerchantId: MA0000000552
description: Метод позволяет создать заказ и инициировать списание со счета клиента в рамках созданной подписки. При успешном списании будет направлено стандартное уведомление об оплате.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createPayment'
examples:
Payload:
value:
account: 40700000000000000000
additionalInfo: Доп информация
amount: 1110
currency: RUB
order: 1-22-333
paymentDetails: Назначение платежа
tags:
- qr-subscription
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
'/sbp/v1/subscriptions/{subscriptionId}/orders/{order}':
parameters:
- schema:
type: string
name: subscriptionId
in: path
required: true
description: Идентификатор подписки
- schema:
type: string
name: order
in: path
required: true
description: Уникальный идентификатор заказа в системе партнёра.
get:
summary: Проверка статуса платежа по подписке
tags:
- qr-subscription
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/paymentStatus'
examples:
'200':
value:
additionalInfo: Доп информация
paymentDetails: Назначение платежа
amount: 12399
currency: RUB
order: 282a60f8-dd75-4286-bde0-af321dd081b3
paymentStatus: SUCCESS
qrId: AD100051KNSNR64I98CRUJUASC9M72QT
sbpMerchantId: MA0000000552
operationId: get-sbp-v1-subscriptions-subscriptionId-orders-id
description: Метод позволяет получить данные по платежу сделанному по подписки
parameters:
- schema:
type: string
in: header
name: 'Content-type:'
description: application/json
required: true
- schema:
type: string
in: header
name: 'Authorization:'
description: '[secretKey](#section/Opisanie-API/Avtorizaciya)'
required: true
components:
schemas:
paymentInfo:
description: ''
type: object
x-examples:
example-1:
additionalInfo: Доп информация
paymentPurpose: Назначение платежа
amount: 12399.1
code: SUCCESS
createDate: '2020-01-31T09:14:38.107227+03:00'
currency: RUB
merchantId: 123
order: 282a60f8-dd75-4286-bde0-af321dd081b3
paymentStatus: SUCCESS
qrId: AD100051KNSNR64I98CRUJUASC9M72QT
sbpMerchantId: MA0000000552
transactionDate: '2019-07-11T17:45:13.109227+03:00'
transactionId: 23
qrExpirationDate: '2020-01-15T13:00:40+03:00'
title: paymentRespone
properties:
additionalInfo:
type: string
minLength: 1
description: 'Дополнительная информация, заполняемая по желанию партнёра при генерации QR-кода. Может быть доступна для пользователя в зависимости от банка.'
paymentPurpose:
type: string
minLength: 1
description: Назначение платежа.
amount:
type: number
description: Сумма платежа
code:
type: string
minLength: 1
description: Код сообщения
createDate:
type: string
minLength: 1
description: Время формирования заявки
currency:
type: string
minLength: 1
enum:
- RUB
description: Валюта платежа
merchantId:
type: number
description: 'Уникальный идентификатор партнёра, выданный банком'
order:
type: string
minLength: 1
description: Уникальный идентификатор заказа в системе партнёра.
paymentStatus:
type: string
minLength: 1
enum:
- SUCCESS
- DECLINED
- NO_INFO
- IN_PROGRESS
description: Статус платежа
qrId:
type: string
minLength: 1
description: 'Уникальный идентификатор QRC, выданный СБП при запросе генерации QR'
sbpMerchantId:
type: string
minLength: 1
description: 'Уникальный идентификатор партнёра, выданный СБП'
transactionDate:
type: string
minLength: 1
description: Дата и время проведения платежа
transactionId:
type: integer
description: Идентификатор операции платежа в Райффайзенбанке
qrExpirationDate:
type: string
minLength: 1