На стороне партнера должен быть реализован метод POST с URL на который будет отправляться вебхук. Важно, чтобы второй уровень домена совпадал со вторым уровнем домена, который указывали в качестве redirect_uri при интеграции с Alfa ID. Подробнее здесь.
Авторизация
Реализованный метод может быть как открытым, так и закрыт авторизацией. В случае, если метод закрыт авторизацией необходимо отправить письмо на почту alfa_api@alfabank.ru с данными, как авторизоваться в методе. Для авторизации запросов может использоваться Client Credentials Flow (RFC 6749) или Basic Authentication (RFC 7617).
Retry-запросы
Если метод партнера отвечает с ошибкой, то со стороны Банка отправляются retry-запросы на доставку вебхука. Время повторной отправки retry-запросов: 30 секунд, 5 минут, 30 минут, 1 час, 3 часа, 6 часов, 12 часов, 24 часа, 48 часов, 72 часа.
Возможные причини отправки retry-запроса:
- •Был получен ответ с одним из следующих статусов: 401, 408, 409, 429, 500, 502, 503, 504, 507, 508, 509;
- •Ответ на запрос не был получен в пределах сконфигурированного времени ожидания (5 секунд);
- •Не удалось установить TCP-соединение;
- •Хост не доступен или не отвечает.
Выписки
В сервисе "Выписки по счетам юр. лиц" в методах есть уникальный идентфикатор транзакции( transactionId ). Важно, чтобы на своей стороне партнер игнорировал задублированные сообщения по этому идентификатору.
Параметры запроса
Действие над объектом. Возможные значения: create - Создание объекта; update - Обновление объекта; delete - Удаление объекта
Время, когда произошло событие
Объект/сущность, на который партнер API хочет подписаться. Возможные значения: ul_transaction_default - Получение выписки
Данные по вебхукам. Для object: ul_transaction_default доступные значения полей указаны в методе Получение выписки, возвращается новый массив транзакций
Идентификатор организации
Идентификатор субъекта
curl -X POST https://webhook.partner.ru/api/v1/webhook-events \
[
{
"actionType": "update",
"eventTime": "2022-01-12T00:00:00",
"object": "ul_transaction_default",
"organizationId": "vvvvvv",
"sub": "f7490296-1ae1-11ec-9621-0242ac130002",
"data": {
"amount": {
"amount": 1.00,
"currencyName": "RUR"
},
"amountRub": {
"amount": 1.00,
"currencyName": "RUR"
},
"correspondingAccount": "30101810200000000593",
"direction": "CREDIT",
"documentDate": "2022-01-12",
"filial": "АО \"АЛЬФА-БАНК\" г Москва",
"number": "178",
"operationCode": "01",
"operationDate": "2022-01-12T00:00:00",
"paymentPurpose": "Перевод собственных средств. НДС не облагается.",
"priority": "5",
"revaln": null,
"uuid": "9084d309-b30b-5083-9a54-d4522472e11a",
"transactionId": "1220112MOCO#DS4001415",
"rurTransfer": {
"cartInfo": {
"documentCode": null,
"documentContent": null,
"documentDate": null,
"documentNumber": null,
"paymentNumber": null,
"restAmount": null
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "1",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "12301000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.01.2022",
"docNumber108": "123",
"docDate109": "12.01.2022",
"paymentKind110": "1"
},
"payeeAccount": "40702810301300000763",
"payeeBankBic": "044525593",
"payeeBankCorrAccount": "30101810200000000593",
"payeeBankName": "АО \"АЛЬФА-БАНК\" г Москва",
"payeeInn": "0140237176",
"payeeKpp": "770801001",
"payeeName": "Полное наименование Орг № 11329",
"payerAccount": "40702810701300000761",
"payerBankBic": "044525593",
"payerBankCorrAccount": "30101810200000000593",
"payerBankName": "АО \"АЛЬФА-БАНК\" г Москва",
"payerInn": "0140237176",
"payerKpp": "770801001",
"payerName": "Полное наименование Орг № 11329",
"payingCondition": null,
"purposeCode": "2",
"receiptDate": "2022-01-12",
"valueDate": "2022-01-12"
}
}
},
{
"actionType": "create",
"eventTime": "2022-01-12T12:00:00",
"object": "ul_transaction_default",
"organizationId": "vvvvvv",
"sub": "f7490296-1ae1-11ec-9621-0242ac130002",
"data": {
"amount": {
"amount": 5.00,
"currencyName": "RUR"
},
"amountRub": {
"amount": 5.00,
"currencyName": "RUR"
},
"correspondingAccount": "30101810200000000593",
"direction": "CREDIT",
"documentDate": "2022-01-12",
"filial": "АО \"АЛЬФА-БАНК\" г Москва",
"number": "178",
"operationCode": "01",
"operationDate": "2022-01-12T00:00:00",
"paymentPurpose": "Перевод собственных средств. НДС не облагается.",
"priority": "5",
"revaln": null,
"uuid": "9084d309-b30b-5083-9a54-d4522472e11a",
"transactionId": "1220112MOCO#DS4001415",
"rurTransfer": {
"cartInfo": {
"documentCode": null,
"documentContent": null,
"documentDate": null,
"documentNumber": null,
"paymentNumber": null,
"restAmount": null
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "1",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "12301000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.01.2022",
"docNumber108": "123",
"docDate109": "12.01.2022",
"paymentKind110": "1"
},
"payeeAccount": "40702810301300000763",
"payeeBankBic": "044525593",
"payeeBankCorrAccount": "30101810200000000593",
"payeeBankName": "АО \"АЛЬФА-БАНК\" г Москва",
"payeeInn": "0140237176",
"payeeKpp": "770801001",
"payeeName": "Полное наименование Орг № 11329",
"payerAccount": "40702810701300000761",
"payerBankBic": "044525593",
"payerBankCorrAccount": "30101810200000000593",
"payerBankName": "АО \"АЛЬФА-БАНК\" г Москва",
"payerInn": "0140237176",
"payerKpp": "770801001",
"payerName": "Полное наименование Орг № 11329",
"payingCondition": null,
"purposeCode": "2",
"receiptDate": "2022-01-12",
"valueDate": "2022-01-12"
}
}
}
]
Параметры ответа
В случае успешной обработки ответа на стороне клиента необходимо вернуть любой код успешной обработки (2xx).