На стороне партнёра должен быть реализован метод POST с URL, на который будет отправляться вебхук. Важно, чтобы второй уровень домена совпадал со вторым уровнем домена, который указывали в качестве redirect_uri при интеграции с Alfa ID. Подробнее в инструкции по подключению вебхуков.
Авторизация
Реализованный метод может быть как открытым, так и закрыт авторизацией. В случае, если метод закрыт авторизацией, необходимо отправить письмо на почту alfa_api@alfabank.ru с данными, как авторизоваться в методе. Для авторизации запросов может использоваться Client Credentials Flow (RFC 6749) или Basic Authentication (RFC 7617).
Время ответа
Метод партнёра должен возвращать ответ не более чем за 300 миллисекунд. Это оптимальная скорость ответа для обеспечения стабильной работы интеграции и оперативной обработки событий.
Retry-запросы
Если метод партнёра отвечает с ошибкой, превышает сконфигурированное время ожидания или Банку не удаётся отправить запрос, то банк отправляет retry-запросы на доставку вебхука. Время повторной отправки retry-запросов: 30 секунд, 5 минут, 30 минут, 1 час, 3 часа, 6 часов, 12 часов, 24 часа, 48 часов, 72 часа.
Возможные причины отправки retry-запроса:
- •был получен ответ с одним из статусов ошибок 4xx или 5xx;
- •ответ на запрос не был получен в пределах сконфигурированного времени ожидания (5 секунд);
- •не удалось установить TCP-соединение;
- •хост недоступен или не отвечает.
Для предотвращения отправки Банком лишних retry-запросов необходимо возвращать коды, отличные от 2xx, только при возникновении технических сбоев на стороне партнёра, которые требуют повторной отправки вебхука.
Выписки по счетам ЮЛ
В сервисе «Выписки по счетам ЮЛ» в методах есть уникальный идентификатор транзакции ( transactionId ). Важно, чтобы партнёр на своей стороне игнорировал задублированные сообщения по этому идентификатору, возвращая код успешной обработки (2xx), так как такие сообщения не являются ошибкой.
Входящие платежи по СБП для ЮЛ
В методе «Получение входящих платежей» есть уникальный идентификатор операции НСПК ( nspkTransactionId ). Важно, чтобы партнёр на своей стороне игнорировал задублированные сообщения по этому идентификатору, при этом возвращая код успешной обработки (2xx), так как такие сообщения не являются ошибкой.
Параметры запроса
Действие над объектом. Возможные значения:
- •
create- создание объекта; - •
update- обновление объекта; - •
delete- удаление объекта
Время, когда произошло событие
Объект/сущность, на которую партнёр API хочет подписаться. Возможные значения:
- •
ul_transaction_default- получение выписки; - •
jp_sbp_incoming_payments- получение входящих платежей
Данные по вебхукам.
- •Для объекта
ul_transaction_defaultдоступные значения полей указаны в методе «Получение выписки»; - •Для объекта
jp_sbp_incoming_paymentsдоступные значения полей указаны в методе «Получение входящих платежей»
Идентификатор организации
Идентификатор субъекта
1curl -X POST https://webhook.partner.ru/api/v1/webhook-events \
2
3[
4 {
5 "actionType": "create",
6 "eventTime": "2022-01-12T00:00:00",
7 "object": "ul_transaction_default",
8 "organizationId": "vvvvvv",
9 "sub": "f7490296-1ae1-11ec-9621-0242ac130002",
10 "data": {
11 "amount": {
12 "amount": 1.00,
13 "currencyName": "RUR"
14 },
15 "amountRub": {
16 "amount": 1.00,
17 "currencyName": "RUR"
18 },
19 "correspondingAccount": "30101810200000000593",
20 "direction": "CREDIT",
21 "documentDate": "2022-01-12",
22 "filial": "АО \"АЛЬФА-БАНК\" г Москва",
23 "number": "178",
24 "operationCode": "01",
25 "operationDate": "2022-01-12T00:00:00",
26 "paymentPurpose": "Перевод собственных средств. НДС не облагается.",
27 "priority": "5",
28 "revaln": null,
29 "uuid": "9084d309-b30b-5083-9a54-d4522472e11a",
30 "transactionId": "1220112MOCO#DS4001415",
31 "rurTransfer": {
32 "cartInfo": {
33 "documentCode": null,
34 "documentContent": null,
35 "documentDate": null,
36 "documentNumber": null,
37 "paymentNumber": null,
38 "restAmount": null
39 },
40 "deliveryKind": "электронно",
41 "departmentalInfo": {
42 "uip": "1",
43 "drawerStatus101": "01",
44 "kbk": "18210102010011000110",
45 "oktmo": "12301000",
46 "reasonCode106": "ТП",
47 "taxPeriod107": "ГД.01.2022",
48 "docNumber108": "123",
49 "docDate109": "12.01.2022",
50 "paymentKind110": "1"
51 },
52 "payeeAccount": "40702810301300000763",
53 "payeeBankBic": "044525593",
54 "payeeBankCorrAccount": "30101810200000000593",
55 "payeeBankName": "АО \"АЛЬФА-БАНК\" г Москва",
56 "payeeInn": "0140237176",
57 "payeeKpp": "770801001",
58 "payeeName": "Полное наименование Орг № 11329",
59 "payerAccount": "40702810701300000761",
60 "payerBankBic": "044525593",
61 "payerBankCorrAccount": "30101810200000000593",
62 "payerBankName": "АО \"АЛЬФА-БАНК\" г Москва",
63 "payerInn": "0140237176",
64 "payerKpp": "770801001",
65 "payerName": "Полное наименование Орг № 11329",
66 "payingCondition": null,
67 "purposeCode": "2",
68 "receiptDate": "2022-01-12",
69 "valueDate": "2022-01-12"
70 }
71 }
72 },
73 {
74 "actionType": "update",
75 "eventTime": "2022-01-12T12:00:00",
76 "object": "ul_transaction_default",
77 "organizationId": "vvvvvv",
78 "sub": "f7490296-1ae1-11ec-9621-0242ac130002",
79 "data": {
80 "amount": {
81 "amount": 5.00,
82 "currencyName": "RUR"
83 },
84 "amountRub": {
85 "amount": 5.00,
86 "currencyName": "RUR"
87 },
88 "correspondingAccount": "30101810200000000593",
89 "direction": "CREDIT",
90 "documentDate": "2022-01-12",
91 "filial": "АО \"АЛЬФА-БАНК\" г Москва",
92 "number": "178",
93 "operationCode": "01",
94 "operationDate": "2022-01-12T00:00:00",
95 "paymentPurpose": "Перевод собственных средств. НДС не облагается.",
96 "priority": "5",
97 "revaln": null,
98 "uuid": "9084d309-b30b-5083-9a54-d4522472e11a",
99 "transactionId": "1220112MOCO#DS4001415",
100 "rurTransfer": {
101 "cartInfo": {
102 "documentCode": null,
103 "documentContent": null,
104 "documentDate": null,
105 "documentNumber": null,
106 "paymentNumber": null,
107 "restAmount": null
108 },
109 "deliveryKind": "электронно",
110 "departmentalInfo": {
111 "uip": "1",
112 "drawerStatus101": "01",
113 "kbk": "18210102010011000110",
114 "oktmo": "12301000",
115 "reasonCode106": "ТП",
116 "taxPeriod107": "ГД.01.2022",
117 "docNumber108": "123",
118 "docDate109": "12.01.2022",
119 "paymentKind110": "1"
120 },
121 "payeeAccount": "40702810301300000763",
122 "payeeBankBic": "044525593",
123 "payeeBankCorrAccount": "30101810200000000593",
124 "payeeBankName": "АО \"АЛЬФА-БАНК\" г Москва",
125 "payeeInn": "0140237176",
126 "payeeKpp": "770801001",
127 "payeeName": "Полное наименование Орг № 11329",
128 "payerAccount": "40702810701300000761",
129 "payerBankBic": "044525593",
130 "payerBankCorrAccount": "30101810200000000593",
131 "payerBankName": "АО \"АЛЬФА-БАНК\" г Москва",
132 "payerInn": "0140237176",
133 "payerKpp": "770801001",
134 "payerName": "Полное наименование Орг № 11329",
135 "payingCondition": null,
136 "purposeCode": "2",
137 "receiptDate": "2022-01-12",
138 "valueDate": "2022-01-12"
139 }
140 }
141 }
142]Параметры ответа
В случае успешной обработки ответа на стороне клиента необходимо вернуть любой код успешной обработки (2xx).