Получение списка контрагентов организации
Обновлено 15 октября 2024
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур
https://iftfintech.testsbi.sberbank.ru:9443 - Промышленный контур
https://fintech.sberbank.ru:9443
Список контрагентов по рублевым операциям
Ресурс /v1/correspondents/rur позволяет Партнеру получить список контрагентов по рублевым операциям.
Шаги
1. Получить AccessToken.
2. Отправить запрос.
Для получения списка необходимо отправить GET-запрос (/v1/correspondents/rur), в котором передать авторизационный токен к данным организации клиента (Access Token) и номер запрашиваемой страницы. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_CORRESPONDENTS.
Модель запроса
| Наименование | Описание |
|---|---|
| Параметры заголовка | |
| Authorization (String) | Access token полученный через SSO Пример: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1 |
| Параметры запроса | |
| page (String) | Номер запрашиваемой страницы (Если параметр не указан, то по умолчанию считаем, что page=1) |
Пример запроса
curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1'
'http://iftfintech.testsbi.sberbank.ru:9443/fintech/api/v1/correspondents/rur?page=1'
Модель ответа
| Наименование | Описание |
|---|---|
| Correspondents { | |
| _links (Array[Link], optional) | Ссылки на связанные ресурсы , |
| correspondents (Array[Correspondent], optional) | Список "Контрагенты по рублевым операциям" |
| }Link { | |
| href (string) | Абсолютный или относительный адрес , |
| rel (string) | Отношение ссылки к текущей сущности (next, prev) |
| }Correspondent { | |
| accountNumber (string, optional) | Номер счета контрагента , |
| bankBic (string, optional) | БИК банка, где открыт счет , |
| bankCorrAcct (string, optional) | Корр. счет банка , |
| bankName (string, optional) | Наименование банка , |
| inn (string, optional) | ИНН контрагента , |
| kpp (string, optional) | КПП контрагента , |
| name (string, optional) | Наименование организации контрагента , |
| remark (string, optional) | Комментарий , |
| signed (boolean, optional) | Признак 'подписан' |
| } |
Пример ответа
{
"_links":[
{
"href":"?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel":"next"
}
],
"correspondents":[
{
"accountNumber":"40802810600000200000",
"bankBic":"044525225",
"bankCorrAcct":"30101810400000000225",
"bankName":"ПАО СБЕРБАНК",
"inn":"7707083893",
"kpp":"222201001",
"name":"Общество с ограниченной ответственностью \"Клиент\"",
"remark":"Комментарий",
"signed":false
}
]
}
Коды возврата
| Код возврата | Описание кода возврата | Причина возникновения |
|---|---|---|
| 200 (GET-запроса) | OK | |
| 201 (POST-запрос) | CREATED | |
| Создан | ||
| 400 | DESERIALIZATION_FAULT | |
| Неверный формат запроса | Неверный формат запроса | |
WORKFLOW_FAULT | ||
| Для внешнего сервиса недоступны операции по счету: 40702810ХХХХХХХХХХХХ | Для внешнего сервиса недоступны операции по счету: счет не добавлен в список разрешенных в оферте; внешний сервис заблокирован в СББОЛ; счет указан неверно. Отсутствует доступный открытый рублевый расчетный счет у организации плательщика | |
| Документ с такими реквизитами уже существует | Документ с такими реквизитами уже существует. Проверка по номер документа в течении года. | |
| Не указан идентификатор сертификата подписи | Не указан идентификатор сертификата подписи(параметр kid заголовка JWS) | |
| Некорректный формат параметра kid заголовка JWS | Некорректный формат параметра kid заголовка JWS(ожидается UUID) | |
VALIDATION_FAULT | ||
| Ошибка валидации | Ошибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели. | |
SIGN_CHECK_EXCEPTION | ||
| Подлинность подписи не установлена/Сертификат не обнаружен или не является активным | Ошибка возникает, если не удалось установить подлинность подписи | |
| 401 | UNAUTHORIZED | |
| accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. | |
| 403 | ACTION_ACCESS_EXCEPTION | |
| Операция не может быть выполнена: доступ к ресурсу запрещен | У пользователя нет прав на использование соответствующего сервиса Sber API, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом. | |
| 415 | JWS_EXCEPTED | |
| В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact Serialization | Ошибка возникает, если в настройках внешних сервисов выставлен флаг «Требуется подпись для внешнего сервиса» | |
| 500 | UNKNOWN_EXCEPTION | |
| Внутренняя ошибка сервера | ||
| 503 | UNAVAILABLE_RESOURCE_EXCEPTION | |
| Сервис временно недоступен | Проводятся технические работы |