ym88659208ym87991671
Получение списка контрагентов организации | Документация для разработчиков
Skip to main content

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

Обновлено 20 апреля 2022

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

  • Тестовый контур https://edupirfintech.sberbank.ru:9443

  • Промышленный контур https://fintech.sberbank.ru:9443

Список контрагентов по валютным операциям

Ресурс /v1/correspondents/cur позволяет Партнеру получить список контрагентов по валютным операциям.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения списка необходимо отправить GET-запрос (/v1/correspondents/cur), в котором передать авторизационный токен к данным организации клиента (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://edupirfintech.sberbank.ru:9443/fintech/api/v1/correspondents/cur?page=1'

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

НаименованиеОписание
Beneficiaries {
_links (Array[Link], optional)Ссылки на связанные ресурсы ,
beneficiaries (Array[Beneficiar], optional)Список"Контрагенты по валютным операциям"
}Link {
href (string)Абсолютный или относительный адрес ,
rel (string)Отношение ссылки к текущей сущности (next, prev)
}Beneficiar {
accountNumber (string, optional)Номер счёта контрагента ,
address (string, optional)Адрес контрагента ,
bankInfo (BankInfo, optional)Информация о банке контрагента ,
country (string, optional)Страна контрагента ,
countryCode (string, optional)Цифровой код страны контрагента ,
countryIsoCode (string, optional)Буквенный код страны контрагента ,
currCode (string, optional)Цифровой код валюты ,
currlsoCode (string, optional)Буквенный код валюты ,
externalId (string)Уникальный идентификатор бенефициара ,
inn (string, optional)ИНН контрагента ,
mediaBankInfo (MediaBankinfo, optional)Информация о банке-посреднике ,
name (string, optional)Наименование организации контрагента ,
operCode (string, optional)Код валютной операции ,
operName (string, optional)Наименование валютной операции ,
payDirection (string, optional)Назначение платежа ,
paymentType (string, optional)Тип перевода ,
place (string, optional)Город контрагента ,
remark (string, optional)Комментарий
}BankInfo {
bankAddress (string, optional)Адрес банка ,
bankCorrAccount (string, optional)Корреспондентский счёт банка ,
bankCountry (string, optional)Страна банка ,
bankCountryCode (string, optional)Цифровой код страны банка ,
bankCountryIsCode (string, optional)Буквенный код страны банка ,
bankName (string, optional)Наименование банка ,
bankPlace (string, optional)Населённый пункт банка ,
branch (string, optional)Филиал банка ,
clirCode (string, optional)Клиринговый код банка ,
clirCountry (string, optional)Страна клирингового кода банка ,
clirCountryCode (string, optional)Код страны клирингового кода банка ,
swiftCode (string, optional)SWIFT-код банка ,
symbolClirCode (string, optional)Символьный клиринговый код банка
}MediaBankinfo {
bankAddress (string, optional)Адрес банка ,
bankCorrAccount (string, optional)Корреспондентский счёт банка ,
bankCountry (string, optional)Страна банка ,
bankCountryCode (string, optional)Цифровой код страны банка ,
bankCountryIsCode (string, optional)Буквенный код страны банка ,
bankName (string, optional)Наименование банка ,
bankPlace (string, optional)Населённый пункт банка ,
branch (string, optional)Филиал банка ,
clirCode (string, optional)Клиринговый код банка ,
clirCountry (string, optional)Страна клирингового кода банка ,
clirCountryCode (string, optional)Код страны клирингового кода банка ,
swiftCode (string, optional)SWIFT-код банка ,
symbolClirCode (string, optional)Символьный клиринговый код банка
}

Пример ответа

{
"_links":[
{
"href":"?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel":"next"
}
],
"beneficiaries":[
{
"accountNumber":"40802840600000200000",
"address":"Moscow,Novoslobodskaya,11",
"bankInfo":{
"bankAddress":"65 B, POZESKA",
"bankCorrAccount":"30101810400000000225",
"bankCountry":"РОССИЯ",
"bankCountryCode":"RUS",
"bankCountryIsCode":"643",
"bankName":"SBERBANK",
"bankPlace":"BELGRAD",
"branch":"REGIONAL BRANCH",
"clirCode":"77876576856",
"clirCountry":"Canadian Payment Association",
"clirCountryCode":"CA",
"swiftCode":"SABRRUMM",
"symbolClirCode":"СС"
},
"country":"РОССИЯ",
"countryCode":"643",
"countryIsoCode":"RUS",
"currCode":"840",
"currlsoCode":"USD",
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"inn":"7707083893",
"mediaBankInfo":{
"bankAddress":"65 B, POZESKA",
"bankCorrAccount":"30101810400000000225",
"bankCountry":"РОССИЯ",
"bankCountryCode":"643",
"bankCountryIsCode":"RUS",
"bankName":"SBERBANK",
"bankPlace":"Moscow",
"branch":"ДО №1654 Московского банка ПАО Сбербанк",
"clirCode":"77876576856",
"clirCountry":"Canadian Payment Association",
"clirCountryCode":"CA",
"swiftCode":"SABRRUMM",
"symbolClirCode":"СС"
},
"name":"Общество с ограниченной ответственностью \"Клиент\"",
"operCode":"01",
"operName":"Покупка резидентом иностранной валюты за валюту Российской Федерации",
"payDirection":"Оплата заказа №123. НДС нет.",
"paymentType":"sbrfOut",
"place":"Moscow",
"remark":"Комментарий"
}
]
}

Список контрагентов по рублевым операциям

Ресурс /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://edupirfintech.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
}
]
}

Передача информации по валютным контрагентам

Ресурс v1/correspondents/cur/{externalId}/additional позволяет Партнеру предоставить в Банк дополнительную информацию по валютным контрагентам.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для предоставлении информации необходимо отправить PUT-запрос (/v1/correspondents/cur/{externalId}/additional), в котором передать авторизационный токен к данным организации клиента (Access Token) и информацию по контрагенту. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CORRESPONDENT_CUR_ADDITIONAL.

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

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token полученный через SSO
Пример: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1
Параметры запроса
externalID (String)Идентификатор бенефициара в организации-партнёре (UUID)
Параметры тела запроса
CorrespondentCurAdditional {
easyIcon (string, optional)EASY / ICON номер ,
externalId (string)Идентификатор валютного контрагента (бенефициара) (UUID) ,
lastBalanceDate (string, optional)Дата составления последнего балансового отчета ,
legalForm (string, optional)Организационно-правовая форма компании ,
ratingCompany (string, optional)Рейтинг компании ,
registerAddress (string, optional)Адрес регистрации ,
registerCountry (string, optional)Страна регистрации ,
registerDate (string, optional)Дата регистрации ,
registerNumber (string, optional)Регистрационный номер ,
sourceName (string, optional)Источник информации (имя партнера) ,
updateRegistryDate (string, optional)Дата и время обновления сведений в реестре
}

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

{
"easyIcon":"999",
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"lastBalanceDate":"2018-12-31",
"legalForm":"GmbH",
"ratingCompany":"Высокий уровень",
"registerAddress":"ZURICH PARADEPLATZ 8",
"registerCountry":"ШВЕЙЦАРИЯ",
"registerDate":"2018-12-31",
"registerNumber":"1",
"sourceName":"PARTNER_NAME",
"updateRegistryDate":"2018-12-31T23:59:59"
}

Коды возврата

Код возвратаОписание кода возвратаПричина возникновения
200 (GET-запроса)OK
201 (POST-запрос)CREATED
Создан
400DESERIALIZATION_FAULT
Неверный формат запросаНеверный формат запроса
WORKFLOW_FAULT
Для внешнего сервиса недоступны операции по счету: 40702810ХХХХХХХХХХХХДля внешнего сервиса недоступны операции по счету: счет не добавлен в список разрешенных в оферте; внешний сервис заблокирован в СББОЛ; счет указан неверно. Отсутствует доступный открытый рублевый расчетный счет у организации плательщика
Документ с такими реквизитами уже существуетДокумент с такими реквизитами уже существует. Проверка по номер документа в течении года.
Не указан идентификатор сертификата подписиНе указан идентификатор сертификата подписи(параметр kid заголовка JWS)
Некорректный формат параметра kid заголовка JWSНекорректный формат параметра kid заголовка JWS(ожидается UUID)
VALIDATION_FAULT
Ошибка валидацииОшибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели.
SIGN_CHECK_EXCEPTION
Подлинность подписи не установлена/Сертификат не обнаружен или не является активнымОшибка возникает, если не удалось установить подлинность подписи
401UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token.
403ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещенУ пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
415JWS_EXCEPTED
В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact SerializationОшибка возникает, если в настройках внешних сервисов выставлен флаг «Требуется подпись для внешнего сервиса»
500UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступенПроводятся технические работы

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней