Сервис получения статуса ранее направленного документа по СПФС

Обновлено 11 февраля 2025

C помощью данного API Клиент может настроить в ERP получение статуса ранее направленных документов по СПФС.

Описание бизнес-процесса:

1. Клиент в ERP системе осуществляет настройку вызова API для получения статуса ранее направленных документов в соответствии со спецификацией канала;

2. ERP Клиента вызывает API для аутентификации и авторизации;

3. Банк проводит аутентификацию и авторизацию. Генерирует access token и возвращает Клиенту;

4. ERP Клиента вызывает API;

5. Банк осуществляет валидацию запрос, проверку access token и поиск исходного документа;

6. В случае успешной валидации сообщения Банк принимает запрос в обработку;

7. В ответ на запрос возвращается статус ранее направленного документа по OrgnlRqUID.

Описание атрибутов запроса:

Параметры	Описание
Authorization (header)	Получение токена авторизации осуществляется в методе Сервиc получения токена авторизации.
RqUID (header)	Уникальный идентификатор сообщения, сгенерированный клиентом в формате [0-9A-Fa-f]32. Для того, чтобы гарантировать уникальность, требуется использовать стандартные библиотеки и классы генерации UUID, убрав из результата символ разделителя «-». Если заголовок отсутствует в запросе, идентификатор будет сгенерирован автоматически и передан клиенту в аналогичном заголовке ответа.
OrgnlRqUID	Уникальный идентификатор исходного сообщения, по которому запрашивается статус

Статусы http-запросов

Данные статусы распространяются на все типы запросов и свидетельствуют об успешности выполнения метода.

Код	Статус	Описание
200	OK	Сообщение передано в обслуживающий банк
202	Accepted	Сообщение принято, повторите запрос позже
400	Bad request	Bad request
401	Unauthorized	Unauthorized
404	Not Found	Не найден запрашиваемый OrgnlRqUID
405	Method Not Allowed	Method Not Allowed
409	Conflict	Найдена дублирующая запись
423	Locked	Сообщение не может быть передано в обслуживающий банк (отказ от ЦОС БР. Необходимо проверить корректность оформления сообщения или получателя)
500	Internal Server Error	Internal Server Error
503	Service Unavailable	Try again later
504	Gateway Timeout	Gateway Timeout

Описание примеров сообщений

Вызов сервиса получения статуса ранее направленных документов по СПФС:

Тип запроса GET

GET https://mc.api.sberbank.ru:443/prod/sberconnect/sbspfs/v1/spfs/response/364f1e3db4caf533decc5a725b30b919
 
Connection: keep-alive
RqUID: 7a89962e864325921cff888c3013d61c
Authorization: Bearer 027fb1a7-761b-47f1-a7eb-ffb6737a5cd0
Host: mc.api.sberbank.ru:443
User-Agent: Apache-HttpClient/4.5.10 (Java/1.8.0_321)

Ответ сервиса:

HTTP/1.1 202 Accepted
Server: nginx/1.20.1
Date: Thu, 13 Oct 2022 13:20:27 GMT
Content-Length: 0
Connection: keep-alive
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 1665667228463
Expires: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RqUID: 7a89962e864325921cff888c3013d61c
X-XSS-Protection: 1; mode=block
Pragma: no-cache
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains