Создание черновика заявления ЗДА

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

/fintech/api/v1/acceptance-advances

Ресурс позволяет создать черновик заявления на заранее данный акцепт.

Для создания черновика заранее данного акцепта необходимо отправить POST-запрос /fintech/api/v1/acceptance-advances с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами документа в теле запросе.

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

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

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

Request

/fintech/api/v1/acceptance-advances

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

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
Content-Type	string	string	^(application/json|text/plain|application/xml|multipart/form-data|application/x-www-form-urlencoded)$	required	Тип данных, которые передаются в теле запроса. Должен содержать значение application/json.
BODY
AcceptanceAdvance {
acceptLastDate	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	optional	Дата окончания периода действия ЗДА. Если поле оставить незаполненным, то будет создаваться черновик заявления на выпуск бессрочного ЗДА,
acceptStartDate	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	required	Дата начала периода действия ЗДА,
contractDate	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	required	Дата заключения договора, на основании которого в дальнейшем Клиенту выставляется ИПТ,
contractNumber	string	string	^[0-9a-zA-Zа-яА-ЯеЁ \t]{1,40}$	required	Номер договора, на основании которого в дальнейшем Клиенту выставляется ИПТ,
date	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	required	Дата составления документа,
externalId	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Идентификатор документа, присвоенный вами,
number	string	string	^[0-9]{1,6}$	required	Номер документа,
obligation	string	string	^[0-9a-zA-Zа-яА-ЯеЁ \t]{1,50}$	optional	Предмет договора,
payeeAccount	string	string	^[0-9]{20}$	required	Счет получателя,
payeeBankBic	string	string	^[0-9]{9}$	optional	БИК получателя,
payeeInn	string	string	^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$	optional	ИНН получателя,
payeeName	string	string	^[0-9a-zA-Zа-яА-ЯеЁ \t]+$	optional	Наименование получателя,
payerAccount	string	string	^[0-9]{20}$	optional	Счет плательщика,
payerBic	string	string	^[0-9]{9}$	optional	БИК плательщика,
payerInn	string	string	^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$	optional	ИНН плательщика,
payerName	string	string	^[0-9a-zA-Zа-яА-ЯеЁ \t]+$	optional	Наименование плательщика
}

POST /fintech/api/v1/acceptance-advances HTTP/1.1
Content-Type: application/json
Authorization: Bearer 9126b3df-0a3c-4963-bd82-e88a2f3d4994-2
 
{
    "acceptStartDate": "2024-04-18",
    "contractDate": "2024-04-17",
    "contractNumber": "3735",
    "date": "2024-04-17",
    "externalId": "c8a4bf86-fa63-411f-b705-1b764386855a",
    "number": "670",
    "obligation": "Оплата телефонных услуг. НДС 20%",
    "payeeAccount": "40702810006000001792",
    "payeeBankBic": "048073601",
    "payeeInn": "7379190522",
    "payeeName": "ТЕСТ9036",
    "payerAccount": "40702810506000002149",
    "payerBic": "048073601",
    "payerInn": "213504669246",
    "payerName": "ИП_Автотест_Клиент_ЕКС_20231027092336"
}

Responses

201 (Сreated)

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

Наименование	Тип	Обязательность	Описание
AcceptanceAdvance {
acceptLastDate	string	optional	Дата окончания периода действия ЗДА,
acceptStartDate	string	required	Дата начала периода действия ЗДА,
bankComment	string	optional	Расшифровка статуса обработки,
bankStatus	string	optional	Статус обработки,
contractDate	string	required	Дата договора,
contractNumber	string	required	Номер договора,
date	string	required	Дата документа,
externalId	string	required	Идентификатор документа, присвоенный партнером,
number	string	required	Номер документа,
obligation	string	optional	Предмет договора,
payeeAccount	string	required	Счет получателя,
payeeBankBic	string	optional	БИК получателя,
payeeInn	string	optional	ИНН получателя,
payeeName	string	optional	Наименование получателя,
payerAccount	string	optional	Счет плательщика,
payerBic	string	optional	БИК плательщика,
payerInn	string	optional	ИНН плательщика,
payerName	string	optional	Наименование плательщика
}

HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
 
{
    "externalId": "c8a4bf86-fa63-411f-b705-1b764386855a",
    "contractNumber": "3735",
    "acceptStartDate": "2024-04-18",
    "acceptLastDate": null,
    "contractDate": "2024-04-17",
    "number": "670",
    "date": "2024-04-17",
    "obligation": "Оплата телефонных услуг. НДС 20%",
    "payeeAccount": "40702810006000001792",
    "bankStatus": "CREATED",
    "bankComment": null,
    "payeeName": "ТЕСТ9036",
    "payeeInn": "7379190522",
    "payeeBankBic": "048073601",
    "payerAccount": "40802810706000000087",
    "payerName": "ИП_Автотест_Клиент_ЕКС_20231027092336",
    "payerInn": "213504669246",
    "payerBic": "048073601"
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULT	Документ с таким externalId уже существует в системе	Используется externalId, который уже есть в системе (дубль). Сгенерируйте новый externalId и повторите запрос.
	Неизвестный счет плательщика: {payerAccount}
	Неизвестный счет получателя: {accountNumber}
	Отсутствует доступный открытый рублевый расчетный счет	Ошибка может возникнуть если: 1. Указан не расчетный счет (например, транзитный) 2. Указан валютный счет 3. Указан счет для гособоронзаказа 4. Указан счет ТСЖ
	Счет закрыт: {accountNumber}
	Счет заблокирован: {accountNumber}
	Введен некорректный ИНН получателя
	Введен некорректный ИНН плательщика
	БИК банка получателя не соответствует БИК привязанного к счету получателя
	БИК банка плательщика не соответствует БИК привязанного к счету плательщика
VALIDATION_FAULT	Объект AcceptanceAdvance не соответствует модели	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

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

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "DESERIALIZATION_FAULT",
    "referenceId": "d202ea3a-d380-464d-ad75-c398728d111c",
    "message": "Неверный формат запроса",
    "checks": [
        {
            "level": "ERROR",
            "message": "Cannot deserialize value of type `java.util.Date` from String \"17.04.2024\": not a valid representation",
            "fields": [
                "acceptStartDate"
            ]
        }
    ],
    "fieldNames": [
        "acceptStartDate"
    ]
}

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	Уникальный идентификатор ошибки,
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, не указана операция ACCEPTANCE_ADVANCE. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

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

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки,
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": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

415 (Unsupported Media Type)

Cause	Message	Description
		Отсутствует параметр Content-type в header запроса
		В параметре Content-type установлено значение, отличное от application/json

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

Наименование	Тип	Обязательность	Описание
Отсутствует

HTTP/1.1 415 Unsupported Media Type

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
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

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

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

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

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

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

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки,
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": "Внутренняя ошибка сервера"
}