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

Заказать бизнес-карту

Обновлено 12 апреля 2024

Схема работы функциональности

Шаги

  1. Получить access_token
  2. Создать заявление на выпуск
  3. Подписать заявление на выпуск
  4. Получить статус заявления

Usecase

Участники

  • Руководитель - представитель ЮЛ/ИП, ответственный за финансовые операции компании и который имеет пользовательский профиль в СберБизнес своей компании с правом подписи;
  • Платформа - любое программное обеспечение для внутреннего использования компании или web-ресурс (интернет-магазин, мобильное приложение и т.д.), который Вы используете в рамках клиентского пути Клиентов;
  • СберБизнес ID - единая учетная запись пользователя ЮЛ/ИП, используемая для регистрации и входа пользователей в продукты и сервисы Банка и партнеров Sber API;
  • Банк - в контексте usecase включает в себя ресурсы Sber API и любые службы ПАО "Сбербанк";

Предусловия

  • Руководитель авторизован на Платформе
  • Руководитель находится на Платформе

Постусловия

  • Выпущена бизнес-карта
Usecase

Создание заявления на открытие бизнес-карты (/v1/corporate-card-request)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/corporate-card-request

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

Для создания заявления необходимо отправить POST-запрос /v1/corporate-card-request с токеном доступа (access_token) пользователя в параметре Authorization заголовка и параметрами заявления теле запроса.

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


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

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

Request

/v1/corporate-card-request
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^([a-zA-Z0-9]){38}$requiredAccess token пользователя, полученный через SSO.
BODY
CorpCardIssueRequest {
typeNamestringstring^[a-zA-Z0-9._ -]{1,19}$
Актуальный список значений можно получить с помощью справочника CorpCardType		requiredНазвание типа карты,
paymentSystemNamestringstring^[a-zA-Z0-9._ -]{1,19}$
Актуальный список значений можно получить с помощью справочника CorpCardPaySystem		requiredНазвание платежной системы,
servicePeriodstringstring^(YEAR|MONTH)$requiredТариф за обслуживание бизнес-карты,
accountNumberstringstring^[0-9]{34}$requiredНомер бизнес-счета,
embossedTextstringstring^[a-zA-Z0-9._ -]{1,19}$requiredЭмбоссированное название компании,
externalIdstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$requiredИдентификатор заявления, который присваивается вами,
plasticbooleanstring^(true|false)$optionalПризнак необходимости выпуска пластиковой бизнес-карты.
Выпуск карты происходит при plastic=1, обслуживание согласно тарифам банка,
cardLimitsArray[CorpCardLimits]objectoptionalЛимиты операций по карте,
branchInfoArray[BranchInfo]objectoptional
required при plastic=1		Информация о месте выдачи карты,
cardholderArray[Cardholder]objectoptionalДанные держателя карты
}
CorpCardLimits {
dayCashLimitnumberfloat^[0-9]{38}$optionalСнятие наличных в сутки,
dayNonCashLimitnumberfloat^[0-9]{38}$optionalБезналичные операции в сутки,
dayTransactionsLimitnumberfloat^[0-9]{38}$optionalПереводы на карту в сутки,
monthCashLimitnumberfloat^[0-9]{38}$optionalСнятие наличных в месяц,
monthLimitAllOperationsnumberfloat^[0-9]{38}$optionalМесячный лимит на все операции,
monthTransactionsLimitnumberfloat^[0-9]{38}$optionalПереводы на карту в месяц
}
BranchInfo {
addressstringstring^[a-zA-Z0-9._ -]{1,19}$l
Актуальный список значений можно получить с помощью справочника Subdivision		requiredАдрес места выдачи карты,
agencyCodestringstring^[a-zA-Z0-9._ -]{1,19}$l
Актуальный список значений можно получить с помощью справочника Subdivision		requiredКод отделения,
branchCodestringstring^[a-zA-Z0-9._ -]{1,19}$l
Актуальный список значений можно получить с помощью справочника Subdivision		requiredКод филиала,
namestringstring^[a-zA-Z0-9._ -]{1,19}$l
Актуальный список значений можно получить с помощью справочника Subdivision		requiredНаименование подразделения,
regionCodestringstring^[a-zA-Z0-9._ -]{1,19}$l
Актуальный список значений можно получить с помощью справочника Subdivision		requiredКод территориального банка
}
Cardholder {
birthDatedateISO 8601 YYYY-MM-DD^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$requiredДата рождения,
birthPlacestringstring^[a-zA-Zа-яА-ЯеЁ]{1-500}$requiredМесто рождения,
cellphonestringstring^\d{10,11}$requiredМобильный телефон,
citizenshipstringstring^[a-zA-Zа-яА-ЯеЁ]{1,25}$requiredГражданство,
emailstringstring^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+.[A-Za-z]{2,}$requiredАдрес электронной почты,
firstNamestringstring^[a-zA-Zа-яА-ЯеЁ]{1-50}$requiredИмя,
emailstringstring^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+.[A-Za-z]{2,}$requiredАдрес электронной почты,
middleNamestringstring^[a-zA-Zа-яА-ЯеЁ]{1-50}$requiredОтчество,
emailstringstring^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+.[A-Za-z]{2,}$requiredАдрес электронной почты,
lastNamestringstring^[a-zA-Zа-яА-ЯеЁ]{1-50}$requiredФамилия,
embossedLastNamestringstring^[a-zA-Z0-9._ -]{1,26}$requiredЭмбоссированная фамилия,
embossedNamestringstring^[a-zA-Z0-9._ -]{1,26}$requiredЭмбоссированное имя,
sexstringstring^(0|1)$requiredПол.
Женский = 0, мужской = 1,
addressArray[CardholderAddress]objectoptionalДанные о регистрации держателя,
identityDocArray[CorpCardIdentityDoc]objectoptionalДокумент удостоверяющий личность
}
CardholderAddress {
postalCodestringstring^\d{6}$requiredИндекс,
countrystringstring^[a-zA-Zа-яА-ЯеЁ]{1,250}$
Актуальный список значений можно получить с помощью справочника Country		requiredСтрана,
countryCodestringISO 3166^[a-zA-Z0-9._ -]{0,3}$requiredСтрана, ISO-код,
statestringstring^[a-zA-Zа-яА-ЯеЁ]{1-70}$optionalРегион,
settlementNamestringstring^[a-zA-Zа-яА-ЯеЁ]{1,100}$optionalНаселенный пункт,
citystringstring^[a-zA-Zа-яА-ЯеЁ]{1-100}$requiredГород,
districtstringstring^[a-zA-Zа-яА-ЯеЁ]{1,100}$optionalРайон,
streetstringstring^[a-zA-Zа-яА-ЯеЁ]{1,20}$requiredУлица,
housestringstring^\d+{1,20}$requiredДом,
buildingstringstring^\d+{1,20}$optionalКорпус,
flatstringstring^\d+{1,20}$requiredКвартира
}
CorpCardIdentityDoc {
issueDatedateISO 8601 YYYY-MM-DD^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$requiredДата выдачи,
issuerstringstring^[a-zA-Z0-9._ -]{1,150}$requiredКем выдан,
issuerCodestringstring^[a-zA-Z0-9._ -]{1,15}$requiredКод органа, выдавшего документ,
numberstringstring^[a-zA-Z0-9._ -]{1,15}$requiredНомер,
serialstringstring^[a-zA-Z0-9._ -]{1,15}$requiredСерия,
typestringstring^[a-zA-Z0-9._ -]{1,150}$requiredНаименование документа, удостоверяющего личность,
typeCodestringstring^[a-zA-Z0-9._ -]{1,15}$requiredКод вида документа.
В данный момент можно передавать только значение гражданства России. Передавать значение '21'
}

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
DocStateShort {
bankCommentstringoptionalБанковский комментарий к статусу документа,
bankStatusstringoptionalСтатус документа
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
WORKFLOW_FAULTДля внешнего сервиса недоступны операции по счету: номер счетаДля Платформы недоступны операции по счету:
- счет не добавлен в список разрешенных в оферте;
- счет указан неверно.
Отсутствует доступный открытый рублевый расчетный счет.
Не найден тип карты название типа карты для платежной системой название платежной системыДля указанного типа бизнес-карты нет возможности выпуска с указанной платежной системой. Проверьте на сайте Банка доступные платежные системы для требуемого типа бизнес-карты.
Не найден тип карты название типа картыДля параметра typeName используется значение не из справочника СorpCardType. Получите корректные доступные значения для параметра, используя ресурс /v1/dicts
НаименованиеТипОбязательностьОписание
ResourceFault {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
checksArray[Check]optionalСписок проверок, приведших к ошибке,
fieldNamesArray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
{
levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
messagestringoptionalСообщение,
fieldsArray[string]optionalНазвания полей (при наличии связи с моделью)
}
]
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
FORBIDDEN_ACTION_EXCEPTIONНевозможен выпуск карты с платежной системной название платежной системыВыпуск карт с указанной платежной системой на данный момент невозможен. Проверьте на сайте Банка доступные для выпуска платежные системы и повторите запрос с доступной платежной системой для открытия бизнес-карты.
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В строке аутентификации СберБизнес ID, в параметре scope, не указана операция CORPORATE_CARD_REQUEST. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}

Подписание заявления на открытие бизнес-карты

Банк примет на обработку заявление на открытие бизнес-карты после его подписания. Подписать может уполномоченное лицо, пользователь СберБизнес, имеющий право подписи (Первая, Вторая, Единственная).

После успешного создания заявления на открытие бизнес-карты, необходимо переадресовать Руководителя в клиентскую часть СберБизнес для подписания заявления. Перейдя по ссылке, Руководителю потребуется пройти авторизацию и подписать заявление.

Ссылка переадресации выглядит следующим образом:

{контур Банка}/ic/dcb/index.html#/corporate-cards/requests/common-corp-card/{extrenalId}?backUrl={backUrl}

ПеременнаяОписаниеДополнительная информация
контур Банкаадрес Банка, на который делается запрос для открытия страницы сервиса оплаты- Тестовый контур https://efs-sbbol-ift-web.testsbi.sberbank.ru:9443
- Промышленный контур https://sbi.sberbank.ru:9443
extrenalIdуникальный идентификатор платежного документаДанный идентификатор присваивает ваша Платформа на шаге формирования черновика платежного поручения
backUrlстраница возврата, на которую Банк вернет Руководителя после успешного подписания заявления на открытие бизнес-карты- backUrl нужно закодировать URLEncode;
- Если не указать backUrl в ссылке, пользователи не смогут после подписания заявления вернуться на Платформу;
- Если backUrl будет отличаться от адреса вашей платформы, который указали при регистрации в Банке, то при возврате Руководителя на backUrl он будет видеть ошибку.

Получение статуса заявления на открытие бизнес-карты (/v1/corporate-card-request/{externalId}/state)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/corporate-card-request/{externalId}/state

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

Для получения статуса рассмотрения заявления на открытие бизнес-карты необходимо отправить GET-запрос /v1/corporate-card-request/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором заявления (externalId) в path-параметраметре запроса.

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


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

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

Request

/v1/corporate-card-request/:externalId/state
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^([a-zA-Z0-9]){38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETERS
externalIdstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$requiredИдентификатор заявления на открытие бизнес-карты, который вы присвоили документу при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
CorpCardIssueRequestState {
bankCommentstringoptionalБанковский комментарий к статусу документа,
bankStatusstringoptionalСтатус документа,
corpCardIdstringoptionalИдентификатор бизнес-карты
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
ResourceFault {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
checksArray[Check]optionalСписок проверок, приведших к ошибке,
fieldNamesArray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
{
levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
messagestringoptionalСообщение,
fieldsArray[string]optionalНазвания полей (при наличии связи с моделью)
}
]
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В строке аутентификации СберБизнес ID, в параметре scope, не указана операция CORPORATE_CARD_REQUEST. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.
Документация
SberJazzSaluteSpeechSaluteBotВся документация
Наши продукты
Витрина технологийБаза знанийСтань частью IT-команды
Юридические документы
Политика конфиденциальности Политика обработки данныхВсе соглашения и политики
© 1997–2024 ПАО СберБанк. Генеральная лицензия на осуществление банковских операций от 11 августа 2015 года. Регистрационный номер — 1481