Получение документа по списанию средств

Обновлено 29 февраля 2024

Ресурс /v1/client-accruals/{externalId} позволяет Партнеру получить документ по списанию банком денежных средств с клиента за пользование сервисом.

Шаги

1. При авторизации пользователя партнера передать в scope сервис CLIENT_ACCRUAL.

2. Отправить GET-запрос (/v1/client-accruals/{externalId}), в котором передать авторизационный токен к данным клиента (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.

Модель запроса

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации-клиента, полученный через SSO Пример: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1
Параметры запроса
externalId (String)	Идентификатор документа, присвоенный клиентом

Пример запроса

curl -X GET --header 'Accept: application/json' --header
'Authorization:  Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1'
'https://iftfintech.testsbi.sberbank.ru:9443/fintech/api/v1/client-accruals/22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6'

Модель ответа

Соответствует модели запроса v1/client-accruals.

Возможные статусы

Код состояние документа	Наименование статуса	Назначение кода состояния
	Промежуточные статусы/Продолжать опрашивать
CREATED	Создан факт потребления
DELIVERED	Доставлено в ЕКС
EXPORTED	Сформирован файл с начислениями
NOT_PROCESSED	Не обработано
NOTPAID	Не оплачено
PARTPAID	Частично оплачено
PROCESSING	В обработке
SENDED	Отправлено в ЕКС
WAITING	Ожидается проводка
	Окончательные статусы/Прекратить опрос
ANNULLED	Аннулировано
CHECKERROR	Ошибка контроля	ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками.
CANCELED	Отменено на стороне СББОЛ
CHECKERRORABS	Ошибка валидации ЭЦП ЕКС
DECLINED	Отказано
REFUSED_BY_LIMIT	Отказано по лимиту суммы
REQUISITEERROR	Ошибка реквизитов
	Окончательные(Успешные) статусы/Прекратить опрос
PAID	Оплачено