ym88659208ym87991671
Открытие бизнес-карты | Документация для разработчиков

Открытие бизнес-карты

Обновлено 14 ноября 2023

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

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

  • Новый тестовый контур https://iftfintech.testsbi.sberbank.ru:9443

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

Для использования методов бизнес-карт необходимо произвести соответствующие настройки сервиса на стороне Банка.

Создание заявления на открытие карты

Ресурс /v1/corporate-card-request позволяет Партнеру создать заявление на открытие бизнес-карты.

Шаги

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

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

Авторизация

Чтобы создать заявление на открытие бизнес-карты, необходимо отправить POST запрос (/v1/corporate-card-request), в котором передать авторизационный токен к данным организации клиента (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.

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

После отправки запроса на создание заявления на открытие бизнес-карты, необходимо перенаправить клиента по ссылке corporate-cards/requests/common-corp-card/{extrenalId}?{backUrl}, передав в нее параметр externalId (id заявления) и backUrl (ссылка для редиректа).

Пример ссылки, на которую необходимо направить клиента после создания заявления: /dcb/index.html#/corparate-cards/open-request/795aa6d9-42e8-4c9e-a8ec-205f18d61972?backUrl=http://www.sberbank.ru.

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

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
typeName (String (50))Название типа карты (Business - Дебетовая карта, Business Travel - Карта Travel, Business Platinum - Премиальная карта).
Актуальный список можно получить с помощью справочника CorpCardType
paymentSystemName (String (50))Название платежной системы
servicePeriod (String (10))Тариф за обслуживание бизнес-карты
Может принимать только два значения: 'YEAR', 'MONTH'
accountNumber (String (34))Номер бизнес-счета
embossedText (String (19))Эмбоссированное название компании
externalId (String (38))Внешний идентификатор заявления присвоенный партнером
plastic (Boolean)Признак необходимости выпуска пластиковой бизнес-карты.
Выпуск карты происходит при plastic=1, обслуживание согласно тарифам банка.
cardholder (Массив JSON(array))
lastName (String (50))Фамилия
firstName (String (50))Имя
middleName (String (50), optional)Отчество
sex (String (1))Пол
(false-женский, true-мужской)
birthDate (Date)Дата рождения
birthPlace (String (500))Место рождения
citizenship (String (25))Гражданство
Значение из справочника COUNTRY
cellphone (String (11))Мобильный телефон
Передавать значение номера без +
email (String (255), optional)Адрес электронной почты
embossedName (String (26))Эмбоссированное имя
embossedLastName (String (26))Эмбоссированная фамилия
identityDoc (Массив JSON(array))
typeCode (String (50))Код типа документа удостоверяющего личность
Передавать значение '21'
В данный момент можно передавать только значение гражданства России
type (String (150))Название типа документа удостоверяющего личность
Передавать значение 'Паспорт гражданина Российской Федерации'
serial (String (15), optional)Серия
number (String (15), optional)Номер
issueDate (Date, optional)Дата выдачи документа
Формат: "yyy-MM-dd"
issuerCode (String (15), optional)Код подразделения
issuer (String (150), optional)Кем выдан
аddress (Массив JSON(array))
postalCode (String (6))Индекс
country (String (250))Страна
city (String (100))Город
state (String (70))Регион
district (String (100))Район
settelmentName (String (100))Населенный пункт
street (String (100))Улица
house (String (20))Дом
building (String (20))Корпус
flat (String (20))Квартира
countryCode (String (3))Страна, ISO-код
cardLimits (Массив JSON(array))
monthLimitAllOperations (Number (38, 2))Месячный лимит на все операции
dayNonCashLimit (Number (38, 2), optional)Безналичные операции в сутки
dayCashLimit (Number (38, 2), optional)Снятие наличных в сутки
dayTransactionsLimit (Number (38, 2), optional)Переводы на карту в сутки
monthCashLimit (Number (38, 2), optional)Снятие наличных в месяц
monthTrasactionsLimit (Number (38, 2), optional)Переводы на карту в месяц
branchInfo (Массив JSON(array), optional)Информация о месте выдачи карты.
Блок заполняется только при plastic=1
address (String (240))Адрес места выдачи карты
regionCode (String (5))Код сбербанка
agencyCode (String (10))Код отделения
branchCode (String (10))Код филиала
name (String (240))Наименование места выдачи карты

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

{
"accountNumber": "40802810600000200000",
"branchInfo": {
"address": "Боровский район, ст-ца Боковская, ул.Советская, 20",
"agencyCode": "5221",
"branchCode": "0480",
"name": "Доп.офис №5221/0480",
"regionCode": "52"
},
"cardLimits": {
"dayCashLimit": 1.01,
"dayNonCashLimit": 1.01,
"dayTransactionsLimit": 1.01,
"monthCashLimit": 1.01,
"monthLimitAllOperations": 1.01,
"monthTransactionsLimit": 1.01
},
"cardholder": {
"address": {
"building": "1",
"city": "Королев",
"country": "РОССИЯ",
"countryCode": "RUS",
"district": "Липецкий",
"flat": "4",
"house": "233",
"postalCode": "334532",
"settlementName": "Подгорное",
"state": "МО",
"street": "Трубная"
},
"birthDate": "2018-12-31",
"birthPlace": "РОССИЯ, г.Москва",
"cellphone": "89269999999",
"citizenship": "РОССИЯ",
"email": "address@email.ru",
"embossedLastName": "PETROV",
"embossedName": "DMITRIY",
"firstName": "Дмитрий",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
},
"lastName": "Петров",
"middleName": "Сергеевич",
"sex": "1"
},
"embossedText": "SBERBANK",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"paymentSystemName": "Visa",
"plastic": true,
"servicePeriod": "MONTH",
"typeName": "Business card"
}

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

НаименованиеОписание
bankComment (String, optional)Банковский комментарий к статусу документа
bankStatus (String, optional)Статус документа

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

{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING"
}

Получение статуса заявления

Ресурс /v1/corporate-card-request/{externalId}/state позволяет получить статус рассмотрения заявления на открытие бизнес-карты.

Шаги

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

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

Авторизация

Чтобы получить статус рассмотрения заявления на открытие бизнес-карты, необходимо отправить GET запрос (/v1/corporate-card-request/{externalId}/state), в котором нужно передать авторизационный токен к данным организации клиента (Access Token) и идентификатор заявления ( externalId ). Авторизационный токен передается в параметре Authorization заголовка запроса.

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

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

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
externalId (String)Идентификатор документа в организации-партнере
Пример: 550e8400-e29b-41d4-a716-446655440000

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'
'https://edupirfintech.sberbank.ru:9443 /fintech/api/v1/corporate-card-request/{externalId}/state?externalId=550e8400-e29b-41d4-a716-446655440000'

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

НаименованиеОписание
CorpCardIssueRequestState
bankStatus (String (255))Статус заявления на открытие бизнес карты
bankComment (String (4000))Комментарий к статусу
corpCardId (String (36), optional)Идентификатор бизнес-карты

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

{
"bankStatus": "PROCESSING"
"bankComment": "Документ в обработке"
"corpCardId": "c76fb018-27c9-43f7-a751-62646eda7e1a-1"
}

В случае успешного статуса заявления 'CREATED', в ответе вернется идентификатор созданной бизнес-карты - corpCardId. Для использования методов по бизнес-картам необходимо использовать данный параметр.

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

Код состояние документаНаименование статусаНазначение кода состояния
Промежуточный/Продолжать опрашивать
CREATEDСозданДокумент записан в БД, проверки не выполнялись
CHECKERRORОшибка контроляЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками
DELIVEREDДоставленЗапрос доставлен в ДБО и взят в обработку
PARTSIGNEDЧастично подписанЭД подписан частью подписей, входящих в предусмотренный для данного документа комплект подписей
PROCESSING_BUSINESS_ACC_REGISTRATIONВ обработкеОбработка заявления на регистрацию бизнес-счета
PROCESSING_CORP_CARD_LIMITS_CHANGEВ обработкеОбработка заявления на установку лимитов по карте
PROCESSING_CORP_CARD_ISSUВ обработкеОбработка заявления на выпуск бизнес-карты и держателя
PROCESSING_LOYALTY_PROGRAM_REQUESTВ обработкеОбработка заявления на подключение к программе лояльности
SIGNEDПодписанЭД подписан предусмотренным для него комплектом подписей
Окончательный/Прекратить опрос
DELETEDУдаленЭлектронный документа удален из числа действующих документов
INVALIDEDSЭП/АСП не вернаПроверка ЭП под ЭД на стороне Банка дала отрицательный результат
PROCESSERRORОтказано БанкомЭлектронный документ отказан банком
REQUISITEERRORОшибка реквизитовВ ЭД указаны ошибочные реквизиты
Окончательный(Успешный)/Прекратить опрос
IMPLEMENTEDИсполненЭлектронный документ исполнен Банком

Дополнительная информация

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

КодОписаниеПричина возникновения
200 (GET-запрос)OK
Успешный код возврата
201 (POST-запрос)CREATED
Создан
204NO_CONTENT
Данные о клиенте не найдены
400DESERIALIZATION_FAULT
Неверный формат запросаНеверный формат запроса
VALIDATION_FAULT
Ошибка валидацииОшибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели
401UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token
403ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещенУ пользователя нет прав на использование соответствующего сервиса SberBusinessAPI (Fintech API), доступ к которому не предусмотрен настройками scope
404NOT_FOUND
Бизнес-карта с указанным ID не найденаНевозможно найти бизнес-карту с указанным внешним идентификатором
500UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступенПроводятся технические работы
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.