Получение списка контрагентов

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

/fintech/api/v1/correspondents/rur

Запрос позволяет получить список контрагентов по рублевым операциям.

Для получения списка контрагентов необходимо отправить GET-запрос /fintech/api/v1/correspondents/rur с токеном доступа (access_token) пользователя в параметре Authorization заголовка и номером страницы (page) в query-параметре.

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

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

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

Request

/fintech/api/v1/correspondents/rur

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

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
QUERY PARAMETERS
page	integer	integer	^[0-9]+$	required	Номер запрашиваемой страницы. Если параметр не указан, то по умолчанию считаем, что page=1

GET /fintech/api/v1/correspondents/rur&page=1 HTTP/1.1
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678

Responses

200 (OK)

На запрос первой страницы в ответе вернется список объектов (если они существуют на выбранной странице) и контейнер links с параметром (href) на следующую страницу и признаком "rel": "next".

На запрос второй страницы в ответе вернется список объектов и контейнер links с параметром (href) на следующую и предыдущую страницы и признаками: "rel": "prev", "rel": "next". Получение последующих страниц производится по аналогии.

Если следующей страницы нет, в полученном ответе перестанет приходить href c признаком "rel": "next".

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

Наименование	Тип	Обязательность	Описание
Correspondents {
_links	array[Link]	optional	Ссылки на связанные ресурсы,
correspondents	array[Correspondent]	optional	Список "Контрагенты по рублевым операциям"
}
Link {
href	string	required	Абсолютный или относительный адрес,
rel	string	required	Отношение ссылки к текущей сущности (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	Признак 'подписан'
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
   "_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
      }
   ]
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в 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": "DESERIALIZATION_FAULT",
    "referenceId": "4a0e6754-ad22-4d7d-ac82-810afd08b5b2",
    "message": "Неверный формат запроса",
    "checks": [
        {
            "level": "ERROR",
            "message": "Cannot deserialize instance of `java.util.ArrayList<Signature>` out of START_OBJECT token",
            "fields": [
                "digestSignatures"
            ]
        }
    ],
    "fieldNames": [
        "digestSignatures"
    ]
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
	Некорректное значение Access Token	Указан некорректный 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_CORRESPONDENTS`. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
	Операция не может быть выполнена: приостановлено оказание услуг
	Операция не может быть выполнена: организация заблокирована по идентификации
	Операция не может быть выполнена: организация заблокирована
	Операция не может быть выполнена: пользователь заблокирован

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

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

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

404 (Not Found)

Cause	Message	Description
DATA_NOT_FOUND_EXCEPTION	Запрошенной страницы не существует	В query-параметре page используете номер страницы, которая не существует. Проверьте в последнем успешном запросе объект _links

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

Наименование	Тип	Обязательность	Описание
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": "1bd1b8b9-1bd3-4159-9909-d30536211114",
    "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": "Внутренняя ошибка сервера"
}