Данные по бизнес-картам

Обновлено 13 июля 2023

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

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

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

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

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

Получение информации по карте

Ресурс /v1/corporate-cards/{corpCardId} позволяет получить информацию по открытой бизнес-карте.

Шаги

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

2. Получить corpCardId.

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

Авторизация

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

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

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

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации-клиента, полученный через SSO Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
corpCardId (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-cards/550e8400-e29b-41d4-a716-446655440000'

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

Наименование	Описание
embossedText (String (50), optional)	Эмбоссированный текст
cardPan (String (22), optional)	Номер карты
accountNumber (String (22), optional)	Номер счета, к которому привязана карта
cardType (String (122), optional)	Название платежной системы (Visa, Mastercard) и Тип карты (Business Digital - Цифровая карта, Business - Дебетовая карта, Business Travel - Карта Travel, Business Platinum - Премиальная карта, Business Credit - Кредитная карта)
cardIssuedDate (Date, optional)	Дата выдачи карты
cardExpiredDate (Date, optional)	Дата окончания
corpCardId (String (40), optional)	Идентификатор бизнес-карты
limit (массив JSON (array))
code (String (60), optional)	Код типа лимита Заполняется значением из справочника СorpCardLimitType
amount (Number (34,4), optional)	Значение лимита

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

{
   "embossedText":"KARTY BIZNES"
   "cardPan":0000000000000000
   "accountNumber":00000000000000000000
   "cardType":"Visa Business Credit"
   "cardIssuedDate":09-2020
   "cardExpiredDate":09-2023
   "corpCardId":"550e8400-e29b-41d4-a716-446655440000"
   "limit":[
      {
         "code":"T_MN_BUS"
         "amount":100000
      }
   ]
}

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

Ресурс /v1/corporate-cards позволяет получить информацию по всем бизнес-картам клиента.

Шаги

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

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

Авторизация

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

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

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

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации-клиента, полученный через SSO Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1

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

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-cards'

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

Наименование	Описание
corpCards
embossedText (String (50), optional)	Эмбоссированный текст
cardPan (String (22), optional)	Номер карты
accountNumber (String (22), optional)	Номер счета, к которому привязана карта
cardType (String (122), optional)	Название платежной системы (Visa, Mastercard) и Тип карты (Business Digital - Цифровая карта, Business - Дебетовая карта, Business Travel - Карта Travel, Business Platinum - Премиальная карта, Business Credit - Кредитная карта, Business Momentum - Моментальная карта)
cardIssuedDate (Date, optional)	Дата выдачи карты
cardExpiredDate (Date, optional)	Дата окончания
corpCardId (String (40), optional)	Идентификатор бизнес-карты
limit (массив JSON (array))
code (String (60), optional)	Код типа лимита
amount (Number (34,4), optional)	Значение лимита

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

{
   "embossedText":"KARTY BIZNES"
   "cardPan":0000000000000000
   "accountNumber":00000000000000000000
   "cardType":"Visa Business Credit"
   "cardIssuedDate":09-2020
   "cardExpiredDate":09-2023
   "corpCardId":"550e8400-e29b-41d4-a716-446655440000"
   "limit":[
      {
         "code":"T_MN_BUS"
         "amount":100000
      }
   ]
}

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

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

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