Получение сведений о подписчиках

Обновлено 6 марта 2024

Получение сведений о подписчиках (/v1/partner-info/advance-acceptances)

https://fintech.sberbank.ru:9443/fintech/api/v1/partner-info/advance-acceptances

Ресурс /v1/partner-info/advance-acceptances позволяет получить сведения о клиентах, которые подключились или отписались. В ответе возвращается массив данных с перечнем подписчиков и отписавшихся на запрашиваемый день. Для поддержания актуальной информации необходимо осуществлять ежедневный запрос информации. В массиве данных по клиентам также содержится информация с реквизитным составом, которую дальше можно использовать в запросах на безакцепное списание.

Для получения сведений необходимо отправить GET-запрос /v1/partner-info/advance-acceptances с токеном доступа (access_token) пользователя собственной организации в параметре Authorization заголовка, а также датой, на которую запрашиваете информацию, и идентификатор сервиса (clientId) в querry-параметрах запроса.

В параметре scope ссылки авторизации пользователя вашей компании должен быть указан сервис GET_ADVANCE_ACCEPTANCES для получения доступа к этому ресурсу.

Для обращения к ресурсу необходимо отправлять запрос на:

Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443/fintech/api
Промышленный контур https://fintech.sberbank.ru:9443/fintech/api

Request

/v1/partner-info/advance-acceptances

Модель
Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^([a-zA-Z0-9]){38}$	required	Access token пользователя, полученный через SSO.
QUERRY PARAMETERS
date	data-time	ISO 8601 YYYY-MM-DD	^(\d{4})-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$	required	Дата (подключения или отключения),
clientId	string	string	\d{1,10}	required	Идентификатор платформы

GET /fintech/api/v1/payments/v1/partner-info/advance-acceptances?date=2023-11-20&clientid=142545731
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678

Responses

200 (OK)

Модель
Пример

Наименование	Тип	Обязательность	Описание
AdvanceAcceptance [
{
AdvanceAcceptance 1 {
active	boolean	optional	Признак активности ЗДА. Значение "true" возвращается по клиентам, подписавшим ЗДА. Если Клиент не подписал ЗДА или отменил его у себя в СберБизнес, то будет возвращаться значение "false",
bundles	Array[AdvanceAcceptanceBundle]	optional	Информация о пакете услуг,
payerAccount	string	optional	Счет плательщика,
payerBankBic	string	optional	БИК банка плательщика,
payerBankCorrAccount	string	optional	Корсчет банка плательщика,
payerInn	string	optional	ИНН плательщика,
payerName	string	optional	Наименование плательщика,
payerOrgIdHash	string	optional	Идентификатор организации плательщика,
purpose	string	optional	Назначение платежа,
sinceDate	string	optional	Дата начала действия ЗДА,
untilDate	string	optional	Дата окончания действия ЗДА
}
AdvanceAcceptanceBundle {
code	string	optional	Код пакета услуг,
name	string	optional	Наименование пакета услуг,
sinceDate	string	optional	Дата подключения пакета услуг,
untilDate	string	optional	Дата отключения пакета услуг,
currentState	string	optional	Статус пакета услуг в настоящее время. Возможные варианты: `ACTIVE`, `NOT_PAID`, `DEACTIVATED`
}
]

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
 
[⁣
 ⁣ ⁣{
 ⁣ ⁣ ⁣ ⁣"payerInn": "5414009744",
 ⁣ ⁣ ⁣ ⁣"payerAccount": "40702810938000000849",
 ⁣ ⁣ ⁣ ⁣"payerBankBic": "044525225",
 ⁣ ⁣ ⁣ ⁣"payerBankCorrAccount": "30101810400000000225",
 ⁣ ⁣ ⁣ ⁣"purpose": "202020 По договору №202020 от 29.03.2022",
 ⁣ ⁣ ⁣ ⁣"payerOrgIdHash": "286f8685274592b5a1e5f7e3d2f2aa583f65ad1f41165425fb4c0fafa790a9e7",
 ⁣ ⁣ ⁣ ⁣"payerName": "ООО_Автотест_Клиент_ЕКС_20200619123849",
 ⁣ ⁣ ⁣ ⁣"sinceDate": "2022-03-29",
 ⁣ ⁣ ⁣ ⁣"untilDate": "2022-06-07",
 ⁣ ⁣ ⁣ ⁣"active": true,
 ⁣ ⁣ ⁣ ⁣"bundles": null
 ⁣ ⁣},
 ⁣ ⁣{
 ⁣ ⁣ ⁣ ⁣"payerInn": "5331355363",
 ⁣ ⁣ ⁣ ⁣"payerAccount": "40702810338000000614",
 ⁣ ⁣ ⁣ ⁣"payerBankBic": "044525225",
 ⁣ ⁣ ⁣ ⁣"payerBankCorrAccount": "30101810400000000225",
 ⁣ ⁣ ⁣ ⁣"purpose": "202020 По договору №202020 от 29.03.2022",
 ⁣ ⁣ ⁣ ⁣"payerOrgIdHash": "e646c19e82e80f6b0895e711a1e8da511d34d1ac4eb0f9103867dfc8413007d0",
 ⁣ ⁣ ⁣ ⁣"payerName": "ООО_Автотест_Клиент_ЕКС_20200608203238",
 ⁣ ⁣ ⁣ ⁣"sinceDate": "2022-03-29",
 ⁣ ⁣ ⁣ ⁣"untilDate": null,
 ⁣ ⁣ ⁣ ⁣"active": true,
 ⁣ ⁣ ⁣ ⁣"bundles": null
 ⁣ ⁣},
 ⁣ ⁣{
 ⁣ ⁣ ⁣ ⁣"payerInn": "8755334940",
 ⁣ ⁣ ⁣ ⁣"payerAccount": "40702810338000000656",
 ⁣ ⁣ ⁣ ⁣"payerBankBic": "044525225",
 ⁣ ⁣ ⁣ ⁣"payerBankCorrAccount": "30101810400000000225",
 ⁣ ⁣ ⁣ ⁣"purpose": "202020 По договору №202020 от 29.03.2022",
 ⁣ ⁣ ⁣ ⁣"payerOrgIdHash": "a9137f1c0e7ece7576679e99f9ff67574f34fd6ad3fb5d7c629137dacc4b9ffb",
 ⁣ ⁣ ⁣ ⁣"payerName": "ООО_Автотест_Клиент_ЕКС_20200609164415",
 ⁣ ⁣ ⁣ ⁣"sinceDate": "2022-03-29",
 ⁣ ⁣ ⁣ ⁣"untilDate": null,
 ⁣ ⁣ ⁣ ⁣"active": true,
 ⁣ ⁣ ⁣ ⁣"bundles": null
 ⁣ ⁣}
]

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	Array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	Array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
{
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	Array[string]	optional	Названия полей (при наличии связи с моделью)
}
]

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "VALIDATION_FAULT",
    "referenceId": "934088e0-f079-4fa6-acb4-6fbb69671979",
    "message": "Ошибка при разборе параметров запроса",
    "checks": [
        {
            "level": "ERROR",
            "message": "Unparseable date: \"2023/11/22\"",
            "fields": [
                "date"
            ]
        }
    ],
    "fieldNames": [
        "date"
    ]
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959-bbd5-490a-9f9f-67fb7380fae5-2"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция `GET_ADVANCE_ACCEPTANCES`. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
		Вы использовали access_token пользователя Клиента, а не пользователя вашей организации. Нужно использовать access_token пользователя вашей организации.
		Проверьте используемый access_token в header и clientId в querry-параметре запроса. Оба параметра должны принадлежать одной вашей организации.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACCESS_EXCEPTION",
    "referenceId": "74cbc645-297c-451d-af9c-97c68c2c3560",
    "message": "Получение информации о подключенных клиентах возможно только по собственной организации"
}

404 (Not found)

Cause	Message	Description
DATA_NOT_FOUND_EXCEPTION	Не найдено ни одного заранее данного акцепта за указанную дату	На указанную в запросе дату никто не подписался и не отписался

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "DATA_NOT_FOUND_EXCEPTION",
    "referenceId": "075e05bf-f8cc-44d7-873e-ff46ed9171c3",
    "message": "Не найдено ни одного заранее данного акцепта за указанную дату"
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}

Получение сведений о подписчиках