Бизнес-карты

Обновлено 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#/corporate-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), optional)	Регион
district (String (100), optional)	Район
settelmentName (String (100), optional)	Населенный пункт
street (String (100))	Улица
house (String (20))	Дом
building (String (20), optional)	Корпус
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))	Наименование места выдачи карты

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

{
   "typeName":"Business Travel"
   "paymentSystemName":"Visa"
   "servicePeriod":"Month"
   "accountNumber":40702810238000001331
   "embossedText":"SBERBANK"
   "externalId":550e8400-e29b-41d4-a716-446655440000
   "plastic":1
   "cardholder":[
      {
         "lastName":"Петров"
         "firstName":"Леонид"
         "middleName":"Викторович"
         "sex":true
         "birthDate":1996-07-23
         "birthPlace":"Москва"
         "citizenship":"РОССИЯ"
         "cellphone":79058653965
         "email":"test@ya.ru"
         "embossedName":"LEONID"
         "embossedLastName":"PETROV"
         "identityDoc":[
            {
               "typeCode":21
               "type":"Паспорт гражданина Российской Федерации"
               "serial":4676
               "number":234543
               "issueDate":2020-12-13
               "issuerCode":121-212
               "issuer":"ОУФМС по городу Москве по району Царицыно"
            }
         ]"аddress":[
            {
               "postalCode":334532
               "country":"РОССИЯ"
               "city":"Королев"
               "state":"МО"
               "district":"Липецкий"
               "settelmentName":"Подгорное"
               "street":"Трубная"
               "house":233
               "building":1
               "flat":4
               "countryCode":"RUS"
            }
         ]
      }
   ]"cardLimits":[
      {
         "monthLimitAllOperations":3000000.20
         "dayNonCashLimit":100000.20
         "dayCashLimit":200000.20
         "dayTransactionsLimit":300000.20
         "monthCashLimit":1000000.20
         "monthTrasactionsLimit":1000000.20
      }
   ]"branchInfo":[
      {
         "address":"Боровский район, ст-ца Боковская, ул.Советская, 20"
         "regionCode":52
         "agencyCode":5221
         "branchCode":0480
         "name":"Доп.офис №5221/0480"
      }
   ]
}

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

Ресурс /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`	Ошибка реквизитов	В ЭД указаны ошибочные реквизиты
	Окончательный(Успешный)/Прекратить опрос
`PROCESSED`	Исполнен	Электронный документ исполнен Банком

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

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

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

Бизнес-карты

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

Шаги﻿

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

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

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

Шаги﻿

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

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

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

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

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

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

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

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

Шаги

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

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

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

Шаги

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

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

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

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

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

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

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