Получение списка и статусов заявлений на перевод

Обновлено 29 ноября 2024

Компаниям

/fintech/api/v2/сorporate-cards/transfer/list

Возвращает cписок документов «Заявление на перевод между бизнес-картами» по токену авторизации пользователя, а также статусы переводов по этим заявлениям за указанный период.

Чтобы ресурс был доступен, ссылка авторизации должна содержать код сервиса BUSINESS_CARDS_TRANSFER в параметре scope.

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

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

Request

/fintech/api/v2/сorporate-cards/transfer/list

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
BODY
startDate	string	string	YYYY-MM-DD	optional	Дата (год, месяц, число) начала периода, за который нужно получить список переводов. Если дата startDate не введена Клиентом, а дата endDate введена, то Клиент получит список переводов, совершенных начиная с  00:00;00 часов даты за тридцать дней ранее даты 00:00;00 часов endDate.Если дата startDate и дата endDate не введены Клиент получит список переводов, совершенных начиная с  даты за тридцать дней ранее текущей даты/времени.Если введены обе даты startDate и endDate, то Клиент получит список переводов с 00:00;00 часов startDate до 00:00;00 часов даты endDate. Те переводы совершенные в endDate позднее 00:00;00 часов не включаются в выборку.
endDate	string	string	YYYY-MM-DD	optional	Дата (год, месяц, число) окончания периода, за который нужно получить список переводов. Если дата endDate не введена Клиентом, а дата startDate введена, то клиент получит список переводов с  00:00;00 часов даты startDate по текущую дату/текущее время.Если дата startDate и дата endDate не введены Клиент получит список переводов, совершенных начиная с  даты за тридцать дней ранее текущей даты/времени. Если введены обе даты startDate и endDate, то Клиент получит список переводов с 00:00;00 часов startDate до 00:00;00 часов даты endDate. Те переводы совершенные в endDate позднее 00:00;00 часов не включаются в выборку. Чтобы получить список переводов по текущее время текущего дня нужно НЕ вводить endDate.
withDraft	boolean	string		optional	Признак вывода неподписанных заявок на перевод,
pagination {	object			required	Пагинация
count	number	integer	^[0-9]{10000}$	required	Количество заявлений на перевод, которое нужно вывести на странице.
offset	number	integer	^[0-9]$	required	Оффсет, количество заявлений, которые необходимо пропустить.
}

POST /fintech/api/v2/сorporate-cards/transfer/list HTTP/1.1
Content-Type: application/json
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678
 
{   
  "startDate": "2024-03-15",
  "endDate": "2024-03-16",
  "withDraft": "true",
  "pagination": {
      "count": 5,    
      "offset": 0
    }
 }

Responses

200 (OK)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
transfers [
{
createDate	DateTime	required	Дата и время создания документа,
externalId	string	required	Уникальный идентификатор заявления на перевод,
transferPurpose	string	required	Назначение перевода,
status	enum	required	Статус перевода (ERROR,FORM,PROCESSING,END),
statusDescription	string	required	Описание статуса перевода,
transferAmount {	object	required	Сумма перевода
amount	number	required	Сумма перевода,
currency	string	required	Валюта перевода.
}
transferComission {	object	required	Комиссия за перевод
amount	number	required	Комиссия за перевод,
currency	string	required	Валюта комиссии за перевод.
}
senderInfo {	object	optional	Информация об отправителе
maskedCardNumber	string	optional	Маскированный номер карты отправителя.
}
receiverInfo {	object	optional	Информация о получателе
maskedCardNumber	string	optional	Маскированный номер карты получателя,
phoneNumber	string	optional	Номер телефона получателя,
bankName	string	optional	Банк получателя,
organizationName	string	optional	Наименование организации получателя.
}
}
]

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
 { 
  "transfers": [
   
  {
   "createDate": "2024-03-18T12:07:02.298Z",
   "externalId": "293e94c4-ecef-4e4d-a923-9453b16dbddd",
   "transferPurpose": "За товар по договору №2 от 12/01/2024",
   "status": "FORM",
   "statusDescription": "Заявка создана, требуется подтверждение."

   "transferAmount": {
    "amount": 1000.00,
    "сurrency": "RUR"
    },
   "transferComission": {
    "amount": 10.00,
    "сurrency": "RUR"
    },
   "senderInfo": {
     "maskedCardNumber": "220220******0760"
    },
   "receiverInfo": {
    "maskedCardNumber": "220220******6675",
    "phoneNumber":"79037865643"
    "bankName": "Сбербанк",
    "organizationName": "ПАО ВСПЫШКА"
   }
  }
  ]
}

400 (Bad request)

Cause	Message	Description
VALIDATION_ERROR	Ошибка валидации	Данные не соответствуют требованиям валидации. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
	Ошибка валидации запроса. Код ошибки: 428-001.	Проверьте данные запроса. Попробуйте скорректировать запрос и отправить его повторно.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
errorCode	string	optional	Код ошибки,
errorName	string	optional	Название ошибки,
errorDesc	string	optional	Описание ошибки.

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
 
{
    "errorCode": "428-001",
    "errorName": "VALIDATION_ERROR",
    "errorDesc": "Ошибка валидации запроса. Код ошибки: 428-001."
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959-bbd5-490a-9f9f-67fb7380fae5-2"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция BUSINESS_CARDS_TRANSFER. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
		Вы использовали access_token пользователя вашей организации, а не Клиента. Нужно использовать access_token пользователя Клиента.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice{
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

json HTTP/1.1 429 Too Many Requests Content-Type: application/json;charset=UTF-8

{ "cause": " TOO_MANY_REQUESTS ", "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61", "message": " Превышен лимит запросов. Повторите операцию позже" }

500 (Internal Server Error)

Cause	Message	Description
VALIDATION_ERROR	Ошибка валидации	Данные не соответствуют требованиям валидации. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
	Ошибка валидации ответа. Код ошибки: 428-002.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
	Ошибка валидации запроса. Код ошибки: 428-003.	Недопустимые символы в теле запроса - сработало правило детектирования SQL-иньекций.
	Ошибка валидации запроса. Код ошибки: 428-004.	Недопустимые символы в теле запроса - сработало правило детектирования lfI-атаки
UNEXPECTED_SERVER_ERROR	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
	Непредвиденная ошибка. Код ошибки: 428-431.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
GATEWAY_ERROR	Ошибка подключения к прокси-серверу.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
	Попробуйте позднее. Код ошибки: 428-009 / 428-010 / 428-439.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
CONTEXT_ERROR	Ошибка получения сессионных данных.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
	Попробуйте позднее. Код ошибки: 428-006 / 428-007 / 428-008.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
FORBIDDEN_ERROR	Отсутствуют полномочия	Недостаточно полномочий для исполнения запроса.
	Нет полномочий. Код ошибки: 428-432.	Недостаточно полномочий для исполнения запроса.
	Попробуйте позднее. Код ошибки: 428-433 / 428-434 / 428-435.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
INTEGRATION_ERROR	Интеграционная ошибка	Ошибка обращения к мастер-системе.
	Попробуйте позднее. Код ошибки: 428-436 / 428-437 / 428-438 / 428-441.	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
errorCode	string	optional	Код ошибки,
errorName	string	optional	Название ошибки,
errorDesc	string	optional	Описание ошибки.

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
    "errorCode": "428-006",
    "errorName": "CONTEXT_ERROR",
    "errorDesc": "Попробуйте позднее. Код ошибки: 428-006."
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}