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

Получить выписку по операциям

Обновлено 21 февраля 2024

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

Шаги

  1. Получить access_token
  2. Получить corpCardId
  3. Получить выписку по операциям

Usecase

Участники

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

Предусловия

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

Постусловия

  • Получена информация по последним 10 операциям по бизнес-карте
Usecase
  • Процесс получения access_token необходимо реализовать с помощью сервиса СберБизнес ID.

Получение информации по бизнес-картам (/v1/corporate-cards)

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

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

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

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


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

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

Request

/v1/corporate-cards
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
AuthorizationstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})-((1)|(2))$requiredAccess token пользователя, полученный через SSO.

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
Inline Model [
   Inline Model 1Array[Inline Model 1]requiredПеречень всех бизнес-карт сотрудника
]
Inline Model 1 {
   accountstringoptionalНомер счета, к которому привязана карта,
   cardExpiredDatestringoptionalДата окончания действия карты,
   cardIssuedDatestringoptionalДата выдачи карты,
   cardPanstringoptionalНомер карты,
   cardTypestringoptionalТип карты,
   corpCardIdstringoptionalИдентификатор бизнес-карты,
   embossedTextstringoptionalЭмбоссированный текст,
   limitsArray[CorpCardLimit]optionalЛимиты по карте
}
CorpCardLimit [
   {
      amountnumberoptionalЗначение лимита,
      codestringoptionalКод типа лимита
   }
]
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
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В строке аутентификации СберБизнес ID, в параметре scope, не указана операция CORPORATE_CARDS. Необходимо добавить эту операцию в 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Сообщение,
}

Получение мини-выписки по бизнес-карте (/v1/corporate-cards/{corpCardId}/transactions)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/corporate-cards/{corpCardId}/transactions

Метод /v1/corporate-cards/{corpCardId}/transactions позволяет получать выписку на последние 10 операций по бизнес-карте.

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

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


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

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

Request

/v1/corporate-cards/:corpCardId/transactions
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
AuthorizationstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})-(1|2)$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETERS
corpCardIdstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$requiredИдентификатор бизнес-карты, который вы ранее получили в рамках процесса выпуска бизнес-карты либо запросили на предыдущем шаге с помощью метода /v1/corporate-cards.

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
CorpCardTransactions [
   corpCardTransactionsArray[CorpCardTransaction]requiredДанные по операциям выписки бизнес-карты
]
CorpCardTransaction {
   amountnumberrequiredСумма транзакции,
   currencyNamestringrequiredКод валюты транзакции,
   datestringrequiredДата транзакции,
   descriptionstringrequiredОписание транзакции,
   placestringrequiredМесто транзакции
}
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, не указана операция ``. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
CARD_ID_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 в настройках своего браузера.