openapi: 3.0.3 info: title: Alfa API contact: name: API Support email: baas_support@alfabank.ru version: 1.0.0 externalDocs: description: Документация Alfa API url: https://developers.alfabank.ru/old servers: - url: https://sandbox.alfabank.ru/api/ description: Sandbox server API - url: https://sandbox.alfabank.ru/oidc/ description: Sandbox server OIDC security: - bearerAuth: [] tags: - name: BonusNumbers description: Получение бонусных номеров карт клиента - name: UserCompliance description: Проверка актуальности сведений клиента - name: Transactions description: Операции по счетам - name: Customer-info description: Профиль организации - name: OIDC description: "Получение/обновление токена доступа, Получение информации о пользо\ вателе, Получение Client Secret" - name: Signature description: Электронная подпись - name: Payments description: Платёжные поручения - name: PaymentRegistries description: Реестры рублёвых платежей - name: Escrow-accounts description: Функционал АПИ для застройщиков - name: Loans description: Кредиты - name: Webhooks description: Подписки на события - name: Selfemployed-Agreements description: Онбординг самозанятых и оформление с ними соглашений - name: Selfemployed description: Операции с самозанятыми в системе - name: Payouts-processing description: Выплаты исполнителям - name: Selfemployed-Dictionaries description: Справочники в части работы с самозанятыми - name: Poa description: Операции с машиночитаемыми доверенностями (МЧД) - name: Beneficiaries description: Работа с бенефициарами - name: Accounts description: Счета ФЛ - name: Cards description: Карты ФЛ - name: OperationsHistory & Statements description: История операций и выписки ФЛ - name: Reports description: Справки ФЛ - name: Limits description: Лимиты ФЛ - name: Loyalty description: Программа лояльности ФЛ - name: DebitCards description: Дебетовая анкета - name: SBP description: Сервисы для СБП - name: B2B SPB 1C description: API-интерфейс для интеграции AlfaAPI с 1С - name: b2cpay description: Сервисы b2cpay - name: Credit Offers description: Кредитные предложения физического лица - name: C2B SBP description: Операции СБП для C2B - name: AlfaSecurity description: Альфа Безопасность - name: Logistics description: Логистика / SFA Delivery - name: Channel-Provider description: SFA Delivery. Логистический центр - name: Aff-integration description: Интеграция с AFF - name: Business Lounge description: Сервисы для интеграции NFS с внешними партнерами - name: DFA description: Серфисы ЦФА - name: Crypto-Service description: Управление сертификатами шифрования и электронной подписи - name: Claims description: Работа с обращениями - name: Order-Core description: Управление заказом партнеров - name: Self-encashment description: Самоинкассация - name: Partner description: Сервисы Партнёрской Программы ММБ - name: Mathmod scorings description: Проверка контрагента - name: Offices-rates description: Выгрузка курсов валют по запросу в разрезе офисов paths: /token: post: tags: - OIDC summary: Получение токена доступа description: Получение токена доступа requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TokenRequest' required: true responses: "200": description: OK headers: Content-Type: schema: type: string example: application/json enum: - application/json Cache-Control: schema: type: string example: no-store enum: - no-store Pragma: schema: type: string example: no-cache enum: - no-cache content: application/json: schema: $ref: '#/components/schemas/TokenResponse' "400": description: BAD REQUEST headers: Content-Type: schema: type: string example: application/json enum: - application/json Cache-Control: schema: type: string example: no-store enum: - no-store Pragma: schema: type: string example: no-cache enum: - no-cache content: application/json: schema: $ref: '#/components/schemas/TokenError' "404": description: NOT FOUND headers: Content-Type: schema: type: string example: application/json enum: - application/json "429": description: Cлишком много запросов в заданный период "503": description: Сервер временно недоступен /userinfo: get: tags: - OIDC summary: Получение информации о пользователе description: Получение информации о пользователе responses: "200": description: OK headers: Content-Type: schema: type: string example: application/jwt enum: - application/jwt content: application/jwt: schema: type: string example: eyJraWQiOiJhbGZhLXRlc3Qtand0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJjdXMiOiJVQUFBQUEiLCJzdWIiOiIzMjI4ZTY4ZS1jYzM0LTRiODItYjQzZC00OTExMmI1ZDlkM2UiLCJiaXJ0aGRhdGUiOiIyMDAwLTAyLTIwIiwicm9sZSI6IkFDQ09VTlRBTlQsIE1BTkFHRVIiLCJnZW5kZXIiOiJNQUxFIiwiaWRlbnRpdHlfZG9jdW1lbnRfbmFtZSI6ItCf0LDRgdC_0L7RgNGCINCz0YDQsNC20LTQsNC90LjQvdCwINCg0KQiLCJpZGVudGl0eV9kb2N1bWVudF9udW1iZXIiOjIyMjIyMiwiaXNzIjoiaHR0cHM6XC9cL2JhYXMuYWxmYWJhbmsucnUiLCJpbm4iOjc0MTUxMTExMjIyMiwiZWlvIjp0cnVlLCJnaXZlbl9uYW1lIjoi0KLQtdGB0YIiLCJtaWRkbGVfbmFtZSI6ItCi0LXRgdGC0L7QstC40YciLCJhY3VzIjoiWEFBQUFBIiwiaWRlbnRpdHlfZG9jdW1lbnRfc2VyaWVzIjoxMTExLCJhdWQiOiIwY2VlMDY4My04NWFlLTQ5ZjItYTYzZC0yOWY5N2FhZDE5MTEiLCJhY2xjIjoiWEFBQUExIiwidXBkYXRlZF9hdCI6IjIwMjItMDEtMjAiLCJuYW1lIjoi0KLQtdGB0YLQvtCyINCi0LXRgdGCINCi0LXRgdGC0L7QstC40YciLCJwaG9uZV9udW1iZXIiOjc5MTkxMTEyMjMzLCJjbGMiOiJVQUFBQTEiLCJmYW1pbHlfbmFtZSI6ItCi0LXRgdGC0L7QsiIsImVtYWlsIjoiZW1haWxAZW1haWwucnUifQ.WVr5xkQSEGqpPXN3aIo0zHZLDL0vvtxEEQ83BrgJo7l0BjjALeGDRYENF2bL8j3n1pXRnduiBQcYNV6teBhESI8V_8kd7Kh7LTePkJWadPSvD__KskC69b4XZ-zN-IQ73NmAcBDStnnhSXGKL6xhdRy-TGiAoKPsRWiDVntsDlpCQNHAt3tJk8q_SQS4S1k6qju9eJ2GFkgmd6z8rR2vaBykaOF0K61ltksw6YgXhuek3OlYkqIAivyKYl59uio8zMpJk-YrPlmawwmvWPF0vKhaLj8Mvn4mVMsVSfuVVKP2ksHG0MAlWpO3Sh9GoKO4d6TQplJ4vgIIeNx-44npqw "400": description: BAD REQUEST headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/UserInfoError' "401": description: UNAUTHORIZED headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/UserInfoError' "403": description: FORBIDDEN headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/UserInfoError' "404": description: NOT FOUND headers: Content-Type: schema: type: string example: application/json enum: - application/json "429": description: Cлишком много запросов в заданный период времени "500": description: INTERNAL SERVER ERROR headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/UserInfoError' "503": description: Сервер временно недоступен /clients/{clientId}/client-secret: post: tags: - OIDC summary: Получение Client Secret description: Получение Client Secret parameters: - name: clientId in: path description: Идентификатор партнерского сервиса required: true schema: type: string format: uuid example: 0cee0683-85ae-49f2-a63d-29f97aad1911 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ClientSecretResponse' "400": description: BAD REQUEST headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/ClientSecretError' "404": description: NOT FOUND headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/ClientSecretError' "429": description: Cлишком много запросов в заданный период времени "500": description: INTERNAL SERVER ERROR headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/ClientSecretError' "503": description: Сервер временно недоступен /revoke: post: tags: - OIDC summary: Отзыв токена description: Отзыв токена requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RevokeRequest' required: true responses: "200": description: OK "400": description: BAD REQUEST headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/RevokeError' "429": description: Cлишком много запросов в заданный период времени "500": description: INTERNAL SERVER ERROR headers: Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/RevokeError' "503": description: Сервер временно недоступен /v1/customer-info: get: tags: - Customer-info summary: Получение профиля организации responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ClientInfo' examples: example: $ref: '#/components/examples/getCustomerInfo' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /statement/transactions: get: tags: - Transactions summary: Получение операций по счетам parameters: - name: accountNumber in: query description: Номер расчетного счета required: true schema: pattern: "\\d{20}" type: string example: 40702810701300000761 - name: statementDate in: query description: Дата исполнения операции required: true schema: type: string format: date example: 2022-01-13 - name: page in: query description: Номер запрашиваемой страницы required: false schema: minimum: 1 type: integer default: 1 example: 2 - name: curFormat in: query description: Формат операции по валютному счету required: false schema: pattern: ^(curTransfer|swiftTransfer)$ type: string example: curTransfer responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/Statement' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v2/accounts/{accountNumber}/transactions/1C: get: tags: - Transactions summary: Получение операций по счетам в формате 1С parameters: - name: accountNumber in: path description: Номер расчетного счета required: true schema: pattern: "\\d{20}" type: string example: 40702810701300000761 - name: executeDate in: query description: Дата исполнения required: true schema: type: string format: date example: 2022-01-20 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: true schema: minimum: 0 type: integer default: 0 example: 0 - name: limit in: query description: Количество объектов на одной странице required: false schema: minimum: 1 type: integer default: 10 example: 1000 - name: X-Response-ChannelSecurity in: header description: "Тип защиты канала в ответе (SIGNATURE - только подпись, ENCRYPTION\ \ - подпись и шифрование)" required: false schema: type: string example: SIGNATURE responses: "200": description: OK headers: X-TraceId: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 X-Pagination-Limit: description: Количество записей на одной странице schema: type: integer example: 1000 X-Pagination-Offset: description: "Количество записей в списке, которые были пропущены" schema: type: integer example: 0 X-Pagination-Total-Count: description: Общее количество записей schema: type: integer example: 10000 X-SymmetricKey: description: Симметричный ключ schema: type: string example: AGpWUZip/ita8COYlDotThRde4Opx3FNs3/l4Q3ncVcYN4Yuid6Npx3USq5RE9rLiL/G7VQcJkmsfIkwW/CfaRo9MjclwUq/l3GSwUTBSf+5lsiE5WrCobzIDoVYLL6n2Q+wWC23jobEM+7aFlDRR3lmlXBTouR98I2nNEg2Dtuo8m0/SrwWyADpDI680Vey4Uki5asraVR50zRh0D61mgesIxARHHkC2OvjmsC4AJd2cyrEo/uAFICZNcc/v8jFpHXgSL+Y7IiyJsMusz6uh15oU2ytBQkyUYUn5r6/r+e1z5uTiC9JLcm7tEzSEuzmw4FUF4p9WtQm30j+4GQUQQ== X-InitializationVector: description: Вектор инициализации schema: type: string example: BX4RGLMrWXhHZaoSfkfZLMu/pO5K81sJWIsDoabUBiymhA6xZy7LNJWkUGpWndaCGgLn5l4csmvzDp0+c9kHgDbObXfhbw6wKOGf3wB8dYyexhau5krW/40EEukO0O3d/IB0UsXiE3mXA0/G52vQTxi+V3L+l1+g4rsipQhhY8yzliYZ7XrkvGnri4plnB8jX1EFfMiE6Q3QdmAGAz5fLY0oDTOi8dGgH7XkURtPX3VsuYFBO7Glxvr6PeHSG7Xnl5qAbayKHg3lAW9u7YEwvRd+OF+y7xlp9f2j5xCBhw0LXt+RTMTBEvSHqTYpY+vgYnKW/J79ExL2WLsbc/Y++A==HgDbObXfhbw6wKOGf3wB8dYyexhau5krW/40EEukO0O3d/IB0UsXiE3mXA0/G52vQTxi+V3L+l1+g4rsipQhhY8yzliYZ7XrkvGnri4plnB8jX1EFfMiE6Q3QdmAGAz5fLY0oDTOi8dGgH7XkURtPX3VsuYFBO7Glxvr6PeHSG7Xnl5qAbayKHg3lAW9u7YEwvRd+OF+y7xlp9f2j5xCBhw0LXt+RTMTBEvSHqTYpY+vgYnKW/J79ExL2WLsbc/Y++A== content: application/xml: schema: $ref: '#/components/schemas/ResponseSigned' examples: Response: $ref: '#/components/examples/Response' ResponseSigned: $ref: '#/components/examples/ResponseSigned' Signed and Encrypted: $ref: '#/components/examples/ResponseSignedEncrypted' "400": description: Неверные входные параметры запроса content: application/xml: schema: $ref: '#/components/schemas/ErrorBadRequestXML' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/xml: schema: $ref: '#/components/schemas/ErrorUnauthorizedXML' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/xml: schema: $ref: '#/components/schemas/ErrorScopeXML' "404": description: Эндпоинт не найден или неактивен content: application/xml: schema: $ref: '#/components/schemas/ErrorNotFoundXML' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/xml: schema: $ref: '#/components/schemas/ErrorInternalXML' "503": description: Сервер временно недоступен /accounts/{accountNumber}/transactions/MT940: get: tags: - Transactions summary: Получение операций по счетам в формате MT940 parameters: - name: accountNumber in: path description: Номер расчетного счета required: true schema: pattern: "\\d{20}" type: string example: 40702810701300000761 - name: executeDate in: query description: Дата исполнения required: true schema: type: string format: date example: 2022-01-20 - name: limit in: query description: Количество объектов на одной странице required: false schema: minimum: 1 type: integer default: 10 example: 1000 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer default: 0 example: 0 responses: "200": description: OK content: text/plain: schema: $ref: '#/components/schemas/StatementMT940' "400": description: Неверные входные параметры запроса content: text/plain: schema: $ref: '#/components/schemas/ErrorBadRequestText' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: text/plain: schema: $ref: '#/components/schemas/ErrorUnauthorizedText' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: text/plain: schema: $ref: '#/components/schemas/ErrorScopeText' "404": description: Эндпоинт не найден или неактивен content: text/plain: schema: $ref: '#/components/schemas/ErrorNotFoundText' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: text/plain: schema: $ref: '#/components/schemas/ErrorInternalText' "503": description: Сервер временно недоступен /statement/summary: get: tags: - Transactions summary: Получение информации об оборотах parameters: - name: accountNumber in: query description: Номер расчетного счета required: true schema: pattern: "\\d{20}" type: string example: 40702810701300000761 - name: statementDate in: query description: Дата исполнения операции required: true schema: type: string format: date example: 2022-01-13 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/StatementSummary' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /gd/v1/accounts/{accountNumber}/status: get: tags: - Transactions summary: Получение информации о действующем счете в Банке parameters: - name: accountNumber in: path description: Номер счета required: true schema: pattern: "^\\d{20}$" type: string example: "40817810210210066268" responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/_gd_v1_accounts__accountNumber__status_get_200_response' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' example: error: invalid_request error_description: Parameter accountNumber is not valid "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' example: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' example: error: insufficient_scope error_description: The request requires higher privileges than provided by the access token "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' example: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен /jp/v1/correspondent-accounts/{accountNumber}/transactions: get: tags: - Transactions summary: Получение операций по корреспондентским счетам parameters: - name: accountNumber in: path description: Номер корреспондентского расчетного счета required: true schema: type: string example: 30102810701300000761 - name: executeDate in: query description: Дата исполнения required: true schema: type: string format: date example: 2022-01-20 - name: limit in: query description: Количество объектов на одной странице required: false schema: type: integer example: 1000 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: type: integer example: 0 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/CorrespondentStatement' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/accounts/{accountNumber}/transactions/files/requests: post: tags: - Transactions summary: Создание заявки на формирование файла выписки parameters: - name: accountNumber in: path description: Номер расчетного счета required: true schema: type: string example: 40702810701300000761 requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestsCreateFileTransaction' responses: "201": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/RequestsCreateFileTransaction' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/accounts/transactions/files/requests/{requestId}: get: tags: - Transactions summary: Получение информации по заявке на формирование файла выписки parameters: - name: requestId in: path description: Идентификатор запроса required: true schema: type: string example: 67e50b09-a203-4119-86cb-647d06a803a0 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponseGetFileTransaction' examples: example: $ref: '#/components/examples/ResponseGetFileTransaction' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/open-banking/v1.3/accounts: get: tags: - Transactions summary: Получение списка счетов Альфа-Банка в формате OpenBanking description: | Конечная точка позволяет СПИУ получать полный список счетов Альфа-Банка и их идентификаторы (accountId), которые были авторизованы Пользователем на стороне ППИУ parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d - name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 - name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значени\ е предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Нап\ ример, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" - name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент под\ ключен к Стороннему Поставщику (авторизован в приложении Стороннего Пост\ авщика)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 - name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который\ \ использует Пользователь. Сторонний Поставщик может заполнить это поле\ \ значением типа устройства (user-agent), указанным Пользователем. Если\ \ Пользователь использует мобильное приложение Стороннего Поставщика, Ст\ оронний Поставщик проверяет, что строка типа устройства (user-agent) отл\ ичается от строки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile responses: "200": description: "Полный список счетов (с идентификаторами accountId), котор\ ые были авторизованы Пользователем на стороне ППИУ" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/AccountResponse' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: "Сторонний Поставщик пытается получить доступ к ресурсу с п\ омощью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406": description: "Запрос содержал параметр заголовка Accept, отличный от раз\ решенных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501": description: "Сторонний поставщик не поддерживает функции, необходимые д\ ля выполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description /jp/open-banking/v1.3/external/accounts: get: tags: - Transactions summary: Получение списка счетов других банков в формате OpenBanking description: | Конечная точка позволяет получать полный список счетов пользователей в других банках и их идентификаторы (accountId) в формате АФТ parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d - name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 - name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значени\ е предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Нап\ ример, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" - name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент под\ ключен к Стороннему Поставщику (авторизован в приложении Стороннего Пост\ авщика)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 - name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который\ \ использует Пользователь. Сторонний Поставщик может заполнить это поле\ \ значением типа устройства (user-agent), указанным Пользователем. Если\ \ Пользователь использует мобильное приложение Стороннего Поставщика, Ст\ оронний Поставщик проверяет, что строка типа устройства (user-agent) отл\ ичается от строки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile responses: "200": description: "Полный список счетов (с идентификаторами accountId), котор\ ые были авторизованы Пользователем на стороне ППИУ" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/AccountResponse' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: "Сторонний Поставщик пытается получить доступ к ресурсу с п\ омощью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406": description: "Запрос содержал параметр заголовка Accept, отличный от раз\ решенных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501": description: "Сторонний поставщик не поддерживает функции, необходимые д\ ля выполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description /jp/open-banking/v1.3/accounts/{accountId}/statements: get: tags: - Transactions summary: Получение выписки по идентификатору счета Альфа-Банка в формате OpenBanking description: "Конечная точка позволяет СПИУ получать выписки по идентификато\ ру счета Альфа-Банка, который предоставляется при вызове конечной точки GET\ \ /accounts, в режиме онлайн" parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d - name: accountId in: path description: Идентификатор счета required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: this-is-a-slug-format-account-id - name: fromBookingDateTime in: query description: Дата и время начала фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: toBookingDateTime in: query description: Дата и время окончания фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 - name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значени\ е предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Нап\ ример, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" - name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент под\ ключен к Стороннему Поставщику (авторизован в приложении Стороннего Пост\ авщика)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 - name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который\ \ использует Пользователь. Сторонний Поставщик может заполнить это поле\ \ значением типа устройства (user-agent), указанным Пользователем. Если\ \ Пользователь использует мобильное приложение Стороннего Поставщика, Ст\ оронний Поставщик проверяет, что строка типа устройства (user-agent) отл\ ичается от строки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile responses: "200": description: Ответ получения выписки по идентификатору выписки headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/StatementResponse' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: "Сторонний Поставщик пытается получить доступ к ресурсу с п\ омощью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406": description: "Запрос содержал параметр заголовка Accept, отличный от раз\ решенных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501": description: "Сторонний поставщик не поддерживает функции, необходимые д\ ля выполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description /jp/open-banking/v1.3/statements: post: tags: - Transactions summary: Создание ресурса выписки Альфа-Банка в формате OpenBanking description: "Конечная точка позволяет СПИУ создать ресурс выписки по иденти\ фикатору счета Альфа-Банка, accountId, который предоставляется при вызове\ \ конечной точки GET /accounts" parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d - name: x-idempotency-key in: header description: Уникальный идентификатор запроса для поддержки идемпотентности. Обязательно для запросов POST к конечным точкам идемпотентного ресурса. Для других запросов не указывается. required: true schema: type: string format: uuid - name: x-jws-signature in: header description: Отделяемая подпись полезной нагрузки в формате JWS required: true schema: type: string - name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значени\ е предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Нап\ ример, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" - name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент под\ ключен к Стороннему Поставщику (авторизован в приложении Стороннего Пост\ авщика)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 - name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который\ \ использует Пользователь. Сторонний Поставщик может заполнить это поле\ \ значением типа устройства (user-agent), указанным Пользователем. Если\ \ Пользователь использует мобильное приложение Стороннего Поставщика, Ст\ оронний Поставщик проверяет, что строка типа устройства (user-agent) отл\ ичается от строки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile requestBody: content: application/json: schema: $ref: '#/components/schemas/StatementInitRequest' examples: Response: $ref: '#/components/examples/RequestCreateStatements' required: true responses: "201": description: Индентификатор выписки headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid x-jws-signature: description: Отделяемая подпись полезной нагрузки в формате JWS required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementInitResponse' example: Data: Statement: statementId: this-is-a-slug-format-statement-id accountId: this-is-a-slug-format-account-id fromBookingDateTime: 2019-09-15T00:00:00+00:00 toBookingDateTime: 2019-12-15T00:00:00+00:00 Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: "Сторонний Поставщик пытается получить доступ к ресурсу с п\ омощью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406": description: "Запрос содержал параметр заголовка Accept, отличный от раз\ решенных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501": description: "Сторонний поставщик не поддерживает функции, необходимые д\ ля выполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description /jp/open-banking/v1.3/statements/{statementId}: get: tags: - Transactions summary: Получение выписки Альфа-Банка по идентификатору в формате OpenBanking description: Конечная точка позволяет СПИУ получать выписку из Альфа-Банка по идентификатору parameters: - name: statementId in: path description: Идентификатор выписки required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: 9b23e27e-f4f8-4cab-9b80-aaa008d4330c - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d - name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 - name: fromBookingDateTime in: query description: Дата и время начала фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: toBookingDateTime in: query description: Дата и время окончания фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значени\ е предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Нап\ ример, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" - name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент под\ ключен к Стороннему Поставщику (авторизован в приложении Стороннего Пост\ авщика)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 - name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который\ \ использует Пользователь. Сторонний Поставщик может заполнить это поле\ \ значением типа устройства (user-agent), указанным Пользователем. Если\ \ Пользователь использует мобильное приложение Стороннего Поставщика, Ст\ оронний Поставщик проверяет, что строка типа устройства (user-agent) отл\ ичается от строки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile responses: "200": description: Ответ получения выписки по идентификатору выписки headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/StatementResponse' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: "Сторонний Поставщик пытается получить доступ к ресурсу с п\ омощью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406": description: "Запрос содержал параметр заголовка Accept, отличный от раз\ решенных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501": description: "Сторонний поставщик не поддерживает функции, необходимые д\ ля выполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description /jp/open-banking/v1.3/external/statements: post: tags: - Transactions summary: Создание ресурса выписки банка-партнера в формате OpenBanking description: "Конечная точка позволяет СПИУ создать ресурс выписки из банка\ -партнера по идентификатору счета accountId, который предоставляется при в\ ызове конечной точки GET /accounts" parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d - name: x-idempotency-key in: header description: Уникальный идентификатор запроса для поддержки идемпотентности. Обязательно для запросов POST к конечным точкам идемпотентного ресурса. Для других запросов не указывается. required: true schema: type: string format: uuid - name: x-jws-signature in: header description: Отделяемая подпись полезной нагрузки в формате JWS required: true schema: type: string - name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значени\ е предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Нап\ ример, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" - name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент под\ ключен к Стороннему Поставщику (авторизован в приложении Стороннего Пост\ авщика)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 - name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который\ \ использует Пользователь. Сторонний Поставщик может заполнить это поле\ \ значением типа устройства (user-agent), указанным Пользователем. Если\ \ Пользователь использует мобильное приложение Стороннего Поставщика, Ст\ оронний Поставщик проверяет, что строка типа устройства (user-agent) отл\ ичается от строки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile requestBody: content: application/json: schema: $ref: '#/components/schemas/StatementInitRequest' examples: Response: $ref: '#/components/examples/RequestCreateStatements' required: true responses: "201": description: Индентификатор выписки headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid x-jws-signature: description: Отделяемая подпись полезной нагрузки в формате JWS required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementInitResponse' example: Data: Statement: statementId: this-is-a-slug-format-statement-id accountId: this-is-a-slug-format-account-id fromBookingDateTime: 2019-09-15T00:00:00+00:00 toBookingDateTime: 2019-12-15T00:00:00+00:00 Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: "Сторонний Поставщик пытается получить доступ к ресурсу с п\ омощью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406": description: "Запрос содержал параметр заголовка Accept, отличный от раз\ решенных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501": description: "Сторонний поставщик не поддерживает функции, необходимые д\ ля выполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description /jp/open-banking/v1.3/external/statements/{statementId}: get: tags: - Transactions summary: Получение выписки по идентификатору банка-партнера в формате OpenBanking description: Конечная точка позволяет СПИУ получать выписку из банка-партнера по идентификатору выписки parameters: - name: statementId in: path description: Идентификатор выписки required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: 9b23e27e-f4f8-4cab-9b80-aaa008d4330c - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d - name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 - name: fromBookingDateTime in: query description: Дата и время начала фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: toBookingDateTime in: query description: Дата и время окончания фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значени\ е предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Нап\ ример, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" - name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент под\ ключен к Стороннему Поставщику (авторизован в приложении Стороннего Пост\ авщика)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 - name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который\ \ использует Пользователь. Сторонний Поставщик может заполнить это поле\ \ значением типа устройства (user-agent), указанным Пользователем. Если\ \ Пользователь использует мобильное приложение Стороннего Поставщика, Ст\ оронний Поставщик проверяет, что строка типа устройства (user-agent) отл\ ичается от строки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile responses: "200": description: Ответ получения выписки по идентификатору выписки headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/StatementResponse' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: "Сторонний Поставщик пытается получить доступ к ресурсу с п\ омощью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406": description: "Запрос содержал параметр заголовка Accept, отличный от раз\ решенных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501": description: "Сторонний поставщик не поддерживает функции, необходимые д\ ля выполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description /jp/v3/signature/dn: get: tags: - Signature summary: Получение DN пользователя responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponseDN' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/dn/file: get: tags: - Signature summary: Получение DN пользователя файлом в формате .cnf responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: text/plain: schema: $ref: '#/components/schemas/ResponseDNcnf' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/rsa-certificates/requests/issue: post: tags: - Signature summary: Заявка на выпуск RSA-сертификата requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestIssueRSACertificate' responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponesIssueRSACertificate' examples: example: $ref: '#/components/examples/postIssueResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/requests/{id}/operations: post: tags: - Signature summary: Отправка заявки на подпись parameters: - name: id in: path description: Идентификатор заявки required: true schema: type: string example: 62550ef50163785f2222707e requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPostOperations' responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponsePostOperations' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/requests/operations/{id}: put: tags: - Signature summary: Подписание заявки c помощью кода из СМС parameters: - name: id in: path description: Идентификатор операции required: true schema: type: string example: 2629a563-3c82-44a2-a4f5-67b79e44cbea requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPutOperations' responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponsePutOperations' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/requests/{id}: get: tags: - Signature summary: Получение данных заявки parameters: - name: id in: path description: Идентификатор заявки required: true schema: type: string example: 62550ef50163785f2222707e responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/RequestData' examples: example: $ref: '#/components/examples/getIssueResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/rsa-certificates/{id}: get: tags: - Signature summary: Получение RSA-сертификата parameters: - name: id in: path description: Идентификатор сертификата required: true schema: type: string example: 62552f2457595f1652c4b179 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/RSACertificate' examples: example: $ref: '#/components/examples/getRsaResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/rsa-certificates/{id}/requests/activation: post: tags: - Signature summary: Заявка на активацию RSA-сертификата parameters: - name: id in: path description: Идентификатор сертификата required: true schema: type: string example: 62552f2457595f1652c4b179 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponesIssueRSACertificate' examples: example: $ref: '#/components/examples/postActivateResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/sign-settings: put: tags: - Signature summary: Заявка на изменение текущего способа подписи requestBody: content: application/json: schema: $ref: '#/components/schemas/SignSettings' responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/ResponesIssueRSACertificate' examples: example: $ref: '#/components/examples/putSignSettingResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/rsa-certificates/{id}/requests/revocation: post: tags: - Signature summary: Заявка на отзыв RSA-сертификата parameters: - name: id in: path description: Идентификатор сертификата required: true schema: type: string example: 62552f2457595f1652c4b179 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponesIssueRSACertificate' examples: example: $ref: '#/components/examples/postRevocationResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/rsa-certificates/{id}/requests/switch: post: tags: - Signature summary: Заявка на переключение RSA-сертификата parameters: - name: id in: path description: Идентификатор сертификата required: true schema: type: string example: 62552f2457595f1652c4b179 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponesIssueRSACertificate' examples: example: $ref: '#/components/examples/postSwitchResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/rsa-certificates/{id}/requests/reissue: post: tags: - Signature summary: Заявка на перевыпуск RSA-сертификата parameters: - name: id in: path description: Идентификатор сертификата required: true schema: type: string example: 62552f2457595f1652c4b179 requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestReissueRSACertificate' responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponesIssueRSACertificate' examples: example: $ref: '#/components/examples/postReissueResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/qes/requests: post: tags: - Signature summary: Заявка на подключение КЭП operationId: qesRequestsEnablePost responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/EnableQesResponse' examples: example: $ref: '#/components/examples/enableQesResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/qes/requests/{id}: post: tags: - Signature summary: Отправка заявки на подключение КЭП на подпись operationId: qesRequestsPost parameters: - name: id in: path description: Идентификатор заявки required: true schema: type: string example: 63160a37e27edd0c316567a6 requestBody: content: application/json: schema: $ref: '#/components/schemas/SendRequestQes' examples: example: $ref: '#/components/examples/qesRequestsPostRequestExample' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SendRequestQesResponse' examples: example: $ref: '#/components/examples/qesRequestsPostResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен patch: tags: - Signature summary: Подписание заявки с помощью КЭП operationId: qesRequestsPatch parameters: - name: id in: path description: Идентификатор заявки required: true schema: type: string example: 63160a37e27edd0c316567a6 requestBody: content: application/json: schema: $ref: '#/components/schemas/SignRequestQes' examples: example: $ref: '#/components/examples/qesRequestsPatchRequestExample' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SignRequestQesResponse' examples: example: $ref: '#/components/examples/qesRequestsPatchResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/powers-of-attorney/requests: post: tags: - Signature summary: Регистрация МЧД в банке operationId: poaRequestsPost requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadPoaRequest' examples: example: $ref: '#/components/examples/downloadPoaRequestExample' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/DownloadPoaResponse' examples: example: $ref: '#/components/examples/downloadPoaResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/powers-of-attorney/requests/{id}/status: get: tags: - Signature summary: Получение статуса регистрации МЧД operationId: poaRequestsStatusGet parameters: - name: id in: path description: Идентификатор запроса в системе МЧД required: true schema: type: string example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetDownloadStatus' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v3/signature/powers-of-attorney/requests/{id}: get: tags: - Signature summary: Скачивание файла машиночитаемой доверенности operationId: poaRequestsDownloadGet parameters: - name: id in: path description: Идентификатор запроса в системе МЧД required: true schema: type: string example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: "200": description: OK headers: Content-Type: required: true schema: type: string example: application/pdf Content-Disposition: required: false schema: type: string example: attachment; filename=poa-e386c9e2-b37b-484d-a691-38a74e8d3fbf.pdf content: application/pdf: schema: type: string format: binary application/zip: schema: type: string format: binary "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v2/payments: post: tags: - Payments summary: Создание рублёвого платёжного поручения requestBody: content: application/json: schema: $ref: '#/components/schemas/Payment' examples: example: $ref: '#/components/examples/createPaymentRequest' responses: "201": description: Документ создан headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/Payment' examples: example: $ref: '#/components/examples/createPaymentResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Конфликт content: application/json: schema: $ref: '#/components/schemas/ErrorConflict' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v2/payments/{externalId}/state: get: tags: - Payments summary: Получение статуса поручения parameters: - name: externalId in: path description: "Идентификатор документа, присвоенный партнером (UUID)" required: true schema: type: string format: uuid responses: "200": description: OK headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/PaymentDocState' examples: example: $ref: '#/components/examples/getPaymentStatusResponse' "400": description: Неверный формат запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Платёжный документ не найден content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен patch: tags: - Payments summary: Обновление статуса платёжного поручения parameters: - name: externalId in: path description: "Идентификатор документа, присвоенный партнером (UUID)" required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchPaymentStateRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentDocState' examples: example: $ref: '#/components/examples/patchPaymentStateResponse' "400": description: Неверный формат запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Платёжный документ не найден content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /payments/{externalId}: get: tags: - Payments summary: Получение атрибутов поручения parameters: - name: externalId in: path description: "Идентификатор документа, присвоенный партнером (UUID)" required: true schema: type: string format: uuid responses: "200": description: OK headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/Payment' examples: example: $ref: '#/components/examples/createPaymentResponse' "400": description: Неверный формат запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Платежный документ не найден content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /payments/{externalId}/print-form: get: tags: - Payments summary: Получение печатной формы платёжного поручения parameters: - name: externalId in: path description: "Идентификатор документа, присвоенный партнером (UUID)" required: true schema: type: string format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: "200": description: Успешный результат headers: Content-Type: required: true schema: type: string example: application/json content: application/json: schema: $ref: '#/components/schemas/PaymentPrintForm' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Конфликт content: application/json: schema: $ref: '#/components/schemas/ErrorConflict' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /payments/{externalId}/print-form/download: get: tags: - Payments summary: Получение печатной формы платёжного поручения в PDF parameters: - name: externalId in: path description: "Идентификатор документа, присвоенный партнером (UUID)" required: true schema: type: string format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: "200": description: Успешный результат headers: Content-Type: required: true schema: type: string example: application/pdf Content-Disposition: required: false schema: type: string example: attachment; filename*=UTF-8'%D0%9F%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%BD%D0%BE%D0%B5_%D0%BF%D0%BE%D1%80%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%E2%84%96657073_11.10.2022.pdf content: application/pdf: schema: type: string format: byte "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Конфликт content: application/json: schema: $ref: '#/components/schemas/ErrorConflict' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v2/payments/count: get: tags: - Payments summary: "Получение количества рублёвых платежей, созданных через канал Alfa\ \ API" parameters: - name: status in: query description: Статус обработки документа required: true schema: $ref: '#/components/schemas/Status' example: SIGNED responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/PaymentsCountResponse' "400": description: Неверный формат запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /payments/from-invoice: post: tags: - Payments summary: Выставление счета клиенту для Альфа-Банка requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceRequest' examples: example: $ref: '#/components/examples/fromInvoiceRequest' responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/InvoiceResponse' examples: example: $ref: '#/components/examples/fromInvoiceResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v2/payments/from-invoice-budget: post: tags: - Payments summary: Выставление счета на оплату в бюджет requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceBudgetRequest' examples: example: $ref: '#/components/examples/fromInvoiceBudgetRequest' responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/InvoiceBudgetResponse' examples: example: $ref: '#/components/examples/fromInvoiceBudgetResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/registries: post: tags: - PaymentRegistries summary: Создание реестра рублёвых платежей operationId: createRegistry requestBody: content: application/json: schema: $ref: '#/components/schemas/RegistryPaymentsRequest' examples: example: $ref: '#/components/examples/CreateRegistryRequest' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/RegistryPaymentsResponse' examples: example: $ref: '#/components/examples/CreateRegistryResponse' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Too Many Requests "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Service Unavailable /jp/v1/registries/{registryId}: get: tags: - PaymentRegistries summary: Получение данных реестра рублёвых платежей operationId: getRegistry parameters: - name: registryId in: path description: Идентификатор реестра required: true schema: type: string example: U102702240001208 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Registry' examples: example: $ref: '#/components/examples/GetRegistryResponse' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Too Many Requests "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Service Unavailable patch: tags: - PaymentRegistries summary: Обновление статуса реестра рублёвых платежей operationId: updateRegistryStatus parameters: - name: registryId in: path description: "Идентификатор реестра (U102702240001209 со статусом ON_SIGNING,\ \ U102702240001210 - PROCESSING)" required: true schema: type: string example: U102702240001209 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRegistryStatusRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RegistryWithContent' examples: example: $ref: '#/components/examples/UpdateRegistryStatusResponse' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Too Many Requests "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Service Unavailable /jp/v1/registries/{registryId}/payments: get: tags: - PaymentRegistries summary: Получение списка рублёвых платежей в реестре operationId: getRegistryPayments parameters: - name: registryId in: path description: Идентификатор реестра required: true schema: type: string example: U102702240001208 - name: status in: query description: | Статусы платежей для фильтрации: * `DRAFT` - Черновик; * `ON_SIGNING` - На подпись; * `TO_BE_SEND` - К отправке; * `PROCESSING` - На исполнении; * `DONE` - Исполнен; * `REJECTED` - Не исполнен; * `DECLINED` - Отклонён; * `DELETED` - Удалён required: false schema: type: array items: type: string enum: - DRAFT - ON_SIGNING - TO_BE_SEND - PROCESSING - DONE - REJECTED - DECLINED - DELETED example: ?status=DRAFT&status=DONE - name: fromDate in: query description: Дата начала периода required: false schema: type: string format: date example: 2024-08-01 - name: toDate in: query description: Дата окончания периода required: false schema: type: string format: date example: 2024-09-01 - name: sort in: query description: "Сортировка результатов поиска. Возможные значения: 'number',\ \ 'date', 'amount'." required: false schema: type: string example: "amount,asc" - name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer default: 100 example: 10 - name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetRegistryPaymentsResponse' examples: example: $ref: '#/components/examples/GetRegistryPaymentsResponse' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Too Many Requests "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Service Unavailable /jp/v1/registries/{registryId}/signatures: post: tags: - PaymentRegistries summary: Наложение подписей на реестр рублёвых платежей operationId: signRegistry parameters: - name: registryId in: path description: Идентификатор реестра required: true schema: type: string example: U102702240001208 requestBody: content: application/json: schema: $ref: '#/components/schemas/RegistrySignRequest' examples: example: $ref: '#/components/examples/SignRegistryRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RegistrySignResponse' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Too Many Requests "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Service Unavailable /jp/v1/registries/{registryId}/signatures/{signatureId}: get: tags: - PaymentRegistries summary: Получение результата наложения подписей operationId: getSignResult parameters: - name: registryId in: path description: Идентификатор реестра required: true schema: type: string example: U102702240001208 - name: signatureId in: path description: Идентификатор запроса на подписание required: true schema: type: string example: 0937b8b1-b226-45f3-b93e-7ba9008db79a responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetRegistrySignResponse' examples: exampleRsa: $ref: '#/components/examples/GetSignResultRsa' examplePartially: $ref: '#/components/examples/GetSignResultPartially' exampleQes: $ref: '#/components/examples/GetSignResultQes' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Too Many Requests "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Service Unavailable /build-projects: get: tags: - Escrow-accounts summary: Получение списка объектов строительства застройщика responses: "200": description: Проекты строительства headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: type: array items: $ref: '#/components/schemas/EscrowBuildProject' examples: example: $ref: '#/components/examples/getBuildProjectsResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /escrow-orders: get: tags: - Escrow-accounts summary: Получение списка заявок застройщика parameters: - name: filterFromDate in: query description: Дата начала периода создания заявки required: true schema: type: string format: date example: 2020-10-23 - name: filterToDate in: query description: Дата окончания периода создания заявки required: true schema: type: string format: date example: 2020-10-23 - name: filterStatuses in: query required: false schema: type: array items: $ref: '#/components/schemas/FilterStatusesV0' - name: limit in: query description: Количество объектов на одной странице required: false schema: type: integer example: 10 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: type: integer example: 2 responses: "200": description: Список заявок застройщика headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: b57610640b625736 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/GetEscrowOrdersV0Response' examples: example: $ref: '#/components/examples/getEscrowOrdersV0ResponseExample' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен post: tags: - Escrow-accounts summary: Создание заявки на резервирование счета эскроу requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEscrowOrderRequest' examples: example: $ref: '#/components/examples/postEscrowOrdersRequestExample' required: true responses: "200": description: Заявка на резервирование счета эскроу успешно создана headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/CreateEscrowOrderResponse' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": content: application/json: schema: $ref: '#/components/schemas/CreateEscrowOrderErrorConflict' "429": description: Cлишком много запросов в заданный период времени "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/escrow-orders: get: tags: - Escrow-accounts summary: Получение списка заявок застройщика parameters: - name: filterFromDate in: query description: Дата начала периода создания заявки required: true schema: type: string format: date example: 2020-10-23 - name: filterToDate in: query description: Дата окончания периода создания заявки required: true schema: type: string format: date example: 2020-10-23 - name: filterStatuses in: query required: false schema: type: array items: $ref: '#/components/schemas/FilterStatusesV1' - name: limit in: query description: Количество объектов на одной странице required: false schema: type: integer example: 10 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: type: integer example: 2 responses: "200": description: Список заявок застройщика headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: b57610640b625736 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/GetEscrowOrdersV1Response' examples: example: $ref: '#/components/examples/getEscrowOrdersV1ResponseExample' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /escrow-orders/{referenceID}: get: tags: - Escrow-accounts summary: Получение детальной информации по заявке на резервирование счета эскроу parameters: - name: referenceID in: path description: Номер заявки на резервирование счета эскроу required: true schema: type: string example: EA10808220000061 responses: "200": description: Детальная информация по заявке на резервирование счета эскроу headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/GetEscrowOrderV0Response' examples: example: $ref: '#/components/examples/getEscrowOrderV0ResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен delete: tags: - Escrow-accounts summary: Удаление заявки в статусе черновик parameters: - name: referenceID in: path description: Номер заявки на резервирование счета эскроу required: true schema: type: string example: EA10808220000061 responses: "204": description: Заявка в статусе черновик успешно удалена headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/escrow-orders/{referenceID}: get: tags: - Escrow-accounts summary: Получение детальной информации по заявке на резервирование счета эскроу parameters: - name: referenceID in: path description: Номер заявки на резервирование счета эскроу required: true schema: type: string example: EA10808220000061 responses: "200": description: Детальная информация по заявке на резервирование счета эскроу headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/GetEscrowOrderV1Response' examples: example: $ref: '#/components/examples/getEscrowOrderV1ResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/escrow-orders/{referenceID}/cancel: post: tags: - Escrow-accounts summary: Отмена заявки на резервирование счета эскроу parameters: - name: referenceID in: path description: Номер заявки на резервирование счета эскроу required: true schema: type: string example: EA10808220000061 responses: "200": description: Успешная отмена заявки headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/CancelOrderV1Response' examples: example: $ref: '#/components/examples/escrowOrderCancelV1ResponseExample' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /escrow-orders/{referenceID}/execute: patch: tags: - Escrow-accounts summary: Отправка признака регистрации ДДУ в Росреестре parameters: - name: referenceID in: path description: Номер заявки на резервирование счета эскроу required: true schema: type: string example: EA10808220000061 requestBody: content: application/json: schema: $ref: '#/components/schemas/ExecuteEscrowOrderRequest' examples: example: $ref: '#/components/examples/postExecuteRequestExample' required: true responses: "204": description: Заявка переведена в статус Исполнено headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/escrow-orders-full: post: tags: - Escrow-accounts summary: Создание заявки с расширенными параметрами на резервирование счета эскроу requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFullOrderV1Request' examples: example: $ref: '#/components/examples/postEscrowOrdersFullRequestExample' required: true responses: "200": description: Заявка на резервирование счета эскроу успешно создана headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/CreateFullOrderV1Response' examples: example: $ref: '#/components/examples/postEscrowOrdersFullResponseExample' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": content: application/json: schema: $ref: '#/components/schemas/CreateEscrowOrderErrorConflict' "429": description: Слишком много запросов в заданный период времени "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/escrow-reports/developers/build-projects: get: tags: - Escrow-accounts summary: Получение списка объектов и этапов строительства застройщика responses: "200": description: Список заявок застройщика headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: b57610640b625736 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/EscrowReportsBuildProjectsV1Response' examples: example: $ref: '#/components/examples/getEscrowReportsV1ResponseExample' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/escrow-reports: post: tags: - Escrow-accounts summary: Генерация отчета по счетам эскроу в соответствии с переданной фильтрацией parameters: - name: limit in: query description: Количество объектов на одной странице required: true schema: type: integer example: 10 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: true schema: type: integer example: 2 - name: periodFrom in: query description: Начальная дата периода для формирования отчета required: true schema: type: string example: 2024-11-11T00:00:00.000Z - name: periodTo in: query description: Конечная дата периода для формирования отчета required: true schema: type: string example: 2024-11-11T00:00:00.000Z requestBody: content: application/json: schema: $ref: '#/components/schemas/EscrowReportsGenerateReportV1Request' examples: example: $ref: '#/components/examples/postEscrowReportsV1RequestExample' required: true responses: "200": description: Сформированный отчёт в формате json headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: c57610640b625732 Content-Type: schema: type: string example: application/json enum: - application/json content: application/json: schema: $ref: '#/components/schemas/EscrowReportsGenerateReportV1Response' examples: example: $ref: '#/components/examples/postEscrowReportsV1ResponseExample' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": content: application/json: schema: $ref: '#/components/schemas/CreateEscrowOrderErrorConflict' "429": description: Слишком много запросов в заданный период времени "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /smart-loans/jp/v1/loan-applications: post: tags: - Loans summary: Отправка данных для скоринга и создания черновика заявки requestBody: content: application/json: schema: $ref: '#/components/schemas/ScoringAny' examples: example: $ref: '#/components/examples/ScoringAnyResponseExample' required: true responses: "200": description: Успешное создание черновика заявки content: application/json: schema: $ref: '#/components/schemas/ScoringAnyResponse' "400": description: Отсутствие обязательных параметров content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Ошибка в JWT (просрочен, отозван и т.д.)" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервера content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /smart-loans/jp/v1/loan-applications/{dealId}/status: get: tags: - Loans summary: Запрос информации о статусе кредитной заявки parameters: - name: dealId in: path description: Уникальный идентификатор заявки (UUIDv4) required: true schema: pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" type: string format: uuid example: aef72949-0e9a-41bf-a11d-abbbcccf1e22 responses: "200": description: Ответ с информацией о статусе content: application/json: schema: $ref: '#/components/schemas/StatusResponse' "400": description: Отсутствие обязательных параметров content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Ошибка в JWT (просрочен, отозван и т.д.)" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервера content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/bonus-numbers: summary: Ресурс для получение бонусных номеров карт клиента description: Получение бонусных номеров карт клиента get: tags: - BonusNumbers summary: Получение бонусных номеров карт клиента operationId: getBonusNumbers responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BonusNumbersResponse' examples: example: $ref: '#/components/examples/BonusNumbersResponse' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/user-compliance: summary: Проверка актуальности сведений description: Метод возвращает результат проверки актуальности сведений клиента. get: tags: - UserCompliance summary: Получение результатов проверок актуальности сведений клиента operationId: getUserCompliance responses: "200": description: Успешный запрос. Возвращает результат проверки актуальности сведений клиента. content: application/json: schema: $ref: '#/components/schemas/UserComplianceGetResponse' examples: positive: $ref: '#/components/examples/successGetUserCompliancePositive' negative: $ref: '#/components/examples/successGetUserComplianceNegative' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/user-compliance/operations: post: tags: - UserCompliance summary: Инициация асинхронной проверки compliance description: | Принимает запрос на проверку пользователя и возвращает operationId. Результат проверки будет отправлен по переданному callbackUri. operationId: initiateUserCompliance requestBody: content: application/json: schema: $ref: '#/components/schemas/ComplianceRequest' required: true responses: "202": description: Запрос принят к асинхронной обработке. Возвращает operationId. content: application/json: schema: $ref: '#/components/schemas/OperationResponse' examples: success: $ref: '#/components/examples/OperationResponseSuccess' "400": description: Неверные или отсутствующие параметры или тело запроса. content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при приёме запроса. content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен. /pp/v1/user-compliance/operations/simplified: post: tags: - UserCompliance summary: Инициация асинхронной упрощенной проверки compliance description: | Принимает запрос на проверку пользователя и возвращает operationId. Результат проверки будет отправлен по переданному callbackUri. operationId: initiateUserCompliance requestBody: content: application/json: schema: $ref: '#/components/schemas/ComplianceRequest' required: true responses: "202": description: Запрос принят к асинхронной обработке. Возвращает operationId. content: application/json: schema: $ref: '#/components/schemas/OperationResponse_1' examples: success: $ref: '#/components/examples/OperationResponseSuccess' "400": description: Неверные или отсутствующие параметры или тело запроса. content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при приёме запроса. content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен. /v2/webhooks: get: tags: - Webhooks summary: Получение списка вебхуков parameters: - name: object in: query description: Объект required: true schema: type: string example: ul_transaction_default - name: limit in: query description: Количество объектов на одной странице required: false schema: type: integer example: 1000 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: type: integer example: 0 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponeWebhooks' examples: example: $ref: '#/components/examples/ResponeWebhooks' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен post: tags: - Webhooks summary: Создание вебхука requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPostWebhook' examples: example: $ref: '#/components/examples/RequestPostWebhook' responses: "201": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponeWebhook' examples: example: $ref: '#/components/examples/ResponeWebhook' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /v2/webhooks/{id}: get: tags: - Webhooks summary: Получение вебхука parameters: - name: object in: query description: Объект required: true schema: type: string example: ul_transaction_default - name: id in: path description: Идентификатор вебхука required: true schema: type: string example: f7490296-1ae1-11ec-9621-0242ac130002 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponeWebhook' examples: example: $ref: '#/components/examples/ResponeWebhook' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен put: tags: - Webhooks summary: Редактирование вебхука parameters: - name: id in: path description: Идентификатор вебхука required: true schema: type: string example: f7490296-1ae1-11ec-9621-0242ac130002 requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPutWebhook' examples: example: $ref: '#/components/examples/RequestPutWebhook' responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponeWebhook' examples: example: $ref: '#/components/examples/ResponeWebhook' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен delete: tags: - Webhooks summary: Удаление вебхука parameters: - name: object in: query description: Объект required: true schema: type: string example: ul_transaction_default - name: id in: path description: Идентификатор вебхука required: true schema: type: string example: f7490296-1ae1-11ec-9621-0242ac130002 responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /v1/webhooks-events: post: tags: - Webhooks summary: "Метод, имитирующий создание транзакций, для проверки работоспособн\ ости вебхука" requestBody: content: application/json: schema: $ref: '#/components/schemas/PostWebhooksEvent' responses: "201": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /semp/v1/payouts/registries/receipts-and-payouts: post: tags: - Payouts-processing summary: Провести выплаты на заданные суммы с одновременной декларацией доходов и формированием чеков operationId: addReceiptAndPayoutList requestBody: content: application/json: schema: $ref: '#/components/schemas/ReceiptAndPayoutList' examples: example: $ref: '#/components/examples/ReceiptAndPayoutListRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/payouts/registries/receipts: post: tags: - Payouts-processing summary: Задекларировать доходы с получением чеков по ранее проведенным выплатам operationId: addReceiptList requestBody: content: application/json: schema: $ref: '#/components/schemas/ReceiptList' examples: example: $ref: '#/components/examples/ReceiptListRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/payouts/registries/with-selfemployed-check-status: post: tags: - Payouts-processing summary: "Провести выплаты самозанятым, с предварительной проверкой их стату\ са в ФНС, но без декларации доходов и формирования чеков" operationId: addCheckSelfemployedStatusAndPayoutList requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckSelfemployedStatusAndPayoutList' examples: example: $ref: '#/components/examples/CheckSelfemployedStatusAndPayoutListRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/payouts/registries/payouts: post: tags: - Payouts-processing summary: Провести выплаты без проверки статуса в ФНС и декларации доходов operationId: addPayoutList requestBody: content: application/json: schema: $ref: '#/components/schemas/PayoutList' examples: example: $ref: '#/components/examples/PayoutListRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/payouts/registries/{requestId}: get: tags: - Payouts-processing summary: "Получить статус обработки выплат, загруженных в систему" operationId: getPayoutListState parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID' - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PayoutListState' examples: example: $ref: '#/components/examples/PayoutListStateResponse' "202": description: REGISTRY IS LOADING "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/payouts/registries/cancel-receipts: post: tags: - Payouts-processing summary: Аннулировать чеки в ФНС operationId: addCancelReceiptsList requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelReceiptList' examples: example: $ref: '#/components/examples/CancelReceiptRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse' examples: example: $ref: ../examples/payouts-processing.yaml#/components/examples/ListResponse "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/payouts/registries/cancel-receipts/{requestId}: get: tags: - Payouts-processing summary: Получить статус аннулирования чеков по загруженному списку operationId: getCancelReceiptListState parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID' - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PayoutListState' examples: example: $ref: '#/components/examples/CancelReceiptStateResponse' "202": description: REGISTRY IS LOADING "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/payouts: get: tags: - Payouts-processing summary: "Получить список выплат, загруженных в систему" operationId: getPayouts parameters: - name: createdDate in: query description: Дата создания выплаты required: false schema: type: string format: date example: 2022-03-02 - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PayoutResponse' examples: example: $ref: '#/components/examples/PayoutResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/payouts/selfemployed/{vatin}: get: tags: - Payouts-processing summary: Получить список выплат по самозанятому operationId: getPayoutSelfemployedInfo parameters: - name: vatin in: path description: ИНН самозанятого required: true schema: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string example: "112233445566" - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PayoutResponse' examples: example: $ref: '#/components/examples/PayoutVatinResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/selfemployed/registries/add-selfemployed: post: tags: - Selfemployed summary: Добавить самозанятых в систему operationId: addSelfemployedList requestBody: content: application/json: schema: $ref: '#/components/schemas/SelfemployedList' examples: example: $ref: '#/components/examples/SelfemployedListRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse_1' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/registries/add-selfemployed/{requestId}: get: tags: - Selfemployed summary: Получить статус добавления самозанятых в систему operationId: getSelfemployedListState parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_1' - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SelfemployedListState' examples: example: $ref: '#/components/examples/SelfemployedListStateResponse' "202": description: REGISTRY IS LOADING "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/taxpayer-statuses: post: tags: - Selfemployed summary: Запросить статус самозанятого из ФНС operationId: getSelfemployedFtsStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestTaxpayerStatusList' examples: example: $ref: '#/components/examples/RequestTaxpayerStatusList' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse_1' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/taxpayer-statuses/{requestId}: get: tags: - Selfemployed summary: Запросить статус самозанятого из ФНС operationId: getTaxpayerStatus parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_1' - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TaxpayerListStatus' examples: example: $ref: '#/components/examples/TaxpayerListStatusResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/accruals-and-debts: post: tags: - Selfemployed summary: Запросить данные о неоплаченных налоговых начислениях и задолженностях самозанятого operationId: getAccrualAndDebt requestBody: content: application/json: schema: $ref: '#/components/schemas/AccrualList' examples: example: $ref: '#/components/examples/AccrualAndDebtListStatusRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse_1' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/accruals-and-debts/{requestId}: get: tags: - Selfemployed summary: Получить данные о неоплаченных налоговых начислениях и задолженностях самозанятого operationId: getAccrualAndDebtFronFtsStatus parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_1' - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AccrualAndDebtListStatus' examples: example: $ref: '#/components/examples/AccrualAndDebtListStatusResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/payment-documents: post: tags: - Selfemployed summary: "Запросить данные платежных документов на оплату налоговых начислен\ ий, задолженности и пеней самозанятого" operationId: getPaymentDocuments requestBody: content: application/json: schema: $ref: '#/components/schemas/AccrualList' examples: example: $ref: '#/components/examples/AccrualAndDebtListStatusRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse_1' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/payment-documents/{requestId}: get: tags: - Selfemployed summary: "Получить данные платежных документов на оплату налоговых начислени\ й, задолженности и пеней самозанятого" operationId: getPaymentDocumentFromFts parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_1' - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить'" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentDocumentListStatus' examples: example: $ref: '#/components/examples/PaymentDocumentListStatusResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed: get: tags: - Selfemployed summary: "Получение списка самозанятых, загруженных в систему" operationId: getSelfemployed parameters: - name: fromDate in: query description: "Дата загрузки кандидата в систему, с" required: false schema: type: string format: date example: 2022-03-02 - name: toDate in: query description: "Дата загрузки кандидата в систему, по" required: false schema: type: string format: date example: 2022-03-02 - name: limit in: query description: Количество объектов на одной странице required: false schema: maximum: 1000 minimum: 1 type: integer example: 1000 default: 100 - name: offset in: query description: "Количество объектов в списке, которые необходимо пропустить" required: false schema: minimum: 0 type: integer example: 0 default: 0 example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SelfemployedResponse' examples: example: $ref: '#/components/examples/SelfemployedListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/selfemployed/{vatin}: get: tags: - Selfemployed summary: Получение детальной информации о самозанятом operationId: getSelfemployedInfo parameters: - name: vatin in: path description: ИНН самозанятого required: true schema: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string example: "112233445566" responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SelfemployedInfo' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] put: tags: - Selfemployed summary: Повторно привязать самозанятого к партнеру operationId: requestSelfemployedUniqueRights parameters: - name: vatin in: path description: ИНН самозанятого required: true schema: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string example: "112233445566" requestBody: content: aplication/json: schema: $ref: '#/components/schemas/RequestSelfemployedVatin' examples: example: $ref: '#/components/examples/RequestSelfemployedVatin' responses: "201": description: CREATED "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/selfemployed/taxpayer-account-info: post: tags: - Selfemployed summary: Запросить информацию о состоянии Лицевого счета НП НПД operationId: getTaxpayerAccountStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxpayerAccountStatusRequest' examples: example: $ref: '#/components/examples/TaxpayerAccountInfoRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse_1' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/selfemployed/taxpayer-account-info/{requestId}: get: tags: - Selfemployed summary: Получить информацию о состоянии Лицевого счета НП НПД operationId: getTaxpayerAccountStatusFromFns parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_1' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TaxpayerAccountStatusResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/selfemployed/income-for-period: post: tags: - Selfemployed summary: Запросить информацию по доходу НП НПД за период operationId: getIncomeForPeriod requestBody: content: application/json: schema: $ref: '#/components/schemas/IncomeForPeriodRequest' examples: example: $ref: '#/components/examples/IncomeForPeriodRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse_1' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/selfemployed/income-for-period/{requestId}: get: tags: - Selfemployed summary: Получить информацию по доходу НП НПД за период operationId: getIncomeForPeriodFromFns parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_1' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/IncomeForPeriodResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/selfemployed/income: post: tags: - Selfemployed summary: Запросить информацию по зарегистрированным доходам с разбивкой по чекам operationId: getIncomeV2 requestBody: content: application/json: schema: $ref: '#/components/schemas/IncomeV2Request' examples: example: $ref: '#/components/examples/IncomeV2Request' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListResponse_1' examples: example: $ref: '#/components/examples/ListResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/selfemployed/income/{requestId}: get: tags: - Selfemployed summary: Получить информацию по зарегистрированным доходам с разбивкой по чекам operationId: getIncomeV2FromFns parameters: - name: requestId in: path description: Уникальный идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_1' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetIncomeV2Response' examples: example: $ref: '#/components/examples/GetIncomeV2Response' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' security: - bearerAuth: [] /semp/v1/agreement-pages: post: tags: - Selfemployed-Agreements summary: Создать параметризируемую ссылку на страницу оформления соглашения с Альфа-Банком. operationId: createAgreementPage requestBody: content: application/json: schema: $ref: '#/components/schemas/AgreementPage' examples: example: $ref: '#/components/examples/AgreementPageRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AgreementPageUrl' examples: example: $ref: '#/components/examples/AgreementPageResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/dictionary/activities: get: tags: - Selfemployed-Dictionaries summary: Получить справочные данные по видам деятельности responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Activities' examples: example: $ref: '#/components/examples/ActivitiesResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/dictionary/regions: get: tags: - Selfemployed-Dictionaries summary: Получить справочные данные по регионам ведения деятельности operationId: getRegions responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Regions' examples: example: $ref: '#/components/examples/RegionsResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /semp/v1/dictionary/sbp-banks: get: tags: - Selfemployed-Dictionaries summary: Получить список банков-участников СБП responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SbpBanks' examples: example: $ref: '#/components/examples/SbpBanksResponse' "400": description: BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_2' "401": description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized_1' "403": description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/ErrorForbidden' "404": description: NOT FOUND content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound_1' "429": description: TOO MANY REQUESTS content: application/json: schema: $ref: '#/components/schemas/ErrorTooManyRequests' "500": description: INTERNAL SERVER ERROR content: application/json: schema: $ref: '#/components/schemas/ErrorInternal_1' "503": description: SERVICE UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/ErrorServiceUnavailable' /jp/v1/poa/{poaNumber}/inn/{inn}/request: post: tags: - Poa summary: Создать запрос на выгрузку МЧД operationId: createPoaRequest parameters: - name: poaNumber in: path description: Номер МЧД required: true schema: $ref: '#/components/schemas/PoaNumber' - name: inn in: path description: ИНН доверителя required: true schema: $ref: '#/components/schemas/Vatin_1' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CreatePoaResponse' examples: example: $ref: '#/components/examples/CreatePoaResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest_3' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/poa/requests/{requestUuid}/status: get: tags: - Poa summary: Получить статус запроса выгрузки МЧД operationId: getPoaRequestStatus parameters: - name: requestUuid in: path required: true schema: $ref: '#/components/schemas/requestUuid' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetPoaRequestStatusResponse' examples: example: $ref: '#/components/examples/GetPoaRequestStatusResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/RequestPoaNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/poa/requests/{requestUuid}/download: get: tags: - Poa summary: "Выгрузить МЧД (ZIP, PDF)" operationId: getPoa parameters: - name: requestUuid in: path required: true schema: $ref: '#/components/schemas/requestUuid' - name: format in: query description: | Формат выгрузки МЧД: * `ZIP` - ZIP-архив; * `PDF` - PDF-файл. required: true responses: "200": description: OK content: application/pdf: schema: type: string format: binary application/zip: schema: type: string format: binary "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/RequestDownloadError' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/poa/{poaNumber}/status: get: tags: - Poa summary: Запросить статус МЧД operationId: getPoaStatus parameters: - name: poaNumber in: path description: Номер МЧД required: true schema: $ref: '#/components/schemas/PoaNumber' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetPoaStatusResponse' examples: example: $ref: '#/components/examples/GetPoaStatusResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/PoaNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries/nominal-accounts: get: tags: - Beneficiaries summary: Получить список номинальных счетов клиента description: Метод позволяет получить список номинальных счетов клиента operationId: getAccounts responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetAccounts' examples: example: $ref: '#/components/examples/GetAccounts' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries/requests/{requestId}: get: tags: - Beneficiaries summary: Получить статус запроса description: Метод позволяет получить статус запроса по `requestId` operationId: getRequestStatus parameters: - name: requestId in: path description: Идентификатор запроса required: true schema: $ref: '#/components/schemas/UUID_2' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RequestResponse' examples: example1: $ref: '#/components/examples/StatusPENDINGResponse' example2: $ref: '#/components/examples/StatusFAILEDResponse' example3: $ref: '#/components/examples/StatusCOMPLETEResponse' example4: $ref: '#/components/examples/StatusResultDataResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries: get: tags: - Beneficiaries summary: Получить список бенефициаров номинального счета description: Метод позволяет получить список бенефициаров номинального счета operationId: getBeneficiaryList parameters: - name: accountNumber in: query description: Номер номинального счета required: true schema: $ref: '#/components/schemas/AccountNumber' - name: type in: query description: | Тип бенефициара: * `FL_RESIDENT` - Физ. лицо, резидент; * `UL_RESIDENT` - Юр. лицо, резидент. required: true schema: $ref: '#/components/schemas/BeneficiaryType' - name: firstName in: query description: Имя required: false schema: maxLength: 64 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string example: Иван - name: middleName in: query description: Отчество required: false schema: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string example: Иванoвич - name: lastName in: query description: Фамилия required: false schema: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string example: Иванов - name: inn in: query description: ИНН required: false schema: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string example: "112233445566" - name: kpp in: query description: КПП required: false schema: pattern: "^(\\d{9})$" type: string example: "123456789" - name: name in: query description: Наименование организации required: false schema: type: string example: Акционерное общество «Ромашка» - name: ogrn in: query description: Основной государственный регистрационный номер required: false schema: pattern: "^(\\d{13})$" type: string example: "1122334455667" - name: isVpr in: query description: | Признак ВПР: * `true` - является выгодоприобретателем; * `false` - не является выгодоприобретателем. required: false schema: type: boolean - name: isBeneficiary in: query description: | Признак бенефициара: * `true` - является бенефициаром; * `false` - является универсальным реципиентом. required: false schema: type: boolean - name: isActive in: query description: | Признак активности бенефициара: * `true` - активен; * `false` - деактивирован. required: false schema: type: boolean - name: date in: query description: Дата выборки required: false schema: $ref: '#/components/schemas/Date' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BeneficiaryListResponse' examples: example: $ref: '#/components/examples/BeneficiaryListResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен post: tags: - Beneficiaries summary: Создать запрос на регистрацию бенефициара description: |- Метод позволяет зарегистрировать бенефициара в системе. В ответ метод возвращает идентификатор запроса (requestId), который при достижении статуса `COMPLETE` будет присвоен зарегистрированному бенефициару в качестве идентификатора `beneficiaryId` _Примечание_: В зависимости от типа бенефициара необходимо по-разному заполнять данные. Примеры необходимых данных по каждому из типов внизу. operationId: addBeneficiaryRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/BeneficiaryRequest' examples: example1: $ref: '#/components/examples/AddFLRequest' example2: $ref: '#/components/examples/AddULRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RequestResponse' examples: example: $ref: '#/components/examples/RequestResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries/{beneficiaryId}: get: tags: - Beneficiaries summary: Получить информацию о бенефициаре description: Метод позволяет получить информацию о бенефициаре по `beneficiaryId`. operationId: getBeneficiary parameters: - name: beneficiaryId in: path description: Идентификатор бенефициара required: true schema: $ref: '#/components/schemas/UUID_2' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BeneficiaryResponse' examples: example1: $ref: '#/components/examples/GetFLResponse' example2: $ref: '#/components/examples/GetULResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен put: tags: - Beneficiaries summary: Создать запрос на изменение бенефициара description: Метод позволяет изменить информацию о бенефициаре по `beneficiaryId`. operationId: changeBeneficiaryRequest parameters: - name: beneficiaryId in: path description: Идентификатор бенефициара required: true schema: $ref: '#/components/schemas/UUID_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBeneficiaryRequest' examples: example1: $ref: '#/components/examples/ChangeFLRequest' example2: $ref: '#/components/examples/ChangeULRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RequestResponse' examples: example: $ref: '#/components/examples/RequestResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries/{beneficiaryId}/scoring: post: tags: - Beneficiaries summary: Создать запрос на проверку бенефициара description: Метод позволяет запустить актуализацию проверки скоринга бенефициара по `beneficiaryId`. operationId: beneficiaryScoringRequest parameters: - name: beneficiaryId in: path description: Идентификатор бенефициара required: true schema: $ref: '#/components/schemas/UUID_2' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RequestResponse' examples: example: $ref: '#/components/examples/RequestResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries/{beneficiaryId}/requisites: post: tags: - Beneficiaries summary: Добавить платежные реквизиты бенефициара description: |- Метод позволяет добавить платежные реквизиты бенефициара по `beneficiaryId`. _Примечание_: Первые добавленные реквизиты автоматически назначаются основными для бенефициара. operationId: addBeneficiaryRequisites parameters: - name: beneficiaryId in: path description: Идентификатор бенефициара required: true schema: $ref: '#/components/schemas/UUID_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequisiteRequest' examples: example1: $ref: '#/components/examples/RequisiteAccountRequest' example2: $ref: '#/components/examples/RequisitePhoneRequest' example3: $ref: '#/components/examples/RequisitePanRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RequisiteResponse' examples: example1: $ref: '#/components/examples/RequisiteAccountResponse' example2: $ref: '#/components/examples/RequisitePhoneResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries/{beneficiaryId}/requisites/{requisiteId}: put: tags: - Beneficiaries summary: Изменить признаки платежных реквизитов бенефициара description: |- Метод позволяет изменить признаки платежных реквизитов бенефициара по `beneficiaryId` и `requisiteId`. _Примечание_: Хотя бы один активный реквизит бенефициара должен быть основным. operationId: changeBeneficiaryRequisites parameters: - name: beneficiaryId in: path description: Идентификатор бенефициара required: true schema: $ref: '#/components/schemas/UUID_2' - name: requisiteId in: path description: Идентификатор реквизита required: true schema: $ref: '#/components/schemas/UUID_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequisiteSignRequest' examples: example1: $ref: '#/components/examples/IsActiveRequest' example2: $ref: '#/components/examples/IsMainRequest' responses: "200": description: OK "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/beneficiaries/{beneficiaryId}/balance: get: tags: - Beneficiaries summary: Получить баланс бенефициара description: Метод позволяет получить баланс бенефициара по `beneficiaryId`. operationId: getBeneficiaryBalance parameters: - name: beneficiaryId in: path description: Идентификатор бенефициара required: true schema: $ref: '#/components/schemas/UUID_2' - name: accountNumber in: query description: Номер номинального счета required: true schema: $ref: '#/components/schemas/AccountNumber' - name: date in: query description: Дата required: true schema: $ref: '#/components/schemas/Date' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BalanceResponse' examples: example: $ref: '#/components/examples/BalanceResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/accounts: summary: Метод предназначен для получения всех счетов клиента Банка description: Счета клиента get: tags: - Accounts summary: Получение списка счетов клиента operationId: getAccounts responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Accounts_1' examples: accountGet: $ref: '#/components/examples/successAccountsGet' accountGetEmpty: summary: Нет Счетов value: accounts: [] "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/accounts/{accountNumber}: summary: "Метод предназначен для получения информации о банковском счёте, пере\ данном в path-параметре" description: Информация по счёту get: tags: - Accounts summary: Получение информации по счёту operationId: getAccountByNumber parameters: - name: accountNumber in: path description: Номер счета required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Account_2' examples: accountGet: $ref: '#/components/examples/successAccountByNumber' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/accounts/{accountNumber}/requisites: summary: "Метод предназначен для получения банковских реквизитов счёта, переда\ нного в запросе" description: Реквизиты счёта get: tags: - Accounts summary: Получение реквизитов счёта operationId: getAccountRequisites parameters: - name: accountNumber in: path description: Номер счета required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AccountRequisites' examples: accountRequsitesRurGet: $ref: '#/components/examples/accountRequisitesRurGet' accountRequsitesForeignGet: $ref: '#/components/examples/accountRequisitesForeignGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/cards: summary: Метод предназначен для получения всех карт клиента Банка description: Карты клиента get: tags: - Cards summary: Получение списка карт клиента operationId: getCards parameters: - name: cardFilter in: query description: Фильтр карт required: false responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Cards' examples: successCardsGet: $ref: '#/components/examples/successCardsGet' cardsGetEmpty: summary: Нет карт value: cards: [] "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/cards/{cardId}/actions: description: Операции и действия доступные по определенной карте get: tags: - Cards summary: Получение списка доступных действий по карте operationId: getCardActions parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CardActions' examples: getCardAvailableActionsSuccessResponse: $ref: '#/components/examples/GetCardActionsSuccessResponse' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен put: tags: - Cards summary: Подтверждение действия по карте operationId: confirmCardAction parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardActionConfirmBody' required: true responses: "200": description: OK "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен post: tags: - Cards summary: Выполнение действия по карте operationId: createCardAction parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardActionCreateBody' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CardActionCreateResponse' examples: cardBlockActionCreateSuccessResponse: $ref: '#/components/examples/CardActionCreateSuccessResponse' /pp/v1/cards/{cardId}/tariffs: summary: Метод предназначен для получения информации о стоимости обслуживания и снятия наличных description: Тариф по дебетовой карте get: tags: - Cards summary: Получение тарифов по карте operationId: getTariffs parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Tariffs' examples: tariffsGet: $ref: '#/components/examples/successTariffsGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/cards/{cardId}/subscriptions: summary: Метод предназначен для получения информации о подключенных уведомлениях по операциям description: Уведомления по операциям get: tags: - Cards summary: Получение информации о подключенных уведомлениях по карте operationId: getSubscriptions parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Subscriptions' examples: successSubscriptionsGet: $ref: '#/components/examples/successSubscriptionsGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/operations: summary: Ресурс для работы с историей операций description: История операций get: tags: - OperationsHistory & Statements summary: Получение истории операций operationId: getOperationsHistory parameters: - name: dateFrom in: query description: Дата начала запроса истории операций (включительно) required: false schema: type: string format: date - name: dateTo in: query description: Дата окончания запроса истории операций (включительно) required: false schema: type: string format: date - name: accounts in: query description: Массив номеров счетов для выборки истории операций required: false schema: type: array items: type: string description: Номер счёта - name: cards in: query description: Массив идентификаторов пластиковых карт для выборки истории операций required: false schema: type: array items: type: string description: Идентификатор пластиковой карты - name: operationDirection in: query description: "Направление движения денежных средств: INCOME - приход/попол\ нение, EXPENSE - расход/списание" required: false schema: type: string enum: - EXPENSE - INCOME - name: offset in: query description: Параметр пагинации - Смещение от начала required: false schema: type: integer - name: limit in: query description: Параметр пагинации - Запрашиваемое кол-во элементов на странице required: false schema: type: integer responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/OperationsHistory' examples: example: $ref: '#/components/examples/successOperationsHistoryGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/operations/{id}: summary: Ресурс для работы с одной операцией description: Информация об операции get: tags: - OperationsHistory & Statements summary: Получение детальной информации по операции operationId: getOperationDetails parameters: - name: id in: path description: Идентификатор операции required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/OperationDetails' examples: example: $ref: '#/components/examples/successOperationDetailsGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/reports/type/account: summary: Метод предназначен для заказа выписки по счету description: Выписка по счету post: tags: - OperationsHistory & Statements summary: Заказ выписки по счету operationId: createAccountStatementReport requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountReportRequest' required: true responses: "201": description: OK content: application/json: schema: $ref: '#/components/schemas/Report' examples: successReport: $ref: '#/components/examples/successCreateAccountReport' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/reports/type/credit/statement: summary: Метод предназначен для заказа выписки по кредиту description: Выписка по кредиту post: tags: - OperationsHistory & Statements summary: Заказ выписки по кредиту operationId: createCreditProductReport requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditProductReportRequest' required: true responses: "201": description: OK content: application/json: schema: $ref: '#/components/schemas/Report' examples: successReport: $ref: '#/components/examples/createCreditProductReport' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/reports/type/account/balance/eng: summary: Метод предназначен для заказа справки о доступном остатке на английском description: Справка о доступном остатке на английском post: tags: - Reports summary: Заказ справки о доступном остатке на английском operationId: createAccountBalanceEngReport requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountBalanceEngReportRequest' required: true responses: "201": description: OK content: application/json: schema: $ref: '#/components/schemas/Report' examples: successReport: $ref: '#/components/examples/successCreateAccountBalanceEngReport' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/reports/type/account/balance/rus: summary: Метод предназначен для заказа справки о доступном остатке на русском description: Справка о доступном остатке на русском post: tags: - Reports summary: Заказ справки о доступном остатке на русском operationId: createAccountBalanceRurReport requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountBalanceRurReportRequest' required: true responses: "201": description: OK content: application/json: schema: $ref: '#/components/schemas/Report' examples: successReport: $ref: '#/components/examples/successCreateAccountBalanceRurReport' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/reports/type/credit/closed: summary: Метод предназначен для заказа справки о закрытых кредитах description: Справка о закрытых кредитах post: tags: - Reports summary: Заказ справки о закрытых кредитах operationId: createClosedCreditsReport responses: "201": description: OK content: application/json: schema: $ref: '#/components/schemas/Report' examples: successReport: $ref: '#/components/examples/createClosedCreditsReport' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/reports/type/credit/info: summary: Метод предназначен для заказа справки о наличии или отсутствии кредитов description: Справка о наличии или отсутствии кредитов post: tags: - Reports summary: Заказ справки о наличии или отсутствии кредитов operationId: createCreditInfoReport responses: "201": description: OK content: application/json: schema: $ref: '#/components/schemas/Report' examples: successReport: $ref: '#/components/examples/createCreditInfoReport' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/reports/type/deposit: summary: Метод предназначен для заказа справки по депозиту description: Справка по депозиту post: tags: - Reports summary: Заказ справки по депозиту operationId: createDepositReport requestBody: content: application/json: schema: $ref: '#/components/schemas/DepositReportRequest' required: true responses: "201": description: OK content: application/json: schema: $ref: '#/components/schemas/Report' examples: successReport: $ref: '#/components/examples/successCreateDepositReport' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/limits/general: summary: Метод предназначен для получения основных лимитов клиента Банка description: Получение лимитов get: tags: - Limits summary: Получение базовых лимитов клиента operationId: getGeneralLimits responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Limits' examples: example: $ref: '#/components/examples/successLimits' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/cards/{cardId}/user-limits: summary: "Методы предназначены для получения лимитов, установленных клиентом Б\ анка, их добавления и удаления" description: Получение лимитов get: tags: - Limits summary: Получение пользовательских лимитов клиента operationId: getUserLimits parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/UserLimitsGetResponse' examples: example: $ref: '#/components/examples/successGetUserLimits' post: tags: - Limits summary: Создание пользовательского лимита operationId: createUserLimit parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserLimitSeed' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/UserLimitId' examples: example: $ref: '#/components/examples/successCreateUserLimit' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/cards/{cardId}/user-limits/{limitId}: summary: "Методы предназначены для удаления лимитов, установленных клиентом Ба\ нка" description: Удаление лимитов установленных пользователем delete: tags: - Limits summary: Удаление пользовательского лимита operationId: deleteUserLimit parameters: - name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string - name: limitId in: path description: Идентификатор пользовательского лимита required: true schema: type: integer responses: "200": description: OK "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/bonus-accounts: summary: Ресурс для работы с бонусными счетами клиента description: Бонусные счета клиента get: tags: - Loyalty summary: Получение списка бонусных счетов operationId: getLoyaltyAccounts responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LoyaltyAccount' examples: example: $ref: '#/components/examples/successLoyaltyAccountsGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/bonus-account-transactions: summary: Ресурс для работы с историей начислений лояльности description: История начисления лояльности по транзакциям post: tags: - Loyalty summary: Получение истории начисления баллов лояльности operationId: getLoyaltyTransactions requestBody: description: Запрос для фильтрации content: application/json: schema: $ref: '#/components/schemas/LoyaltyFilter' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LoyaltyTransaction' examples: example: $ref: '#/components/examples/successLoyaltyTransactionsGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/bonus-accounts/{accountNumber}: summary: Ресурс для получения информации о начислениях по бонусному счету description: Начисление кешбэка по бонусному счету клиента get: tags: - Loyalty summary: Получение информации о начислениях по бонусному счету operationId: getAccountCashback parameters: - name: accountNumber in: path description: Номер счета required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AccountCashback' examples: example: $ref: '#/components/examples/successAccountCashbackGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms: summary: Метод предназначен для отправки необходимой информации в Банк для оформления заявки на дебетовую карту description: Формирование заявки для заказа карты post: tags: - DebitCards summary: Формирование заявки для заказа карты operationId: createForm requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFormRequest' examples: example: $ref: '#/components/examples/CreateFormRequest' required: true responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/CreateFormResponse' examples: createForm: $ref: '#/components/examples/CreateFormResponse' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms/{formId}/verification-passport: summary: Метод предназначен для отправки паспортных данных пользователя с целью его однозначной идентификации description: Уточнение паспортных данных post: tags: - DebitCards summary: Уточнение паспортных данных operationId: verifyPassport parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyPassportRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VerifyPassportResponse' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms/{formId}/verification-sms: summary: Метод предназначен для отправки SMS кода с целью верификации определённого действия по процессу оформления заявки на дебетовую карту description: Отправка SMS-кода post: tags: - DebitCards summary: Отправка SMS-кода operationId: verifySms parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 - name: phase in: query description: Этап процесса оформления заявки required: true schema: $ref: '#/components/schemas/PhaseId' requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifySmsRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/verifySms_200_response' examples: verifySmsFormCreation: $ref: '#/components/examples/VerifySmsFormCreation' verifySmsFormCompletion: $ref: '#/components/examples/VerifySmsFormCompletion' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "426": description: Данные по заявке устарели content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: UpgradeRequired: $ref: '#/components/examples/UpgradeRequired' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms/{formId}/resending-sms: summary: Метод предназначен для повторной отправки SMS кода пользователю description: Повторная отправка SMS-кода пользователю post: tags: - DebitCards summary: Повторная отправка SMS-кода пользователю operationId: resendSms parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 - name: phase in: query description: Этап процесса оформления заявки required: true schema: $ref: '#/components/schemas/PhaseId' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/resendSms_200_response' examples: resendSms: $ref: '#/components/examples/ResendSms' ResendSmsStep2: $ref: '#/components/examples/ResendSmsStep2' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Превышено количество обращений в единицу времени к сервису dt-product-api content: application/json: schema: $ref: '#/components/schemas/TooManyRequests' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms/{formId}/draft: summary: "Метод предназначен для проверки заявки по formId, является ли она че\ рновиком" description: Проверка наличия у заявки состояния "Черновик" get: tags: - DebitCards summary: Проверка наличия у заявки состояния "Черновик" operationId: checkDraft parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CheckDraftResponse' examples: checkDraft: $ref: '#/components/examples/CheckDraftSuccess' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Заявка не находится в статусе 'Черновик' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: ConflictingRequest: $ref: '#/components/examples/ConflictingRequest' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms/{formId}/delivery-type: summary: "Метод предназначен для получения способов доставки пластика по задан\ ному адресу, координатам, КЛАДР (Классификатор адресов РФ), радиусу, идентиф\ икатору заявки" description: Получение способов доставки get: tags: - DebitCards summary: Получение способов доставки operationId: deliveryTypes parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 - name: accuracy in: query description: Точность определения координат required: true schema: type: integer example: 5 - name: address in: query description: "Адрес, в радиусе которого ведется поиск" required: true schema: type: string example: "г. Москва, ул. Анохина, д. 9" - name: kladrId in: query description: КЛАДР города доставки required: true schema: type: string example: "7700000000000" - name: latitude in: query description: Широта required: true schema: type: number example: 55.659348 - name: longitude in: query description: Долгота required: true schema: type: number example: 37.472997 - name: radius in: query description: "Радиус поиска относительно указанных координат, м." required: false schema: type: number example: 3000 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DeliveryTypesResponse' examples: deliveryTypes: $ref: '#/components/examples/DeliveryTypesSuccess' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms/{formId}/time-slots: summary: Методы предназначены для получение списка свободных тайм-слотов и бронирования тайм-слота для курьерской доставки по идентификатору заявки formId description: Получение списка тайм-слотов для курьерской доставки get: tags: - DebitCards summary: Получение списка тайм-слотов для курьерской доставки operationId: timeSlots parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 - name: isUnnamed in: query description: Признак неименной/именной карты required: true schema: type: boolean example: true - name: cityId in: query description: Код города доставки required: true schema: type: string example: "21" responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TimeSlotsResponse' examples: timeSlots: $ref: '#/components/examples/TimeSlotsSuccess' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Заявка не находится в статусе 'Черновик' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: ConflictingRequest: $ref: '#/components/examples/ConflictingRequest' "426": description: Данные по заявке устарели content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: UpgradeRequired: $ref: '#/components/examples/UpgradeRequired' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен post: tags: - DebitCards summary: Бронирование тайм-слота для курьерской доставки operationId: bookTimeSlot parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 requestBody: content: application/json: schema: $ref: '#/components/schemas/BookTimeSlotRequest' required: true responses: "200": description: OK "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/v1/debit-cards/forms/{formId}/confirmation: summary: Метод предназначен для завершения оформления заявки на выпуск дебетовой карты description: Завершение формирования заявки post: tags: - DebitCards summary: Завершение формирования заявки operationId: formConfirmation parameters: - name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 requestBody: content: application/json: schema: $ref: '#/components/schemas/FormConfirmationRequest' examples: example: $ref: '#/components/examples/FormConfirmationRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FormConfirmationResponse' examples: formConfirmationSuccess: $ref: '#/components/examples/FormConfirmationSuccess' formConfirmationNeedSms: $ref: '#/components/examples/FormConfirmationNeedSms' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: InvalidRequest: $ref: '#/components/examples/InvalidRequest' FormNotFound: $ref: '#/components/examples/FormNotFound' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /pp/open-banking/v1.3/accounts: get: tags: - Accounts summary: Получение списка счетов operationId: getAccounts parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetAccountsResponse' examples: example: $ref: '#/components/examples/GetAccountsResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /pp/open-banking/v1.3/accounts/{accountId}: get: tags: - Accounts summary: Получение детальной информации о счете по его идентификатору operationId: getAccount parameters: - name: accountId in: path description: Идентификатор счета required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: this-is-a-slug-format-account-id - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetAccountsResponse' examples: example: $ref: '#/components/examples/GetAccountResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /pp/open-banking/v1.3/balances: get: tags: - Balances summary: Остаток денежных средств по всем счетам operationId: getBalances parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BalanceResponse_1' examples: example: $ref: '#/components/examples/BalancesResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /pp/open-banking/v1.3/accounts/{accountId}/balances: get: tags: - Balances summary: Баланс банковского счета по идентификатору accountId operationId: getAccountIdBalances parameters: - name: accountId in: path description: Идентификатор счета required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: this-is-a-slug-format-account-id - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BalanceResponse_1' examples: example: $ref: '#/components/examples/BalanceResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /pp/open-banking/v1.3/transactions: get: tags: - Transactions summary: Список операций по всем счетам operationId: getAllTransactions parameters: - name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 - name: fromBookingDateTime in: query description: Дата и время начала фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: toBookingDateTime in: query description: Дата и время окончания фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionResponse' examples: example: $ref: '#/components/examples/GetTransactionsResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /pp/open-banking/v1.3/accounts/{accountId}/transactions: get: tags: - Transactions summary: Ресурс операции по счету с идентификатором accountId operationId: getAccountTransactions parameters: - name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 - name: accountId in: path description: Идентификатор счета required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: this-is-a-slug-format-account-id - name: fromBookingDateTime in: query description: Дата и время начала фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: toBookingDateTime in: query description: Дата и время окончания фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionResponse' examples: example: $ref: '#/components/examples/GetTransactionsResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /pp/open-banking/v1.3/payment-cards: get: tags: - PaymentCards summary: Получение списка платежных карт operationId: getPaymentCards parameters: - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AccountPaymentCardsResponse' examples: example: $ref: '#/components/examples/GetCardsResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /pp/open-banking/v1.3/accounts/{accountId}/payment-cards: get: tags: - PaymentCards summary: Получение списка платежных карт по идентификатору счета operationId: getAccountPaymentCards parameters: - name: accountId in: path description: Идентификатор счета required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: this-is-a-slug-format-account-id - name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляц\ ии. Если необходимо, то Сторонний поставщик передает обратно значение ид\ ентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в\ \ соответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID)\ \ URN Namespace\"." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AccountPaymentCardsResponse' examples: example: $ref: '#/components/examples/GetCardResponseExample' "400": description: "Запрос имеет неверное, отсутствующее или несовместимое тел\ о JSON, параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в\ \ полезной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active "429": description: "Операция была отклонена, так как слишком много запросов бы\ ло сделано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора ко\ рреляции. Если необходимо, то Сторонний поставщик передает обратно\ \ значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description /reports/payments-sbp: post: tags: - SBP summary: Инициирование формирования отчета для X5 description: Метод инициирует асинхронный процесс формирования отчета requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportRequest' responses: "201": description: Идентификатор зарегистрированного запроса content: application/json: schema: $ref: '#/components/schemas/ReportResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/terminals: post: tags: - SBP summary: Добавление кассы к ТСП в СБП description: Метод позволяет зарегистрировать терминал ТСП в СБП requestBody: content: application/json: schema: $ref: '#/components/schemas/RegTerminalRequest' responses: "200": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/RegTerminalResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/merchants/{merchantId}: get: tags: - SBP summary: Получение информации о ТСП и терминалах в СБП description: Метод позволяет получить информацию о ТСП и подключенных терминалах СБП parameters: - name: merchantId in: path description: Идентификатор ТСП required: true schema: pattern: "^.{12}$" type: string example: MA0000002752 responses: "200": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/MerchantInfoResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/legal: get: tags: - SBP summary: Получение информации о ЮЛ в СБП description: Метод позволяет получить информацию о ЮЛ и списка ТСП в СБП responses: "200": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/LegalInfoResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/payment-urls/one-time-use: post: tags: - SBP summary: Зарегистрировать новую платежную одноразовую ссылку description: Метод создает новую платежную одноразовую ссылку operationId: registerOneTimeUseUrl requestBody: content: application/json: schema: $ref: '#/components/schemas/OneTimePaymentUrlRequest' examples: example: $ref: '#/components/examples/paymentUrlsOneTimeUseRequest' responses: "201": description: Информация о зарегистрированной платежной ссылке content: application/json: schema: $ref: '#/components/schemas/PaymentUrl' examples: example: $ref: '#/components/examples/paymentUrlsOneTimeUseResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/payment-urls/reusable: post: tags: - SBP summary: Зарегистрировать новую платежную многоразовую ссылку description: Метод создает новую платежную многоразовую ссылку operationId: registerReusableUrl requestBody: content: application/json: schema: $ref: '#/components/schemas/ReusablePaymentUrlRequest' examples: example: $ref: '#/components/examples/paymentUrlsReusableRequest' responses: "201": description: Информация о зарегистрированной платежной ссылке content: application/json: schema: $ref: '#/components/schemas/PaymentUrl' examples: example: $ref: '#/components/examples/paymentUrlsReusableResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/payment-urls/batch: post: tags: - SBP summary: Зарегистрировать новые платёжные ссылки description: Метод позволяет зарегистрировать массив новых платёжных ссылок operationId: registerPaymentUrls requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBatchPaymentUrlRequest' examples: example: $ref: '#/components/examples/registerPaymentUrlsRequest' responses: "201": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/PostBatchPaymentUrlResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/payment-urls: get: tags: - SBP summary: Получить зарегистрированные платежные ссылки клиента description: "Метод возвращает платежные ссылки, зарегистрированные клиентом" operationId: getPaymentUrlsByClientId parameters: - name: b2bClientId in: query description: "Идентификатор клиента, от имени которого выполняется запрос" required: true schema: type: string format: uuid example: 021be5ed-6312-4982-a4e9-2a2cc44bc88c - name: qrcId in: query description: Идентификатор платежной ссылки required: false schema: maxLength: 32 minLength: 1 type: string example: AO1000670LSS7DN18SJQDNP4B05KLJL2 - name: onlyActive in: query description: Вернуть только действующие ссылки (Да/Нет). Действующими считаются неоплаченные и с неистекшим сроком действия (expirationDate в будущем). Значение по умолчанию false. required: false schema: type: boolean example: false - name: sort in: query description: "Сортировка результатов поиска (не более трех параметров). Ес\ ли параметры сортировки не заданы, записи сортируются по убыванию registrationDate.\ \ Возможные значения: name, merchantId, payeeAccount, amount, qrcType, takeTax,\ \ registrationDate, expirationDate." required: false schema: type: array items: type: string example: "?sort=amount,asc&sort=qrcType,asc&sort=registrationDate,desc" - name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer example: 10 - name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer example: 0 responses: "200": description: "Список платежных ссылок, зарегистрированных пользователем" content: application/json: schema: $ref: '#/components/schemas/GetPaymentUrlsResponse' examples: example: $ref: '#/components/examples/getPaymentUrls' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен patch: tags: - SBP summary: Обновить статусы платёжных ссылок description: Метод позволяет обновлять статусы платёжных ссылок operationId: updateStatusPaymentUrls requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStatusPaymentUrls' examples: example: $ref: '#/components/examples/updateStatusPaymentUrlsRequest' responses: "204": description: No Content "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/payment-urls/batch/{batchId}: get: tags: - SBP summary: Получить результат регистрации массива платёжных ссылок description: Метод возвращает результат регистрации массива платёжных ссылок operationId: getPaymentUrlsByBatchId parameters: - name: batchId in: path description: Идентификатор массива платёжных ссылок required: true schema: type: string format: uuid example: a7631fbb-f94f-4c17-1e13-0e96a3a77113 - name: b2bClientId in: query description: "Идентификатор клиента, от имени которого выполняется запрос" required: true schema: type: string format: uuid example: 021be5ed-6312-4982-a4e9-2a2cc44bc88c - name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer example: 10 - name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer example: 0 responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/GetBatchPaymentUrlResponse' examples: example: $ref: '#/components/examples/getPaymentUrlsResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/payment-urls/{qrcId}/data: get: tags: - SBP summary: Получить данные по зарегистрированной платёжной ссылке клиента (ЮЛ) description: "Метод возвращает платёжные данные по ссылке, зарегистрированно\ й клиентом" operationId: getPaymentDataByQRc parameters: - name: qrcId in: path description: Идентификатор платежной ссылки required: true schema: type: string example: AD1000038AQ1FG409KGACUQU5QRSH3FM responses: "200": description: "Данные по платежный ссылке, зарегистрированной пользовател\ ем" content: application/json: schema: $ref: '#/components/schemas/PaymentUrlData' examples: example: $ref: '#/components/examples/getPaymentDataByQRc' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/incoming-payments: get: tags: - SBP summary: Получить список входящих платежей description: Метод запрашивает информацию о входящих платежах клиента operationId: getIncomingPayments parameters: - name: b2bClientId in: query description: "Идентификатор клиента, от имени которого выполняется запрос" required: true schema: type: string format: uuid example: 021be5ed-6312-4982-a4e9-2a2cc44bc88c - name: qrcId in: query description: Идентификатор платежной ссылки required: false schema: maxLength: 32 minLength: 1 type: string example: AO1000670LSS7DN18SJQDNP4B05KLJL2 - name: sort in: query description: "Сортировка результатов поиска (не более трех параметров). Во\ зможные значения: qrcId, amount, taxAmount, paymentPurpose, payeeAccount,\ \ timestamp." required: false schema: type: array items: type: string example: "?sort=amount,asc&sort=timestamp,desc" - name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer example: 10 - name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer example: 0 responses: "200": description: "Информация о платежах, совершенных по платежным ссылкам" content: application/json: schema: $ref: '#/components/schemas/GetIncomingPaymentsResponse' examples: example: $ref: '#/components/examples/getIncomingPayments' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/outgoing-payments: get: tags: - SBP summary: Получить список исходящих платежей клиента description: Метод запрашивает информацию о исходящих платежах клиента operationId: getOutgoingPayments parameters: - name: b2bClientId in: query description: "Идентификатор клиента, от имени которого выполняется запрос" required: true schema: type: string format: uuid example: 021be5ed-6312-4982-a4e9-2a2cc44bc88c - name: outgoingPaymentId in: query description: Идентификатор исходящего платежа required: false schema: type: string format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 - name: qrcId in: query description: Идентификатор платежной ссылки required: false schema: maxLength: 32 minLength: 1 type: string example: AO1000670LSS7DN18SJQDNP4B05KLJL2 - name: sort in: query description: "Сортировка результатов поиска (не более трех параметров). Ес\ ли параметры сортировки не заданы, записи сортируются по убыванию outgoingPaymentId.\ \ Возможные значения: status, amount, payerAccount, paymentPurpose, timestamp,\ \ outgoingPaymentId." required: false schema: type: array items: type: string example: "?sort=status,asc&sort=timestamp,desc" - name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer example: 10 - name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer example: 0 responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/GetOutgoingPaymentsResponse' examples: example: $ref: '#/components/examples/getOutgoingPaymentsResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/outgoing-payments/one-pay: post: tags: - SBP summary: Выполнить исходящий платеж за один шаг description: Метод инициирует проведение проверок и выполнение платежа operationId: executeOneStepOutgoingPayment requestBody: content: application/json: schema: $ref: '#/components/schemas/OneStepExecuteOutgoingPayment' examples: example: $ref: '#/components/examples/executeOneStepOutgoingPaymentRequest' responses: "201": description: Успешная инициация платежа content: application/json: schema: $ref: '#/components/schemas/OneStepExecuteOutgoingPaymentResponse' examples: example: $ref: '#/components/examples/executeOneStepOutgoingPaymentResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/outgoing-payments/{outgoingPaymentId}/status: get: tags: - SBP summary: Получить статус исходящего платежа description: Метод запрашивает информацию о статусе исходящего платежа по идентификатору operationId: getOutgoingPaymentStatus parameters: - name: outgoingPaymentId in: path description: Идентификатор исходящего платежа required: true schema: type: string format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 - name: b2bClientId in: query description: "Идентификатор клиента, от имени которого выполняется запрос" required: true schema: type: string format: uuid example: 021be5ed-6312-4982-a4e9-2a2cc44bc88c responses: "200": description: Успешный результат content: application/json: schema: $ref: '#/components/schemas/OutgoingPaymentStatus' examples: example: $ref: '#/components/examples/outgoingPaymentStatusResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Слишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /1c/merchants/{merchantId}: get: tags: - B2B SPB 1C summary: Проверка настроек и аутентификации мерчанта description: "[ВХОДЯЩИЙ] " parameters: - name: merchantId in: path required: true schema: type: string example: MF0000000001 - name: Authorization-1C in: header description: Basic auth логин и пароль клиента в формате base64(login:password) required: true schema: type: string example: Basic NWUfYlNaUkR6dUpGc3JtGTtULkJVOk3eNmlwTWRLdk8yUg== responses: "200": description: Информация о мерчанте content: application/json: schema: $ref: '#/components/schemas/inline_response_200' examples: example: $ref: '#/components/examples/merchantResponse' "400": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadRequest' "401": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadCredentials' "403": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/authorizationException' "404": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/notFoundException' "429": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/tooManyRequestsException' "500": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/internalServerErrorException' "503": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/timeoutException' /1c/payments/search: post: tags: - B2B SPB 1C summary: Получение информации об оплате description: "[ВХОДЯЩИЙ] " parameters: - name: Authorization-1C in: header description: Basic auth логин и пароль клиента в формате base64(login:password) required: true schema: type: string example: Basic NWUfYlNaUkR6dUpGc3JtGTtULkJVOk3eNmlwTWRLdk8yUg== requestBody: content: application/json: schema: $ref: '#/components/schemas/payments_search_body' examples: example: $ref: '#/components/examples/PaymentsSearchBody' required: true responses: "200": description: Коллекция результатов оплаты content: application/json: schema: $ref: '#/components/schemas/PaymentInfoArray' examples: example: $ref: '#/components/examples/paymentInfo' "400": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadRequest' "401": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadCredentials' "403": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/authorizationException' "404": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/notFoundException' "429": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/tooManyRequestsException' "500": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/internalServerErrorException' "503": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/timeoutException' /1c/payment-link/{qrId}: get: tags: - B2B SPB 1C summary: Получение данных по функциональной ссылке description: "[ВХОДЯЩИЙ] " parameters: - name: qrId in: path required: true schema: type: string example: EX2E009997EAL2DG8VFAEN07M1VH92DW - name: Authorization-1C in: header description: Basic auth логин и пароль клиента в формате base64(login:password) required: true schema: type: string example: Basic NWUfYlNaUkR6dUpGc3JtGTtULkJVOk3eNmlwTWRLdk8yUg== responses: "200": description: Информация по ссылке content: application/json: schema: $ref: '#/components/schemas/LinkDetail' "400": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadRequest' "401": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadCredentials' "403": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/authorizationException' "404": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/notFoundException' "429": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/tooManyRequestsException' "500": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/internalServerErrorException' "503": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/timeoutException' /1c/payment-link/reusable: post: tags: - B2B SPB 1C summary: Регистрация многоразовой платёжной ссылки description: "[ВХОДЯЩИЙ] " parameters: - name: Authorization-1C in: header description: Basic auth логин и пароль клиента в формате base64(login:password) required: true schema: type: string example: Basic NWUfYlNaUkR6dUpGc3JtGTtULkJVOk3eNmlwTWRLdk8yUg== requestBody: content: application/json: schema: $ref: '#/components/schemas/ReusableLinkRequest' examples: example: $ref: '#/components/examples/ReusableLinkBody' required: true responses: "200": description: Успешная регистрация content: application/json: schema: $ref: '#/components/schemas/LinkResponse' "400": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadRequest' "401": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadCredentials' "403": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/authorizationException' "404": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/notFoundException' "429": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/tooManyRequestsException' "500": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/internalServerErrorException' "503": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/timeoutException' /1c/payment-link/one-time-use: post: tags: - B2B SPB 1C summary: Регистрация одноразовой платёжной ссылки description: "[ВХОДЯЩИЙ] " parameters: - name: Authorization-1C in: header description: Basic auth логин и пароль клиента в формате base64(login:password) required: true schema: type: string example: Basic NWUfYlNaUkR6dUpGc3JtGTtULkJVOk3eNmlwTWRLdk8yUg== requestBody: content: application/json: schema: $ref: '#/components/schemas/OneTimeLinkRequest' examples: example: $ref: '#/components/examples/oneTimeLinkBody' required: true responses: "200": description: Успешная регистрация content: application/json: schema: $ref: '#/components/schemas/LinkResponse' "400": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadRequest' "401": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/errorBadCredentials' "403": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/authorizationException' "404": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/notFoundException' "429": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/tooManyRequestsException' "500": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/internalServerErrorException' "503": description: Ошибка content: application/json: schema: $ref: '#/components/schemas/BusinessException' examples: example: $ref: '#/components/examples/timeoutException' /b2cpay/jp/v1/payments: get: tags: - b2cpay summary: Сформировать отчетность по платежам по номеру транзакции или за период description: Метод получения отчетности по платежам по транзакции или по периоду operationId: getPaymentPhoneReport parameters: - name: b2cClientId in: query description: "Идентификатор клиента, от имени которого интегратором отправ\ ляется платеж" schema: type: string - name: partnerId in: query description: Идентификатор партнера required: true schema: type: integer format: int64 - name: startDate in: query description: Дата начала периода schema: type: string format: date-time - name: finishDate in: query description: Дата окончания периода schema: type: string format: date-time - name: transactionId in: query description: Идентификатор транзакции schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PhonePaymentReportResponse' examples: example: $ref: '#/components/examples/getPhonePaymentReportResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' post: tags: - b2cpay summary: Отправить платеж или пакет платежей физическому лицу через СБП description: Метод отправки платежа или пакета платежей operationId: addPhonePayment requestBody: content: application/json: schema: $ref: '#/components/schemas/PhonePaymentRequest' examples: example: $ref: '#/components/examples/addPhonePaymentRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PhonePaymentResponse' examples: example: $ref: '#/components/examples/addPhonePaymentResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' /b2cpay/jp/v1/payments/packages/{packageId}: description: Метод получения отчетности по платежам по пакету транзакций get: tags: - b2cpay summary: Сформировать отчетность по платежам по пакету транзакций operationId: getPaymentPackagePhoneReport parameters: - name: packageId in: path description: Идентификатор пакета платежей required: true schema: type: integer format: int64 - name: b2cClientId in: query description: "Идентификатор клиента, от имени которого интегратором отправ\ ляется платеж" schema: type: string - name: partnerId in: query description: Идентификатор партнера required: true schema: type: integer format: int64 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PhonePaymentReportResponse' examples: example: $ref: '#/components/examples/getPhonePaymentReportResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' /b2cpay/jp/v1/clients/checks: description: Метод проверки возможности выплаты на ФЛ post: tags: - b2cpay summary: Отправить запрос на проверку возможности выплаты физическому лицу через СБП по реквизитам operationId: addCheckPhonePayment requestBody: content: application/json: schema: $ref: '#/components/schemas/PhonePaymentCheckRequest' examples: example: $ref: '#/components/examples/addPhonePaymentCheckRequest' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PhonePaymentCheckResponse' examples: example: $ref: '#/components/examples/addPhonePaymentCheckResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' /b2cpay/jp/v1/clients/checks/{checkId}: description: Метод получения результатов проверки возможности выплаты на ФЛ get: tags: - b2cpay summary: Получить результат проверки возможности выполнить платеж на ФЛ по реквизитам operationId: getCheckPaymentPhoneStatus parameters: - name: checkId in: path description: Идентификатор асинхронного запроса на проверку возможности платежа required: true schema: type: string - name: b2cClientId in: query description: "Идентификатор клиента, от имени которого интегратором отправ\ ляется платеж" schema: type: string - name: partnerId in: query description: Идентификатор партнера required: true schema: type: integer format: int64 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PhonePaymentCheckStatusResponse' examples: example: $ref: '#/components/examples/getPhonePaymentCheckStatusResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' /b2cpay/jp/v1/banks: get: tags: - b2cpay summary: Получить список банков НСПК для платежей на ФЛ по реквизитам description: Метод получения списка банков НСПК operationId: getBanksList responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BanksResponse' examples: example: $ref: '#/components/examples/getBanksResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' /b2cpay/jp/v1/clients/info: description: Метод получения внутреннего b2cpayClientId клиента по ИНН get: tags: - b2cpay summary: Получить ClientID по ИНН клиента operationId: getINNByClientId parameters: - name: partnerId in: query description: Идентификатор партнера required: true schema: type: integer format: int64 - name: inn in: query description: ИНН ЮЛ required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ClientInnResponse' examples: example: $ref: '#/components/examples/getClientInnResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' /pp/v1/credit-offers: description: Получение кредитный предложений физического лица get: tags: - Credit Offers summary: Запрос получения кредитных предложений operationId: getCreditOffers responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CreditOffers' examples: example: $ref: '#/components/examples/successCreditOffersGet' "400": description: Authorization отсутствует в заголовках запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/qrcs: post: tags: - C2B SBP summary: Сгенерировать QR-код для оплаты description: Метод позволяет сгенерировать QR-код для оплаты operationId: GenerateQRCode requestBody: content: application/json: schema: $ref: '#/components/schemas/GetStatisOrDynamicQRc' examples: example: $ref: '#/components/examples/GetStatisOrDynamicQRc' responses: "201": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/GetQRcResponse' examples: example: $ref: '#/components/examples/GetQRcResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/qrc-status: get: tags: - C2B SBP summary: Получить статус оплаты QR-кода и кассовой платёжной ссылки description: Метод позволяет получить статус оплаты QR-кода и кассовой платёжной ссылки operationId: GetQRCodeStatus parameters: - name: termNo in: query description: Уникальный идентификатор терминала required: true schema: type: string example: 30000600 - name: qrcId in: query description: Идентификатор QR-кода required: false schema: pattern: "^.{32}$" type: string example: AS1000670LSS7DN18SJQDNP4B05KLJL2 - name: payrrn in: query description: Референсный идентификатор запроса required: false schema: type: string example: "012345678912" - name: messageId in: header description: Уникальный идентификатор сообщения required: false schema: type: string example: 123Rersal_Num567 responses: "200": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/GetQRcStatusResponse' examples: example: $ref: '#/components/examples/GetQRcStatusResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/subscriptions: post: tags: - C2B SBP summary: Сгенерировать QR-код для привязки счёта/подписки СБП description: Метод позволяет сгенерировать QR-код для привязки счёта/подписки СБП operationId: GenerateQRCodeSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/GetQRcSubscriptionRequest' examples: example: $ref: '#/components/examples/GetQRcSubscriptionRequest' responses: "201": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/GetQRcSubscriptionResponse' examples: example: $ref: '#/components/examples/GetQRcSubscriptionResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/petitions: post: tags: - C2B SBP summary: Произвести оплату с привязанного счёта по инициативе ТСП description: Метод позволяет произвести оплату с привязанного счёта по инициативе ТСП requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentFromBindedAccountRequest' examples: example: $ref: '#/components/examples/PaymentFromBindedAccountRequest' responses: "201": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/PaymentFromBindedAccountResponse' examples: example: $ref: '#/components/examples/PaymentFromBindedAccountResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/refund: post: tags: - C2B SBP summary: Запросить возврат оплаты QR-кода и кассовой платёжной ссылки description: Метод позволяет запросить возврат оплаты QR-кода и кассовой платёжной ссылки requestBody: content: application/json: schema: $ref: '#/components/schemas/QRcRefundRequest' examples: example: $ref: '#/components/examples/QRcRefundRequest' responses: "201": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/QRcRefundResponse' examples: example: $ref: '#/components/examples/QRcRefundResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/refund/status: get: tags: - C2B SBP summary: Получить статус возврата СБП description: Метод позволяет получить статус возврата СБП parameters: - name: termNo in: query description: Уникальный идентификатор терминала required: true schema: type: string example: 30000600 - name: payrrn in: query description: Референсный идентификатор запроса required: false schema: type: string example: "012345678912" - name: originalTrxId in: query description: Уникальный идентификатор платежа в НСПК required: false schema: type: string example: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 - name: trxId in: query description: Уникальный идентификатор операции возврата в НСПК required: false schema: type: string example: 1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2 - name: messageId in: query description: Уникальный идентификатор сообщения required: false schema: type: string example: 123Rersal_Num567 responses: "200": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/GetQRcRefundStatusResponse' examples: example: $ref: '#/components/examples/GetQRcRefundStatusResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/terminals/{termNo}/cash-qrcs: post: tags: - C2B SBP summary: Зарегистрировать кассовую ссылку СБП description: Метод позволяет зарегистрировать кассовую ссылку СБП operationId: RegisterCashQRCode parameters: - name: termNo in: path description: Уникальный идентификатор терминала required: true schema: type: string example: 30000600 requestBody: content: application/json: schema: $ref: '#/components/schemas/CashQRcsRegistrationRequest' examples: example: $ref: '#/components/examples/CashQRcsRegistrationRequest' responses: "201": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/CashQRcsRegistrationResponse' examples: example: $ref: '#/components/examples/CashQRcsRegistrationResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /sbp/jp/v1/terminals/{termNo}/cash-qrcs/{qrcId}/activation: post: tags: - C2B SBP summary: Активировать кассовую ссылку СБП description: Метод позволяет активировать кассовую ссылку СБП operationId: ActivateCashQRCode parameters: - name: termNo in: path description: Уникальный идентификатор терминала required: true schema: type: string example: 30000600 - name: qrcId in: path description: Идентификатор QR-кода required: true schema: pattern: "^.{32}$" type: string example: AS1000670LSS7DN18SJQDNP4B05KLJL2 requestBody: content: application/json: schema: $ref: '#/components/schemas/CashQRcsActivationRequest' examples: example: $ref: '#/components/examples/CashQRcsActivationRequest' responses: "200": description: Успешный ответ content: application/json: schema: $ref: '#/components/schemas/CashQRcsActivationResponse' examples: example: $ref: '#/components/examples/CashQRcsActivationResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен delete: tags: - C2B SBP summary: Деактивировать кассовую ссылку СБП description: Метод позволяет деактивировать кассовую ссылку СБП operationId: DeactivateCashQRCode parameters: - name: termNo in: path description: Уникальный идентификатор терминала required: true schema: type: string example: 30000600 - name: qrcId in: path description: Идентификатор QR-кода required: true schema: pattern: "^.{32}$" type: string example: AS1000670LSS7DN18SJQDNP4B05KLJL2 responses: "204": description: "Успешный ответ, без тела сообщения" "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/salary-project/accounts/applications: post: tags: - Salary-Project summary: Создать электронный реестр на открытие счетов operationId: createAccountsOpeningApplication parameters: - name: X-Salary-Signatures in: header description: Открепленные PKCS7 подписи запроса required: false schema: type: string example: "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIGMzCCBBugAwIBAgIIQ+Ua6h49X/kwDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAlJVMQ8wDQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazElMCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsucnUwHhcNMjQwNTI3MTMzNTAwWhcNMjkwNTI3MTMzNTAwWjCByTELMAkGA1UEBhMCUlUxDzANBgNVBAgTBk1vc2NvdzEPMA0GA1UEBxMGTW9zY293MRYwFAYDVQQKEw1KU0MgQWxmYS1CYW5rMSUwIwYDVQQLExxEaWdpdGFsIFNlcnZpY2VzIERldmVsb3BtZW50MSswKQYDVQQDEyJURVNUIFRydXN0Q29yZVJTQSBTaWduZXIyIDIwNDggYml0MSwwKgYJKoZIhvcNAQkBFh10cnVzdGNvcmVfc3VwcG9ydEBhbGZhYmFuay5ydTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALbaUlic4XF47DJtoFQKNnd46jvaoE9pyxByuEKQkZY8Na5XWNuyr5ZALF6RTYXRS+i2wqig+zsGhEKG5rM2VZFJB4p6VvwbULzDeH08tEw01hvnIiUFxrlVlpMIM649rLaMUTZnh8RKq23WkvDxPaEEeLV0f0sgeHpBf2nV7ZeM4w6LdC2T/hnYAy7VxIS+BN2nDGOIePqh+lGgUZIHY9cO3IbN7yWSQQSC7hQ696RC9L5vWedOXb6CmyWlFsuOnAgp+O3z2U1wbovCQ48CU8VprzjLorw/UTz/qJr7uGGICuY7M1Go7qLvICsHclkKqvRcCMLBGxdg6RBkA+6t96cCAwEAAaOCAScwggEjMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFFp1la5QGzpdMD7SCyadt9CVfElrMAsGA1UdDwQEAwID+DAdBgNVHSUEFjAUBggrBgEFBQcDAwYIKwYBBQUHAwQwgccGA1UdHwSBvzCBvDA8oDqgOIY2aHR0cDovL2FydGFwcC9hcnRpZmFjdG9yeS9UcnVzdENvcmUvQ1JMcy90cnVzdGNvcmUuY3JsMDqgOKA2hjRodHRwOi8vaGF2ZW4ubW9zY293LmFsZmFpbnRyYS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMECgPqA8hjpodHRwOi8vczAxZHBydXByYnMubW9zY293LmFsZmFpbnRyYS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMA0GCSqGSIb3DQEBCwUAA4ICAQARCvm8JwBOGonGKMlnwyxnFX2aV1qIkzMgo7ILaCXT/MybvPH/3GQByBOUsASFU7cod57qEOOyQSN/JTQ/ZdKz3B8goGoO1XC/toybaTib92Dru7XyiJAeOLHksDjMQ7U6Xgk/51xoPa6AvZyOUWNW0KUdQFWlfyJeH+Gt4Xr1OH+LYuUMhiVubUPn+edW/PW8WTzlpjvd55/e69YViSJBuNenV0cmxKe/xWD7ZnfGfBsf+Sy/xhfjP0nFd7qANeQJXmb07gl7zJUyV0oK7fXyHO7Rg2wVcWEr8p9uS/sTS0ZnXJZKN3/OO+zp9UPM23uzZNuySsBbc7QNlJ3c8GLL/R93xvE3BNV+DtZVbu7xaqcWZmFEnfp0iTVCfMC3d9Cig+KZ5NKBQp+vB0A4+vj8jO/ZCCjtho3nqeJ+exO2AHgLYj6XaeCTed4fW0ENt0XWNrFaVW/wRyHOXvEN8Ocj8LV5Xtwh6xPuwSbas2VL4v7V50O7V5RA4ZucdpdmRj5z/qkqkirGRcWnf+UWwjniI+BzCGlsPjGJmGgl8OjGUnb/vZ4fN1g2QVBcS1riln0mQDPbaBJNtFOSc3GCh+HttX075tinnux348YgqsHeKfsVZ6+5gmrumdaS8uN/L/cgFtPJFfwpbz5YGq98owU8BVlodP1eM8C5eEPU1X0BGQAAMYICkTCCAo0CAQEwgcowgb0xCzAJBgNVBAYTAlJVMQ8wDQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazElMCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsucnUCCEPlGuoePV/5MA0GCWCGSAFlAwQCAQUAoIGYMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MTAxMDIyMzEwM1owLQYJKoZIhvcNAQk0MSAwHjANBglghkgBZQMEAgEFAKENBgkqhkiG9w0BAQsFADAvBgkqhkiG9w0BCQQxIgQgtePFfYxpG652D9kwL4qQku/nF/GmYibgbJMWYU3kMj0wDQYJKoZIhvcNAQELBQAEggEAqPJ/bBA+ft7AxpdkOmpzIrsK2X6aoxg326IMoTUkyT3xNWZux6cYJCl58XjfCKMUCQzrquruSzaP9+P8tL5nW/lcttiTXZNis3VcUOyN936Eql/jUPilsL7jIOcB6WOVDnfhjQI2/oGKjDIOKKoie9QhTBVNxPQBjmRnntRyP5JXZHRiS0dyV8nbKdJ/oFpteon58ES95DvcyDZwOIaJ5zj1GzoxzTcfRbPZlK4wXhhbxORt01CuA+VfmhuXX1jbOVIYF2StM9XdXG5X25SsYG+42D2c5noSbhh5vj5TA+1I+V9TCspv3g2ULjSDva7RnkTcY0H2XjBSy4OtR2b5pAAAAAAAAA==,MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIHMzCCBRugAwIBAgIIYnDbwSiFECUwDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAlJVMQ8wDQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazElMCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsucnUwHhcNMjQwNTI3MTMxMjAwWhcNMjkwNTI3MTMxMjAwWjCByTELMAkGA1UEBhMCUlUxDzANBgNVBAgTBk1vc2NvdzEPMA0GA1UEBxMGTW9zY293MRYwFAYDVQQKEw1KU0MgQWxmYS1CYW5rMSUwIwYDVQQLExxEaWdpdGFsIFNlcnZpY2VzIERldmVsb3BtZW50MSswKQYDVQQDEyJURVNUIFRydXN0Q29yZVJTQSBTaWduZXIxIDQwOTYgYml0MSwwKgYJKoZIhvcNAQkBFh10cnVzdGNvcmVfc3VwcG9ydEBhbGZhYmFuay5ydTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAM62+ggXZkPhAeWYqhqoFDazgSVjKOj4ZL5Alx0P1Jg6iMsA1d3ZiXBf5xGHx6xkeeyX1jlOOxK5NeFRDLXP0rmxJIKr8sgKcLxArH2LxqQ7HJHeXzmHaWRnU8jB/al+gHPVGTZmsSJWBGhxXRiwMR25LrTx7rBJ7lUDKa+Ja6y+Hbt6jdZG+dH9E004EOrIRim5aANMI9aO71eZWVZhCWMJ6mhwPv+6adUMiY16YF9ldBbQqmgtOIUELFBX requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccountsApplicationRequest' examples: example: $ref: '#/components/examples/Request' required: true responses: "201": description: Запрос принят в обработку content: application/json: schema: $ref: '#/components/schemas/CreateAccountsApplicationResponse' examples: example: $ref: '#/components/examples/Response' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/salary-project/accounts/applications/{applicationId}: get: tags: - Salary-Project summary: Получить статус электронного реестра на открытие счетов operationId: getAccountsOpeningApplicationStatus parameters: - name: applicationId in: path required: true schema: maxLength: 35 type: string responses: "200": description: Успешное получение статуса content: application/json: schema: $ref: '#/components/schemas/GetAccountsApplicationResponse' examples: example: $ref: '#/components/examples/Response' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/salary-project/payroll/applications: post: tags: - Salary-Project summary: Отправить зарплатную ведомость operationId: createPayrollApplication parameters: - name: X-Salary-Signatures in: header description: Открепленные PKCS7 подписи запроса required: false schema: type: string example: "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIGMzCCBBugAwIBAgIIQ+Ua6h49X/kwDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAlJVMQ8wDQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazElMCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsucnUwHhcNMjQwNTI3MTMzNTAwWhcNMjkwNTI3MTMzNTAwWjCByTELMAkGA1UEBhMCUlUxDzANBgNVBAgTBk1vc2NvdzEPMA0GA1UEBxMGTW9zY293MRYwFAYDVQQKEw1KU0MgQWxmYS1CYW5rMSUwIwYDVQQLExxEaWdpdGFsIFNlcnZpY2VzIERldmVsb3BtZW50MSswKQYDVQQDEyJURVNUIFRydXN0Q29yZVJTQSBTaWduZXIyIDIwNDggYml0MSwwKgYJKoZIhvcNAQkBFh10cnVzdGNvcmVfc3VwcG9ydEBhbGZhYmFuay5ydTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALbaUlic4XF47DJtoFQKNnd46jvaoE9pyxByuEKQkZY8Na5XWNuyr5ZALF6RTYXRS+i2wqig+zsGhEKG5rM2VZFJB4p6VvwbULzDeH08tEw01hvnIiUFxrlVlpMIM649rLaMUTZnh8RKq23WkvDxPaEEeLV0f0sgeHpBf2nV7ZeM4w6LdC2T/hnYAy7VxIS+BN2nDGOIePqh+lGgUZIHY9cO3IbN7yWSQQSC7hQ696RC9L5vWedOXb6CmyWlFsuOnAgp+O3z2U1wbovCQ48CU8VprzjLorw/UTz/qJr7uGGICuY7M1Go7qLvICsHclkKqvRcCMLBGxdg6RBkA+6t96cCAwEAAaOCAScwggEjMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFFp1la5QGzpdMD7SCyadt9CVfElrMAsGA1UdDwQEAwID+DAdBgNVHSUEFjAUBggrBgEFBQcDAwYIKwYBBQUHAwQwgccGA1UdHwSBvzCBvDA8oDqgOIY2aHR0cDovL2FydGFwcC9hcnRpZmFjdG9yeS9UcnVzdENvcmUvQ1JMcy90cnVzdGNvcmUuY3JsMDqgOKA2hjRodHRwOi8vaGF2ZW4ubW9zY293LmFsZmFpbnRyYS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMECgPqA8hjpodHRwOi8vczAxZHBydXByYnMubW9zY293LmFsZmFpbnRyYS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMA0GCSqGSIb3DQEBCwUAA4ICAQARCvm8JwBOGonGKMlnwyxnFX2aV1qIkzMgo7ILaCXT/MybvPH/3GQByBOUsASFU7cod57qEOOyQSN/JTQ/ZdKz3B8goGoO1XC/toybaTib92Dru7XyiJAeOLHksDjMQ7U6Xgk/51xoPa6AvZyOUWNW0KUdQFWlfyJeH+Gt4Xr1OH+LYuUMhiVubUPn+edW/PW8WTzlpjvd55/e69YViSJBuNenV0cmxKe/xWD7ZnfGfBsf+Sy/xhfjP0nFd7qANeQJXmb07gl7zJUyV0oK7fXyHO7Rg2wVcWEr8p9uS/sTS0ZnXJZKN3/OO+zp9UPM23uzZNuySsBbc7QNlJ3c8GLL/R93xvE3BNV+DtZVbu7xaqcWZmFEnfp0iTVCfMC3d9Cig+KZ5NKBQp+vB0A4+vj8jO/ZCCjtho3nqeJ+exO2AHgLYj6XaeCTed4fW0ENt0XWNrFaVW/wRyHOXvEN8Ocj8LV5Xtwh6xPuwSbas2VL4v7V50O7V5RA4ZucdpdmRj5z/qkqkirGRcWnf+UWwjniI+BzCGlsPjGJmGgl8OjGUnb/vZ4fN1g2QVBcS1riln0mQDPbaBJNtFOSc3GCh+HttX075tinnux348YgqsHeKfsVZ6+5gmrumdaS8uN/L/cgFtPJFfwpbz5YGq98owU8BVlodP1eM8C5eEPU1X0BGQAAMYICkTCCAo0CAQEwgcowgb0xCzAJBgNVBAYTAlJVMQ8wDQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazElMCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsucnUCCEPlGuoePV/5MA0GCWCGSAFlAwQCAQUAoIGYMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MTAxMDIyMzU0MFowLQYJKoZIhvcNAQk0MSAwHjANBglghkgBZQMEAgEFAKENBgkqhkiG9w0BAQsFADAvBgkqhkiG9w0BCQQxIgQgAMHlWtd4sPzSuIVyGdmb3UzPu/j71+tReEDSQP9+wmowDQYJKoZIhvcNAQELBQAEggEAmnrE5fN56ogpK5UcgipdbsGO1+Hg6B2Z8iDVnCLVUHbEGKd4yV8WZ1/Jc9Re4bDC1piQfQVoH04/PGBcEz7wcOGg2MfQwj8LCkHCknDkHJpVvuBPj+2mnf+X7R5NkK9mMoPRk3gOz4cVx/vxR4ECjhvzHC9pRmICGujo7Dt8Ce8qVq9d2uRFDgsKk6enM4Ih9pGRJzs+ublfDHF19fO04VnvCU6pJnsy3U7vI5aPj3gC4N+C+y5SYwd1iEzm/AQ6sDIVjh72etITNPHXyUxPrFLqab+vr1OORstfSViVTUU6dH2X/ceoiCywDgygrpuuoH9bHBFyvBSiwIhlhddrzQAAAAAAAA==,MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIHMzCCBRugAwIBAgIIYnDbwSiFECUwDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAlJVMQ8wDQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazElMCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsucnUwHhcNMjQwNTI3MTMxMjAwWhcNMjkwNTI3MTMxMjAwWjCByTELMAkGA1UEBhMCUlUxDzANBgNVBAgTBk1vc2NvdzEPMA0GA1UEBxMGTW9zY293MRYwFAYDVQQKEw1KU0MgQWxmYS1CYW5rMSUwIwYDVQQLExxEaWdpdGFsIFNlcnZpY2VzIERldmVsb3BtZW50MSswKQYDVQQDEyJURVNUIFRydXN0Q29yZVJTQSBTaWduZXIxIDQwOTYgYml0MSwwKgYJKoZIhvcNAQkBFh10cnVzdGNvcmVfc3VwcG9ydEBhbGZhYmFuay5ydTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAM62+ggXZkPhAeWYqhqoFDazgSVjKOj4ZL5Alx0P1Jg6iMsA1d3ZiXBf5xGHx6xkeeyX1jlOOxK5NeFRDLXP0rmxJIKr8sgKcLxArH2LxqQ7HJHeXzmHaWRnU8jB/al+gHPVGTZmsSJWBGhxXRiwMR25LrTx7rBJ7lUDKa+Ja6y+Hbt6jdZG+dH9E004EOrIRim5aANMI9aO71eZWVZhCWMJ6mhwPv+6adUMiY16YF9ldBbQqmgtOIUELFBX requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePayrollApplicationRequest' examples: example: $ref: '#/components/examples/Request' required: true responses: "201": description: Запрос принят в обработку content: application/json: schema: $ref: '#/components/schemas/CreatePayrollApplicationResponse' examples: example: $ref: '#/components/examples/Response' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/salary-project/payroll/applications/{applicationId}: get: tags: - Salary-Project summary: Получить статус зарплатной ведомости operationId: getPayrollApplicationStatus parameters: - name: applicationId in: path required: true schema: maxLength: 35 type: string responses: "200": description: Успешное получение статуса content: application/json: schema: $ref: '#/components/schemas/GetPayrollApplicationResponse' examples: example: $ref: '#/components/examples/Response' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /alfa-security/jp/v1/subscription-api/client/subscriptions: get: tags: - AlfaSecurity summary: Получение клиентских подписок description: Получение информации о подписках клиента на сервисы "Альфа-Безопасность" operationId: getClientSubscriptions parameters: - name: active in: query description: Признак возврата активных подписок required: false schema: type: boolean default: true example: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ClientSubscriptions' examples: example: $ref: '#/components/examples/GetClientSubscriptions' "400": description: Не переданы/переданы пустыми обязательные поля и/или их значения не соответствуют заданному формату content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope или правами\ \ на операцию." content: application/json: schema: $ref: '#/components/schemas/ErrorScope' examples: ErrorScope: $ref: '#/components/examples/ErrorScope' NotEnoughRightsForOperation: $ref: '#/components/examples/NotEnoughRightsForOperation' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса/ content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /logistics/jp/v1/partners/deliveries: get: tags: - Logistics summary: Получение списка доставок партнера description: "Получение списка доставок по дате, смещению по offset и ограни\ чению по limit." parameters: - name: limit in: query description: Размер страницы required: false schema: maximum: 100 minimum: 10 type: integer format: int32 default: 10 example: 10 - name: dateTime in: query description: "Дата, для которой запрашивается список доставок. Формат: YYYY-MM-DDThh:mm:ss.SSSZ" required: true schema: type: string format: date-time - name: offset in: query description: "Offset смещения для следующего запроса. Если параметр не пер\ едан, то будет выполнена выборка с первой записи (c 0 offset)" required: false schema: minimum: 0 type: integer format: int32 default: 0 example: 0 responses: "200": description: Статус успешного ответа content: application/json: schema: $ref: '#/components/schemas/DeliveryPageResponse' examples: example: $ref: '#/components/examples/DeliveryPageResponseExample' "400": description: Отсутствие обязательных параметров content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Ошибка в JWT (просрочен, отозван и т.д.)" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервера content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /api/gd/v1/channels/{channelId}/providers/{providerId}/orders/{orderId}/do/{action}: post: tags: - Channel-Provider summary: Выполнение действия над конкретным заказом description: | Выполняет указанное действие над конкретным заказом. Переход сущности в состояние не гарантируется. Действие указывается в path параметре {action}, где {action} - это переменная (не отдельный ресурс). operationId: executeOrderActionByIdUsingPOST parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: orderId in: path description: "Уникальный идентификатор Заказа в формате нестандартного, сж\ атого UUIDv7 - UUIDv7.compressed. См. дополнительную документацию." required: true schema: type: string - name: action in: path description: | Тип действия, выполняемого над заказом. Каждое действие переводит заказ в соответствующее состояние: - confirm: подтверждение Провайдером взятия Заказа в работу - in-process: обновление неформализованного состояния Заказа - reject: вызывается Провайдером при невозможности взятия в работу назначенного на него Заказа - deliver: вызывается Провайдером при успешной выдаче Заказа в Order.endPoint - cancel: вызывается Провайдером для завершения процесса отмены заказа - cancelling-in-process: вызывается Провайдером или Владельцем заказа при необходимости остановки процесса доставки - error: вызывается при возникновении нештатной ситуации с заказом, которая не допускает продолжение бизнес-процесса - pickup: вызывается Провайдером при получении Посылки в Order.beginPoint - last-mile: вызывается Провайдером при готовности выдачи Заказа - participant-change: вызывается для изменения Participant в Order.beginPoint или Order.endPoint - channel-change: вызывается для изменения Канала доставки Заказа. Id Провайдера нужно обязательно указывать в случае, если текущий Провайдер отсутствует в новом Канале - provider-change: вызывается для изменения Провайдера Заказа - renotify - вызывается для инициализации повторного уведомления получателя Провайдером. В случае если в параметре channel передано несколько каналов для связи - нужно уведомить по каждому каналу - in-process-warning - вызывается Провайдером при возникновении проблемной ситуации с Заказом, которая не ограничивает продолжение бизнес-процесса required: true schema: type: string enum: - confirm - reject - cancel - cancelling-in-process - error - deliver - in-process - pickup - last-mile - participant-change - channel-change - provider-change - renotify - in-process-warning requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderActionDto' example: createdAt: 2025-09-19T13:45:00Z type: cancellinginprocess cancelledBy: name: 5Post type: provider reason: Недоступен адрес доставки cancelledAt: 2025-09-19T13:46:10Z required: true responses: "200": description: OK "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_action: summary: Неверное действие value: error: invalid_request error_description: "No such action name: confirm1" "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: order_not_found: summary: Заказ не найден value: error: not_found error_description: Not found order by id EvNTKaXm4nonNpwhi1 "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] /api/gd/v1/channels/{channelId}/providers/{providerId}/orders/do/{action}: post: tags: - Channel-Provider summary: Групповое выполнение действия над заказами description: | Выполняет указанное действие над группой заказов. Переход сущности в состояние не гарантируется. Все действия выполняются в транзакции: или все успешно, или ни одно не выполняется. В случае ошибки при выполнении любого действия над заказом, никакие изменения не применяются. Ответ будет содержать словарь с ошибками для каждого заказа, который не был обработан. Действие указывается в path параметре {action}. operationId: executeActionToOrdersUsingPOST parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: action in: path description: | Тип действия, выполняемого над заказом. Каждое действие переводит заказ в соответствующее состояние: - confirm: подтверждение Провайдером взятия Заказа в работу - in-process: обновление неформализованного состояния Заказа - reject: вызывается Провайдером при невозможности взятия в работу назначенного на него Заказа - deliver: вызывается Провайдером при успешной выдаче Заказа в Order.endPoint - cancel: вызывается Провайдером для завершения процесса отмены заказа - cancelling-in-process: вызывается Провайдером или Владельцем заказа при необходимости остановки процесса доставки - error: вызывается при возникновении нештатной ситуации с заказом, которая не допускает продолжение бизнес-процесса - pickup: вызывается Провайдером при получении Посылки в Order.beginPoint - last-mile: вызывается Провайдером при готовности выдачи Заказа - participant-change: вызывается для изменения Participant в Order.beginPoint или Order.endPoint - channel-change: вызывается для изменения Канала доставки Заказа. Id Провайдера нужно обязательно указывать в случае, если текущий Провайдер отсутствует в новом Канале - provider-change: вызывается для изменения Провайдера Заказа - renotify - вызывается для инициализации повторного уведомления получателя Провайдером. В случае если в параметре channel передано несколько каналов для связи - нужно уведомить по каждому каналу - in-process-warning - вызывается Провайдером при возникновении проблемной ситуации с Заказом, которая не ограничивает продолжение бизнес-процесса required: true schema: type: string enum: - confirm - reject - cancel - cancelling-in-process - error - deliver - in-process - pickup - last-mile - participant-change - channel-change - provider-change - renotify - in-process-warning requestBody: content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/OrderActionDto' description: "Ключи — orderId, значения — тело action" examples: multipleOrders: summary: Пример с несколькими заказами value: EC7UYFCYYbGELNFwv: createdAt: 2025-09-19T13:45:00Z type: cancellinginprocess cancelledBy: name: 5Post type: provider reason: Недоступен адрес доставки cancelledAt: 2025-09-19T13:46:10Z EC7UYFCYYbGELNF34: createdAt: 2025-09-19T13:45:00Z type: cancellinginprocess cancelledBy: name: 5Post type: provider reason: Недоступен адрес доставки cancelledAt: 2025-09-19T13:46:10Z EC7UYFCYYbGE52532: createdAt: 2025-09-19T13:45:00Z type: cancellinginprocess cancelledBy: name: 5Post type: provider reason: Недоступен адрес доставки cancelledAt: 2025-09-19T13:46:10Z required: true responses: "200": description: OK "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_action: summary: Неверное действие value: error: invalid_request error_description: "No such action name: confirm1" "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: orders_not_found: summary: Заказы не найдены value: error: not_found error_description: "Not found order by ids EvNTKaXm4nonNpwhi1,\ \ AmNTKaXm4nonNpwhi2" unknown_endpoint: summary: Эндпоинт не найден или неактивен value: error: unknown_endpoint error_description: Endpoint is not found or not active "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] /api/gd/v1/channels/{channelId}/providers/{providerId}/locations: get: tags: - Channel-Provider summary: Получение всех локаций провайдера description: | Метод микросервиса предназначен для получения локаций провайдера. Если локации не найдены - вернется пустой массив. operationId: getLocationsUsingGET parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: since in: query description: | Идентификатор локации, относительно которого возвращается count элементов в направлении direction - Если параметр не передан, то вернется первые count локаций, упорядоченные во времени (от старых к новым), параметр direction не учитывается - Если count также не передан, то вернутся первые 10 локаций, упорядоченные во времени (от старых к новым). required: false schema: type: string - name: count in: query description: | Количество элементов, которое нужно вернуть - Минимальное значение - 1 - Максимальное значение - 1000 required: false schema: type: integer format: int32 default: 10 - name: direction in: query description: | Указывает, вернуть предыдущие записи или следующие - Если передано значение direction = next, то возвращается count локаций, идентификаторы которых > since - Если передано значение direction = prev, то возвращается count локаций, идентификаторы которых < since required: false schema: type: string default: next responses: "200": description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderLocationDto' examples: locations_list: summary: Локации успешно получены value: - id: 018f3a9d-8b8b-7234-8665-cd32ef189a21 type: parcel_locker name: Постамат 5Post address: "г. Москва, ул. Тверская, д. 1" coordinates: latitude: 55.751244 longitude: 37.618423 description: Постамат на Тверской externalId: 557ec28c-cf2b-4c6c-9603-33619d3c68d5 - id: 158f3a9d-8b8b-7234-8665-cd32ef189a22 type: shop name: Магазин 5Post address: "г. Москва, ул. Тверская, д. 3" coordinates: latitude: 55.751245 longitude: 37.618426 description: Магазин на Тверской externalId: 997ec28c-cf2b-4c6c-9603-33619d3c6851 empty_locations: summary: Локации не найдены value: [] "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_count: summary: Неверный параметр count value: error: invalid_request error_description: "Параметр count должен быть целым числом (п\ олучено: 'dfgs')" invalid_direction: summary: Неверный параметр direction value: error: invalid_request error_description: "Параметр direction должен быть 'next' или\ \ 'prev' (получено: 'иваыи')" count_exceeded: summary: Превышено максимальное значение count value: error: invalid_request error_description: "getLocations.count: must be less than or equal\ \ to 1000" "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] post: tags: - Channel-Provider summary: Создание локации провайдером operationId: createLocationsUsingPOST parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 requestBody: content: application/json: schema: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ProviderLocationDto' example: - type: parcel_locker name: Центральный район address: "г. Москва, ул. Тверская, д. 1" coordinates: latitude: 55.751244 longitude: 37.618423 description: string externalId: 557ec28c-cf2b-4c6c-9603-33619d3c68d5 - type: shop name: Центральный район address: "г. Москва, ул. Тверская, д. 3" coordinates: latitude: 55.751245 longitude: 37.618426 description: string externalId: 997ec28c-cf2b-4c6c-9603-33619d3c6851 required: true responses: "200": description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderLocationDto' example: - id: 018f3a9d-8b8b-7234-8665-cd32ef189a21 type: parcel_locker name: Центральный район address: "г. Москва, ул. Тверская, д. 1" coordinates: latitude: 55.751244 longitude: 37.618423 description: string externalId: 557ec28c-cf2b-4c6c-9603-33619d3c68d5 - id: 158f3a9d-8b8b-7234-8665-cd32ef189a22 type: shop name: Центральный район address: "г. Москва, ул. Тверская, д. 3" coordinates: latitude: 55.751245 longitude: 37.618426 description: string externalId: 997ec28c-cf2b-4c6c-9603-33619d3c6851 "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: validation_errors: summary: Ошибки валидации данных value: error: invalid_request error_description: "Параметр 0.coordinates.latitude должен быт\ ь числом с плавающей точкой (получено: 'qwe')" "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] /api/gd/v1/channels/{channelId}/providers/{providerId}/locations/do/{action}: post: tags: - Channel-Provider summary: Выполнение указанного действия над локациями description: | Метод микросервиса предназначен для выполнения указанного действия над локацией. Возможные действия (action): activate: активировать локацию, deactivate: деактивировать локацию. operationId: executeLocationActionUsingPOST parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: action in: path description: "Тип действия, выполняемого над локацией" required: true schema: type: string enum: - activate - deactivate requestBody: content: application/json: schema: $ref: '#/components/schemas/LocationIds' example: ids: - 018f3a9c-7a7a-7000-8000-7a7a7a7a7a7a - 018f3a9d-8b8b-7234-8665-cd32ef189a21 - 018f3a9e-9c9c-7567-9123-45ab67cd89ef required: true responses: "200": description: OK "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_action: summary: Неверное действие value: error: invalid_request error_description: "No such action name: confirm1" inactive_channel: summary: Локации недоступны для провайдера value: error: invalid_request error_description: "Not found all location ids [018f3a9d-8b8b-7234-8665-cd32ef189a21,\ \ 018f3a9d-8b8b-7234-8665-cd32ef189a22] for provider 6" "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: locations_not_found: summary: Локации не найдены value: error: not_found error_description: "Not found location by ids fkjdfjkfsk, alkgglka" unknown_endpoint: summary: Эндпоинт не найден или неактивен value: error: unknown_endpoint error_description: Endpoint is not found or not active "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] /api/gd/v1/channels/{channelId}/providers/{providerId}/orders: get: tags: - Channel-Provider summary: Получить список заказов description: | Возвращает список заказов с момента указанного ID с ограничением по лимитам Если провайдер или канал не активен, то будут возвращены только назначенные на провайдера заказы. operationId: getOrdersUsingGET parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: since in: query description: | Идентификатор заказа, относительно которого возвращается count элементов в направлении direction - Если параметр не передан, то вернется первые count заказов, упорядоченные во времени (от старых к новым), параметр direction не учитывается - Если count также не передан, то вернутся первые 10 заказов, упорядоченные во времени (от старых к новым). required: false schema: type: string - name: fullHistory in: query description: | Флаг для получения полной истории состояний заказа. - true: возвращает все состояния в хронологическом порядке - false (по умолчанию): возвращает только текущее актуальное состояние (actual=true) Использование fullHistory=false экономит трафик и ускоряет запросы к базе данных. required: false schema: type: boolean default: false - name: count in: query description: | Количество элементов, которое нужно вернуть - Минимальное значение - 1 - Максимальное значение - 1000 required: false schema: type: integer format: int32 default: 10 - name: direction in: query description: | Указывает, вернуть предыдущие записи или следующие - Если передано значение direction = next, то возвращается count заказов, идентификаторы которых > since - Если передано значение direction = prev, то возвращается count заказов, идентификаторы которых < since required: false schema: type: string default: next responses: "200": description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/OrderDto' examples: orders_list: summary: Список заказов value: - id: EC7UYFCYYbGELNFwv limits: whiteListChannelIds: - 1 blackListChannelIds: - 2 whiteListProviderIds: - 1 blackListProviderIds: - 2 parcel: weight: 1500 height: 100 length: 300 width: 200 description: Электронные компоненты value: 100 amount: 4 externalIds: supply_order_id: 12345 beginPoint: locationId: 018f7c7d-0123-7f4c-8abc-1234567890ab participant: id: 0 type: individual name: string phone: 79999999999 email: email@gmail.com endPoint: locationId: 018f7c7d-0123-7f4c-8abc-1234567890ab participant: id: 0 type: individual name: string phone: 79999999999 email: email@gmail.com states: - actual: false createdAt: 2025-08-10T10:00:00Z type: created initiator: name: CustomerApp - actual: false createdAt: 2025-08-10T11:00:00Z type: confirmed providerId: 1 channelId: 1 confirmedAt: 2025-08-10T21:38:49.675Z tracking: - name: Трек номер format: BARCODE value: - string providerStateDescription: Заказ подтвержден - actual: false createdAt: 2025-08-10T12:00:00Z type: rejected rejectedBy: name: DeliverySystem type: system reason: Недоступен адрес доставки rejectedAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T13:00:00Z type: delivered deliveredAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T14:00:00Z type: cancellinginprocess cancelledBy: name: Customer type: user reason: Отмена по инициативе клиента cancelledAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T15:00:00Z type: cancelled - actual: true createdAt: 2025-08-10T16:00:00Z type: error message: Ошибка при обработке заказа reportedBy: name: System type: system - actual: false createdAt: 2025-08-10T17:00:00Z type: atlastmile deliveredAt: 2025-08-10T21:38:49.675Z expireAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T18:00:00Z type: pickedup - actual: false createdAt: 2025-08-10T19:00:00Z type: inprocess providerStateDescription: Заказ в обработке - actual: false createdAt: 2025-08-10T20:00:00Z type: participantchanged beginPointParticipant: id: 0 type: individual name: Иванов Иван phone: 79999999999 email: email@gmail.com - actual: false createdAt: 2025-08-10T21:00:00Z type: providerchanged providerId: 1 - actual: false createdAt: 2025-08-10T22:00:00Z type: channelchanged channelId: 1 providerId: 1 - actual: false createdAt: 2025-08-10T23:00:00Z type: renotified channel: sms: 79999999999 email: email@gmail.com - actual: false createdAt: 2025-08-11T00:00:00Z type: inprocesswarning providerStateDescription: Детализированное описание проблемы empty_orders: summary: Заказы не найдены value: [] "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_fullHistory: summary: Неверный параметр fullHistory value: error: invalid_request error_description: "Параметр fullHistory должен быть 'true' ил\ и 'false' (получено: 'пыавпы')" invalid_count: summary: Неверный параметр count value: error: invalid_request error_description: "Параметр count должен быть целым числом (п\ олучено: 'dfgs')" invalid_direction: summary: Неверный параметр direction value: error: invalid_request error_description: "Параметр direction должен быть 'next' или\ \ 'prev' (получено: 'иваыи')" count_exceeded: summary: Превышено максимальное значение count value: error: invalid_request error_description: "getOrders.count: must be less than or equal\ \ to 1000" "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] /api/gd/v1/channels/{channelId}/providers/{providerId}/orders/{orderId}: get: tags: - Channel-Provider summary: Получить заказ description: Получение заказа по его ID operationId: getOrderUsingGET parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: orderId in: path description: "Уникальный идентификатор Заказа в формате нестандартного, сж\ атого UUIDv7 - UUIDv7.compressed. См. дополнительную документацию." required: true schema: type: string - name: fullHistory in: query required: false schema: type: boolean default: false responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/OrderDto' example: id: EC7UYFCYYbGELNFwv limits: whiteListChannelIds: - 1 blackListChannelIds: - 2 whiteListProviderIds: - 1 blackListProviderIds: - 2 parcel: weight: 1500 height: 100 length: 300 width: 200 description: Электронные компоненты value: 100 amount: 4 externalIds: supply_order_id: 12345 beginPoint: locationId: 018f7c7d-0123-7f4c-8abc-1234567890ab participant: id: 0 type: individual name: Иванов Иван phone: 79999999999 email: email@gmail.com endPoint: locationId: 018f7c7d-0123-7f4c-8abc-1234567890ab participant: id: 0 type: individual name: Петров Петр phone: 79999999999 email: email@gmail.com states: - actual: false createdAt: 2025-08-10T10:00:00Z type: created initiator: name: CustomerApp - actual: false createdAt: 2025-08-10T11:00:00Z type: confirmed providerId: 1 channelId: 1 confirmedAt: 2025-08-10T21:38:49.675Z tracking: - name: Трек номер format: BARCODE value: - MTIzNDU2Nzg= providerStateDescription: Заказ подтвержден - actual: false createdAt: 2025-08-10T12:00:00Z type: rejected rejectedBy: name: DeliverySystem type: system reason: Недоступен адрес доставки rejectedAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T13:00:00Z type: delivered deliveredAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T14:00:00Z type: cancellinginprocess cancelledBy: name: Customer type: user reason: Отмена по инициативе клиента cancelledAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T15:00:00Z type: cancelled - actual: true createdAt: 2025-08-10T16:00:00Z type: error message: Ошибка при обработке заказа reportedBy: name: System type: system - actual: false createdAt: 2025-08-10T17:00:00Z type: atlastmile deliveredAt: 2025-08-10T21:38:49.675Z expireAt: 2025-08-10T21:38:49.675Z - actual: false createdAt: 2025-08-10T18:00:00Z type: pickedup - actual: false createdAt: 2025-08-10T19:00:00Z type: inprocess providerStateDescription: Заказ в обработке - actual: false createdAt: 2025-08-10T20:00:00Z type: participantchanged beginPointParticipant: id: 0 type: individual name: Сидоров Алексей phone: 79999999999 email: email@gmail.com - actual: false createdAt: 2025-08-10T21:00:00Z type: providerchanged providerId: 1 - actual: false createdAt: 2025-08-10T22:00:00Z type: channelchanged channelId: 1 providerId: 1 - actual: false createdAt: 2025-08-10T23:00:00Z type: renotified channel: sms: 79999999999 email: email@gmail.com - actual: false createdAt: 2025-08-11T00:00:00Z type: inprocesswarning providerStateDescription: Детализированное описание проблемы "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_fullHistory: summary: Неверный параметр fullHistory value: error: invalid_request error_description: "Параметр fullHistory должен быть 'true' ил\ и 'false' (получено: 'пыавпы')" "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: order_not_found: summary: Заказ не найден value: error: not_found error_description: Not found order by id впв unknown_endpoint: summary: Эндпоинт не найден или неактивен value: error: unknown_endpoint error_description: Endpoint is not found or not active "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] /api/gd/v1/channels/{channelId}/providers/{providerId}/locations/{locationId}: get: tags: - Channel-Provider summary: Получение локации провайдера operationId: getLocationUsingGET parameters: - name: channelId in: path description: Уникальный идентификатор канала доставки required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: providerId in: path description: Уникальный идентификатор провайдера required: true schema: minimum: 1 type: integer format: int64 example: 1 - name: locationId in: path description: Уникальный идентификатор локации в формате UUIDv7 required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProviderLocationDto' example: id: 018f3a9d-8b8b-7234-8665-cd32ef189a21 type: parcel_locker name: Центральный район address: "г. Москва, ул. Тверская, д. 1" coordinates: latitude: 55.751244 longitude: 37.618423 description: string externalId: 557ec28c-cf2b-4c6c-9603-33619d3c68d5 "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: invalid_token: summary: Токен просрочен value: error: invalid_token error_description: "The access token provided is expired, revoked,\ \ malformed, or invalid for other reasons" "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope_1' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: location_not_found: summary: Локация не найдена value: error: not_found error_description: Not found location by id fkjdfjkfsk unknown_endpoint: summary: Эндпоинт не найден или неактивен value: error: unknown_endpoint error_description: Endpoint is not found or not active "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' examples: internal_error: summary: Внутренняя ошибка сервера value: error: internal_error error_description: Internal server error "503": description: Сервер временно недоступен security: - bearerAuth: [] /aff/jp/v1/creditors/compliance: summary: Проверка комплаенса контрагента description: Метод для проверки контрагента на комплаенс get: tags: - Aff-integration summary: Получение результата проверки клиента operationId: checkSoftCompanyByInn parameters: - name: inn in: query description: ИНН Кредитора required: true schema: type: string - name: name in: query description: Наименование Кредитора required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ComplianceResponse' examples: example: $ref: '#/components/examples/ComplianceResponse' "400": description: Отсутствие заголовков или неверные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /aff/jp/v1/registers/{registerId}/documents: summary: Получение документов реестра description: Метод для получения документов реестра по переданному идентификатору get: tags: - Aff-integration summary: Получение зип архива файлов operationId: downloadRegisterZip parameters: - name: registerId in: path description: Идентификатор реестра required: true schema: $ref: '#/components/schemas/requestUuid_1' responses: "200": description: Successful download of archive content: application/zip: schema: type: string format: binary "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Ендпоинт или запрашиваемый объект не найден content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /aff/jp/v1/payments/{paymentId}: summary: Проверить существование платежа и передать его статус description: Метод проверяет существование платежа с переданным идентификатором и возвращает его статус get: tags: - Aff-integration summary: Получение статуса платежа operationId: getPaymentStatus parameters: - name: paymentId in: path description: Идентификатор платежа required: true schema: $ref: '#/components/schemas/requestUuid_1' responses: "200": description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentStatusResponse' examples: example: $ref: '#/components/examples/StatusResponse' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Ендпоинт или запрашиваемый объект не найден content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /aff/jp/v1/payments: summary: Создать платежные поручения description: "Метод создает платежные поручения на основании массива исходных\ \ данных, полученных во входных параметрах" post: tags: - Aff-integration summary: Сохранение платежного поручения operationId: save requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePaymentRequest' examples: example: $ref: '#/components/examples/CreatePaymentRequest' required: true responses: "201": description: Ok content: application/json: schema: $ref: '#/components/schemas/SavePaymentResponse' examples: example: $ref: '#/components/examples/SavePaymentResponse' "400": description: Отсутствие заголовков или неверные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /aff/jp/v1/registers/{registerId}: summary: Проверить существование реестра и передать его статус description: Метод проверяет существование реестра с переданным идентификатором и возвращает его статус get: tags: - Aff-integration summary: Получение статуса реестра operationId: getRegisterStatus parameters: - name: registerId in: path description: Идентификатор реестра required: true schema: $ref: '#/components/schemas/requestUuid_1' responses: "200": description: Ok content: application/json: schema: $ref: '#/components/schemas/RegisterStatusResponse' examples: example: $ref: '#/components/examples/StatusResponse' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Ендпоинт или запрашиваемый объект не найден content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /aff/jp/v1/registers: summary: Создать реестр поручений description: Метод принимает платежное поручение и отдает id реестра post: tags: - Aff-integration summary: Создать реестр поручений operationId: create requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRegisterRequest' examples: example: $ref: '#/components/examples/CreateRegisterRequest' required: true responses: "201": description: Ok content: application/json: schema: $ref: '#/components/schemas/SaveRegisterResponse' examples: example: $ref: '#/components/examples/SaveRegisterResponse' "400": description: Отсутствие заголовков или неверные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /aff/jp/v1/registers/sign: summary: Подписание реестра description: "Метод подписывает реестр, проверяет корректность подписи и отпра\ вляет результат" post: tags: - Aff-integration summary: Подписание реестра operationId: sign requestBody: content: application/json: schema: $ref: '#/components/schemas/SignRegisterRequest' examples: example: $ref: '#/components/examples/SignRegisterRequest' required: true responses: "200": description: The registry has been successfully signed and sent for funding content: application/json: schema: $ref: '#/components/schemas/SignRegisterResponse' examples: example: $ref: '#/components/examples/SignRegisterResponse' "400": description: Отсутствие заголовков или неверные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Ендпоинт или запрашиваемый объект не найден content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' /pp/v1/orders: put: tags: - Business Lounge summary: Изменение информации о статусе заказа на списание лимитов проходов в БЗ operationId: updateOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOrderRequest' required: true responses: "200": description: Успешное изменение информации о статусе заказа content: application/json: schema: $ref: '#/components/schemas/UpdateOrderResponse' examples: example: $ref: '#/components/examples/UpdateOrderResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен security: - bearerAuth: [] post: tags: - Business Lounge summary: Создание заказа на списание лимитов проходов в БЗ по запросу от внешнего партнера operationId: createOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrderRequest' required: true responses: "201": description: Успешное создание заказа на списание лимитов проходов content: application/json: schema: $ref: '#/components/schemas/CreateOrderResponse' examples: example: $ref: '#/components/examples/CreateOrderResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "424": description: Недостаточно кол-во лимитов для осуществления компенсации content: application/json: schema: $ref: '#/components/schemas/ErrorLowBalance' "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен security: - bearerAuth: [] /pp/v1/balance: get: tags: - Business Lounge summary: "Получение кол-ва лимитов клиента по проходам в БЗ, доступных для с\ писания на данный момент" operationId: getBalance responses: "200": description: Успешное получение кол-ва лимитов клиента content: application/json: schema: $ref: '#/components/schemas/GetBalanceResponse' examples: example: $ref: '#/components/examples/GetBalanceResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен security: - bearerAuth: [] /pp/v1/lounge-reports: post: tags: - Business Lounge summary: "Передача факта посещения БЗ, vip-lounge, пользование услугой fasttrack" operationId: createLoungeReport requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLoungeReportRequest' examples: example: $ref: '#/components/examples/CreateLoungeReportRequest' required: true responses: "201": description: "Успешная передача факта посещения БЗ, vip-lounge либо поль\ зование услугой fasttrack" content: application/json: schema: $ref: '#/components/schemas/LoungeReportResponse' examples: example: $ref: '#/components/examples/LoungeReportResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен security: - bearerAuth: [] /dfa/gd/v1/dfa-profile/initial-placement-list: get: tags: - DFA summary: Получения списка первичных размещений ЦФА description: Получения списка первичных размещений ЦФА operationId: getInitialPlacementList parameters: - name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer example: 0 - name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer example: 10 - name: sort in: query description: "Порядок сортировки в формате <имя_поля,asc|desc>. Допустимо\ \ указать несколько значений" required: false schema: type: array items: type: string example: - "dfaName,desc" - name: customerType in: query description: | Тип инвестора. Возможные значения: * `PERSON` - физическое лицо; * `COMPANY` - юридическое лицо required: false schema: type: string example: PERSON - name: dfaName in: query description: Параметр фильтрации по наименованию ЦФА required: false schema: type: string example: NRD-DT-080324-0100 - name: dfaRedemptionDate in: query description: Параметр фильтрации по дате погашения ЦФА required: false schema: type: string format: date example: 2024-04-30 - name: dfaParValue in: query description: Параметр фильтрации по стоимости ЦФА required: false schema: type: integer format: int64 example: 100000 - name: dfaType in: query description: Параметр фильтрации по типу ЦФА required: false schema: type: string example: MONEY_CLAIM - name: dfaRateAmount in: query description: Параметр фильтрации по процентной ставке ЦФА required: false schema: type: string example: "1" - name: companyIssuerName in: query description: Параметр фильтрации по наименованию эмитента required: false schema: type: string example: Акционерное общество "Альфа банк" responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/getInitialPlacementListResponse' examples: example: $ref: '#/components/examples/getInitialPlacementListResponse' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error_1' "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_1' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error_1' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error_1' "409": description: Conflict content: application/json: schema: $ref: '#/components/schemas/Error_1' "429": description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error_1' "503": description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/Error_1' /gd/v1/crypto-service/certificates: get: tags: - Crypto-Service summary: Получение сертификатов подписи / шифрования responses: "200": description: Успешный результат headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponseCertificates' examples: example: $ref: '#/components/examples/responseGetCertificates' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен post: tags: - Crypto-Service summary: Загрузка сертификата шифрования requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestAddCertificate' examples: example: $ref: '#/components/examples/requestAddCertificate' responses: "201": description: Сертификат успешно загружен headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponseCertificate' examples: example: $ref: '#/components/examples/responseAddCertificate' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /gd/v1/crypto-service/certificates/{id}: patch: tags: - Crypto-Service summary: Обновление сертификата шифрования parameters: - name: id in: path description: Идентификатор сертификата required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestChangeCertificate' examples: example: $ref: '#/components/examples/requestChangeCertificate' responses: "200": description: Статус сертификата успешно обновлен headers: x-traceid: description: Идентификатор трассировки запроса schema: type: string example: a57610880b621435 content: application/json: schema: $ref: '#/components/schemas/ResponseCertificate' examples: example: $ref: '#/components/examples/responseChangeCertificate' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /claims/pp/v1/claims/{claimId}: put: tags: - Claims summary: Передать обработанное обращение в Банк description: Передача обработанного на стороне Партнера обращения operationId: CreateResolvedClaim parameters: - name: claimId in: path description: Идентификатор обращения в Банке required: true schema: type: string example: A2504090003 requestBody: content: application/json: schema: $ref: '#/components/schemas/claims-resolved' examples: example: $ref: '#/components/examples/claims-resolved' required: true responses: "200": description: Обращение передано "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен security: - bearerAuth: [] /order-core/pp/v1/travel/orders: post: tags: - Order-Core summary: Создание нового заказа Travel operationId: CreateTravelOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTravelOrder_request' examples: example: $ref: '#/components/examples/CreateOrderTravelRequest' required: true responses: "201": description: Заказ создан content: application/json: schema: $ref: '#/components/schemas/SuccessResponseCreateOrder' examples: example: $ref: '#/components/examples/SuccessResponseCreateOrder' "200": description: Заказ уже создан content: application/json: schema: $ref: '#/components/schemas/SuccessResponseAlreadyOrder' examples: example: $ref: '#/components/examples/SuccessResponseAlreadyOrder' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ \ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Route не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "502": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorBadGateway' security: - bearerAuth: - travelorder /order-core/pp/v1/afisha/orders: post: tags: - Order-Core summary: Создание нового заказа Afisha operationId: CreateAfishaOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAfishaOrder_request' examples: example: $ref: '#/components/examples/CreateOrderAfishaRequest' required: true responses: "201": description: Заказ создан content: application/json: schema: $ref: '#/components/schemas/SuccessResponseCreateOrder' examples: example: $ref: '#/components/examples/SuccessResponseCreateOrder' "200": description: Заказ уже создан content: application/json: schema: $ref: '#/components/schemas/SuccessResponseAlreadyOrder' examples: example: $ref: '#/components/examples/SuccessResponseAlreadyOrder' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ \ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Route не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "502": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorBadGateway' security: - bearerAuth: - afishaorder /order-core/pp/v1/travel/orders/{orderId}: put: tags: - Order-Core summary: Обновление заказа Travel operationId: UpdateTravelOrder parameters: - name: orderId in: path description: Идентификатор заказа в банке required: true schema: type: string example: s-5555 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTravelOrder_request' examples: example: $ref: '#/components/examples/UpdateOrderTravelRequest' required: true responses: "200": description: Заказ обновлен "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ \ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Route не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "422": description: Некорректный статус заказа content: application/json: schema: $ref: '#/components/schemas/ErrorIncorrectStatus' "429": description: Cлишком много запросов в заданный период времени "500": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "502": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorBadGateway' security: - bearerAuth: - travelorder /order-core/pp/v1/orders/{orderId}/confirmations: post: tags: - Order-Core summary: Подтверждение заказа operationId: ConfirmationBankOrder parameters: - name: orderId in: path description: Идентификатор заказа в банке required: true schema: type: string example: s-5555 requestBody: content: application/json: schema: $ref: '#/components/schemas/PostConfirmationRequest' examples: example: $ref: '#/components/examples/ConfirmationRequest' responses: "201": description: Заказ подтвержден content: application/json: schema: $ref: '#/components/schemas/SuccessResponseConfirmOrder' examples: example: $ref: '#/components/examples/SuccessResponseConfirmationOrder' "200": description: Заказ был подтвержден ранее content: application/json: schema: $ref: '#/components/schemas/SuccessConfirmAlreadyOrder' examples: example: $ref: '#/components/examples/SuccessConfirmAlreadyOrder' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ \ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Route не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "422": description: Некорректный статус заказа content: application/json: schema: $ref: '#/components/schemas/ErrorIncorrectStatus' "429": description: Cлишком много запросов в заданный период времени "500": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "502": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorBadGateway' security: - bearerAuth: - coreorders /order-core/pp/v1/orders/{orderId}: patch: tags: - Order-Core summary: Деактивация заказа operationId: DeactivateBankOrder parameters: - name: orderId in: path description: Идентификатор заказа в банке required: true schema: type: string example: s-5555 requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchDeactivateRequest' examples: example: $ref: '#/components/examples/PatchDeactivateRequest' responses: "204": description: Заказ деактивирован "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ \ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Route не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "502": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorBadGateway' security: - bearerAuth: - coreorders /order-core/pp/v1/bonus-accounts: get: tags: - Order-Core summary: Получение баланса operationId: GetBonusAccounts responses: "200": description: Успешный ответ баланса бонусных счетов content: application/json: schema: $ref: '#/components/schemas/SuccessResponseBonus' examples: example: $ref: '#/components/examples/SuccessResponseBonus' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ \ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Route не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "502": description: Неуспешный ответ content: application/json: schema: $ref: '#/components/schemas/ErrorBadGateway' security: - bearerAuth: - coreorders /jp/v1/self-encashment/registries: post: tags: - Self-encashment summary: Создание реестра раскассировки operationId: createSelfEncashmentRegistry requestBody: content: application/json: schema: $ref: '#/components/schemas/PostRegistriesRequest' examples: example: $ref: '#/components/examples/createRegistryRequest' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/PostRegistriesResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Конфликт content: application/json: schema: $ref: '#/components/schemas/ErrorConflict' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/self-encashment/registries/cancel: post: tags: - Self-encashment summary: Пакетная отмена реестров раскассировки operationId: cancelSelfEncashmentRegistries requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelRegistriesRequest' examples: example: $ref: '#/components/examples/cancelRegistriesRequest' responses: "202": description: Accepted content: application/json: schema: $ref: '#/components/schemas/CancelRegistriesResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Конфликт content: application/json: schema: $ref: '#/components/schemas/ErrorConflict' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /jp/v1/self-encashment/adm: get: tags: - Self-encashment summary: Получение информации об АДМ по их идентификаторам operationId: getAdmDevicesInfo parameters: - name: admPids in: query description: "Идентификаторы АДМ через запятую. Если не переданы, то возвр\ ащается информация по всем устройствам." required: false explode: false schema: maxItems: 100 type: array items: pattern: "^\\d{8}$" type: string example: - "00330456" - "00349012" - name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer example: 10 - name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer example: 0 responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetAdmResponse' examples: example: $ref: '#/components/examples/getAdmResponse' "400": description: Неверные входные параметры запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам." content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "409": description: Конфликт content: application/json: schema: $ref: '#/components/schemas/ErrorConflict' "429": description: Cлишком много запросов в заданный период времени "500": description: Внутренняя ошибка сервиса при выполнении обработки запроса content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /partner/jp/v1/individuals: get: tags: - Partner summary: Получение заявок ИП parameters: - name: fromDate in: query description: Начало интервала (ISO 8601 с миллисекундами и Z) required: false schema: pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" type: string format: date-time example: 2025-08-01T00:00:00.001Z - name: toDate in: query description: Конец интервала (ISO 8601 с миллисекундами и Z) required: false schema: pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" type: string format: date-time example: 2025-08-31T23:59:59.999Z - name: limit in: query description: Параметр пагинации - Запрашиваемое кол-во элементов на странице required: false schema: type: integer - name: offset in: query description: Параметр пагинации - Смещение от начала required: false schema: type: integer - name: sort in: query description: "Сортировка по полю и направлению. Формат: поле,направление.\ \ Доступные поля: createdAt, updatedAt. Доступные направления: asc (по в\ озрастанию), desc (по убыванию)." required: false schema: pattern: "^(createdAt|updatedAt),(asc|desc)$" type: string example: "createdAt,asc" responses: "200": content: application/json: schema: $ref: '#/components/schemas/IndividualsPage' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' security: - bearerAuth: [] post: tags: - Partner summary: Создание заявки ИП requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIndividualRequest' examples: create: $ref: '#/components/examples/create_individual_example' required: true responses: "201": description: Создано headers: Location: schema: type: string format: uri content: application/json: schema: $ref: '#/components/schemas/CreatedIndividualId' "400": content: application/json: schema: $ref: '#/components/schemas/Error_2' "401": content: application/json: schema: $ref: '#/components/schemas/Error_2' "403": content: application/json: schema: $ref: '#/components/schemas/Error_2' "415": content: application/json: schema: $ref: '#/components/schemas/Error_2' "500": content: application/json: schema: $ref: '#/components/schemas/Error_2' "503": content: application/json: schema: $ref: '#/components/schemas/Error_2' security: - bearerAuth: [] /partner/jp/v1/individuals/{individualId}: get: tags: - Partner summary: Получение заявки ИП по ID parameters: - name: individualId in: path required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/IndividualLead' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' security: - bearerAuth: [] /partner/jp/v1/llcs: get: tags: - Partner summary: Получение заявок ООО parameters: - name: fromDate in: query description: Начало интервала (ISO 8601 с миллисекундами и Z) required: false schema: pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" type: string format: date-time example: 2025-08-01T00:00:00.001Z - name: toDate in: query description: Конец интервала (ISO 8601 с миллисекундами и Z) required: false schema: pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" type: string format: date-time example: 2025-08-31T23:59:59.999Z - name: limit in: query description: Параметр пагинации - Запрашиваемое кол-во элементов на странице required: false schema: type: integer - name: offset in: query description: Параметр пагинации - Смещение от начала required: false schema: type: integer - name: sort in: query description: "Сортировка по полю и направлению. Формат: поле,направление.\ \ Доступные поля: createdAt, updatedAt. Доступные направления: asc (по в\ озрастанию), desc (по убыванию)." required: false schema: pattern: "^(createdAt|updatedAt),(asc|desc)$" type: string example: "createdAt,asc" responses: "200": content: application/json: schema: $ref: '#/components/schemas/LlcsPage' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' security: - bearerAuth: [] post: tags: - Partner summary: Создание заявки ООО requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLlcRequest' examples: create: $ref: '#/components/examples/create_llc_example' required: true responses: "201": description: Создано headers: Location: schema: type: string format: uri content: application/json: schema: $ref: '#/components/schemas/CreatedLlcId' "400": content: application/json: schema: $ref: '#/components/schemas/Error_2' "401": content: application/json: schema: $ref: '#/components/schemas/Error_2' "403": content: application/json: schema: $ref: '#/components/schemas/Error_2' "415": content: application/json: schema: $ref: '#/components/schemas/Error_2' "500": content: application/json: schema: $ref: '#/components/schemas/Error_2' "503": content: application/json: schema: $ref: '#/components/schemas/Error_2' security: - bearerAuth: [] /partner/jp/v1/llcs/{llcId}: get: tags: - Partner summary: Получение заявки ООО по ID parameters: - name: llcId in: path required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/LlcLead' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' security: - bearerAuth: [] /partner/jp/v1/manager-cities: get: tags: - Partner summary: Получение списка городов присутствия менеджеров parameters: - name: limit in: query description: Параметр пагинации - Запрашиваемое кол-во элементов на странице required: false schema: type: integer - name: offset in: query description: Параметр пагинации - Смещение от начала required: false schema: type: integer responses: "200": content: application/json: schema: $ref: '#/components/schemas/ManagerCitiesPage' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' security: - bearerAuth: [] /partner/jp/v1/clients-inn: get: tags: - Partner summary: Список ИНН клиентов с продажами за месяц по выбранным продуктам parameters: - name: month in: query description: Отчётный месяц (ISO 8601). Не старше 6 месяцев от текущей даты. required: true style: form explode: false schema: $ref: '#/components/schemas/MonthPeriod' example: 2025-08-01T00:00:00.000Z - name: productCode in: query description: Код продукта. Допускается передача только одного значения. required: true style: form explode: false schema: type: string example: DEBIT_CARD responses: "200": content: application/json: schema: $ref: '#/components/schemas/ClientsResponse' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' security: - bearerAuth: [] /partner/jp/v1/sales: get: tags: - Partner summary: Список успешно проданных продуктов по ИНН за указанный месяц parameters: - name: month in: query description: Отчётный месяц (ISO 8601). Не старше 6 месяцев от текущей даты. required: true style: form explode: false schema: $ref: '#/components/schemas/MonthPeriod' example: 2025-08-01T00:00:00.000Z - name: inn in: query description: ИНН ЮЛ required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/SalesResponse' "400": content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "500": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' security: - bearerAuth: [] /mathmod-scorings/jp/v1/compliance: get: tags: - Mathmod scorings summary: Получить оценку организации description: Метод получения уровня благонадежности организации по комплаенс-мерам operationId: getComplianceScore parameters: - name: inn in: query description: ИНН организации required: true schema: maxLength: 12 minLength: 10 type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ComplianceScoreResponse' examples: example: $ref: '#/components/examples/getComplianceScoreResponse' "400": description: Некорректная структура запроса content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: "Предоставленный токен просрочен, отозван, имеет неправильн\ ый формат или недействителен по другим причинам" content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: У пользователя нет прав на использование запрашиваемого сервиса content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: "Эндпоинт не найден, либо по указанному ИНН не найдена комп\ ания" content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени "500": description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервер временно недоступен /rates/gd/v1/offices-rates: get: tags: - Offices-rates summary: Получить курсы валют по офисам responses: "200": description: Успешный ответ с курсами валют content: application/json: schema: type: object examples: example: {} "400": description: Неверные входные параметры запроса. content: application/json: schema: $ref: '#/components/schemas/ErrorBadRequest' "401": description: Токен недействителен. content: application/json: schema: $ref: '#/components/schemas/ErrorUnauthorized' "403": description: "У пользователя нет прав на использование запрашиваемого се\ рвиса, доступ к которому не предусмотрен настройками scope" content: application/json: schema: $ref: '#/components/schemas/ErrorScope' "404": description: Эндпоинт не найден или неактивен content: application/json: schema: $ref: '#/components/schemas/ErrorNotFound' "429": description: Cлишком много запросов в заданный период времени content: application/json: schema: $ref: '#/components/schemas/Error_1' "500": description: Внутренняя ошибка сервиса. content: application/json: schema: $ref: '#/components/schemas/ErrorInternal' "503": description: Сервис временно недоступен content: application/json: schema: $ref: '#/components/schemas/Error_1' components: schemas: TokenRequest: required: - client_id - client_secret - grant_type type: object properties: grant_type: type: string description: Тип гранта example: authorization_code enum: - authorization_code - refresh_token - client_credentials code: type: string description: Код авторизации format: uuid example: 8962c304-89b1-11ec-a8a3-0242ac120002 client_id: type: string description: Идентификатор партнерского сервиса format: uuid example: 0cee0683-85ae-49f2-a63d-29f97aad1911 client_secret: type: string description: Секретный ключ партнерского сервиса example: Qwerty1234567890Qwerty1234567890! redirect_uri: type: string description: URI перенаправления example: https://wwww.partner.ru/code refresh_token: type: string description: Токен обновления format: uuid example: 13b8230b-b6bf-4bb9-b977-3bc0a988a5fd code_verifier: type: string description: Код верификатор scope: type: string description: Область применения example: loan-applications TokenResponse: required: - access_token - refresh_token - token_type type: object properties: access_token: type: string description: Токен доступа example: eyJraWQiOiJhbGZhLXRlc3Qtand0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIzMjI4ZTY4ZS1jYzM0LTRiODItYjQzZC00OTExMmI1ZDlkM2UiLCJhdWQiOiIwY2VlMDY4My04NWFlLTQ5ZjItYTYzZC0yOWY5N2FhZDE5MTEiLCJpc3MiOiJodHRwczpcL1wvaWQuYWxmYWJhbmsucnUiLCJleHAiOjE2MzE2NjY2NjMsInNjb3BlX3NlcnZpY2VzIjpbInBheW1lbnQiLCJzdGF0ZW1lbnQiXSwiaWF0IjoxNjMxNjYzMDYzLCJzY29wZV9jbGFpbXMiOlsibmFtZSIsImdpdmVuX25hbWUiLCJmYW1pbHlfbmFtZSIsIm1pZGRsZV9uYW1lIiwiZW1haWwiLCJwaG9uZV9udW1iZXIiXX0.RZ98I-PT_HGMzc7IbwGvlZjLOYuInta6pczEc_h4yCvZKCafIqs4ZBbs7eSY3NpXGzTbSZkGQA9wfX2NFDXZelwyNTooFQMpXzytrEhLww05H8ZFCH0kEQ_IpnJk-KeYkBLD0Oa75Gi6Lqj-Dr8KoX4Zq93ZyT4sr7Hzb1H287UlkJWVlpz_E7slLIob8m3keGbDysNyEBKJzsPcW27HENZBnvYwdE1pzwB8ObEZkICO8kbEP7MupLbhFyjxJFlI6Bq2DNjqi_QgQzvjvpD4KILxDms-Upg8h6GptYyoOl1BMGfN7WhN2vOUFYNuivNKctwcfD_H73kHJGu5KIJmGA refresh_token: type: string description: Токен обновления format: uuid example: 13b8230b-b6bf-4bb9-b977-3bc0a988a5fd token_type: type: string description: Тип токена example: Bearer enum: - Bearer expires_in: type: integer description: Срок жизни токена в секундах example: 3600 id_token: type: string description: Идентификационный токен example: eyJraWQiOiJhbGZhLXRlc3Qtand0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIzMjI4ZTY4ZS1jYzM0LTRiODItYjQzZC00OTExMmI1ZDlkM2UiLCJhdWQiOiIwY2VlMDY4My04NWFlLTQ5ZjItYTYzZC0yOWY5N2FhZDE5MTEiLCJhY3IiOiJMb0EzIiwiYXpwIjoiMGNlZTA2ODMtODVhZS00OWYyLWE2M2QtMjlmOTdhYWQxOTExIiwiYXV0aF90aW1lIjoxNjMxNjYzMDUzLCJpc3MiOiJodHRwczpcL1wvaWQuYWxmYWJhbmsucnUiLCJleHAiOjE2MzE2NjY2NjMsImlhdCI6MTYzMTY2MzA2Mywibm9uY2UiOiJuLTBTNl9XekEyTWoifQ.xBE6LEUxOKleHCZVQacldJfKr5KtyyvJKCCmInqapmRJ_aRF-cEoVfpJd_kxlNmJYT7AcjMMppovNkmhB49VL5DK8FhF0fvRgLskKR9Eohy4eiC8ued03Z1LyLz1H7EcKSkusaCIajzIvxxZfVtSHI4jmgLg6ItXPdZgIDUWINgESkl6I7IP5CbfONHweNnbkWEOEzxDgGGnxxtPxrWVoPVP-ijUeUSH_iESHfrhY_ePRMYi2If62IsKX_0GT5BHRYOhXVDZ9fyn5fRCvg8_QoCykDVIOZMtWQ3w4TadqS0dfMlsLBxkVbVftzH2fWRLTCX3SJ5AXiytHkpow8V45w example: access_token: eyJraWQiOiJhbGZhLXRlc3Qtand0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIzMjI4ZTY4ZS1jYzM0LTRiODItYjQzZC00OTExMmI1ZDlkM2UiLCJhdWQiOiIwY2VlMDY4My04NWFlLTQ5ZjItYTYzZC0yOWY5N2FhZDE5MTEiLCJpc3MiOiJodHRwczpcL1wvaWQuYWxmYWJhbmsucnUiLCJleHAiOjE2MzE2NjY2NjMsInNjb3BlX3NlcnZpY2VzIjpbInBheW1lbnQiLCJzdGF0ZW1lbnQiXSwiaWF0IjoxNjMxNjYzMDYzLCJzY29wZV9jbGFpbXMiOlsibmFtZSIsImdpdmVuX25hbWUiLCJmYW1pbHlfbmFtZSIsIm1pZGRsZV9uYW1lIiwiZW1haWwiLCJwaG9uZV9udW1iZXIiXX0.RZ98I-PT_HGMzc7IbwGvlZjLOYuInta6pczEc_h4yCvZKCafIqs4ZBbs7eSY3NpXGzTbSZkGQA9wfX2NFDXZelwyNTooFQMpXzytrEhLww05H8ZFCH0kEQ_IpnJk-KeYkBLD0Oa75Gi6Lqj-Dr8KoX4Zq93ZyT4sr7Hzb1H287UlkJWVlpz_E7slLIob8m3keGbDysNyEBKJzsPcW27HENZBnvYwdE1pzwB8ObEZkICO8kbEP7MupLbhFyjxJFlI6Bq2DNjqi_QgQzvjvpD4KILxDms-Upg8h6GptYyoOl1BMGfN7WhN2vOUFYNuivNKctwcfD_H73kHJGu5KIJmGA refresh_token: 13b8230b-b6bf-4bb9-b977-3bc0a988a5fd id_token: eyJraWQiOiJhbGZhLXRlc3Qtand0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIzMjI4ZTY4ZS1jYzM0LTRiODItYjQzZC00OTExMmI1ZDlkM2UiLCJhdWQiOiIwY2VlMDY4My04NWFlLTQ5ZjItYTYzZC0yOWY5N2FhZDE5MTEiLCJhY3IiOiJMb0EzIiwiYXpwIjoiMGNlZTA2ODMtODVhZS00OWYyLWE2M2QtMjlmOTdhYWQxOTExIiwiYXV0aF90aW1lIjoxNjMxNjYzMDUzLCJpc3MiOiJodHRwczpcL1wvaWQuYWxmYWJhbmsucnUiLCJleHAiOjE2MzE2NjY2NjMsImlhdCI6MTYzMTY2MzA2Mywibm9uY2UiOiJuLTBTNl9XekEyTWoifQ.xBE6LEUxOKleHCZVQacldJfKr5KtyyvJKCCmInqapmRJ_aRF-cEoVfpJd_kxlNmJYT7AcjMMppovNkmhB49VL5DK8FhF0fvRgLskKR9Eohy4eiC8ued03Z1LyLz1H7EcKSkusaCIajzIvxxZfVtSHI4jmgLg6ItXPdZgIDUWINgESkl6I7IP5CbfONHweNnbkWEOEzxDgGGnxxtPxrWVoPVP-ijUeUSH_iESHfrhY_ePRMYi2If62IsKX_0GT5BHRYOhXVDZ9fyn5fRCvg8_QoCykDVIOZMtWQ3w4TadqS0dfMlsLBxkVbVftzH2fWRLTCX3SJ5AXiytHkpow8V45w token_type: Bearer expires_in: 3600 TokenError: required: - error type: object properties: error: type: string description: Ошибка example: invalid_request error_description: type: string description: Описание ошибки UserInfoError: required: - error type: object properties: error: type: string description: Ошибка example: invalid_request error_description: type: string description: Описание ошибки ClientSecretResponse: required: - clientId - clientSecret type: object properties: clientId: type: string description: Идентификатор партнерского сервиса format: uuid example: 0cee0683-85ae-49f2-a63d-29f97aad1911 clientSecret: type: string description: Секретный ключ партнерского сервиса example: Qwerty1234567890Qwerty1234567890! example: clientId: 0cee0683-85ae-49f2-a63d-29f97aad1911 clientSecret: Qwerty1234567890Qwerty1234567890! ClientSecretError: required: - error type: object properties: error: type: string description: Ошибка example: invalid_request error_description: type: string description: Описание ошибки RevokeRequest: required: - client_id - client_secret - token type: object properties: client_id: type: string description: Идентификатор партнерского сервиса format: uuid example: 0cee0683-85ae-49f2-a63d-29f97aad1911 client_secret: type: string description: Секретный ключ партнерского сервиса example: Qwerty1234567890Qwerty1234567890! token: type: string description: Отзываемый токен token_type_hint: type: string description: Тип отзываемого токена example: refresh_token enum: - access_token - refresh_token RevokeError: required: - error type: object properties: error: type: string description: Ошибка example: invalid_request error_description: type: string description: Описание ошибки ClientInfo: required: - category - email - fullName - inn - kpps - ogrn - okpo - okved - organizationForm - organizationId - phone - registrationDate - shortName - status - type type: object properties: organizationId: type: string description: Хэш идентификатора клиента (ЮЛ) example: bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732 fullName: type: string description: Полное наименование организации example: Общество с ограниченной ответственностью "Ромашка" shortName: type: string description: Сокращённое наименование организации example: ООО "Ромашка" inn: type: string description: ИНН example: "114693784" organizationForm: $ref: '#/components/schemas/ClientInfo_organizationForm' kpps: type: array items: type: string description: Список КПП организации example: "2427920" ogrn: type: string description: ОГРН example: "1020203094163" okpo: type: string description: ОКПО example: "41294456" okved: type: string description: ОКВЭД example: "71.12" type: type: string description: Тип организации example: LEGAL phone: type: string description: Контактный телефон клиента example: "79099876543" email: type: string description: Электронная почта клиента example: client@example.com category: type: string description: Категория организации. BANK - банк; FINANCIAL - финансовая; OTHER - другая enum: - BANK - FINANCIAL - OTHER status: type: string description: Статус организации. ACTIVE — действующая; LIQUIDATING — ликвидируется; LIQUIDATED — ликвидирована enum: - ACTIVE - LIQUIDATING - LIQUIDATED registrationDate: type: string description: Дата регистрации организации format: date-time address: $ref: '#/components/schemas/Address' accounts: type: array items: $ref: '#/components/schemas/Account' example: ogrn: "1020203094163" organizationForm: code: "12300" fullName: Общество с ограниченной ответственностью shortName: ООО type: "2014" address: area: Тахтамукайский район settlementType: г. zip: "385600" country: "643" fiasCode: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 city: Майкоп house: "3" building: "1" settlement: Майкоп flat: "123" street: улица Депутатская fullAddress: "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3" region: Республика Адыгея inn: "114693784" fullName: Общество с ограниченной ответственностью "Ромашка" type: LEGAL okpo: "41294456" organizationId: bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732 phone: "79099876543" okved: "71.12" registrationDate: 2000-01-23T04:56:07.000+00:00 kpps: - "2427920" - "2427920" accounts: - specConditions: - code: AI17 description: Счёт заблокирован value: true - code: AI17 description: Счёт заблокирован value: true clientName: Наименование typeName: Расчётный счёт type: PAYMENT amountOverdraftOwnFunds: 0.8008281904610115 amountOverdraftLimit: 100000 amountBalance: 810000 amountHolds: 100 number: "40702810002300001935" blockedSums: - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" bank: bic: "044525593" transitAccountNumber: "40702978904100000001" amountTotal: 100000 openDate: 2021-10-07 currencyCode: "810" - specConditions: - code: AI17 description: Счёт заблокирован value: true - code: AI17 description: Счёт заблокирован value: true clientName: Наименование typeName: Расчётный счёт type: PAYMENT amountOverdraftOwnFunds: 0.8008281904610115 amountOverdraftLimit: 100000 amountBalance: 810000 amountHolds: 100 number: "40702810002300001935" blockedSums: - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" bank: bic: "044525593" transitAccountNumber: "40702978904100000001" amountTotal: 100000 openDate: 2021-10-07 currencyCode: "810" shortName: ООО "Ромашка" category: BANK email: client@example.com status: ACTIVE Address: type: object properties: area: type: string description: Район example: Тахтамукайский район building: type: string description: "Строение, корпус" example: "1" city: type: string description: Город example: Майкоп country: type: string description: Числовой код страны example: "643" flat: type: string description: Квартира example: "123" fullAddress: type: string description: Адрес example: "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3" house: type: string description: Дом example: "3" region: type: string description: Полное наименование региона example: Республика Адыгея settlement: type: string description: Населенный пункт example: Майкоп settlementType: type: string description: Тип населенного пункта example: г. street: type: string description: Улица example: улица Депутатская zip: type: string description: Индекс example: "385600" fiasCode: type: string description: Код ФИАС format: uuid example: area: Тахтамукайский район settlementType: г. zip: "385600" country: "643" fiasCode: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 city: Майкоп house: "3" building: "1" settlement: Майкоп flat: "123" street: улица Депутатская fullAddress: "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3" region: Республика Адыгея Account: type: object properties: number: maxLength: 20 minLength: 20 type: string description: Наименование счета example: "40702810002300001935" type: type: string description: Тип счёта example: PAYMENT typeName: type: string description: Наименование типа счёта example: Расчётный счёт openDate: type: string description: Дата открытия счёта example: 2021-10-07 currencyCode: maxLength: 3 minLength: 3 type: string description: Цифровой код валюты example: "810" transitAccountNumber: type: string description: Парный транзитный счет example: "40702978904100000001" specConditions: type: array items: $ref: '#/components/schemas/SpecCondition' clientName: type: string description: Клиентское наименование счёта example: Наименование amountBalance: type: number description: Текущий остаток по счёту в рублях(или в валюте счета) example: 810000 amountTotal: type: number description: Сумма доступных средств (без учёта овердрафта) в рублях(или в валюте счета) example: 100000 amountHolds: type: number description: Сумма зарезервированных средств (холды) в рублях(или в валюте счета) example: 100 amountOverdraftOwnFunds: type: number description: Собственные средства в рублях(или в валюте счета) amountOverdraftLimit: type: number description: Доступный лимит средств в рублях(или в валюте счета) example: 100000 blockedSums: type: array description: Заблокированные (арестованные) суммы на счёте items: $ref: '#/components/schemas/AccountBlockInfo' bank: $ref: '#/components/schemas/Account_bank' example: specConditions: - code: AI17 description: Счёт заблокирован value: true - code: AI17 description: Счёт заблокирован value: true clientName: Наименование typeName: Расчётный счёт type: PAYMENT amountOverdraftOwnFunds: 0.8008281904610115 amountOverdraftLimit: 100000 amountBalance: 810000 amountHolds: 100 number: "40702810002300001935" blockedSums: - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа №\ \ 53228 от 05.11.2019 г" sum: "988800" - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа №\ \ 53228 от 05.11.2019 г" sum: "988800" bank: bic: "044525593" transitAccountNumber: "40702978904100000001" amountTotal: 100000 openDate: 2021-10-07 currencyCode: "810" SpecCondition: type: object properties: code: type: string description: Код спецусловия example: AI17 description: type: string description: Описание спецусловия example: Счёт заблокирован value: type: boolean description: Текущее значение example: true description: Спецусловия по счету. Для AI12 - Нельзя дебетовать. AI11 - Нельзя кредитовать. AI14 - Клиент закрыт. AI17 - Счёт заблокирован. AI20 - Неактивный счёт. AI30 - Счёт закрыт. AI47 - Внутренний счёт. AI82 - Дебетование ограничено. AI83 - Электронная картотека. AI87 - Бумажная разновалютная картотека. example: code: AI17 description: Счёт заблокирован value: true AccountBlockInfo: type: object properties: num: type: string description: Номер решения example: "112233" beginDate: type: string description: Дата начала действия ограничения format: datetime example: 2020-10-23 cause: type: string description: Основание ареста example: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" initiator: type: string description: "Наименование органа, наложившего арест" example: Межрайонная ИФНС России № 51 по г. Москве sum: type: string description: Заблокированная (арестованная) сумма на счёте в рублях(или в валюте счета) example: "988800" blockType: type: string description: "Бухгалтерский режим, к которому относится данное решение.\ \ OUTGOING_LIMITATION - Полная блокировка; PARTIAL_BALANCE_BLOCK - Бло\ кировка части баланса" example: PARTIAL_BALANCE_BLOCK enum: - OUTGOING_LIMITATION - PARTIAL_BALANCE_BLOCK description: Объект массива с информацией о блокировках счета клиента example: beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа № 53228\ \ от 05.11.2019 г" sum: "988800" ErrorBadRequest: required: - error type: object properties: error: type: string description: Код ошибки example: invalid_request error_description: type: string description: Сообщение об ошибке example: Authorization header is not present in request headers description: Неверные входные параметры запроса ErrorUnauthorized: required: - error type: object properties: error: type: string description: Код ошибки example: invalid_token error_description: type: string description: Сообщение об ошибке example: "The access token provided is expired, revoked, malformed, or invalid\ \ for other reasons" description: "Предоставленный токен просрочен, отозван, имеет неправильный ф\ ормат или недействителен по другим причинам" ErrorScope: required: - error type: object properties: error: type: string description: Код ошибки example: insufficient_scope error_description: type: string description: Сообщение об ошибке example: The request requires higher privileges than provided by the access token description: "У пользователя нет прав на использование запрашиваемого сервис\ а, доступ к которому не предусмотрен настройками scope" ErrorNotFound: required: - error type: object properties: error: type: string description: Код ошибки example: unknown_endpoint error_description: type: string description: Сообщение об ошибке example: Endpoint is not found or not active description: Эндпоинт не найден или неактивен ErrorInternal: required: - error type: object properties: error: type: string description: Код ошибки example: internal_error error_description: type: string description: Сообщение об ошибке example: Internal server error description: Внутренняя ошибка сервиса при выполнении обработки запроса Statement: type: object properties: _links: type: array description: "Ссылки на предыдущую и следующую страницу, если они есть" items: $ref: '#/components/schemas/Links_inner' transactions: type: array description: Массив транзакций items: $ref: '#/components/schemas/Transactions_inner' description: Выписка операций по счетам example: _links: - rel: prev href: accountNumber=40702810500006103990&statementDate=2018-03-15&page=3 - rel: prev href: accountNumber=40702810500006103990&statementDate=2018-03-15&page=3 transactions: - documentDate: 2021-10-07 operationDate: 2018-12-31T00:00:00Z amount: amount: 1.01 currencyName: USD filial: АО "АЛЬФА-БАНК" correspondingAccount: "30101810400000000225" debtorCode: "0" curTransfer: payerBankCorrAccount: "30101810200000000593" intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга instructionCode: instructionCode messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 instructedAmount: "USD70,00" payeeBankCorrAccount: "30101810200000000593" transactionRelatedReference: transactionRelatedReference senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D intermediaryBankAccount: COBADEFF payerInn: "7728168971" senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK\ \ MOSCOW RUSSIAN FEDERATION" payeeBankBic: "9611925" senderCharges: "USD7,03" payeeKpp: "770801001" payeeAccount: "40802810401300015422" bankOperationCode: CRED transactionTypeCode: S01 payeeName: Наименование получателя messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageIdentifier: S000013082900014 beneficiaryCustomerName: ООО Ромашка payerName: Гаврилов Добрыня Петрович urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D orderingInstitutionAccount: ABOCBNBJ080 messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR transactionReferenceNumber: 69528 payerKpp: "770801001" payerBankName: АО \"АЛЬФА-БАНК\" orderingInstitutionOption: D payerAccount: "40802810401300015422" payeeBankName: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 payerBankBic: "044525593" payeeInn: "7728168971" receiverCharges: receiverCharges operationCode: "01" amountRub: amount: 1.01 currencyName: USD extendedDebtorCode: "50012008" swiftTransfer: bankOperationCode: CRED intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга transactionTypeCode: S01 instructionCode: instructionCode messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageIdentifier: S000013082900014 messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 beneficiaryCustomerName: ООО Ромашка instructedAmount: "USD70,00" transactionRelatedReference: transactionRelatedReference urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" orderingInstitutionAccount: ABOCBNBJ080 senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR intermediaryBankAccount: COBADEFF transactionReferenceNumber: 69528 orderingInstitutionOption: D senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK\ \ MOSCOW RUSSIAN FEDERATION" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 senderCharges: "USD7,03" receiverCharges: receiverCharges priority: "5" uuid: 55daccdf-de87-3879-976c-8b8415c8caf9 revaln: ПК transactionId: 1211206MOCO#DS0000017 rurTransfer: payerBankCorrAccount: "30101810200000000593" departmentalInfo: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" payerKpp: "770801001" receiptDate: 2018-12-31 deliveryKind: электронно payerBankName: АО \"АЛЬФА-БАНК\" payerInn: "7728168971" valueDate: 2018-12-31 cartInfo: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber payerAccount: "40802810401300015422" payeeName: Наименование получателя payeeBankName: АО \"АЛЬФА-БАНК\" payeeBankBic: "9611925" payerBankBic: "044525593" purposeCode: "1" payeeInn: "7728168971" payerName: Гаврилов Добрыня Петрович payeeBankCorrAccount: "30101810200000000593" payeeKpp: "770801001" payeeAccount: "40802810401300015422" payingCondition: payingCondition number: "1843" paymentPurpose: НДС не облагается direction: DEBIT - documentDate: 2021-10-07 operationDate: 2018-12-31T00:00:00Z amount: amount: 1.01 currencyName: USD filial: АО "АЛЬФА-БАНК" correspondingAccount: "30101810400000000225" debtorCode: "0" curTransfer: payerBankCorrAccount: "30101810200000000593" intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга instructionCode: instructionCode messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 instructedAmount: "USD70,00" payeeBankCorrAccount: "30101810200000000593" transactionRelatedReference: transactionRelatedReference senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D intermediaryBankAccount: COBADEFF payerInn: "7728168971" senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK\ \ MOSCOW RUSSIAN FEDERATION" payeeBankBic: "9611925" senderCharges: "USD7,03" payeeKpp: "770801001" payeeAccount: "40802810401300015422" bankOperationCode: CRED transactionTypeCode: S01 payeeName: Наименование получателя messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageIdentifier: S000013082900014 beneficiaryCustomerName: ООО Ромашка payerName: Гаврилов Добрыня Петрович urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D orderingInstitutionAccount: ABOCBNBJ080 messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR transactionReferenceNumber: 69528 payerKpp: "770801001" payerBankName: АО \"АЛЬФА-БАНК\" orderingInstitutionOption: D payerAccount: "40802810401300015422" payeeBankName: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 payerBankBic: "044525593" payeeInn: "7728168971" receiverCharges: receiverCharges operationCode: "01" amountRub: amount: 1.01 currencyName: USD extendedDebtorCode: "50012008" swiftTransfer: bankOperationCode: CRED intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга transactionTypeCode: S01 instructionCode: instructionCode messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageIdentifier: S000013082900014 messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 beneficiaryCustomerName: ООО Ромашка instructedAmount: "USD70,00" transactionRelatedReference: transactionRelatedReference urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" orderingInstitutionAccount: ABOCBNBJ080 senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR intermediaryBankAccount: COBADEFF transactionReferenceNumber: 69528 orderingInstitutionOption: D senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK\ \ MOSCOW RUSSIAN FEDERATION" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 senderCharges: "USD7,03" receiverCharges: receiverCharges priority: "5" uuid: 55daccdf-de87-3879-976c-8b8415c8caf9 revaln: ПК transactionId: 1211206MOCO#DS0000017 rurTransfer: payerBankCorrAccount: "30101810200000000593" departmentalInfo: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" payerKpp: "770801001" receiptDate: 2018-12-31 deliveryKind: электронно payerBankName: АО \"АЛЬФА-БАНК\" payerInn: "7728168971" valueDate: 2018-12-31 cartInfo: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber payerAccount: "40802810401300015422" payeeName: Наименование получателя payeeBankName: АО \"АЛЬФА-БАНК\" payeeBankBic: "9611925" payerBankBic: "044525593" purposeCode: "1" payeeInn: "7728168971" payerName: Гаврилов Добрыня Петрович payeeBankCorrAccount: "30101810200000000593" payeeKpp: "770801001" payeeAccount: "40802810401300015422" payingCondition: payingCondition number: "1843" paymentPurpose: НДС не облагается direction: DEBIT Links: type: array description: "Ссылки на предыдущую и следующую страницу, если они есть" items: $ref: '#/components/schemas/Links_inner' Transactions: type: array description: Массив транзакций items: $ref: '#/components/schemas/Transactions_inner' Amount: type: object properties: amount: type: number description: Сумма example: 1.01 currencyName: type: string description: Буквенный ISO-код валюты example: USD description: Сумма в валюте счета example: amount: 1.01 currencyName: USD AmountRub: type: object properties: amount: type: number description: Сумма example: 1.01 currencyName: type: string description: Буквенный ISO-код валюты example: USD description: Сумма в валюте счета example: amount: 1.01 currencyName: USD RurTransfer: type: object properties: cartInfo: $ref: '#/components/schemas/CartInfo' deliveryKind: type: string description: Способ отправки документа enum: - электронно - телеграфом - почтой - срочно x-enum-varnames: - ELECTRONICALLY - TELEGRAPH - POST - URGENT departmentalInfo: $ref: '#/components/schemas/DepartmentalInfo' payeeAccount: type: string description: Номер счёта получателя example: "40802810401300015422" payeeBankBic: type: string description: БИК банка получателя example: "9611925" payeeBankCorrAccount: type: string description: Корсчёт банка получателя example: "30101810200000000593" payeeBankName: type: string description: Наименование банка получателя example: АО \"АЛЬФА-БАНК\" payeeInn: type: string description: ИНН получателя example: "7728168971" payeeKpp: type: string description: КПП получателя example: "770801001" payeeName: type: string description: Наименование получателя example: Наименование получателя payerAccount: type: string description: Номер счёта плательщика example: "40802810401300015422" payerBankBic: type: string description: БИК банка плательщика example: "044525593" payerBankCorrAccount: type: string description: Корсчёт банка плательщика example: "30101810200000000593" payerBankName: type: string description: Наименование банка плательщика example: АО \"АЛЬФА-БАНК\" payerInn: type: string description: ИНН плательщика example: "7728168971" payerKpp: type: string description: КПП плательщика example: "770801001" payerName: type: string description: Наименование плательщика example: Гаврилов Добрыня Петрович payingCondition: type: string description: Условие оплаты (для 02) purposeCode: type: string description: | Кодовое назначение платежа * `1` - При переводе денежных средств, являющихся заработной платой и (или) иными доходами * `2` - При переводе денежных средств, являющихся доходами, на которые не может быть обращено взыскание * `3` - При переводе денежных средств, являющихся видами доходов enum: - "1" - "2" - "3" receiptDate: type: string description: Дата поступления в банк плательщика example: 2018-12-31 valueDate: type: string description: Дата валютирования example: 2018-12-31 description: Блок для описания рублевых счетов example: payerBankCorrAccount: "30101810200000000593" departmentalInfo: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" payerKpp: "770801001" receiptDate: 2018-12-31 deliveryKind: электронно payerBankName: АО \"АЛЬФА-БАНК\" payerInn: "7728168971" valueDate: 2018-12-31 cartInfo: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber payerAccount: "40802810401300015422" payeeName: Наименование получателя payeeBankName: АО \"АЛЬФА-БАНК\" payeeBankBic: "9611925" payerBankBic: "044525593" purposeCode: "1" payeeInn: "7728168971" payerName: Гаврилов Добрыня Петрович payeeBankCorrAccount: "30101810200000000593" payeeKpp: "770801001" payeeAccount: "40802810401300015422" payingCondition: payingCondition CartInfo: type: object properties: documentCode: type: string description: Шифр документа (картотека) (для 16) documentContent: type: string description: Содержание операции (для 16) documentDate: type: string description: Дата документа (картотека) (для 16) example: 2019-10-19T06:33:47.923Z documentNumber: type: string description: Номер документа (картотека) (для 16) paymentNumber: type: string description: Номер платежа (картотека) (для 16) restAmount: type: string description: Сумма остатка платежа (картотека) (для 16) description: Дополнительная информация о документе (картотека) example: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber DepartmentalInfo: type: object properties: uip: type: string description: Уникальный идентификатор платежа example: "32221003200126505006" drawerStatus101: type: string description: Показатель статуса налогоплательщика (реквизит - 101) example: "1" kbk: type: string description: Код бюджетной классификации (реквизит - 104) example: "39210202010061000160" oktmo: type: string description: Код OKTMO (реквизит - 105) example: "11605000" reasonCode106: type: string description: Показатель основания платежа (реквизит - 106) example: ТП taxPeriod107: type: string description: Налоговый период / код таможенного органа (реквизит - 107) example: МС.03.2016 docNumber108: type: string description: Номер налогового документа (реквизит - 108) example: "123" docDate109: type: string description: Дата налогового документа (реквизит - 109) example: 31.12.2018 paymentKind110: type: string description: ип налогового платежа (реквизит - 110) example: "1" description: "Реквизиты налогового, таможенного или иного бюджетного платежа" example: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" SwiftTransfer: type: object properties: bankOperationCode: type: string description: Код банковской операции (формат MT103) enum: - CRED beneficiaryBankAccount: type: string description: Номер счета банка бенефициара. 1-я часть значения поля 57 в формате MT103 example: LOYDGB21323 beneficiaryBankName: type: string description: "Код BIC, расположение или название и адрес банка бенефициа\ ра. Содержимое поля 57 (за исключением номера счета, с разделителями)\ \ в формате MT103" example: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: type: string description: Признак вида поля банка бенефициара (поле 57 в формате MT103) example: D beneficiaryCustomerAccount: type: string description: Номер счета бенефициара. 1-я часть значения поля 59 в формате MT103 example: /40702810701300000761 beneficiaryCustomerName: type: string description: "Код BIC/BEI или название и адрес бенефициара. Содержимое п\ оля 59 (за исключением номера счета, с разделителями) в формате MT103" example: ООО Ромашка detailsOfCharges: type: string description: | Сведения о расходах (формат MT103) * `OUR` - Все расходы по данной операции относятся на счет Плательщика enum: - OUR exchangeRate: type: string description: Курс конвертации (формат MT103) example: "67,74" instructedAmount: type: string description: Валюта/сумма по инструкции (формат MT103) example: "USD70,00" instructionCode: type: string description: Код инструкции (формат MT103) intermediaryBankAccount: type: string description: Номер счета банка-посредника.1-я часть значения поля 56 в формате MT103 example: COBADEFF intermediaryBankName: type: string description: "Код BIC или название банка-посредника. Содержимое поля 56\ \ (за исключением номера счета, с разделителями) в формате MT103" example: АО "АЛЬФА-БАНК" intermediaryBankOption: type: string description: Признак вида поля банка-посредника example: D messageDestinator: type: string description: Получатель сообщения SWIFT (формат MT103) example: LAPBLV2X messageIdentifier: type: string description: Уникальный системный номер сообщения SWIFT (формат MT103) example: S000013082900014 messageOriginator: type: string description: Отправитель сообщения SWIFT (формат MT103) example: SABRRU2P messageReceiveTime: type: string description: Дата и время получения сообщения SWIFT (формат MT103) example: 15-05-27 13:21 messageSendTime: type: string description: Дата и время отправки сообщения SWIFT (формат MT103) example: 15-05-27 13:21 messageType: type: string description: Тип сообщения SWIFT enum: - "103" orderingCustomerAccount: type: string description: Номер счета плательщика в формате example: /08251801040004813 orderingCustomerName: type: string description: "Код BIC/BEI или название и адрес плательщика.Содержимое по\ ля 50 (за исключением номера счета, с разделителями) в формате MT103" example: ООО Радуга orderingCustomerOption: type: string description: Признак вида поля плательщика example: K orderingInstitutionAccount: type: string description: Номер счета банка плательщика.1-я часть значения поля 52 в формате MT103 example: ABOCBNBJ080 orderingInstitutionName: type: string description: "Код BIC или название и адрес банка плательщика. Содержимое\ \ поля 52 (за исключением номера счета, с разделителями) в формате MT103" example: АО "АЛЬФА-БАНК" orderingInstitutionOption: type: string description: Признак вида поля банка плательщика example: D receiverCharges: type: string description: Расходы получателя (формат MT103) receiverCorrespondentAccount: type: string description: Номер счета корреспондента получателя. example: "30101810400000000000" receiverCorrespondentName: type: string description: "Код BIC, расположение или название и адрес корреспондента\ \ получателя. Содержимое поля 54 (за исключением номера счета, с разде\ лителями) в формате MT103" example: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK MOSCOW RUSSIAN FEDERATION" receiverCorrespondentOption: type: string description: Признак вида поля корреспондента example: D regulatoryReporting: type: string description: Контрольная отчетность (формат MT103) example: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 remittanceInformation: type: string description: "Сведения о переводе (формат MT103, поле 70)" example: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES senderCharges: type: string description: Расходы отправителя (формат MT103) example: "USD7,03" senderCorrespondentAccount: type: string description: Номер счета корреспондента отправителя. example: BOTKGB2L senderCorrespondentName: type: string description: "Код BIC, расположение или название и адрес корреспондента\ \ отправителя. Содержимое поля 53 (за исключением номера счета, с разд\ елителями) в формате MT103" example: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentOption: type: string description: Признак вида поля корреспондента example: D senderToReceiverInformation: type: string description: Информация отправителя получателю (формат MT103) example: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA transactionReferenceNumber: type: string description: "Референс операции (формат MT103, поле 20)" example: "69528" transactionRelatedReference: type: string description: Связанный референс (формат MT103) transactionTypeCode: type: string description: Код типа операции (формат MT103) example: S01 urgent: type: string description: | Признак срочности операции (формат MT103) * `URGENT` - Срочная операция * `NORMAL` - Обычная операция enum: - URGENT - NORMAL valueDateCurrencyInterbankSettledAmount: type: string description: "Дата валютирования, код валюты, сумма межбанковского расче\ та (формат MT103)" example: "130824EUR5447,34" description: Блок для описания валютных счетов example: bankOperationCode: CRED intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга transactionTypeCode: S01 instructionCode: instructionCode messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageIdentifier: S000013082900014 messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 beneficiaryCustomerName: ООО Ромашка instructedAmount: "USD70,00" transactionRelatedReference: transactionRelatedReference urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" orderingInstitutionAccount: ABOCBNBJ080 senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR intermediaryBankAccount: COBADEFF transactionReferenceNumber: 69528 orderingInstitutionOption: D senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK MOSCOW\ \ RUSSIAN FEDERATION" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 senderCharges: "USD7,03" receiverCharges: receiverCharges CurTransfer: type: object properties: bankOperationCode: type: string description: Код банковской операции (формат MT103) enum: - CRED beneficiaryBankAccount: type: string description: Номер счета банка бенефициара. 1-я часть значения поля 57 в формате MT103 example: LOYDGB21323 beneficiaryBankName: type: string description: "Код BIC, расположение или название и адрес банка бенефициа\ ра. Содержимое поля 57 (за исключением номера счета, с разделителями)\ \ в формате MT103" example: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: type: string description: Признак вида поля банка бенефициара (поле 57 в формате MT103) example: D beneficiaryCustomerAccount: type: string description: Номер счета бенефициара. 1-я часть значения поля 59 в формате MT103 example: /40702810701300000761 beneficiaryCustomerName: type: string description: "Код BIC/BEI или название и адрес бенефициара. Содержимое п\ оля 59 (за исключением номера счета, с разделителями) в формате MT103" example: ООО Ромашка detailsOfCharges: type: string description: | Сведения о расходах (формат MT103) * `OUR` - Все расходы по данной операции относятся на счет Плательщика enum: - OUR exchangeRate: type: string description: Курс конвертации (формат MT103) example: "67,74" instructedAmount: type: string description: Валюта/сумма по инструкции (формат MT103) example: "USD70,00" instructionCode: type: string description: Код инструкции (формат MT103) intermediaryBankAccount: type: string description: Номер счета банка-посредника.1-я часть значения поля 56 в формате MT103 example: COBADEFF intermediaryBankName: type: string description: "Код BIC или название банка-посредника. Содержимое поля 56\ \ (за исключением номера счета, с разделителями) в формате MT103" example: АО "АЛЬФА-БАНК" intermediaryBankOption: type: string description: Признак вида поля банка-посредника example: D messageDestinator: type: string description: Получатель сообщения SWIFT (формат MT103) example: LAPBLV2X messageIdentifier: type: string description: Уникальный системный номер сообщения SWIFT (формат MT103) example: S000013082900014 messageOriginator: type: string description: Отправитель сообщения SWIFT (формат MT103) example: SABRRU2P messageReceiveTime: type: string description: Дата и время получения сообщения SWIFT (формат MT103) example: 15-05-27 13:21 messageSendTime: type: string description: Дата и время отправки сообщения SWIFT (формат MT103) example: 15-05-27 13:21 messageType: type: string description: Тип сообщения SWIFT enum: - "103" orderingCustomerAccount: type: string description: Номер счета плательщика в формате example: /08251801040004813 orderingCustomerName: type: string description: "Код BIC/BEI или название и адрес плательщика.Содержимое по\ ля 50 (за исключением номера счета, с разделителями) в формате MT103" example: ООО Радуга orderingCustomerOption: type: string description: Признак вида поля плательщика example: K orderingInstitutionAccount: type: string description: Номер счета банка плательщика.1-я часть значения поля 52 в формате MT103 example: ABOCBNBJ080 orderingInstitutionName: type: string description: "Код BIC или название и адрес банка плательщика. Содержимое\ \ поля 52 (за исключением номера счета, с разделителями) в формате MT103" example: АО "АЛЬФА-БАНК" orderingInstitutionOption: type: string description: Признак вида поля банка плательщика example: D receiverCharges: type: string description: Расходы получателя (формат MT103) receiverCorrespondentAccount: type: string description: Номер счета корреспондента получателя. example: "30101810400000000000" receiverCorrespondentName: type: string description: "Код BIC, расположение или название и адрес корреспондента\ \ получателя. Содержимое поля 54 (за исключением номера счета, с разде\ лителями) в формате MT103" example: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK MOSCOW RUSSIAN FEDERATION" receiverCorrespondentOption: type: string description: Признак вида поля корреспондента example: D regulatoryReporting: type: string description: Контрольная отчетность (формат MT103) example: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 remittanceInformation: type: string description: "Сведения о переводе (формат MT103, поле 70)" example: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES senderCharges: type: string description: Расходы отправителя (формат MT103) example: "USD7,03" senderCorrespondentAccount: type: string description: Номер счета корреспондента отправителя. example: BOTKGB2L senderCorrespondentName: type: string description: "Код BIC, расположение или название и адрес корреспондента\ \ отправителя. Содержимое поля 53 (за исключением номера счета, с разд\ елителями) в формате MT103" example: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentOption: type: string description: Признак вида поля корреспондента example: D senderToReceiverInformation: type: string description: Информация отправителя получателю (формат MT103) example: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA transactionReferenceNumber: type: string description: "Референс операции (формат MT103, поле 20)" example: "69528" transactionRelatedReference: type: string description: Связанный референс (формат MT103) transactionTypeCode: type: string description: Код типа операции (формат MT103) example: S01 urgent: type: string description: | Признак срочности операции (формат MT103) * `URGENT` - Срочная операция * `NORMAL` - Обычная операция enum: - URGENT - NORMAL valueDateCurrencyInterbankSettledAmount: type: string description: "Дата валютирования, код валюты, сумма межбанковского расче\ та (формат MT103)" example: "130824EUR5447,34" payeeBankBic: type: string description: БИК банка получателя example: "9611925" payeeBankCorrAccount: type: string description: Корсчёт банка получателя example: "30101810200000000593" payeeAccount: type: string description: Номер счёта получателя example: "40802810401300015422" payeeBankName: type: string description: Наименование банка получателя example: АО \"АЛЬФА-БАНК\" payeeInn: type: string description: ИНН получателя example: "7728168971" payeeKpp: type: string description: КПП получателя example: "770801001" payeeName: type: string description: Наименование получателя example: Наименование получателя payerAccount: type: string description: Номер счёта плательщика example: "40802810401300015422" payerBankBic: type: string description: БИК банка плательщика example: "044525593" payerBankCorrAccount: type: string description: Корсчёт банка плательщика example: "30101810200000000593" payerBankName: type: string description: Наименование банка плательщика example: АО \"АЛЬФА-БАНК\" payerInn: type: string description: ИНН плательщика example: "7728168971" payerKpp: type: string description: КПП плательщика example: "770801001" payerName: type: string description: Наименование плательщика example: Гаврилов Добрыня Петрович description: Блок для описания валютных счетов example: payerBankCorrAccount: "30101810200000000593" intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга instructionCode: instructionCode messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 instructedAmount: "USD70,00" payeeBankCorrAccount: "30101810200000000593" transactionRelatedReference: transactionRelatedReference senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D intermediaryBankAccount: COBADEFF payerInn: "7728168971" senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK MOSCOW\ \ RUSSIAN FEDERATION" payeeBankBic: "9611925" senderCharges: "USD7,03" payeeKpp: "770801001" payeeAccount: "40802810401300015422" bankOperationCode: CRED transactionTypeCode: S01 payeeName: Наименование получателя messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageIdentifier: S000013082900014 beneficiaryCustomerName: ООО Ромашка payerName: Гаврилов Добрыня Петрович urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D orderingInstitutionAccount: ABOCBNBJ080 messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR transactionReferenceNumber: 69528 payerKpp: "770801001" payerBankName: АО \"АЛЬФА-БАНК\" orderingInstitutionOption: D payerAccount: "40802810401300015422" payeeBankName: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 payerBankBic: "044525593" payeeInn: "7728168971" receiverCharges: receiverCharges ResponseSigned: type: object properties: Pagination: $ref: '#/components/schemas/Pagination' Statement: $ref: '#/components/schemas/Statement_1' ds:Signature: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignature' description: Ответ для выписки в формате 1С xml: name: Response Pagination: type: object properties: Limit: minimum: 0 type: integer description: Количество записей на одной странице example: 1000 xml: name: Limit Offset: minimum: 0 type: integer description: "Количество записей в списке, которые были пропущены" example: 0 xml: name: Offset TotalCount: minimum: 0 type: integer description: Общее количество записей example: 10000 xml: name: TotalCount description: Данные пагинации xml: name: Pagination Statement_1: type: object properties: creationDate: type: string description: Дата и время формирования example: 2022-01-21T11:25:22.522Z xml: name: creationDate attribute: true formatVersion: type: string description: Версия формата example: 2.3.2 xml: name: formatVersion attribute: true id: type: string description: Уникальный идентификатор выписки example: f7cbc6af-33dd-4c37-b67d-7400e1c327ad xml: name: id attribute: true Data: $ref: '#/components/schemas/Data' Recipient: $ref: '#/components/schemas/Recipient' Sender: $ref: '#/components/schemas/Sender' description: Выписка операций по счетам в формате 1С xml: name: Statement namespace: http://directbank.1c.ru/XMLSchema Data: type: object properties: Account: type: string description: Номер лиц. счета example: "40702810701300000761" xml: name: Account Bank: $ref: '#/components/schemas/Bank' ClosingBalance: type: number description: Остаток на счете на конец периода example: 99407.2 xml: name: ClosingBalance DateFrom: type: string description: Начало периода выписки example: 2021-05-26T00:00:00.000 xml: name: DateFrom DateTo: type: string description: Конец периода выписки example: 2021-05-26T23:59:59.999 xml: name: DateTo OpeningBalance: type: number description: Остаток на счете на начало периода example: 99527.0 xml: name: OpeningBalance OperationInfo: type: array description: Информация об одной операции по лицевому счету в выписке xml: name: OperationInfo items: $ref: '#/components/schemas/OperationInfo' Stamp: $ref: '#/components/schemas/Stamp' StatementType: type: string description: | Тип выписки * `0` - Окончательная выписка xml: name: StatementType enum: - "0" - "1" - "2" x-enum-varnames: - ZERO - ONE - TWO TotalCredits: type: number description: Общая сумма документов по кредиту счета (поступление) example: 100000.0 xml: name: TotalCredits TotalDebits: type: number description: Общая сумма документов по дебету счета (списание) example: 853.0 xml: name: TotalDebits description: Данные выписки по лиц. счету xml: name: Data Bank: type: object properties: Bic: type: string description: БИК банка example: "044525593" xml: name: BIC CorrespAcc: type: string description: Коррсчет банка example: "30101810200000000593" xml: name: CorrespAcc Name: type: string description: Название банка example: АО "АЛЬФА-БАНК" xml: name: Name description: Данные банка OperationInfo: type: object properties: Date: type: string description: Дата проводки документа по лиц. счету example: 2022-01-20 xml: name: Date Dc: $ref: '#/components/schemas/Dc' ExtId: type: string description: ID исходного платежного документа плательщик example: "null" xml: name: ExtID PayDoc: $ref: '#/components/schemas/PayDoc' Stamp: $ref: '#/components/schemas/PayDocStamp' description: Информация об одной операции по лицевому счету в выписке Dc: type: string description: | Признак дебета/кредита * `1` - Операция по дебету (списание со счета) * `2` - Операция по кредиту (поступление на счет) xml: name: DC enum: - "1" - "2" x-enum-varnames: - DEBIT - CREDIT PayDoc: type: object properties: PayDocRu: $ref: '#/components/schemas/PayDocRu' PayRequest: $ref: '#/components/schemas/PayRequest' CollectionOrder: $ref: '#/components/schemas/PayDocRu' PaymentOrder: $ref: '#/components/schemas/PaymentOrder' BankOrder: $ref: '#/components/schemas/BankOrder' MemOrder: $ref: '#/components/schemas/BankOrder' docKind: type: string description: | Код вида электронного документа * `10` - Платежное поручение * `11` - Платежное требование * `16` - Мемориальный ордер * `17` - Платежный ордер * `18` - Банковский ордер xml: name: docKind attribute: true enum: - "10" - "10" - "11" - "16" - "17" - "18" - "18" x-enum-varnames: - PAYMENT - PAYMENT_ORDER - PAYMENT_REQUEST - MEMORY_ORDER - COLLECTION_LETTER - BANK_ORDER - DEFAULT id: type: string description: Идентификатор платежного документа в банке example: 1220120MOPYTMD0000031_artificially_created xml: name: id attribute: true extId: type: string xml: name: extId attribute: true PayDocRu: type: object properties: BudgetPaymentInfo: $ref: '#/components/schemas/BudgetPaymentInfo' Code: type: string description: Уникальный идентификатор платежа (поле 22) example: "0" xml: name: Code DocDate: type: string description: Дата составления (поле 4) example: 2019-05-04 xml: name: DocDate DocNo: type: string description: Номер документа (поле 3) example: "768" xml: name: DocNo IncomeTypeCode: type: string description: Код вида дохода (поле 20) example: "2" xml: name: IncomeTypeCode Payee: $ref: '#/components/schemas/Accounts' Payer: $ref: '#/components/schemas/Accounts' PaymentKind: $ref: '#/components/schemas/PaymentKind' Priority: type: string description: Очередность платежа (поле 21) example: "5" xml: name: Priority Purpose: type: string description: Назначение платежа (поле 24) example: Комиссия за переводы в валюте РФ за 2022-01-20. xml: name: Purpose Sum: type: number description: Сумма документа (поле 7) example: 36.0 xml: name: Sum TransitionKind: type: string description: Вид операции (поле 18) example: "17" xml: name: TransitionKind description: Данные платежного поручения xml: name: PayDocRu BudgetPaymentInfo: type: object properties: Cbc: type: string description: Код бюджетной классификации (КБК) в соответствии с классификацией доходов бюджетов РФ (поле 104) example: "0" xml: name: CBC DocDate: type: string description: Дата налогового документа или 0 (поле 109) example: 22.01.2022 xml: name: DocDate DocNo: type: string description: Номер налогового документа (поле 108) example: "12345" xml: name: DocNo DrawerStatus: type: string description: Статус составителя (поле 101). example: "1" xml: name: DrawerStatus Oktmo: type: string description: Значение кода ОКТМО муниципального образования (поле 105) example: "54701000" xml: name: OKTMO PayType: type: string description: Код выплат (поле 110) example: "1" xml: name: PayType Reason: type: string description: Основание налогового платежа (поле 106) example: ТП xml: name: Reason TaxPeriod: type: string description: Налоговый период / код таможенного органа (поле 107) example: МС.03.2016 xml: name: TaxPeriod Accounts: type: object properties: Account: type: string description: Расчетный счет клиента example: "40702810701300000761" xml: name: Account Bank: $ref: '#/components/schemas/Bank' Inn: type: string description: ИНН налогоплательщика example: "25247358" xml: name: INN Kpp: type: string description: КПП налогоплательщика example: "037186025" xml: name: KPP Name: type: string description: Наименование налогоплательщика example: Полное наименование Орг № 11329 xml: name: Name description: Данные налогоплательщика PaymentKind: type: string description: Вид платежа (поле 5) xml: name: PaymentKind enum: - электронно - телеграфом - почтой - срочно x-enum-varnames: - ELECTRONICALLY - TELEGRAPH - POST - URGENT PayRequest: type: object properties: AcceptTerm: type: integer description: Срок для акцепта (поле 36) format: int32 example: 0 xml: name: AcceptTerm Code: type: string description: Уникальный идентификатор платежа (поле 22) example: "0" xml: name: Code DocDate: type: string description: Дата составления (поле 4) example: 2019-05-04 xml: name: DocDate DocDispatchDate: type: string description: Дата отсылки (вручения) плательщику предусмотренных договором документов (поле 37) example: 20.01.2022 xml: name: DocDispatchDate DocNo: type: string description: Номер документа (поле 3) example: "768" xml: name: DocNo IncomeTypeCode: type: string description: Код вида дохода (поле 20) example: "2" xml: name: IncomeTypeCode Payee: $ref: '#/components/schemas/Accounts' Payer: $ref: '#/components/schemas/Accounts' PaymentCondition: type: string description: Условие оплаты (поле 35) example: "1" xml: name: PaymentCondition PaymentKind: $ref: '#/components/schemas/PaymentKind' Priority: type: string description: Очередность платежа (поле 21) example: "5" xml: name: Priority Purpose: type: string description: Назначение платежа (поле 24) example: Комиссия за переводы в валюте РФ за 2022-01-20. xml: name: Purpose Sum: type: number description: Сумма документа (поле 7) example: 36.0 xml: name: Sum TransitionKind: type: string description: Вид операции (поле 18) example: "17" xml: name: TransitionKind description: Данные платежного требования xml: name: PayRequest PaymentOrder: type: object properties: BudgetPaymentInfo: $ref: '#/components/schemas/BudgetPaymentInfo' Code: type: string description: Уникальный идентификатор платежа (поле 22) example: "0" xml: name: Code DocDate: type: string description: Дата составления (поле 4) example: 2019-05-04 xml: name: DocDate DocNo: type: string description: Номер документа (поле 3) example: "768" xml: name: DocNo IncomeTypeCode: type: string description: Код вида дохода (поле 20) example: "2" xml: name: IncomeTypeCode PartialDocDate: type: string description: Дата платежного документа (поле 41) example: 20.01.2022 xml: name: PartialDocDate PartialDocNo: type: string description: Номер платежного документа (поле 40) example: "12345" xml: name: PartialDocNo PartialPaymentNo: type: string description: Номер частичного платежа (поле 38) example: "0" xml: name: PartialPaymentNo PartialTransitionKind: type: string description: Шифр платежного документа (поле 39) example: "3" xml: name: PartialTransitionKind Payee: $ref: '#/components/schemas/Accounts' Payer: $ref: '#/components/schemas/Accounts' PaymentKind: $ref: '#/components/schemas/PaymentKind' Priority: type: string description: Очередность платежа (поле 21) example: "5" xml: name: Priority Purpose: type: string description: Назначение платежа (поле 24) example: Комиссия за переводы в валюте РФ за 2022-01-20. xml: name: Purpose Sum: type: number description: Сумма документа (поле 7) example: 36.0 xml: name: Sum SumResidualPayment: type: number description: Сумма остатка платежа (поле 42) example: 0 xml: name: SumResidualPayment TransitionContent: type: string description: Содержание операции (поле 70) example: "null" xml: name: TransitionContent TransitionKind: type: string description: Вид операции (поле 18) example: "17" xml: name: TransitionKind description: Данные платежного ордера xml: name: PaymentOrder BankOrder: type: object properties: Code: type: string description: Уникальный идентификатор платежа (поле 22) example: "0" xml: name: Code DocDate: type: string description: Дата составления (поле 4). example: 2022-01-22 xml: name: DocDate DocNo: type: string description: Номер документа (поле 3). example: "12345" xml: name: DocNo Payee: $ref: '#/components/schemas/Accounts' Payer: $ref: '#/components/schemas/Accounts' PaymentKind: $ref: '#/components/schemas/PaymentKind' Priority: type: string description: Очередность платежа (поле 21) example: "5" xml: name: Priority Purpose: type: string description: Назначение платежа (поле 24) example: За транспортные услуги xml: name: Purpose Sum: type: number description: Сумма документа (поле 7). example: 14 xml: name: Sum TransitionKind: type: string description: Вид операции (поле 18) example: "17" xml: name: TransitionKind description: Данные банковского ордера PayDocStamp: type: object properties: Bic: type: string description: БИК банка example: "044525593" xml: name: BIC Branch: type: string description: Отделение банка xml: name: Branch CorrespAcc: type: string description: Коррсчет банка example: "30101810200000000593" xml: name: CoreespAcc Name: type: string description: Название банка example: АО \"АЛЬФА-БАНК\" xml: name: Name Status: $ref: '#/components/schemas/PayDocStampStatus' description: Данные штампа банка по каждому платежному документу PayDocStampStatus: type: object properties: Code: type: string description: Код статуса (02 - Исполнен) example: "2" xml: name: Code Name: type: string description: Наименование статуса на стороне банка example: Исполнен xml: name: Name MoreInfo: type: string description: Дополнительная информация к статусу example: "null" xml: name: MoreInfo description: Статус платежного документа в банке Stamp: type: object properties: Bic: type: string description: БИК банка example: "044525593" xml: name: BIC CorrespAcc: type: string description: Коррсчет банка example: "30101810200000000593" xml: name: CorrespAcc ExtIdStatementRequest: type: string description: "ID исходного запроса на выписку, если такой был" example: "null" xml: name: ExtIDStatementRequest Name: type: string description: Название банка example: АО \"АЛЬФА-БАНК\" xml: name: Name description: Данные штампа банка по выписке в целом xml: name: Stamp Recipient: type: object properties: id: type: string description: "Идентификатор клиента, как он задан на стороне банка" example: "40702810701300000761" xml: name: id attribute: true inn: type: string description: ИНН клиента example: "25247358" xml: name: inn attribute: true kpp: type: string description: КПП клиента example: "037186025" xml: name: kpp attribute: true name: type: string description: Название клиента example: Полное наименование Орг № 11329 xml: name: name attribute: true description: Получаетель Sender: type: object properties: bic: type: string description: БИК банка example: "044525593" xml: name: bic attribute: true name: type: string description: Название банка example: АО "АЛЬФА-БАНК" xml: name: name attribute: true description: Отправитель ResponseSignatureRsaXmlSignature: type: object properties: ds:SignedInfo: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignedInfo' ds:SignatureValue: type: string description: Значение подписи example: | MRrLr4sMR0ADi12A3PSLPVP+Y8yxTml3TyMMlTl2K9EhyyFrqQPnxHJfQALLC129n+oFSNFdXr0X 3kHEMnBU8mqGPSWPVMHqb1iE+ZyhNXZYQQIyveS43KZAp8USr83tg9CtEUxy6FjYFsYJZgGIirG+ fj9S7PFqn95Bl0fkIZp636s3J1CHr1d9AJBpyJuF8G8TNTPJK1w9po1ObX8iMgtrOG44Vkk3Spp+ kEvEFGflD3pOL/vkaiOOwHqmwBHHc24prczAXg7zsYvHlSdUhHABgx9XFz8tJlg3dNtTQVaHti7X pUAyAGjBsXOXbjbIRz3lBS59N2LIffB0GsMalQ== Id: type: string example: sigID1 xml: attribute: true ds:KeyInfo: $ref: '#/components/schemas/ResponseSignatureRsaXmlKeyInfo' description: Ответ XMLDsig xml: name: ds:Signature namespace: http://www.w3.org/2000/09/xmldsig# ResponseSignatureRsaXmlSignedInfo: type: object properties: ds:CanonicalizationMethod: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignedInfo_ds_CanonicalizationMethod' ds:SignatureMethod: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignedInfo_ds_SignatureMethod' ds:Reference: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignedInfo_ds_Reference' ResponseSignatureRsaXmlTransform1: type: object allOf: - $ref: '#/components/schemas/ResponseSignatureRsaXmlTransformParams' - $ref: '#/components/schemas/ResponseSignatureRsaXmlTransform1_allOf' ResponseSignatureRsaXmlTransformParams: required: - Algorithm type: string discriminator: propertyName: Algorithm ResponseSignatureRsaXmlTransform2: type: object allOf: - $ref: '#/components/schemas/ResponseSignatureRsaXmlTransformParams' - $ref: '#/components/schemas/ResponseSignatureRsaXmlTransform2_allOf' ResponseSignatureRsaXmlKeyInfo: type: object properties: ds:X509Data: $ref: '#/components/schemas/ResponseSignatureRsaXmlKeyInfo_ds_X509Data' ErrorBadRequestXML: type: object properties: Error: type: string description: Код ошибки example: invalid_request xml: name: Error ErrorDescription: type: string description: Сообщение об ошибке example: Authorization header is not present in request headers xml: name: ErrorDescription description: Ошибка запроса xml: name: ErrorResponse ErrorUnauthorizedXML: type: object properties: Error: type: string description: Код ошибки example: invalid_token xml: name: Error ErrorDescription: type: string description: Сообщение об ошибке example: "The access token provided is expired, revoked, malformed, or invalid\ \ for other reasons" xml: name: ErrorDescription description: Ошибка авторизации xml: name: ErrorResponse ErrorScopeXML: type: object properties: Error: type: string description: Код ошибки example: insufficient_scope xml: name: Error ErrorDescription: type: string description: Сообщение об ошибке example: The request requires higher privileges than provided by the access token xml: name: ErrorDescription description: Ошибка прав доступа xml: name: ErrorResponse ErrorNotFoundXML: type: object properties: Error: type: string description: Код ошибки example: unknown_endpoint xml: name: Error ErrorDescription: type: string description: Сообщение об ошибке example: Endpoint is not found or not active xml: name: ErrorDescription description: Ошибка прав доступа xml: name: ErrorResponse ErrorInternalXML: type: object properties: Error: type: string description: Код ошибки example: internal_error xml: name: Error ErrorDescription: type: string description: Сообщение об ошибке example: Internal server error xml: name: ErrorDescription description: Ошибка сервера xml: name: ErrorResponse StatementMT940: type: string description: 20 - Референс операции; 25 - Номер счета; 28С - Номер выписки; 60а - Входящий остаток; 61 - Строка движения по счету; 86 - Информация для владельца счета; 62а - Исходящий остаток example: |- :20:+57610880b621435 :25:40702810701300000761 :28C:1 :60a:C220112RUR99527,00 :61:220113DR20,00NTRFNONREF 20/00000/50012008 :86:/BENM//03271643540000095400 INN5752006960.KPP575301001 GAVRILOV DOBRYNa TROFIMOVIc /NZP/'(VO21100)' OPLATA PO DOGOVORU :62a:C220113RUR99407,00 ErrorBadRequestText: type: string description: Ошибка запроса example: |- error: invalid_request error_description: Authorization header is not present in request headers ErrorUnauthorizedText: type: string description: Ошибка авторизации example: |- error: invalid_token error_description: The access token provided is expired, revoked, malformed, or invalid for other reasons ErrorScopeText: type: string description: Ошибка прав доступа example: |- error: insufficient_scope error_description: The request requires higher privileges than provided by the access token ErrorNotFoundText: type: string example: |- error: unknown_endpoint error_description: Endpoint is not found or not active ErrorInternalText: type: string description: Ошибка сервера example: |- error: internal_error error_description: Internal server error StatementSummary: type: object properties: composedDateTime: type: string description: Дата составления сводки example: 2018-12-31 lastMovementDate: type: string description: Дата последней операции по счёту за запрошенный период example: 2018-12-31 openingRate: type: string description: Курс ЦБ за единицу валюты на начало периода openingBalance: $ref: '#/components/schemas/OpeningBalance' openingBalanceRub: $ref: '#/components/schemas/OpeningBalanceRub' closingBalance: $ref: '#/components/schemas/ClosingBalance' closingBalanceRub: $ref: '#/components/schemas/ClosingBalanceRub' debitTurnover: $ref: '#/components/schemas/DebitTurnover' debitTurnoverRub: $ref: '#/components/schemas/DebitTurnoverRub' debitTransactionsNumber: type: integer description: Количество дебетовых операций по счёту example: 10 creditTurnover: $ref: '#/components/schemas/CreditTurnover' creditTurnoverRub: $ref: '#/components/schemas/CreditTurnoverRub' creditTransactionsNumber: type: integer description: Количество кредитовых операций по счёту example: 10 description: Информация об оборотах example: debitTurnover: amount: 10000.0 currencyName: RUR openingBalanceRub: amount: 10000.55 currencyName: RUR closingBalance: amount: 25000.3 currencyName: RUR creditTurnoverRub: amount: 24999.75 currencyName: RUR debitTransactionsNumber: 10 composedDateTime: 2018-12-31 creditTurnover: amount: 24999.75 currencyName: RUR openingRate: openingRate debitTurnoverRub: amount: 10000.0 currencyName: RUR openingBalance: amount: 10000.55 currencyName: RUR closingBalanceRub: amount: 25000.3 currencyName: RUR creditTransactionsNumber: 10 lastMovementDate: 2018-12-31 OpeningBalance: type: object properties: amount: type: number description: Сумма example: 10000.55 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Входящий остаток в валюте счёта example: amount: 10000.55 currencyName: RUR OpeningBalanceRub: type: object properties: amount: type: number description: Сумма example: 10000.55 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Входящий остаток в рублях example: amount: 10000.55 currencyName: RUR ClosingBalance: type: object properties: amount: type: number description: Сумма example: 25000.3 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Исходящий остаток в валюте счёта example: amount: 25000.3 currencyName: RUR ClosingBalanceRub: type: object properties: amount: type: number description: Сумма example: 25000.3 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Исходящий остаток в рублях example: amount: 25000.3 currencyName: RUR DebitTurnover: type: object properties: amount: type: number description: Сумма example: 10000.0 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Дебетовый оборот в валюте счёта example: amount: 10000.0 currencyName: RUR DebitTurnoverRub: type: object properties: amount: type: number description: Сумма example: 10000.0 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Дебетовый оборот в рублях example: amount: 10000.0 currencyName: RUR CreditTurnover: type: object properties: amount: type: number description: Сумма example: 24999.75 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Кредитовый оборот в валюте счёта example: amount: 24999.75 currencyName: RUR CreditTurnoverRub: type: object properties: amount: type: number description: Сумма example: 24999.75 currencyName: type: string description: Буквенный ISO-код валюты example: RUR description: Кредитовый оборот в рублях example: amount: 24999.75 currencyName: RUR CorrespondentStatement: type: object properties: pagination: $ref: '#/components/schemas/SimplePage' items: type: array description: Массив транзакций items: $ref: '#/components/schemas/TransactionsCorrespondent_inner' description: Выписка операций по корреспондентским счетам example: pagination: offset: 0 limit: 1000 totalCount: 10000 items: - documentDate: 2021-10-07 operationDate: 2018-12-31T00:00:00Z amount: amount: 1.01 currencyName: USD filial: АО "АЛЬФА-БАНК" correspondingAccount: "30101810400000000225" debtorCode: "0" curTransfer: payerBankCorrAccount: "30101810200000000593" intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга instructionCode: instructionCode messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 instructedAmount: "USD70,00" payeeBankCorrAccount: "30101810200000000593" transactionRelatedReference: transactionRelatedReference senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D intermediaryBankAccount: COBADEFF payerInn: "7728168971" senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK\ \ MOSCOW RUSSIAN FEDERATION" payeeBankBic: "9611925" senderCharges: "USD7,03" payeeKpp: "770801001" payeeAccount: "40802810401300015422" bankOperationCode: CRED transactionTypeCode: S01 payeeName: Наименование получателя messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageIdentifier: S000013082900014 beneficiaryCustomerName: ООО Ромашка payerName: Гаврилов Добрыня Петрович urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D orderingInstitutionAccount: ABOCBNBJ080 messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR transactionReferenceNumber: 69528 payerKpp: "770801001" payerBankName: АО \"АЛЬФА-БАНК\" orderingInstitutionOption: D payerAccount: "40802810401300015422" payeeBankName: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 payerBankBic: "044525593" payeeInn: "7728168971" receiverCharges: receiverCharges operationCode: "01" amountRub: amount: 1.01 currencyName: USD extendedDebtorCode: "50012008" priority: "5" uuid: 55daccdf-de87-3879-976c-8b8415c8caf9 revaln: ПК transactionId: 1211206MOCO#DS0000017 rurTransfer: payerBankCorrAccount: "30101810200000000593" departmentalInfo: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" payerKpp: "770801001" receiptDate: 2018-12-31 deliveryKind: электронно payerBankName: АО \"АЛЬФА-БАНК\" payerInn: "7728168971" valueDate: 2018-12-31 cartInfo: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber payerAccount: "40802810401300015422" payeeName: Наименование получателя payeeBankName: АО \"АЛЬФА-БАНК\" payeeBankBic: "9611925" payerBankBic: "044525593" purposeCode: "1" payeeInn: "7728168971" payerName: Гаврилов Добрыня Петрович payeeBankCorrAccount: "30101810200000000593" payeeKpp: "770801001" payeeAccount: "40802810401300015422" payingCondition: payingCondition number: "1843" paymentPurpose: НДС не облагается direction: DEBIT - documentDate: 2021-10-07 operationDate: 2018-12-31T00:00:00Z amount: amount: 1.01 currencyName: USD filial: АО "АЛЬФА-БАНК" correspondingAccount: "30101810400000000225" debtorCode: "0" curTransfer: payerBankCorrAccount: "30101810200000000593" intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга instructionCode: instructionCode messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 instructedAmount: "USD70,00" payeeBankCorrAccount: "30101810200000000593" transactionRelatedReference: transactionRelatedReference senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D intermediaryBankAccount: COBADEFF payerInn: "7728168971" senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK\ \ MOSCOW RUSSIAN FEDERATION" payeeBankBic: "9611925" senderCharges: "USD7,03" payeeKpp: "770801001" payeeAccount: "40802810401300015422" bankOperationCode: CRED transactionTypeCode: S01 payeeName: Наименование получателя messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageIdentifier: S000013082900014 beneficiaryCustomerName: ООО Ромашка payerName: Гаврилов Добрыня Петрович urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D orderingInstitutionAccount: ABOCBNBJ080 messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR transactionReferenceNumber: 69528 payerKpp: "770801001" payerBankName: АО \"АЛЬФА-БАНК\" orderingInstitutionOption: D payerAccount: "40802810401300015422" payeeBankName: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 payerBankBic: "044525593" payeeInn: "7728168971" receiverCharges: receiverCharges operationCode: "01" amountRub: amount: 1.01 currencyName: USD extendedDebtorCode: "50012008" priority: "5" uuid: 55daccdf-de87-3879-976c-8b8415c8caf9 revaln: ПК transactionId: 1211206MOCO#DS0000017 rurTransfer: payerBankCorrAccount: "30101810200000000593" departmentalInfo: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" payerKpp: "770801001" receiptDate: 2018-12-31 deliveryKind: электронно payerBankName: АО \"АЛЬФА-БАНК\" payerInn: "7728168971" valueDate: 2018-12-31 cartInfo: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber payerAccount: "40802810401300015422" payeeName: Наименование получателя payeeBankName: АО \"АЛЬФА-БАНК\" payeeBankBic: "9611925" payerBankBic: "044525593" purposeCode: "1" payeeInn: "7728168971" payerName: Гаврилов Добрыня Петрович payeeBankCorrAccount: "30101810200000000593" payeeKpp: "770801001" payeeAccount: "40802810401300015422" payingCondition: payingCondition number: "1843" paymentPurpose: НДС не облагается direction: DEBIT TransactionsCorrespondent: type: array description: Массив транзакций items: $ref: '#/components/schemas/TransactionsCorrespondent_inner' RequestsCreateFileTransaction: type: object properties: requestId: type: string description: Идентификатор запроса example: 67e50b09-a203-4119-86cb-647d06a803a0 executeDate: type: string description: Дата исполнения example: 2022-01-13 format: type: string description: Формат выписки enum: - pdf - xls - csv - 1c withDocument: type: boolean description: "Параметр, добавляющий к выписке все документы по транзакиц\ ям. Доступно только для формата PDF" withSignature: type: boolean description: Параметр необходимости скачивания документа с подписью. Доступно только для формата PDF description: Данные запроса example: executeDate: 2022-01-13 requestId: 67e50b09-a203-4119-86cb-647d06a803a0 format: pdf withSignature: true withDocument: true ResponseGetFileTransaction: type: object properties: requestId: type: string description: Идентификатор запроса example: 67e50b09-a203-4119-86cb-647d06a803a0 status: type: string description: Статус enum: - SUCCEED - PROCESSING - ERROR downloadFileLinks: type: array description: Данные ответа items: $ref: '#/components/schemas/DownloadFileLinks_inner' description: Данные ответа example: downloadFileLinks: - method: GET url: https://baas.alfabank.ru/filebox/secure-file-transfer.outgoing-files.to-processing/f190bfef-aad6-ce9b-9224-f11ef60564cb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8 - method: GET url: https://baas.alfabank.ru/filebox/secure-file-transfer.outgoing-files.to-processing/f190bfef-aad6-ce9b-9224-f11ef60564cb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8 requestId: 67e50b09-a203-4119-86cb-647d06a803a0 status: SUCCEED DownloadFileLinks: type: array description: Данные ответа items: $ref: '#/components/schemas/DownloadFileLinks_inner' AccountResponse: maxProperties: 3 minProperties: 3 required: - Data type: object properties: Data: $ref: '#/components/schemas/AccountResponse_Data' Links: $ref: '#/components/schemas/AccountResponse_Links' Meta: $ref: '#/components/schemas/AccountResponse_Meta' additionalProperties: false description: Список счетов и их идентификаторы example: Meta: null Links: self: https://sb.example.ru/v1.3/example Data: null DataAccountResponse: type: object properties: Account: maxItems: 50 minItems: 0 type: array items: $ref: '#/components/schemas/Account_1' additionalProperties: false description: Полезная нагрузка ответа на запрос о списке счетов Account_1: required: - accountDescription - accountId - accountType - currency - status type: object properties: accountId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации ресурса" example: this-is-a-slug-format-account-id status: description: Статус счета в форме кода allOf: - $ref: '#/components/schemas/AccountStatus' statusUpdateDateTime: description: Дата и время изменения статуса счета allOf: - $ref: '#/components/schemas/ISODateTime' currency: description: Валюта ведения счета allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' accountType: description: Тип счета (физическое или юридическое лицо) allOf: - $ref: '#/components/schemas/AccountType' accountDescription: maxLength: 128 minLength: 1 pattern: "^[\\w\\W]{1,128}$" type: string description: "Краткое описание назначения счета или продукта, привязанно\ го к счету" example: Розничные операции AccountDetails: maxItems: 24 minItems: 1 type: array description: Идентификация счета items: $ref: '#/components/schemas/CashAccount' Owner: $ref: '#/components/schemas/Account_1_Owner' Servicer: $ref: '#/components/schemas/Account_1_Servicer' additionalProperties: false description: Счет x-openapiru-object-type-contract: true AccountStatus: type: string description: Статус счета example: Enabled enum: - Enabled - Disabled - Deleted x-enum-descriptions: - Cчет доступен и может использоваться - "Cчет не доступен и не может использоваться, временно или навсегда" - Счет удален и не может использоваться x-enum-varnames: - Enabled - Disabled - Deleted ISODateTime: type: string description: Формат даты и времени format: date-time example: 2021-06-05T15:15:13Z ActiveOrHistoricCurrencyCode: pattern: "^[A-Z]{3,3}$" type: string description: "Код валюты, соответствующий международному стандарту ISO 4217" example: RUB AccountType: type: string description: Тип счета enum: - Business - Personal x-enum-descriptions: - Счет юридического лица - Счет физического лица x-enum-varnames: - Business - Personal CashAccount: required: - identification - schemeName type: object properties: name: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: "Наименование счета, присвоенное учреждением, обслуживающим\ \ счет, по согласованию с владельцем счета для обеспечения дополнител\ ьных средств идентификации счета" example: Основной счет schemeName: description: Наименование схемы идентификации счета allOf: - $ref: '#/components/schemas/AccountIdentificationCode' identification: maxLength: 256 minLength: 1 pattern: "^[\\w\\W]{1,256}$" type: string description: "Идентификатор счета, соответствующий схеме идентификации,\ \ известный владельцу счета (номер банковского счета, номер карты, ном\ ер телефона ...)" example: "40817810621234570000" additionalProperties: false description: Идентификация счета AccountIdentificationCode: type: string description: Схема идентификации счета example: RU.CBR.BBAN enum: - RU.CBR.BBAN - RU.CBR.EPID - RU.CBR.PAN - RU.CBR.MTEL - RU.CBR.ORID x-enum-descriptions: - Базовый номер банковского счета (RUCBRAccountIdentifier) - Идентификатор электронного средства платежа - Идентификатор счета по номеру карты - Идентификатор счета по номеру телефона - "Иной идентификатор (номер, однозначно идентифицирующий счет стороны)" x-enum-varnames: - BBAN - EPID - PAN - MTEL - ORID PartyIdentification: required: - Identification - name type: object properties: name: maxLength: 160 minLength: 1 pattern: "^[\\w\\W]{1,160}$" type: string description: Наименование организации или имя физического лица example: Наименование организации или физического лица mobileNumber: pattern: "^((\\+7|7|8)([0-9]){10})$" type: string description: Номер мобильного телефона example: "79206001010" countryOfResidence: description: Страна проживания allOf: - $ref: '#/components/schemas/CountryCode' countryOfBirth: description: Место рождения (страна) allOf: - $ref: '#/components/schemas/CountryCode' provinceOfBirth: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Место рождения (область). example: Ставропольский край cityOfBirth: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Место рождения (город) example: Ставрополь birthDate: description: Дата рождения allOf: - $ref: '#/components/schemas/ISODateTime' Identification: maxItems: 12 minItems: 1 type: array description: Идентификация юридического или физического лица. items: $ref: '#/components/schemas/IdentificationType' PostalAddress: $ref: '#/components/schemas/PostalAddress' additionalProperties: false description: "Информация об участнике, используемая для идентификации юридич\ еского или физического лица" CountryCode: pattern: "^[A-Z]{2,2}$" type: string description: Код страны в формате ISO 3166-1 alpha-2 example: RU IdentificationType: required: - identification - schemeName type: object properties: schemeName: description: Наименование идентификационной схемы юридического или физического лица allOf: - $ref: '#/components/schemas/PartyIdentificationCode' identification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Уникальный и однозначный идентификатор участника, присвоен\ ный идентифицирующей организацией." example: "7728240240" additionalProperties: false description: Идентификация физического лица PartyIdentificationCode: maxLength: 35 type: string description: Схема идентификации юридического или физического лица example: RU.CBR.TXID enum: - RU.CBR.TXID - RU.CBR.LEI - RU.CBR.PASP - RU.CBR.CLID - RU.CBR.QRST - RU.CBR.TAXT - RU.CBR.OGRN - RU.CBR.SNILS - RU.CBR.PAN - RU.CBR.MTEL - RU.CBR.BBAN x-enum-descriptions: - Используется в случае идентификационной схемы ИНН/КИО - Код организации в соответствии с ISO 17442 - Номер паспорта - Другой идентификатор - Идентификатор в виде QR - кода - КПП - ОГРН - СНИЛС - Идентификатор платежной карты - Номер мобильного телефона - Идентификатор банковского счета x-enum-varnames: - TXID - LEI - PASP - CLID - QRST - TAXT - OGRN - SNILS - PAN - MTEL - BBAN PostalAddress: type: object properties: addressType: description: Тип адреса example: Postal allOf: - $ref: '#/components/schemas/AddressTypeCode' addressLine: maxItems: 2 minItems: 0 type: array description: Строка адреса example: - Адрес в виде строки - вторая часть строки адреса items: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: Строка адреса streetName: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: Наименование улицы или проспекта example: Садовая buildingNumber: maxLength: 16 minLength: 1 pattern: "^[\\w\\W]{1,16}$" type: string description: "Номер, который определяет положение здания на улице" example: "11" postCode: maxLength: 16 minLength: 6 pattern: "^[\\w\\W]{6,16}$" type: string description: Почтовый индекс example: "0100010" townName: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Наименование населённого пункта или территории, находящейс\ я вне границ поселений" example: Бигсити countrySubDivision: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Наименование и тип субъекта Российской Федерации example: Мой край country: description: Название страны в кодированной форме allOf: - $ref: '#/components/schemas/CountryCode' additionalProperties: false description: Почтовый адрес AddressTypeCode: type: string description: Тип адреса example: Postal enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement x-enum-descriptions: - "Адрес, указанный в едином государственном реестре юридических лиц" - Адрес для корреспонденции - Адрес доставки - Почтовый ящик - Абонентский ящик - Фактический/почтовый адрес местонахождения юридического лица - Адрес постоянной регистрации физического лица (прописка) - Адрес временной регистрации физического лица (регистрация временного пребывания) x-enum-varnames: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement BranchAndFinancialInstitutionInformationPilot: required: - BankIdentification - CorrespondentAccount - OrganizationIdentification - PostalAddress - name type: object properties: name: maxLength: 160 minLength: 1 pattern: "^[\\w\\W]{1,160}$" type: string description: Наименование организации example: Наименование организации или физического лица BankIdentification: maxItems: 12 minItems: 1 type: array description: Идентификация финансового учреждения items: $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification' OrganizationIdentification: maxItems: 12 minItems: 1 type: array description: Идентификация юридического лица. items: $ref: '#/components/schemas/IdentificationType' CorrespondentAccount: $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationPilot_CorrespondentAccount' PostalAddress: $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationPilot_PostalAddress' additionalProperties: false description: Информация о кредитной организации BranchAndFinancialInstitutionIdentification: required: - identification - schemeName type: object properties: schemeName: description: Наименование идентификационной схемы финансового учреждения allOf: - $ref: '#/components/schemas/FinancialInstitutionIdentificationCode' identification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Банковский идентификационный код (БИК) или другой идентификатор финансового учреждения example: "9612123" additionalProperties: false description: Идентификация финансового учреждения FinancialInstitutionIdentificationCode: type: string description: Схема идентификации финансового учреждения example: RU.CBR.BIC enum: - RU.CBR.BICFI - RU.CBR.BIC x-enum-descriptions: - BIC для финансовых учреждений согласно ISO 9362 - "Уникальный идентификатор банка, используемый в платежных документах на те\ рритории Российской Федерации" x-enum-varnames: - BICFI - BIC BranchAndFinancialInstitutionInformation: required: - BankIdentification - name type: object properties: name: maxLength: 160 minLength: 1 pattern: "^[\\w\\W]{1,160}$" type: string description: Наименование организации example: Наименование организации или физического лица BankIdentification: maxItems: 12 minItems: 1 type: array description: Идентификация финансового учреждения items: $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification' OrganizationIdentification: maxItems: 12 minItems: 0 type: array description: Идентификация юридического лица. items: $ref: '#/components/schemas/OrganizationIdentificationType' CorrespondentAccount: $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationPilot_CorrespondentAccount' PostalAddress: $ref: '#/components/schemas/PostalAddress' additionalProperties: false description: Информация о кредитной организации OrganizationIdentificationType: required: - identification - schemeName type: object properties: schemeName: description: Наименование идентификационной схемы юридического или физического лица allOf: - $ref: '#/components/schemas/OrganizationIdentificationCode' identification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Уникальный и однозначный идентификатор участника, присвоен\ ный идентифицирующей организацией." example: "7728240240" additionalProperties: false description: Идентификация юридического лица OrganizationIdentificationCode: maxLength: 35 type: string description: Схема идентификации юридического лица example: RU.CBR.TXID enum: - RU.CBR.TXID - RU.CBR.LEI - RU.CBR.TAXT - RU.CBR.OGRN - RU.CBR.OKPO x-enum-descriptions: - Используется в случае идентификационной схемы ИНН/КИО - Код организации в соответствии с ISO 17442 - КПП - ОГРН - ОКПО x-enum-varnames: - TXID - LEI - TAXT - OGRN - OKPO Links_1: required: - self type: object properties: self: type: string description: Текущая ссылка format: uri example: https://sb.example.ru/v1.3/example?page=1 first: type: string description: Первая ссылка format: uri example: https://sb.example.ru/v1.3/example?page=1 prev: type: string description: Предыдущая ссылка format: uri example: https://sb.example.ru/v1.3/example?page=1 next: type: string description: Следующая ссылка format: uri example: https://sb.example.ru/v1.3/example?page=1 last: type: string description: Последняя ссылка format: uri example: https://sb.example.ru/v1.3/example?page=1 additionalProperties: false description: "Поставщик услуг предоставляет постраничный ответ для операций\ \ GET, которые возвращают множественные записи." example: next: https://sb.example.ru/v1.3/example?page=1 last: https://sb.example.ru/v1.3/example?page=1 prev: https://sb.example.ru/v1.3/example?page=1 self: https://sb.example.ru/v1.3/example?page=1 first: https://sb.example.ru/v1.3/example?page=1 Meta: type: object properties: totalPages: maximum: 5000 minimum: 1 type: integer description: Указывает на количество передаваемых страниц format: int32 example: 1 additionalProperties: false description: "Дополнительные данные о запросе. «totalPages», указывает на ко\ личество передаваемых страниц. Если передается более одной страницы, то эл\ емент «totalPages» обязательно присутствует." OBRUErrorResponse: required: - Errors - code - message type: object properties: code: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Высокоуровневый текстовый код ошибки, необходимый для клас\ сификации" example: "400" id: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный идентификатор ошибки, для целей аудита, в случа\ е неизвестных / не классифицированных ошибок" example: 4aca5b0d-1730-416f-a52b-6d353b687082 message: maxLength: 500 minLength: 1 pattern: "^[\\w\\W]{1,500}$" type: string description: "Краткое сообщение об ошибке. Например, «что-то не так с пр\ едоставленными параметрами запроса»" example: Bad Request Errors: maxItems: 50 minItems: 1 type: array items: $ref: '#/components/schemas/OBRUError' additionalProperties: false description: Контейнер с детализацией ошибки OBRUError: required: - errorCode - message type: object properties: errorCode: $ref: '#/components/schemas/OBRUErrorResponseErrorCode' message: maxLength: 500 minLength: 1 pattern: "^[\\w\\W]{1,500}$" type: string description: Описание ошибки example: Обязательное поле не указано path: maxLength: 500 minLength: 1 pattern: "^[\\w\\W]{1,500}$" type: string description: "Путь к элементу с ошибкой в JSON объекте. Рекомендуемое, н\ о не обязательное поле" example: Data.Model.Object.name url: type: string description: "URL для помощи в устранении проблемы, Также через URL можн\ о предоставлять дополнительную информацию" format: uri example: https://example.com/error-description additionalProperties: false description: Контейнер с ошибкой OBRUErrorResponseErrorCode: type: string description: "Низкоуровневое описание ошибки. Поставщик услуг должен заполни\ ть сообщение детальным описанием ошибки, не раскрывая конфиденциальную инф\ ормацию." example: RU.CBR.Field.Missing enum: - RU.CBR.Field.Expected - RU.CBR.Field.Invalid - RU.CBR.Field.InvalidDate - RU.CBR.Field.Missing - RU.CBR.Header.Invalid - RU.CBR.Header.Missing - RU.CBR.Resource.InvalidFormat - RU.CBR.Resource.NotFound - RU.CBR.Resource.NotCreated - RU.CBR.Rules.AfterCutOffDateTime - RU.CBR.Signature.Invalid - RU.CBR.Signature.InvalidClaim - RU.CBR.Signature.MissingClaim - RU.CBR.Signature.Malformed - RU.CBR.Signature.Missing - RU.CBR.Unsupported.AccountIdentifier - RU.CBR.Unsupported.LocalInstrument - RU.CBR.Authenticate.InvalidScope - RU.CBR.Authenticate.InvalidConsent - RU.CBR.Rules.ResourceAlreadyExists - RU.CBR.UnexpectedError x-enum-descriptions: - "(HTTP статус 400). Если поля передаются парой (ключ-значение) и значение\ \ не было передано. В поле path должен передаваться путь к ожидаемому полю\ \ (например, ErrorResponse.Errors.path == “AccountResponse.Data.Account.AccountDetails.identification”\ ). Например, для допустимого значения поля «schemeName» должно передаватьс\ я соответствующее значение идентификатора в поле «identification»." - "(HTTP статус 400).В поле указано недопустимое значение или длина предоста\ вленного значения превышает соответствующую максимальную длину поля в доме\ не ППИУ. Ссылка на недопустимое поле должна быть указана в поле path (напр\ имер,ErrorResponse.Errors.path == “AccountResponse.Data.Account.AccountDetails.schemeName”\ ). В поле URL может быть ссылка на веб-страницу, объясняющую правильное по\ ведение. Проблема должна быть подробно описана в сообщении об ошибке (поле\ \ ErrorResponse.Errors.message)." - "(HTTP статус 400).Указана неверная дата. Например, когда ожидается будуща\ я дата, а указана дата в прошлом или текущая дата. В сообщении можно указа\ ть актуальную проблему с датой. Ссылка на недопустимое поле должна быть ук\ азана в поле path, а в поле URL может быть ссылка на веб-страницу, объясня\ ющую правильное поведение." - "(HTTP статус 400).Обязательное поле, необходимое для API, отсутствует в п\ олезной нагрузке. Данный код ошибки можно использовать, если ошибка еще не\ \ определена при проверке RU.CBR.Resource.InvalidFormat. Ссылка на отсутст\ вующее поле должна быть указана в поле path, а в поле URL может быть ссылк\ а на веб-страницу, объясняющую правильное поведение." - (HTTP статус 400).В элементе заголовка HTTP указано неверное значение. Элемент заголовка HTTP должен быть указан в элементе пути. - "(HTTP статус 400).Обязательный элемент HTTP-заголовка не был предоставлен\ . Элемент заголовка HTTP должен быть указан в элементе path. Элемент пути\ \ кода ошибки должен быть заполнен элементом ресурса согласия, который явл\ яется недопустимым." - "(HTTP статус 400).Json-схема полезной нагрузки не соответствует конечной\ \ точке. Например, конечная точка POST /account-consents вызывается с поле\ зной нагрузкой JSON, которая не может быть проанализирована в классе ConsentRequest." - (HTTP статус 400).Ресурс с указанным идентификатором не существует или не может быть обработан (в том числе неприемлимый формат или значение идентификатора ресурса). - "(HTTP статус 400).Ресурс с указанным идентификатором еще не создан и не м\ ожет быть передан в ответном сообщении. Для асинхронных вызовов. Например\ , получение выписки по счету, где сначала создается ресурс выписки (метод\ \ POST /statements/{accountId}) и в ответном сообщение приходит идентифика\ тор созданного ресурса выписки, но для наполнения выписки данными ППИУ тре\ буется некоторое время. Соответственно, будет приходить данное сообщение о\ б ошибке." - (HTTP статус 400).Ресурс согласия или ресурс платежа запрашиваются после даты CutOffDateTime. - "(HTTP статус 400).Заголовок подписи x-jws-signature был проанализирован и\ \ имеет действительный заголовок JOSE, соответствующий спецификации. Но са\ ма подпись не может быть проверена." - "(HTTP статус 400).Заголовок JOSE в элементе x-jws-signature имеет одно ил\ и несколько утверждений (claim) с недопустимым значением. (например, утвер\ ждение kid, которое не принимает сертификат). Наименование отсутствующего\ \ утверждения должно передаваться в поле path ответа об ошибке." - "(HTTP статус 400).Заголовок JOSE в элементе x-jws-signature имеет одно ил\ и несколько обязательных утверждений, которые не указаны. Имя пропущенного\ \ утверждения должно быть указано в поле path ответа об ошибке." - (HTTP статус 400).x-jws-signature в заголовке запроса была искажена и не могла быть проанализирована как допустимый JWS. - "(HTTP статус 400).Запрос API предполагает x-jws-signature в заголовке, но\ \ элемент отсутствовал." - (HTTP статус 400).Идентификатор счета не поддерживается для данной схемы. Элемент path должен быть заполнен путем к элементу accountIdentifier. - (HTTP статус 400).Указанный localInstrument не поддерживается ППИУ. Элемент path должен быть заполнен путем к элементу localInstrument. Элемент URL должен быть заполнен ссылкой на документацию ППИУ со списком поддерживаемых localInstrument. - (HTTP статус 403).Предъявленный токен доступа не содержит область действия ("scope") необходимый для доступа к ресурсу. - "(HTTP статус 403).Отказано доступу к ресурсу с указанным идентификатором\ , так как согласие Пользователя, отсутствует, либо имеет не корректный ста\ тус, либо не содержит необходимых разрешений (\"pernissions\") на данный р\ есурс." - (HTTP статус 409).Ресурс с такими же параметрами уже существует. - "(HTTP статус 5xx).Данный код ошибки можно использовать при возникновении\ \ непредвиденной ошибки. ППИУ должен заполнить сообщение детальным описани\ ем ошибки, не раскрывая конфиденциальную информацию." x-enum-varnames: - FieldExpected - FieldInvalid - FieldInvalidDate - FieldMissing - HeaderInvalid - HeaderMissing - ResourceInvalidFormat - ResourceNotFound - ResourceNotCreated - RulesAfterCutOffDateTime - SignatureInvalid - SignatureInvalidClaim - SignatureMissingClaim - SignatureMalformed - SignatureMissing - UnsupportedAccountIdentifier - UnsupportedLocalInstrument - AuthenticateInvalidScope - AuthenticateInvalidConsent - RulesResourceAlreadyExists - UnexpectedError StatementResponse: maxProperties: 3 minProperties: 3 required: - Data type: object properties: Data: $ref: '#/components/schemas/StatementResponse_Data' Links: $ref: '#/components/schemas/StatementResponse_Links' Meta: $ref: '#/components/schemas/AccountResponse_Meta' additionalProperties: false description: Ответ запроса на выписку example: Data: statementId: this-is-a-slug-format-statement-id accountId: this-is-a-slug-format-account-id fromBookingDateTime: 2019-09-15T00:00:00+00:00 toBookingDateTime: 2019-12-15T00:00:00+00:00 creationDateTime: 2021-06-05T15:15:13+00:00 Balance: - creditDebitIndicator: Debit type: ClosingAvailable Amount: amount: "200.00" currency: RUB TransactionsSummary: TotalCreditEntries: numberOfEntries: "2" sum: "100.00" currency: RUB TotalDebitEntries: numberOfEntries: "2" sum: "1500.00" currency: RUB Entry: - transactionIdentification: this-is-a-slug-format-transaction-id instructionIdentification: 12345-IID-001 endtoendIdentification: 12345-EEID-001 uetr: de2da6c9-18be-48d4-8053-867ed90a316a purpose: "1" creditDebitIndicator: Debit status: AcceptedSettlementCompleted bookingDateTime: 2023-12-15T00:00:00+00:00 accDocDate: 2021-01-01 valueDateTime: 2023-12-15T00:00:00+00:00 Amount: amount: "200.00" currency: RUB TransactionAmount: amount: "200.00" currency: RUB ChargeAmount: amount: "200.00" currency: RUB InstructedAmount: Amount: amount: "200.00" currency: RUB CurrencyExchange: sourceCurrency: RUB targetCurrency: RUB unitCurrency: RUB exchangeRate: "0.7" contractIdentification: DOC441234-1234-1234 quotationDate: 2021-06-05T15:15:13+00:00 BankTransactionCode: code: "20" subCode: "20" issuer: RU.CBR PaymentTypeInformation: localInstrument: "01" categoryPurpose: "1" serviceLevel: URGP UltimateDebtor: name: Наименование организации или физического лица mobileNumber: "79206001010" countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: 2021-06-05T15:15:13+00:00 Identification: - schemeName: RU.CBR.TXID identification: "7728240240" PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: "11" postCode: "0100010" townName: Бигсити countrySubDivision: Мой край country: RU Debtor: Agent: name: Наименование организации или физического лица BankIdentification: - schemeName: RU.CBR.BIC identification: "9612123" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728240240" CorrespondentAccount: schemeName: RU.CBR.BBAN identification: "40817810621234570000" PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: "11" postCode: "0100010" townName: Бигсити countrySubDivision: Мой край country: RU Party: name: Наименование организации или физического лица mobileNumber: "79206001010" countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: 2021-06-05T15:15:13+00:00 Identification: - schemeName: RU.CBR.TXID identification: "7728240240" PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: "11" postCode: "0100010" townName: Бигсити countrySubDivision: Мой край country: RU DebtorAgent: schemeName: RU.CBR.BIC identification: "9612123" DebtorAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: "40817810621234570000" DebtorAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: "40817810621234570000" IntermediaryAgent: schemeName: RU.CBR.BIC identification: "9612123" IntermediaryAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: "40817810621234570000" CreditorAgent: schemeName: RU.CBR.BIC identification: "9612123" CreditorAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: "40817810621234570000" CreditorAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: "40817810621234570000" Creditor: Agent: name: Наименование организации или физического лица BankIdentification: - schemeName: RU.CBR.BIC identification: "9612123" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728240240" CorrespondentAccount: schemeName: RU.CBR.BBAN identification: "40817810621234570000" PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: "11" postCode: "0100010" townName: Бигсити countrySubDivision: Мой край country: RU Party: name: Наименование организации или физического лица mobileNumber: "79206001010" countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: 2021-06-05T15:15:13+00:00 Identification: - schemeName: RU.CBR.TXID identification: "7728240240" PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: "11" postCode: "0100010" townName: Бигсити countrySubDivision: Мой край country: RU UltimateCreditor: name: Наименование организации или физического лица mobileNumber: "79206001010" countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: 2021-06-05T15:15:13+00:00 Identification: - schemeName: RU.CBR.TXID identification: "7728240240" PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: "11" postCode: "0100010" townName: Бигсити countrySubDivision: Мой край country: RU CardTransaction: Card: PlainCardData: PAN: '*0001' cardSequenceNumber: "01" effectiveDate: 12/2021 expiryDate: 12/2025 serviceCode: "121" TrackData: - trackNumber: string trackValue: string CardSecurityCode: CSCManagement: CSCPresent CSCValue: "123" cardCountryCode: "643" CardBrand: identification: string type: ACCP additionalCardData: Дополнительные сведения POI: Identification: identification: string type: ACCP systemName: string groupIdentification: string Component: - POIComponentType: CHIT manufacturerIdentification: manufacturerIdentification model: model versionNumber: versionNumber serialNumber: serialNumber approvalNumber: approvalNumber Transaction: transactionCategory: stri sequenceNumber: string TransactionIdentification: transactionDateTime: 2021-06-05T15:15:13+00:00 transactionReference: string Product: - productCode: string unitOfMeasure: KILO productQuantity: "10.2" unitPrice: "200.00" productAmount: "200.00" taxType: string additionalProductInformation: string authorizationCode: string RemittanceInformation: unstructured: Назначение платежа - оплата за товары или услуги ReferredDocumentInformation: - Type: "0" Number: "0" RelatedDate: 2021-06-05T15:15:13+00:00 CreditorReferenceInformation: type: ИПД reference: CBR-130 TaxRemittance: administrationZone: "45388000" referenceNumber: "120" date: 2021-06-05T15:15:13+00:00 creditor: taxType: "991230001" registrationIdentification: aa-12340 debtor: taxType: "991230001" registrationIdentification: aa-12340 Record: type: "1234" category: TP categoryDetails: "18210301000011000000" debtorStatus: "13" Period: - year: 2021-01-01 type: MM02 fromDate: 2021-06-05T15:15:13+00:00 toDate: 2021-06-05T15:15:13+00:00 TaxAmount: rate: "20" totalAmount: "200.00" Links: self: https://sb.example.ru/v1.3/example?page=1 first: https://sb.example.ru/v1.3/example?page=1 prev: https://sb.example.ru/v1.3/example?page=1 next: https://sb.example.ru/v1.3/example?page=1 last: https://sb.example.ru/v1.3/example?page=1 Meta: totalPages: 1 Statement_2: required: - accountId - creationDateTime - fromBookingDateTime - statementId - toBookingDateTime type: object properties: statementId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: Идентификатор ресурса выписки example: this-is-a-slug-format-statement-id accountId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации ресурса accounts" example: this-is-a-slug-format-account-id fromBookingDateTime: description: Дата и время начала выписки example: 2019-09-15T00:00:00+00:00 allOf: - $ref: '#/components/schemas/ISODateTime' toBookingDateTime: description: Дата и время окончания выписки example: 2019-12-15T00:00:00+00:00 allOf: - $ref: '#/components/schemas/ISODateTime' creationDateTime: description: Дата и время создания ресурса allOf: - $ref: '#/components/schemas/ISODateTime' Balance: maxItems: 10 minItems: 0 type: array description: "Информация об остатках по счету (например, в массиве можно\ \ указать значения на начало и конец операционного дня)" items: $ref: '#/components/schemas/CashBalance' TransactionsSummary: $ref: '#/components/schemas/Statement_2_TransactionsSummary' Entry: maxItems: 50 minItems: 0 type: array description: Список операций items: $ref: '#/components/schemas/ReportEntry' additionalProperties: false description: Выписка по счету CashBalance: required: - Amount - creditDebitIndicator - type type: object properties: creditDebitIndicator: description: Определяет является остаток кредитовым или дебетовым allOf: - $ref: '#/components/schemas/CreditDebitCode' type: description: Тип остатка allOf: - $ref: '#/components/schemas/BalanceType' Amount: $ref: '#/components/schemas/CashBalance_Amount' additionalProperties: false description: Детальная информация об остатке на счете CreditDebitCode: type: string description: Признак дебета/кредита example: Debit enum: - Credit - Debit x-enum-descriptions: - Кредитовая операция по счету - Дебетовая операция по счету x-enum-varnames: - Credit - Debit BalanceType: type: string description: Тип остатка enum: - ClosingAvailable - ClosingBooked - ClosingCleared - Expected - OpeningAvailable - OpeningBooked - OpeningCleared - PreviouslyClosedBooked x-enum-descriptions: - "Конечный остаток суммы денег, которая находится в распоряжении владельца\ \ счета на указанную дату" - "Остаток по счету на конец предварительно согласованного отчетного периода\ . Это сумма начального зарегистрированного баланса в начале периода и всех\ \ записей, зачисленных на счет в течение предварительно согласованного отч\ етного периода" - "Конечный остаток суммы денег, которая очищается в указанную дату" - "Баланс, состоящий из забронированных записей и отложенных позиций, извест\ ных на момент расчета, который прогнозирует остаток на конец дня, если все\ \ зарезервировано на счете и никакая другая запись не публикуется" - "Начальный баланс суммы денег, которая находится в распоряжении владельца\ \ счета на указанную дату" - Баланс счета в начале отчетного периода. Он всегда равен балансу из предыдущего отчета - "Начальный баланс, который очищается в указанную дату" - Остаток по счету за ранее закрытый отчетный период. Начальный зарегистрированный баланс на новый период равен этому балансу x-enum-varnames: - ClosingAvailable - ClosingBooked - ClosingCleared - Expected - OpeningAvailable - OpeningBooked - OpeningCleared - PreviouslyClosedBooked ActiveOrHistoricCurrencyAndAmount: required: - amount - currency type: object properties: amount: description: Сумма денежных средств allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' currency: description: "Код валюты, соответствующий международному стандарту ISO 4217" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' additionalProperties: false description: Сумма денежных средств и код валюты ActiveCurrencyAndAmountSimpleType: pattern: "^\\d{1,15}\\.\\d{2,4}$" type: string description: Сумма денежных средств example: "200.00" TransactionsSummary: type: object properties: TotalCreditEntries: $ref: '#/components/schemas/TransactionsSummary_TotalCreditEntries' TotalDebitEntries: $ref: '#/components/schemas/TransactionsSummary_TotalDebitEntries' additionalProperties: false description: Обороты по кредиту и дебету NumberAndSumOfTransactions: required: - currency - sum type: object properties: numberOfEntries: type: integer description: Количество записей format: int64 sum: description: Общая сумма всех записей allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' currency: description: "Код валюты, соответствующий международному стандарту ISO 4217" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' additionalProperties: false description: "Набор элементов, обеспечивающих общую сумму записей" ReportEntry: required: - Amount - bookingDateTime - creditDebitIndicator - status type: object properties: transactionIdentification: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации операции по счету" example: this-is-a-slug-format-transaction-id instructionIdentification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Уникальный идентификатор, присвоенный инструктирующей стор\ оной для инструктируемой стороны для однозначного определения инструкц\ ии" example: 12345-IID-001 endtoendIdentification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,40}$" type: string description: "Уникальный идентификатор, присвоенный инструктирующей стор\ оной для инструктируемой стороны для однозначного определения инструкц\ ии" example: 12345-EEID-001 uetr: maxLength: 36 minLength: 1 pattern: "[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}" type: string description: "Указывается идентификатор, присваиваемый при передаче расп\ оряжения с использованием системы SWIFT, в соответствии со стандартом\ \ RFC 4122 (IETF)" example: de2da6c9-18be-48d4-8053-867ed90a316a purpose: description: "(Номер реквизита 15.5 Код вида дохода) Причина, по которой\ \ осуществляется платеж." allOf: - $ref: '#/components/schemas/PurposeCode' creditDebitIndicator: description: Определяет является ли операция дебетовая или кредитовая allOf: - $ref: '#/components/schemas/CreditDebitCode' status: description: Статус операции по счету allOf: - $ref: '#/components/schemas/TransactionStatusCode' bookingDateTime: type: string description: "Дата и время, когда запись об операции по счету публикуетс\ я на счете в бухгалтерской книге обслуживающей организации. Использует\ ся стандарт ISO8601" format: date-time example: 2023-12-15T00:00:00Z accDocDate: type: string description: "-> Дата составления распоряжения (!!! Примечание Проверить\ \ реквизит о чем он? Не должно быть здесь, Дата распоряжение указывает\ ся в RemittanceInformation/ReferredDocumentInformation/RelatedDate вме\ сте с номером)" format: date example: 2021-01-01 valueDateTime: type: string description: "Дата и время, когда активы становятся доступными владельцу\ \ счета в случае ввода кредита или перестают быть доступными владельцу\ \ счета в случае ввода дебетовой операции по счету" format: date-time example: 2023-12-15T00:00:00Z Amount: $ref: '#/components/schemas/ReportEntry_Amount' TransactionAmount: $ref: '#/components/schemas/ReportEntry_TransactionAmount' ChargeAmount: $ref: '#/components/schemas/ReportEntry_ChargeAmount' InstructedAmount: $ref: '#/components/schemas/ReportEntry_InstructedAmount' BankTransactionCode: $ref: '#/components/schemas/ReportEntry_BankTransactionCode' PaymentTypeInformation: $ref: '#/components/schemas/ReportEntry_PaymentTypeInformation' UltimateDebtor: $ref: '#/components/schemas/ReportEntry_UltimateDebtor' Debtor: $ref: '#/components/schemas/ReportEntry_Debtor' DebtorAgent: $ref: '#/components/schemas/ReportEntry_DebtorAgent' DebtorAgentAccount: $ref: '#/components/schemas/ReportEntry_DebtorAgentAccount' DebtorAccount: $ref: '#/components/schemas/ReportEntry_DebtorAccount' IntermediaryAgent: $ref: '#/components/schemas/ReportEntry_IntermediaryAgent' IntermediaryAgentAccount: $ref: '#/components/schemas/ReportEntry_IntermediaryAgentAccount' CreditorAgent: $ref: '#/components/schemas/ReportEntry_CreditorAgent' CreditorAccount: $ref: '#/components/schemas/ReportEntry_CreditorAccount' CreditorAgentAccount: $ref: '#/components/schemas/ReportEntry_CreditorAgentAccount' Creditor: $ref: '#/components/schemas/ReportEntry_Creditor' UltimateCreditor: $ref: '#/components/schemas/ReportEntry_UltimateCreditor' CardTransaction: $ref: '#/components/schemas/ReportEntry_CardTransaction' RemittanceInformation: $ref: '#/components/schemas/ReportEntry_RemittanceInformation' additionalProperties: false description: Запись об операция по счету PurposeCode: type: string description: "Код вида дохода -причина, по которой осуществляется платеж." example: "1" enum: - "1" - "2" - "3" x-enum-descriptions: - "При переводе денежных средств, являющихся заработной платой и (или) иными\ \ доходами;" - "При переводе денежных средств, являющихся доходами, на которые не может\ \ быть обращено взыскание;" - "При переводе денежных средств, являющихся доходами, к которым ограничения\ \ по обращению взыскания не применяются." x-enum-varnames: - _1 - _2 - _3 TransactionStatusCode: type: string description: Статус записи операции по счету example: AcceptedSettlementCompleted enum: - AcceptedCreditSettlementCompleted - AcceptedSettlementCompleted - AcceptedSettlementInProcess - AcceptedWithoutPosting - Pending - Rejected x-enum-descriptions: - Расчет по счету Получателя средств завершен - Расчет по счету Плательщика завершен - "Все предыдущие проверки, такие как техническая проверка и профиль клиента\ , были успешными, и поэтому запрос об инициировании платежа был принят к и\ сполнению" - "Платежная инструкция, включенная в перевод, принимается без зачисления на\ \ счет Получателя средств" - "Ожидается инициирование группы платежей или отдельного платежа, включенно\ го в группу платежей" - "Инициирование группы платежей или отдельного платежа, включенная в группу\ \ инициирования платежей, были отклонены" x-enum-varnames: - AcceptedCreditSettlementCompleted - AcceptedSettlementCompleted - AcceptedSettlementInProcess - AcceptedWithoutPosting - Pending - Rejected AmountAndCurrencyExchangeDetails: type: object properties: Amount: $ref: '#/components/schemas/AmountAndCurrencyExchangeDetails_Amount' CurrencyExchange: $ref: '#/components/schemas/AmountAndCurrencyExchangeDetails_CurrencyExchange' additionalProperties: false description: "Сумма денег и информации об обменом курсе, подлежащая перевод\ у между плательщиком и получателем денежных средств до вычета расходов, вы\ раженная в валюте обозначенной инициирующей стороной в случае, если указан\ ная сумма и/или валюта отличаются от суммы и/или валюты операции по счету" CurrencyExchange: required: - exchangeRate - sourceCurrency type: object properties: sourceCurrency: description: "Валюта, из которой необходимо конвертировать сумму" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' targetCurrency: description: "Валюта, в которую необходимо конвертировать сумму" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' unitCurrency: description: "Валюта, в которой обменный курс выражен" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' exchangeRate: maxLength: 12 minLength: 1 pattern: "^[\\w\\W]{1,12}$" type: string description: "Коэффициент, используемый для перевода суммы из одной валю\ ты в другую. Это отражает цену, по которой одна валюта была куплена за\ \ другую валюту" example: "0.7" contractIdentification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Идентификатор для однозначного определения валютного контракта example: DOC441234-1234-1234 quotationDate: description: Дата и время обменного курса allOf: - $ref: '#/components/schemas/ISODateTime' additionalProperties: false description: Подробная информация об обмене валюты BankTransactionCode: required: - code type: object properties: code: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Тип банковской операции example: "20" subCode: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Подтип банковской операции example: "20" issuer: maxLength: 35 pattern: "^[\\w\\W]{1,35}$" type: string description: Идентификация эмитента собственного банковского кода операции по счету example: RU.CBR additionalProperties: false description: Код банковской операции PaymentTypeInformation: type: object properties: localInstrument: description: "(Номер реквизита 5) Вид распоряжения. Этот элемент использ\ уется для указания локального инструмента, опции локального клиринга и\ \ / или дальнейшей квалификации услуги или уровня обслуживания или Вид\ \ платежного распоряжения" allOf: - $ref: '#/components/schemas/LocalInstrumentCode' categoryPurpose: type: string description: | (Номер реквизита 15.3) Категория назначения. Очередность платежа Применение: Поле может принимать значение в диапазоне 0-5. Значение поля должно быть равно 0, если в соответствии с нормативными актами Банка России очередность платежа не применяется example: "1" enum: - "0" - "1" - "2" - "3" - "4" - "5" serviceLevel: description: (Номер реквизита 15.1) Вид платежа allOf: - $ref: '#/components/schemas/ServiceLevelCode' additionalProperties: false description: Информация о платеже LocalInstrumentCode: maxLength: 35 type: string description: яч или код платежной системы или код платежного инструмента (требует уточнения) enum: - "01" - "02" - "06" - "16" - "17" - "09" x-enum-descriptions: - Кредитовый перевод x-enum-varnames: - _01 ServiceLevelCode: type: string description: Вид платежа enum: - URGP - NURG x-enum-descriptions: - Срочный - Не срочный x-enum-varnames: - URGP - NURG PartyChoice: maxProperties: 1 minProperties: 1 type: object properties: Agent: $ref: '#/components/schemas/PartyChoice_Agent' Party: $ref: '#/components/schemas/PartyChoice_Party' additionalProperties: false description: "Информация об участнике, используемая для идентификации юридич\ еского, физического лица или финансовой организации" CardTransaction18: type: object properties: Card: $ref: '#/components/schemas/PaymentCard4' POI: $ref: '#/components/schemas/CardTransaction18_POI' Transaction: $ref: '#/components/schemas/CardTransaction18_Transaction' additionalProperties: false description: "Предоставляет данные по карте (номер, платежная система), терм\ иналу (номер, идентификатор) и транзакционные данные, используемые для уни\ кальной идентификации операции по карте" PaymentCard4: type: object properties: PlainCardData: $ref: '#/components/schemas/PaymentCard4_PlainCardData' cardCountryCode: description: "Код страны, присвоенный карте эмитентом карты" allOf: - $ref: '#/components/schemas/CountryCodeNumeric' CardBrand: $ref: '#/components/schemas/PaymentCard4_CardBrand' additionalCardData: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: "Дополнительные сведения, специфичные для эмитента карты" example: Дополнительные сведения additionalProperties: false description: Данные по платежной карте PlainCardData1: required: - PAN - expiryDate type: object properties: PAN: pattern: "^[*0-9]{4,28}$" type: string description: Основной учетный номер карты (PAN) или номер карты example: '*0001' cardSequenceNumber: pattern: "^[0-9]{2,3}$" type: string description: Идентификатор карты среди множества карт с одинаковым номером карты (PAN) example: "01" effectiveDate: description: "Дата, начиная с которой карту можно использовать" example: 12/2021 allOf: - $ref: '#/components/schemas/ISOYearMonth' expiryDate: description: Дата окончания срока действия карты example: 12/2025 allOf: - $ref: '#/components/schemas/ISOYearMonth' serviceCode: pattern: "^[0-9]{3}$" type: string description: Услуги по карте в соответствии с ISO 7813 example: "121" TrackData: maxItems: 1000 type: array description: Данные магнитной дорожки платежной карты или их эквивалент items: $ref: '#/components/schemas/TrackData1' CardSecurityCode: $ref: '#/components/schemas/PlainCardData1_CardSecurityCode' additionalProperties: false description: "Конфиденциальные данные, связанные с выполнением операции по к\ арте" ISOYearMonth: pattern: "^(1[0-2]|0[1-9]|\\d)\\/([2-9]\\d[1-9]\\d|[1-9]\\d)$" type: string description: Формат даты год и месяц example: 12/2025 TrackData1: required: - trackValue type: object properties: trackNumber: pattern: "^[0-9]$" type: string description: Номер дорожки карты trackValue: maxLength: 140 minLength: 1 pattern: "^[\\w\\W]{1,140}$" type: string description: Содержание дорожки карты или его эквивалент additionalProperties: false description: Данные магнитной дорожки платежной карты или их эквивалент CardSecurityInformation1: required: - CSCManagement type: object properties: CSCManagement: $ref: '#/components/schemas/CSCManagement1Code' CSCValue: pattern: "^[0-9]{3,4}$" type: string description: Код безопасности карты example: "123" additionalProperties: false description: "Код безопасности карты (CSC), связанный с выполнением операции\ \ по карте" CSCManagement1Code: type: string description: Управление кодом безопасности карты (CSC) в связи с операцией enum: - CSCPresent - CSCByPass - CSCUnread - NoCSC CountryCodeNumeric: pattern: "^[0-9]{3}$" type: string description: Код страны по ISO-3166-1 в форме трехзначного цифрового кода example: "643" GenericIdentification32: required: - identification type: object properties: identification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Идентификатор субъекта type: $ref: '#/components/schemas/PartyType3Code' additionalProperties: false description: "Информация, связанная с идентификацией" PartyType3Code: type: string description: Тип субъекта example: ACCP enum: - OPOI - MERC - ACCP - ITAG - ACQR - CISS - DLIS PointOfInteraction1: required: - Identification type: object properties: Identification: $ref: '#/components/schemas/PointOfInteraction1_Identification' systemName: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: "Общее название, присвоенное эквайером POI-системе" groupIdentification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Идентификатор, присвоенный торгово-сервисной организацией\ , идентифицирующий множество POI-терминалов, выполняющих некоторые кат\ егории операций" Component: maxItems: 1000 type: array description: "Данные, относящиеся к компоненту POI, выполняющему операци\ ю" items: $ref: '#/components/schemas/PointOfInteractionComponent1' additionalProperties: false description: "Точка взаимодействия, выполняющая транзакцию" PointOfInteractionComponent1: required: - POIComponentType type: object properties: POIComponentType: $ref: '#/components/schemas/POIComponentType1Code' manufacturerIdentification: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Идентификатор поставщика программного обеспечения, аппарат\ ной части или системы компонента POI-терминала" example: manufacturerIdentification model: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Идентификатор модели компонента POI-терминала для определенного производителя example: model versionNumber: maxLength: 16 minLength: 1 pattern: "^[\\w\\W]{1,16}$" type: string description: "Версия компонента, являющегося частью определенной модели" example: versionNumber serialNumber: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Серийный номер компонента example: serialNumber approvalNumber: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: "Уникальный регистрационный номер компонента, предоставленн\ ый органом сертификации" example: approvalNumber additionalProperties: false description: "Данные, относящиеся к компоненту POI, выполняющему операцию" POIComponentType1Code: type: string description: "Тип компонента, являющегося частью POI-терминала" example: CHIT enum: - SOFT - EMVK - EMVO - MRIT - CHIT - SECM - PEDV CardIndividualTransaction2: type: object properties: transactionCategory: maxLength: 4 minLength: 1 pattern: "^[\\w\\W]{1,4}$" type: string description: "Код категории соответствует ISO 18245 и относится к типу у\ слуг или товаров, которые продавец предоставляет для транзакции" sequenceNumber: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Порядковый номер транзакции по карте, назначенный POI (точ\ ка взаимодействия)" TransactionIdentification: $ref: '#/components/schemas/CardIndividualTransaction2_TransactionIdentification' Product: maxItems: 1000 type: array description: "Товар, заказанный по операции" items: $ref: '#/components/schemas/CardIndividualTransaction2_Product_inner' authorizationCode: maxLength: 35 minLength: 3 pattern: "^[\\w\\W]{3,35}$" type: string description: Код авторизации операции additionalProperties: false description: "Сведения об отдельной операции по карте, записанные на POI-тер\ минале (точке взаимодействия)" TransactionIdentifier1: required: - transactionDateTime - transactionReference type: object properties: transactionDateTime: description: Дата и время основной операции (присвоенные POI-терминалом (точкой взаимодействия) allOf: - $ref: '#/components/schemas/ISODateTime' transactionReference: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Идентификатор операции, который должен быть уникальным в т\ ечение периода времени" additionalProperties: false description: Идентификация операции однозначным способом Product2: required: - productCode type: object properties: productCode: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: Код продукта unitOfMeasure: $ref: '#/components/schemas/UnitOfMeasure1Code' productQuantity: pattern: "^[0-9]{1,18}$|^[0-9]{1,18}[.][0-9]{1,18}$" type: string description: Количество товара example: "10.2" unitPrice: pattern: "^\\d{1,15}\\.\\d{2,4}$" type: string description: Сумма денежных средств example: "200.00" productAmount: pattern: "^\\d{1,15}\\.\\d{2,4}$" type: string description: Сумма денежных средств example: "200.00" taxType: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Информация об уплачиваемом налоге на товар additionalProductInformation: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Дополнительная информация о товаре additionalProperties: false description: Информация о продукте UnitOfMeasure1Code: type: string description: Единица измерения приобретаемой позиции example: KILO enum: - PIEC - TONS - FOOT - GBGA - USGA - GRAM - INCH - KILO - PUND - METR - CMET - MMET - LITR - CELI - MILI - GBOU - USOU - GBQA - USQA - GBPI - USPI - MILE - KMET - YARD - SQKI - HECT - ARES - SMET - SCMT - SMIL - SQMI - SQYA - SQFO - SQIN - ACRE RemittanceInformation: required: - unstructured type: object properties: unstructured: maxLength: 140 minLength: 1 pattern: "^[\\w\\W]{1,140}$" type: string description: Текстовое назначение платежа example: Назначение платежа - оплата за товары или услуги ReferredDocumentInformation: maxItems: 50 minItems: 0 type: array description: Информация о связанном документе. В первом повторении секции ReferredDocumentInformation указывается Дата составления распоряжения. По договоренности участников обмена могут быть указаны иные коды связанных документов в последующих повторениях секции ReferredDocumentInformation. items: $ref: '#/components/schemas/ReferredDocumentInformation' CreditorReferenceInformation: $ref: '#/components/schemas/RemittanceInformation_CreditorReferenceInformation' TaxRemittance: $ref: '#/components/schemas/RemittanceInformation_TaxRemittance' additionalProperties: false description: "Назначение платежа. Предоставляемая информация, позволяющая со\ поставить запись с позициями, для которых предназначен перевод" ReferredDocumentInformation: type: object properties: Type: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Тип связанного документа example: "0" Number: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Номер связанного документа example: "0" RelatedDate: description: Дата связанного документа allOf: - $ref: '#/components/schemas/ISODateTime' additionalProperties: false description: Информация о связанном документе. В первом повторении секции ReferredDocumentInformation указывается Дата составления распоряжения. По договоренности участников обмена могут быть указаны иные коды связанных документов в последующих повторениях секции ReferredDocumentInformation. CreditorReferenceInformation: type: object properties: type: maxLength: 35 pattern: "^[\\w\\W]{1,35}$" type: string description: Тип идентификатора платежа (Номер реквизита 15.6.n) example: ИПД reference: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Значение идентификатора платежа (Номер реквизита 15.7.n).\ \ Ссылка, присвоенная получателем денежных средств, которая является о\ снованием для осуществления перевода" example: CBR-130 additionalProperties: false description: "Информация о референсах, предоставленная получателем денежных\ \ средств, позволяющая идентифицировать исходные документы." TaxInformation: type: object properties: administrationZone: maxLength: 11 pattern: "^\\d{1,11}$" type: string description: Реквизит 105. Код по Общероссийскому классификатору территорий муниципальных образований ОКТМО example: "45388000" referenceNumber: maxLength: 140 minLength: 1 pattern: "^[\\w\\W]{1,140}$" type: string description: Реквизит 108. Номер налогового документа example: "120" date: description: Реквизит 109. Дата налогового документа allOf: - $ref: '#/components/schemas/ISODateTime' creditor: $ref: '#/components/schemas/TaxInformation_creditor' debtor: $ref: '#/components/schemas/TaxInformation_debtor' Record: $ref: '#/components/schemas/TaxInformation_Record' additionalProperties: false description: Налоговая информация TaxParty: type: object properties: taxType: pattern: "^\\d{9}$" type: string description: Код причины постановки на учет (КПП) example: "991230001" registrationIdentification: maxLength: 35 pattern: "^[\\w\\W]{1,35}$" type: string description: Реквизит 107. Код таможенного органа (Поле заполняется для распоряжений по уплате таможенных платежей) example: aa-12340 additionalProperties: false description: Налоговая информация об участнике перевода денежных средств TaxRecord: type: object properties: type: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Реквизит 110. Код выплат example: "1234" category: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Реквизит 106. Основание налогового платежа example: TP categoryDetails: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Код бюджетной классификации example: "18210301000011000000" debtorStatus: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: Статус налогоплательщика example: "13" Period: maxItems: 50 minItems: 0 type: array description: (Номер реквизита 14.2) Налоговый период items: $ref: '#/components/schemas/TaxPeriod' TaxAmount: $ref: '#/components/schemas/TaxRecord_TaxAmount' additionalProperties: false description: Дополнительные налоговые реквизиты TaxPeriod: type: object properties: year: pattern: "^([1-9][0-9]{3}|0[0-9]{3})-01-01$" type: string description: "Год, к которому относится налог" example: 2021-01-01 type: description: Тип налогового периода (реквизит 107) example: MM02 allOf: - $ref: '#/components/schemas/TaxRecordPeriodCode' fromDate: description: Дата уплаты налогового платежа allOf: - $ref: '#/components/schemas/ISODateTime' toDate: description: Дата уплаты налогового платежа allOf: - $ref: '#/components/schemas/ISODateTime' additionalProperties: false description: Налоговый период TaxRecordPeriodCode: type: string description: Тип налогового периода (реквизит 107) example: MM02 enum: - MM01 - MM02 - MM03 - MM04 - MM05 - MM06 - MM07 - MM08 - MM09 - MM10 - MM11 - MM12 - QTR1 - QTR2 - QTR3 - QTR4 - HLF1 - HLF2 x-enum-descriptions: - Январь - Февраль - Март - Апрель - Май - Июнь - Июль - Август - Сентябрь - Октябрь - Ноябрь - Декабрь - Первый квартал - Второй квартал - Третий квартал - Четвертый квартал - Первое полугодие - Второе полугодие x-enum-varnames: - MM01 - MM02 - MM03 - MM04 - MM05 - MM06 - MM07 - MM08 - MM09 - MM10 - MM11 - MM12 - QTR1 - QTR2 - QTR3 - QTR4 - HLF1 - HLF2 TaxAmount: type: object properties: rate: description: Ставка НДС (Номер реквизита 14.3) allOf: - $ref: '#/components/schemas/CBRFTaxRate' totalAmount: description: Сумма НДС (Номер реквизита 14.4) allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' additionalProperties: false description: Информация о НДС CBRFTaxRate: pattern: "^\\d{1,2}$" type: string description: Процентная ставка НДС example: "20" StatementInitRequest: maxProperties: 1 minProperties: 1 required: - Data type: object properties: Data: $ref: '#/components/schemas/StatementInitRequest_Data' additionalProperties: false description: Запрос создания ресурса выписки example: Data: null DataStatementInitRequest: required: - Statement type: object properties: Statement: $ref: '#/components/schemas/DataStatementInitRequest_Statement' additionalProperties: false description: Запрос создания ресурса выписки StatementInitType: required: - accountId - fromBookingDateTime - toBookingDateTime type: object properties: accountId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: Идентификатор ресурса счета example: this-is-a-slug-format-account-id fromBookingDateTime: description: "Дата и время начала расчетов, представленных в выписке" example: 2019-09-15T00:00:00+00:00 allOf: - $ref: '#/components/schemas/ISODateTime' toBookingDateTime: description: "Дата и время окончания расчетов, представленных в выписке" example: 2019-12-15T00:00:00+00:00 allOf: - $ref: '#/components/schemas/ISODateTime' additionalProperties: false description: Объект запроса на создание ресурса выписки StatementInitResponse: maxProperties: 3 minProperties: 3 required: - Data type: object properties: Data: $ref: '#/components/schemas/StatementInitResponse_Data' Links: $ref: '#/components/schemas/AccountResponse_Links' Meta: $ref: '#/components/schemas/AccountResponse_Meta' additionalProperties: false description: Ответ на запрос создания ресурса выписки example: Meta: null Links: self: https://sb.example.ru/v1.3/example Data: null DataStatementInitResponse: required: - Statement type: object properties: Statement: $ref: '#/components/schemas/DataStatementInitResponse_Statement' additionalProperties: false description: Полезная нагрузка ответа запроса на создание выписки StatementInitResponseType: required: - fromBookingDateTime - statementId - toBookingDateTime type: object properties: statementId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: Идентификатор ресурса выписки example: this-is-a-slug-format-statement-id accountId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: Идентификатор ресурса счета example: this-is-a-slug-format-account-id fromBookingDateTime: type: string description: Дата и время начала выписки format: date-time example: 2019-09-15T00:00:00Z toBookingDateTime: type: string description: Дата и время окончания выписки format: date-time example: 2019-12-15T00:00:00Z additionalProperties: false description: Ресурс выписки ResponseDN: type: object properties: dn: type: string description: Данные DN(Distinguished Name) example: "emailAddress=teterkina.natalya@gmail.com, CN=Тетеркина Наталья\ \ Геннадьевна, C=RU, SN=Тетеркина, GN=Наталья" description: Данные DN(Distinguished Name) example: dn: "emailAddress=teterkina.natalya@gmail.com, CN=Тетеркина Наталья Геннад\ ьевна, C=RU, SN=Тетеркина, GN=Наталья" ResponseDNcnf: type: string description: Данные DN(Distinguished Name) пользователя файлом в формате .cnf example: |- [req] prompt = no distinguished_name = dn req_extensions = ext [dn] C = RU SN = Тетеркина GN = Наталья CN = Тетеркина Наталья Геннадьевна emailAddress = User860@pochtochka.com [ext] RequestIssueRSACertificate: type: object properties: tokenSerialNumber: type: string description: Серийный номер USB ключа example: 00a81050 pkcs10Content: type: string description: Контект PKCS10 example: '-----BEGIN CERTIFICATE REQUEST-----\nMIIC3zCCAccCAQAwgZkxCzAJBgNVBAYTAlJVMRUwEwYDVQQEDAzQldGE0LjQvNC+\n0LIxFTATBgNVBCoMDNCk0LjQu9C40L/QvzE1MDMGA1UEAwws0JXRhNC40LzQvtCy\nINCk0LjQu9C40L/QvyDQkNGA0YXQuNC/0L7QstC40YcxJTAjBgkqhkiG9w0BCQEW\nFlVzZXIxNzZAcG9jaHRvY2hrYS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQCibtSH2YP4oxFVgiAvLdtAZpnVDWNZNgAnCEQwNbPIQpavY3OeoI/a\nNchXgwTn2u9yejOCEu8Q+x++RQDXVeSvPciVIzfDJ5Ex2MPzJySro3iPjT+HCITu\n/sddVv3Lnz5koNzOA5RihTQ+toHsvNgI2/aLITBXVM4JtkQ0ezqNsXDFqVr0Xws/\n3xj33BhhDXDrC24ivnDspYwbjevbrc5/L/mFhkHYX5pCJoxcNd5T8JrVUC1qkBIm\nnFA0C5dMAC6qWlglIG7BAkqc4Z/bu0WxEqsi0353BlnD9A/3k4euY5vmVRn2m/6E\ns89K5XrnqRYap5/o6zkQs64n7HLDQ8F3AgMBAAGgADANBgkqhkiG9w0BAQsFAAOC\nAQEASXlft+61y8TeYhXZQbuLdORjXk4yiI4OAecItHg1GcBiscA2OWObXRalLHlP\nsGc/fp5y82wZ24YxgHbyyRGf1DU374Iz5YqEl9IJ6WPsx9j/BpUo8cNPLaBOID2P\nKUHOMNbmy2bpPAi9AiaRXef9Tz3lIlzjW+oBWDoKtLkVmGDY+aTmwm0ASdqzuc/Q\ndFEgJ1JrZtwjDxwDrtAt+FXbwvadWMo9uhKW9DAaPm9XOte8z/ACoNlQ6G6KGPT3\nYQtk+dIjzeB3po9wZklg19xV17H9WCo+p3K85ANyFjkeePB49DIfwv+04a8kOsaY\nG0ocUXmTIgNeVKyDFtFoUF+qeg==\n\n-----END CERTIFICATE REQUEST-----' description: Запрос на создание заявки на выпуск RSA-сертификата example: tokenSerialNumber: 00a81050 pkcs10Content: '-----BEGIN CERTIFICATE REQUEST-----\nMIIC3zCCAccCAQAwgZkxCzAJBgNVBAYTAlJVMRUwEwYDVQQEDAzQldGE0LjQvNC+\n0LIxFTATBgNVBCoMDNCk0LjQu9C40L/QvzE1MDMGA1UEAwws0JXRhNC40LzQvtCy\nINCk0LjQu9C40L/QvyDQkNGA0YXQuNC/0L7QstC40YcxJTAjBgkqhkiG9w0BCQEW\nFlVzZXIxNzZAcG9jaHRvY2hrYS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQCibtSH2YP4oxFVgiAvLdtAZpnVDWNZNgAnCEQwNbPIQpavY3OeoI/a\nNchXgwTn2u9yejOCEu8Q+x++RQDXVeSvPciVIzfDJ5Ex2MPzJySro3iPjT+HCITu\n/sddVv3Lnz5koNzOA5RihTQ+toHsvNgI2/aLITBXVM4JtkQ0ezqNsXDFqVr0Xws/\n3xj33BhhDXDrC24ivnDspYwbjevbrc5/L/mFhkHYX5pCJoxcNd5T8JrVUC1qkBIm\nnFA0C5dMAC6qWlglIG7BAkqc4Z/bu0WxEqsi0353BlnD9A/3k4euY5vmVRn2m/6E\ns89K5XrnqRYap5/o6zkQs64n7HLDQ8F3AgMBAAGgADANBgkqhkiG9w0BAQsFAAOC\nAQEASXlft+61y8TeYhXZQbuLdORjXk4yiI4OAecItHg1GcBiscA2OWObXRalLHlP\nsGc/fp5y82wZ24YxgHbyyRGf1DU374Iz5YqEl9IJ6WPsx9j/BpUo8cNPLaBOID2P\nKUHOMNbmy2bpPAi9AiaRXef9Tz3lIlzjW+oBWDoKtLkVmGDY+aTmwm0ASdqzuc/Q\ndFEgJ1JrZtwjDxwDrtAt+FXbwvadWMo9uhKW9DAaPm9XOte8z/ACoNlQ6G6KGPT3\nYQtk+dIjzeB3po9wZklg19xV17H9WCo+p3K85ANyFjkeePB49DIfwv+04a8kOsaY\nG0ocUXmTIgNeVKyDFtFoUF+qeg==\n\n-----END CERTIFICATE REQUEST-----' ResponesIssueRSACertificate: type: object properties: id: type: string description: Идентификатор заявки example: 62550ef50163785f2222707e type: type: string description: Тип заявки enum: - issueRsaCertificate - activationRsaCertificate - currentSignTypeRsa - currentSignTypeQes status: type: string description: Статус заявки example: CREATED creator: type: string description: ФИО создателя заявки example: Ефимов Филипп Архипович createdDate: type: string description: Дата создания заявки format: date-time description: Ответ на создание заявки на выпуск RSA-сертификата example: creator: Ефимов Филипп Архипович createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: issueRsaCertificate status: CREATED RequestPostOperations: type: object properties: requestType: type: string description: Тип заявки enum: - issueRsaCertificate - activationRsaCertificate - currentSignTypeRsa - switchRsaCertificate - revocationRsaCertificate - reissueRsaCertificate - currentSignTypeQes description: Запрос отправки на подпись example: requestType: issueRsaCertificate ResponsePostOperations: type: object properties: id: type: string description: Идентификатор операции example: 2629a563-3c82-44a2-a4f5-67b79e44cbea requestId: type: string description: Идентификатор заявки example: 62550ef50163785f2222707e requestType: type: string description: Тип заявки enum: - issueRsaCertificate - activationRsaCertificate - currentSignTypeRsa - switchRsaCertificate - revocationRsaCertificate - reissueRsaCertificate - currentSignTypeQes description: Ответ отправки заявки на подпись example: requestType: issueRsaCertificate requestId: 62550ef50163785f2222707e id: 2629a563-3c82-44a2-a4f5-67b79e44cbea RequestPutOperations: type: object properties: code: type: string description: Одноразовый код example: "11111111" description: Запрос на подписание заявки example: code: "11111111" ResponsePutOperations: type: object properties: id: type: string description: Идентификатор операции example: 2629a563-3c82-44a2-a4f5-67b79e44cbea isSigned: type: boolean description: Признак достаточности подписей под документом requestId: type: string description: Идентификатор заявки example: 62550ef50163785f2222707e requestType: type: string description: Тип заявки enum: - issueRsaCertificate - activationRsaCertificate - currentSignTypeRsa - switchRsaCertificate - revocationRsaCertificate - reissueRsaCertificate - currentSignTypeQes description: Ответ на подписание заявки example: isSigned: true requestType: issueRsaCertificate requestId: 62550ef50163785f2222707e id: 2629a563-3c82-44a2-a4f5-67b79e44cbea RequestData: type: object properties: requestIssueRsaCertificate: type: array description: Заявка на выпуск RSA-сертификата items: $ref: '#/components/schemas/DataRequestIssueRsaCertificate' requestActivateRsaCertificate: type: array description: Заявка на активацию RSA-сертификата items: $ref: '#/components/schemas/DataRequestActivateRsaCertificate' requestCurrentSignTypeRsa: type: array description: Заявка на изменение основного способа items: $ref: '#/components/schemas/DataRequestCurrentSignTypeRsa' requestCurrentSignTypeQes: type: array items: $ref: '#/components/schemas/DataRequestCurrentSignTypeRsa' requestSwitchRsaCertificate: type: array description: Заявка на переключение RSA-сертификата items: $ref: '#/components/schemas/DataRequestCurrentSignTypeRsa' requestRevocationRsaCertificate: type: array description: Заявка на отзыв RSA-сертификата items: $ref: '#/components/schemas/DataRequestCurrentSignTypeRsa' requestReissueRsaCertificate: type: array description: Заявка на перевыпуск RSA-сертификата items: $ref: '#/components/schemas/DataRequestActivateRsaCertificate' requestEnableSignTypeQes: type: array items: $ref: '#/components/schemas/DataRequestCurrentSignTypeRsa' description: Данные заявки example: requestActivateRsaCertificate: - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: activationRsaCertificate results: userSignMethodStatus: ENABLED userSignMethodType: RSA status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: activationRsaCertificate results: userSignMethodStatus: ENABLED userSignMethodType: RSA status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 requestSwitchRsaCertificate: - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 requestReissueRsaCertificate: - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: activationRsaCertificate results: userSignMethodStatus: ENABLED userSignMethodType: RSA status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: activationRsaCertificate results: userSignMethodStatus: ENABLED userSignMethodType: RSA status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 requestCurrentSignTypeQes: - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 requestIssueRsaCertificate: - createdAt: 2000-01-23T04:56:07.000+00:00 createdBy: Сафонов Тихон Ерофеевич id: 62550ef50163785f2222707e type: issueRsaCertificate results: owner: Ефимов Филипп Архипович notAfter: 2000-01-23T04:56:07.000+00:00 serialNumber: 6100035c3cff88cd00f01d734a000100035c3c sendDate: 2000-01-23T04:56:07.000+00:00 executionDate: 2000-01-23T04:56:07.000+00:00 thumbprint: f738ec7266d1e3f6d6d4557bcbbc43ec188db3cf dn: firstName: Филипп lastName: Ефимов country: RU fullName: Ефимов Филипп Архипович email: User176@pochtochka.com issuedCertificateId: 62552f2457595f1652c4b179 notBefore: 2000-01-23T04:56:07.000+00:00 caRequestId: 220220 status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - createdAt: 2000-01-23T04:56:07.000+00:00 createdBy: Сафонов Тихон Ерофеевич id: 62550ef50163785f2222707e type: issueRsaCertificate results: owner: Ефимов Филипп Архипович notAfter: 2000-01-23T04:56:07.000+00:00 serialNumber: 6100035c3cff88cd00f01d734a000100035c3c sendDate: 2000-01-23T04:56:07.000+00:00 executionDate: 2000-01-23T04:56:07.000+00:00 thumbprint: f738ec7266d1e3f6d6d4557bcbbc43ec188db3cf dn: firstName: Филипп lastName: Ефимов country: RU fullName: Ефимов Филипп Архипович email: User176@pochtochka.com issuedCertificateId: 62552f2457595f1652c4b179 notBefore: 2000-01-23T04:56:07.000+00:00 caRequestId: 220220 status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 requestCurrentSignTypeRsa: - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 requestRevocationRsaCertificate: - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 requestEnableSignTypeQes: - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 - creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 DataRequestIssueRsaCertificate: type: object properties: id: type: string description: Идентификатор заявки example: 62550ef50163785f2222707e type: type: string description: Тип заявки enum: - issueRsaCertificate status: type: string description: Статус заявки example: FINISHED createdBy: type: string description: ФИО создателя заявки example: Сафонов Тихон Ерофеевич createdAt: type: string description: Дата создания заявки format: date-time finishedDate: type: string description: Дата завершения заявки format: date-time results: $ref: '#/components/schemas/ResultsRequestIssueRsaCertificat' description: Данные заявки на выпуск RSA-сертификата example: createdAt: 2000-01-23T04:56:07.000+00:00 createdBy: Сафонов Тихон Ерофеевич id: 62550ef50163785f2222707e type: issueRsaCertificate results: owner: Ефимов Филипп Архипович notAfter: 2000-01-23T04:56:07.000+00:00 serialNumber: 6100035c3cff88cd00f01d734a000100035c3c sendDate: 2000-01-23T04:56:07.000+00:00 executionDate: 2000-01-23T04:56:07.000+00:00 thumbprint: f738ec7266d1e3f6d6d4557bcbbc43ec188db3cf dn: firstName: Филипп lastName: Ефимов country: RU fullName: Ефимов Филипп Архипович email: User176@pochtochka.com issuedCertificateId: 62552f2457595f1652c4b179 notBefore: 2000-01-23T04:56:07.000+00:00 caRequestId: 220220 status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 ResultsRequestIssueRsaCertificat: type: object properties: owner: type: string description: Владелец сертфиката example: Ефимов Филипп Архипович notAfter: type: string description: Дата истечения срока действия сертификата (UTC) format: date-time notBefore: type: string description: Дата выпуска сертификата в УЦ (UTC) format: date-time serialNumber: type: string description: Серийный номер сертификата example: 6100035c3cff88cd00f01d734a000100035c3c sendDate: type: string description: Дата отправки format: date-time executionDate: type: string description: Дата исполнения format: date-time thumbprint: type: string description: Отпечаток сертификата example: f738ec7266d1e3f6d6d4557bcbbc43ec188db3cf dn: $ref: '#/components/schemas/Dn' issuedCertificateId: type: string description: Идентификатор сертификата example: 62552f2457595f1652c4b179 caRequestId: type: number description: Идентификатор запроса на отзыв в УЦ example: 220220 description: Результат выполнения заявки на выпуск RSA-сертификата example: owner: Ефимов Филипп Архипович notAfter: 2000-01-23T04:56:07.000+00:00 serialNumber: 6100035c3cff88cd00f01d734a000100035c3c sendDate: 2000-01-23T04:56:07.000+00:00 executionDate: 2000-01-23T04:56:07.000+00:00 thumbprint: f738ec7266d1e3f6d6d4557bcbbc43ec188db3cf dn: firstName: Филипп lastName: Ефимов country: RU fullName: Ефимов Филипп Архипович email: User176@pochtochka.com issuedCertificateId: 62552f2457595f1652c4b179 notBefore: 2000-01-23T04:56:07.000+00:00 caRequestId: 220220 Dn: type: object properties: firstName: type: string description: Имя example: Филипп lastName: type: string description: Фамилия example: Ефимов fullName: type: string description: Полное ФИО example: Ефимов Филипп Архипович country: type: string description: Страна example: RU email: type: string description: Электронная почта example: User176@pochtochka.com description: Данные о владельце сертификата example: firstName: Филипп lastName: Ефимов country: RU fullName: Ефимов Филипп Архипович email: User176@pochtochka.com DataRequestActivateRsaCertificate: type: object properties: id: type: string description: Идентификатор заявки example: 62550ef50163785f2222707e type: type: string description: Тип заявки enum: - activationRsaCertificate - reissueRsaCertificate status: type: string description: Статус заявки example: FINISHED creator: type: string description: ФИО создателя заявки example: Сафонов Тихон Ерофеевич createdDate: type: string description: Дата создания заявки format: date-time finishedDate: type: string description: Дата завершения заявки format: date-time results: $ref: '#/components/schemas/ResultsRequestActivateRsaCertificat' description: Данные заявки на активацию RSA-сертификата/на изменение основного способа подписи example: creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: activationRsaCertificate results: userSignMethodStatus: ENABLED userSignMethodType: RSA status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 ResultsRequestActivateRsaCertificat: type: object properties: userSignMethodType: type: string description: Тип метода подписания example: RSA userSignMethodStatus: type: string description: Статус метода подписания example: ENABLED description: Результат выполнения заявки на активацию RSA-сертификата example: userSignMethodStatus: ENABLED userSignMethodType: RSA DataRequestCurrentSignTypeRsa: type: object properties: id: type: string description: Идентификатор заявки example: 62550ef50163785f2222707e type: type: string description: Тип заявки enum: - currentSignTypeRsa - switchRsaCertificate - revocationRsaCertificate - currentSignTypeQes - enableQesSignType status: type: string description: Статус заявки example: FINISHED creator: type: string description: ФИО создателя заявки example: Сафонов Тихон Ерофеевич createdDate: type: string description: Дата создания заявки format: date-time finishedDate: type: string description: Дата завершения заявки format: date-time description: Данные заявки на выпуск RSA-сертификата example: creator: Сафонов Тихон Ерофеевич createdDate: 2000-01-23T04:56:07.000+00:00 id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2000-01-23T04:56:07.000+00:00 RSACertificate: type: object properties: content: type: string description: Содержимое сертификата example: MIIFzDCCBICgAwIBAgITYQADXDz/iM0A8B1zSgABAANcPDBBBgkqhkiG9w0BAQow\r\nNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUA\r\nogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UE\r\nCxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENB\r\nIDEwHhcNMjIwNDEyMDczOTI3WhcNMjQwNDEyMDc0OTI3WjCBmTEVMBMGA1UEKgwM\r\n0KTQuNC70LjQv9C/MRUwEwYDVQQEDAzQldGE0LjQvNC+0LIxCzAJBgNVBAYTAlJV\r\nMTUwMwYDVQQDDCzQldGE0LjQvNC+0LIg0KTQuNC70LjQv9C/INCQ0YDRhdC40L/Q\r\nvtCy0LjRhzElMCMGCSqGSIb3DQEJARYWVXNlcjE3NkBwb2NodG9jaGthLmNvbTCC\r\nASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKJu1IfZg/ijEVWCIC8t20Bm\r\nmdUNY1k2ACcIRDA1s8hClq9jc56gj9o1yFeDBOfa73J6M4IS7xD7H75FANdV5K89\r\nyJUjN8MnkTHYw/MnJKujeI+NP4cIhO7+x11W/cufPmSg3M4DlGKFND62gey82Ajb\r\n9oshMFdUzgm2RDR7Oo2xcMWpWvRfCz/fGPfcGGENcOsLbiK+cOyljBuN69utzn8v\r\n+YWGQdhfmkImjFw13lPwmtVQLWqQEiacUDQLl0wALqpaWCUgbsECSpzhn9u7RbES\r\nqyLTfncGWcP0D/eTh65jm+ZVGfab/oSzz0rleuepFhqnn+jrORCzrifscsNDwXcC\r\nAwEAAaOCAeAwggHcMB0GA1UdDgQWBBTbfzj1CFqgIOUtAqiQPszkaMdawzAfBgNV\r\nHSMEGDAWgBTJFzMem6mUoJYYS25xTIHb6XP+ZTCBuwYDVR0fBIGzMIGwMIGtoIGq\r\noIGnhjlodHRwczovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2ludC9BbGZh\r\nLUJhbmtfU0NBMS5jcmyGMGh0dHA6Ly92bGt3czY6OTA4MS9kaXN0cnBvaW50L0Fs\r\nZmEtQmFua19TQ0ExLmNybIY4aHR0cDovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlz\r\ndHJwb2ludC9BbGZhLUJhbmtfU0NBMS5jcmwwgdsGCCsGAQUFBwEBBIHOMIHLMEUG\r\nCCsGAQUFBzAChjlodHRwczovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2lu\r\ndC9BbGZhLUJhbmtfU0NBMS5jcnQwPAYIKwYBBQUHMAKGMGh0dHA6Ly92bGt3czY6\r\nOTA4MS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBEBggrBgEFBQcwAoY4\r\naHR0cDovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2ludC9BbGZhLUJhbmtf\r\nU0NBMS5jcnQwQQYJKoZIhvcNAQEKMDSgDzANBglghkgBZQMEAgMFAKEcMBoGCSqG\r\nSIb3DQEBCDANBglghkgBZQMEAgMFAKIDAgFAA4IBAQA7qvezzVUukOu6PusP9Ulr\r\n801fn7lJlEG4suRmmqWTaOUkkwfoOV+AjyN4K9LtF8JF4BE7ovoz+BAXNl6IIaxB\r\nLup0lnIf2UUXvg8XoAZ9SCNnDdmHI05NrONrRg+7DyCv8FpyudFTkFhmkaMojuUH\r\nZN8V27KlW3Q0ijDrOyn9/rIqAIA5JVbvUfRIMR8DXpZsIkf0HAnZN4Zswn0U5U0K\r\n46Ewva4fWvF7u3638Hkv8u5XNU6E1eaJTWxVM+4J8HdnnTDHSDO27VFh9SxCP8E7\r\ncvQhIhfOXz2qESMSnC2bmlGm863E7fMGxNIpikE2D5LO8Z0KiI0qrhZA7p4tye2c\r\n certificate: $ref: '#/components/schemas/DataRSACertificate' description: RSA-сертификат example: certificate: owner: Ефимов Филипп Архипович tokenSerialNumber: 00a81050 notAfter: 2000-01-23T04:56:07.000+00:00 serialNumber: 6100035c3cff88cd00f01d734a000100035c3c expireSoon: true id: 62552f2457595f1652c4b179 tokenKeyId: "AlboKey_{BBB5EB5D-2B38-488B-B9E2-5E336DDE3DE9}" actions: - available: true type: UPLOAD_ON_TOKEN - available: true type: UPLOAD_ON_TOKEN notBefore: 2000-01-23T04:56:07.000+00:00 status: CERT_VALID uploadOnToken: true content: MIIFzDCCBICgAwIBAgITYQADXDz/iM0A8B1zSgABAANcPDBBBgkqhkiG9w0BAQow\r\nNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUA\r\nogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UE\r\nCxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENB\r\nIDEwHhcNMjIwNDEyMDczOTI3WhcNMjQwNDEyMDc0OTI3WjCBmTEVMBMGA1UEKgwM\r\n0KTQuNC70LjQv9C/MRUwEwYDVQQEDAzQldGE0LjQvNC+0LIxCzAJBgNVBAYTAlJV\r\nMTUwMwYDVQQDDCzQldGE0LjQvNC+0LIg0KTQuNC70LjQv9C/INCQ0YDRhdC40L/Q\r\nvtCy0LjRhzElMCMGCSqGSIb3DQEJARYWVXNlcjE3NkBwb2NodG9jaGthLmNvbTCC\r\nASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKJu1IfZg/ijEVWCIC8t20Bm\r\nmdUNY1k2ACcIRDA1s8hClq9jc56gj9o1yFeDBOfa73J6M4IS7xD7H75FANdV5K89\r\nyJUjN8MnkTHYw/MnJKujeI+NP4cIhO7+x11W/cufPmSg3M4DlGKFND62gey82Ajb\r\n9oshMFdUzgm2RDR7Oo2xcMWpWvRfCz/fGPfcGGENcOsLbiK+cOyljBuN69utzn8v\r\n+YWGQdhfmkImjFw13lPwmtVQLWqQEiacUDQLl0wALqpaWCUgbsECSpzhn9u7RbES\r\nqyLTfncGWcP0D/eTh65jm+ZVGfab/oSzz0rleuepFhqnn+jrORCzrifscsNDwXcC\r\nAwEAAaOCAeAwggHcMB0GA1UdDgQWBBTbfzj1CFqgIOUtAqiQPszkaMdawzAfBgNV\r\nHSMEGDAWgBTJFzMem6mUoJYYS25xTIHb6XP+ZTCBuwYDVR0fBIGzMIGwMIGtoIGq\r\noIGnhjlodHRwczovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2ludC9BbGZh\r\nLUJhbmtfU0NBMS5jcmyGMGh0dHA6Ly92bGt3czY6OTA4MS9kaXN0cnBvaW50L0Fs\r\nZmEtQmFua19TQ0ExLmNybIY4aHR0cDovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlz\r\ndHJwb2ludC9BbGZhLUJhbmtfU0NBMS5jcmwwgdsGCCsGAQUFBwEBBIHOMIHLMEUG\r\nCCsGAQUFBzAChjlodHRwczovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2lu\r\ndC9BbGZhLUJhbmtfU0NBMS5jcnQwPAYIKwYBBQUHMAKGMGh0dHA6Ly92bGt3czY6\r\nOTA4MS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBEBggrBgEFBQcwAoY4\r\naHR0cDovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2ludC9BbGZhLUJhbmtf\r\nU0NBMS5jcnQwQQYJKoZIhvcNAQEKMDSgDzANBglghkgBZQMEAgMFAKEcMBoGCSqG\r\nSIb3DQEBCDANBglghkgBZQMEAgMFAKIDAgFAA4IBAQA7qvezzVUukOu6PusP9Ulr\r\n801fn7lJlEG4suRmmqWTaOUkkwfoOV+AjyN4K9LtF8JF4BE7ovoz+BAXNl6IIaxB\r\nLup0lnIf2UUXvg8XoAZ9SCNnDdmHI05NrONrRg+7DyCv8FpyudFTkFhmkaMojuUH\r\nZN8V27KlW3Q0ijDrOyn9/rIqAIA5JVbvUfRIMR8DXpZsIkf0HAnZN4Zswn0U5U0K\r\n46Ewva4fWvF7u3638Hkv8u5XNU6E1eaJTWxVM+4J8HdnnTDHSDO27VFh9SxCP8E7\r\ncvQhIhfOXz2qESMSnC2bmlGm863E7fMGxNIpikE2D5LO8Z0KiI0qrhZA7p4tye2c\r\n DataRSACertificate: type: object properties: id: type: string description: Идентификатор сертификата example: 62552f2457595f1652c4b179 serialNumber: type: string description: Серийный номер сертификата example: 6100035c3cff88cd00f01d734a000100035c3c tokenKeyId: type: string description: Идентификатор закрытого ключа на токене example: "AlboKey_{BBB5EB5D-2B38-488B-B9E2-5E336DDE3DE9}" tokenSerialNumber: type: string description: Серийный номер токена на который загружен сертификат example: 00a81050 status: type: string description: Статус сертификата example: CERT_VALID notBefore: type: string description: Дата начала действия сертификата format: date-time notAfter: type: string description: Дата завершения действия сертификата format: date-time owner: type: string description: ФИО владельца сертификата example: Ефимов Филипп Архипович uploadOnToken: type: boolean description: Признак загрузки сертификата на токен expireSoon: type: boolean description: "Признак необходимости перевыпуска сертификата, по причине\ \ завершения действия" actions: type: array description: Список всех возможных действий над сертификатом items: $ref: '#/components/schemas/ActionsRSACertificate_inner' description: Данные сертификата example: owner: Ефимов Филипп Архипович tokenSerialNumber: 00a81050 notAfter: 2000-01-23T04:56:07.000+00:00 serialNumber: 6100035c3cff88cd00f01d734a000100035c3c expireSoon: true id: 62552f2457595f1652c4b179 tokenKeyId: "AlboKey_{BBB5EB5D-2B38-488B-B9E2-5E336DDE3DE9}" actions: - available: true type: UPLOAD_ON_TOKEN - available: true type: UPLOAD_ON_TOKEN notBefore: 2000-01-23T04:56:07.000+00:00 status: CERT_VALID uploadOnToken: true ActionsRSACertificate: type: array description: Список всех возможных действий над сертификатом items: $ref: '#/components/schemas/ActionsRSACertificate_inner' SignSettings: type: object properties: currentSignType: type: string description: Тип основной подписи example: rsa-certificates description: Тип основной подписи example: currentSignType: rsa-certificates RequestReissueRSACertificate: type: object properties: tokenSerialNumber: type: string description: Серийный номер USB ключа example: 00a81050 pkcs10Content: type: string description: Контект PKCS10 example: '-----BEGIN CERTIFICATE REQUEST-----\nMIIC3zCCAccCAQAwgZkxCzAJBgNVBAYTAlJVMRUwEwYDVQQEDAzQldGE0LjQvNC+\n0LIxFTATBgNVBCoMDNCk0LjQu9C40L/QvzE1MDMGA1UEAwws0JXRhNC40LzQvtCy\nINCk0LjQu9C40L/QvyDQkNGA0YXQuNC/0L7QstC40YcxJTAjBgkqhkiG9w0BCQEW\nFlVzZXIxNzZAcG9jaHRvY2hrYS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQCibtSH2YP4oxFVgiAvLdtAZpnVDWNZNgAnCEQwNbPIQpavY3OeoI/a\nNchXgwTn2u9yejOCEu8Q+x++RQDXVeSvPciVIzfDJ5Ex2MPzJySro3iPjT+HCITu\n/sddVv3Lnz5koNzOA5RihTQ+toHsvNgI2/aLITBXVM4JtkQ0ezqNsXDFqVr0Xws/\n3xj33BhhDXDrC24ivnDspYwbjevbrc5/L/mFhkHYX5pCJoxcNd5T8JrVUC1qkBIm\nnFA0C5dMAC6qWlglIG7BAkqc4Z/bu0WxEqsi0353BlnD9A/3k4euY5vmVRn2m/6E\ns89K5XrnqRYap5/o6zkQs64n7HLDQ8F3AgMBAAGgADANBgkqhkiG9w0BAQsFAAOC\nAQEASXlft+61y8TeYhXZQbuLdORjXk4yiI4OAecItHg1GcBiscA2OWObXRalLHlP\nsGc/fp5y82wZ24YxgHbyyRGf1DU374Iz5YqEl9IJ6WPsx9j/BpUo8cNPLaBOID2P\nKUHOMNbmy2bpPAi9AiaRXef9Tz3lIlzjW+oBWDoKtLkVmGDY+aTmwm0ASdqzuc/Q\ndFEgJ1JrZtwjDxwDrtAt+FXbwvadWMo9uhKW9DAaPm9XOte8z/ACoNlQ6G6KGPT3\nYQtk+dIjzeB3po9wZklg19xV17H9WCo+p3K85ANyFjkeePB49DIfwv+04a8kOsaY\nG0ocUXmTIgNeVKyDFtFoUF+qeg==\n\n-----END CERTIFICATE REQUEST-----' revokeCertificates: type: array description: "Список сертификатов, которые необходимо отозвать, включая\ \ идентификатор сертификата для перевыпуска" items: type: string example: 62552f2457595f1652c4b179 description: Запрос на создание заявки на выпуск RSA-сертификата example: revokeCertificates: - 62552f2457595f1652c4b179 - 62552f2457595f1652c4b179 tokenSerialNumber: 00a81050 pkcs10Content: '-----BEGIN CERTIFICATE REQUEST-----\nMIIC3zCCAccCAQAwgZkxCzAJBgNVBAYTAlJVMRUwEwYDVQQEDAzQldGE0LjQvNC+\n0LIxFTATBgNVBCoMDNCk0LjQu9C40L/QvzE1MDMGA1UEAwws0JXRhNC40LzQvtCy\nINCk0LjQu9C40L/QvyDQkNGA0YXQuNC/0L7QstC40YcxJTAjBgkqhkiG9w0BCQEW\nFlVzZXIxNzZAcG9jaHRvY2hrYS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQCibtSH2YP4oxFVgiAvLdtAZpnVDWNZNgAnCEQwNbPIQpavY3OeoI/a\nNchXgwTn2u9yejOCEu8Q+x++RQDXVeSvPciVIzfDJ5Ex2MPzJySro3iPjT+HCITu\n/sddVv3Lnz5koNzOA5RihTQ+toHsvNgI2/aLITBXVM4JtkQ0ezqNsXDFqVr0Xws/\n3xj33BhhDXDrC24ivnDspYwbjevbrc5/L/mFhkHYX5pCJoxcNd5T8JrVUC1qkBIm\nnFA0C5dMAC6qWlglIG7BAkqc4Z/bu0WxEqsi0353BlnD9A/3k4euY5vmVRn2m/6E\ns89K5XrnqRYap5/o6zkQs64n7HLDQ8F3AgMBAAGgADANBgkqhkiG9w0BAQsFAAOC\nAQEASXlft+61y8TeYhXZQbuLdORjXk4yiI4OAecItHg1GcBiscA2OWObXRalLHlP\nsGc/fp5y82wZ24YxgHbyyRGf1DU374Iz5YqEl9IJ6WPsx9j/BpUo8cNPLaBOID2P\nKUHOMNbmy2bpPAi9AiaRXef9Tz3lIlzjW+oBWDoKtLkVmGDY+aTmwm0ASdqzuc/Q\ndFEgJ1JrZtwjDxwDrtAt+FXbwvadWMo9uhKW9DAaPm9XOte8z/ACoNlQ6G6KGPT3\nYQtk+dIjzeB3po9wZklg19xV17H9WCo+p3K85ANyFjkeePB49DIfwv+04a8kOsaY\nG0ocUXmTIgNeVKyDFtFoUF+qeg==\n\n-----END CERTIFICATE REQUEST-----' EnableQesResponse: required: - createdAt - createdBy - id - status - type type: object properties: id: type: string description: Идентификатор заявки example: 63160a37e27edd0c316567a6 type: type: string description: Тип заявки example: enableQesSignType status: type: string description: Статус заявки example: CREATED createdBy: type: string description: ФИО создателя заявки example: Дмитриев Денис Михайлович createdAt: type: string description: Дата создания заявки format: date-time example: 2022-09-05T14:39:51.197Z example: createdAt: 2022-09-05T14:39:51.197Z createdBy: Дмитриев Денис Михайлович id: 63160a37e27edd0c316567a6 type: enableQesSignType status: CREATED SendRequestQes: required: - type type: object properties: type: type: string description: | Тип заявки. Возможные значения: * `enableQesSignType` - заявка на подключение способа подписи КЭП example: enableQesSignType example: type: enableQesSignType RequestType: type: string description: | Тип заявки. Возможные значения: * `enableQesSignType` - заявка на подключение способа подписи КЭП example: enableQesSignType SendRequestQesResponse: required: - content - id - type type: object properties: id: type: string description: Идентификатор заявки example: 63160a37e27edd0c316567a6 type: type: string description: | Тип заявки. Возможные значения: * `enableQesSignType` - заявка на подключение способа подписи КЭП example: enableQesSignType content: type: string description: Документ на подпись в формате base64 example: id: 63160a37e27edd0c316567a6 type: enableQesSignType content: content SignRequestQes: required: - signature - type type: object properties: type: type: string description: | Тип заявки. Возможные значения: * `enableQesSignType` - заявка на подключение способа подписи КЭП example: enableQesSignType signature: minLength: 1 type: string description: "Значение электронной подписи, закодированное в base64" example: signature: signature type: enableQesSignType SignRequestQesResponse: required: - id - isSigned - type type: object properties: id: type: string description: Идентификатор заявки example: 63160a37e27edd0c316567a6 type: type: string description: | Тип заявки. Возможные значения: * `enableQesSignType` - заявка на подключение способа подписи КЭП example: enableQesSignType isSigned: type: boolean description: Признак достаточности подписей example: true example: isSigned: true id: 63160a37e27edd0c316567a6 type: enableQesSignType DownloadPoaRequest: required: - confidantInn - issuerInn - poaNumber type: object properties: poaNumber: type: string description: Номер доверенности example: 8e08423a-bcc0-4fba-a791-9825cb1a7cb3 issuerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН доверителя example: "7727464030" confidantInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН доверенного лица example: "420548688683" description: Данные для регистрации МЧД example: issuerInn: "7727464030" confidantInn: "420548688683" poaNumber: 8e08423a-bcc0-4fba-a791-9825cb1a7cb3 DownloadPoaResponse: required: - id type: object properties: id: type: string description: Идентификатор запроса в системе МЧД example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 example: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 GetDownloadStatus: required: - status type: object properties: status: type: string description: | Статус машиночитаемой доверенности (МЧД). Принимает возможные значения: * `COMPLETE` - Операция завершена; * `PENDING` - Операция выполняется. Идет запрос данных с узла ФНС; * `FAILED` - Ошибка; * `TIMEOUT` - Превышен лимит ожидания example: COMPLETE enum: - COMPLETE - PENDING - FAILED - TIMEOUT description: Объект предоставляет статус скачивания полной версии машиночитаемой доверенности example: status: COMPLETE Payment: required: - amount - date - externalId - operationCode - payeeAccount - payeeBankBic - payeeName - payerAccount - payerBankBic - payerBankCorrAccount - payerInn - payerName - priority - purpose type: object properties: amount: minimum: 0 exclusiveMinimum: true type: number description: Сумма платежа example: 1.01 bankComment: type: string description: Банковский комментарий к статусу документа example: "" bankStatus: type: string description: Статус документа example: CREATED crucialFieldsHash: type: string description: Hash от ключевых полей документа example: 3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316 date: type: string description: Дата составления документа format: date example: 2022-10-11 deliveryKind: type: string description: Вид платежа example: электронно departmentalInfo: $ref: '#/components/schemas/DepartmentalInfo_1' digestSignatures: type: array items: $ref: '#/components/schemas/Signature' externalId: type: string description: "Идентификатор документа, присвоенный партнером (UUID)" format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 incomeTypeCode: pattern: "^\\d{1}$" type: string description: Код вида дохода получателей выплаты по 229-ФЗ example: "2" number: pattern: "^(?!0*$)\\d{1,6}$" type: string description: Номер документа example: "1" operationCode: type: string description: "Код операции: 01" example: "01" enum: - "01" payeeAccount: pattern: "^\\d{20}$" type: string description: Счет получателя платежа example: "40702810564564564531" payeeBankBic: pattern: "^\\d{9}$" type: string description: БИК банка получателя платежа example: "040173745" payeeBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчет банка получателя платежа example: "30101810800000000745" payeeInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН получателя платежа example: "7723870785" payeeKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП получателя платежа example: "553453453" payeeName: maxLength: 160 minLength: 1 type: string description: Полное наименование получателя платежа example: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerAccount: pattern: "^\\d{20}$" type: string description: Счет плательщика example: "40702810102300000001" payerBankBic: pattern: "^\\d{9}$" type: string description: БИК банка плательщика example: "044525593" payerBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчет банка плательщика example: "30101810200000000593" payerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика example: "0453438040" payerKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП плательщика example: "046773311" payerName: maxLength: 160 minLength: 1 type: string description: Полное наименование плательщика example: Общество с ограниченной ответственностью "Клиент" priority: pattern: "^[1-5]{1}$" type: string description: Очередность платежа example: "5" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата заказа №1. НДС не облагается urgencyCode: $ref: '#/components/schemas/UrgencyCode' vat: $ref: '#/components/schemas/Vat' description: Данные рублёвого платёжного поручения example: date: 2022-10-11T00:00:00.000+00:00 payerBankCorrAccount: "30101810200000000593" digestSignatures: - base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 - base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 purpose: Оплата заказа №1. НДС не облагается bankComment: "" operationCode: "01" deliveryKind: электронно crucialFieldsHash: 3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316 number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerName: Общество с ограниченной ответственностью "Клиент" payeeBankCorrAccount: "30101810800000000745" amount: 1.01 departmentalInfo: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: МС.02.2022 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2022-05-25 uip: "0" paymentKind110: "0" payerKpp: "046773311" vat: rate: "0" type: NO_VAT externalId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 urgencyCode: NORMAL payerInn: "0453438040" priority: "5" payerAccount: "40702810102300000001" bankStatus: CREATED payeeBankBic: "040173745" payerBankBic: "044525593" incomeTypeCode: "2" payeeInn: "7723870785" payeeKpp: "553453453" payeeAccount: "40702810564564564531" DepartmentalInfo_1: type: object properties: uip: maxLength: 25 type: string description: Уникальный идентификатор платежа/начисления example: "0" drawerStatus101: pattern: "^\\d{2}$" type: string description: Показатель статуса налогоплательщика example: "01" kbk: pattern: "^(([0]{1})|(\\d{20}))$" type: string description: Код бюджетной классификации example: "18210102010011000110" oktmo: pattern: "^(([0]{1})|(\\d{8}))$" type: string description: Код OKTMO example: "45902000" reasonCode106: maxLength: 2 type: string description: Показатель основания платежа example: ТП taxPeriod107: maxLength: 10 type: string description: Налоговый период или код таможенного органа example: МС.02.2022 docNumber108: maxLength: 15 type: string description: Номер налогового документа example: "000000000000001" docDate109: pattern: "^((\\d{4}-\\d{2}-\\d{2})|([0]{1,2}))$" type: string description: Дата налогового документа в формате YYYY-MM-DD example: 2022-05-25 paymentKind110: maxLength: 2 type: string description: Тип налогового платежа example: "0" description: "Реквизиты налогового, таможенного или иного бюджетного платежа" example: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: МС.02.2022 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2022-05-25 uip: "0" paymentKind110: "0" Signature: required: - base64Encoded - certificateUuid type: object properties: base64Encoded: minLength: 1 type: string description: "Значение электронной подписи, закодированное в Base64" example: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: minLength: 1 type: string description: "Идентификатор сертификата, использованного при создании ЭП" example: 61000366d11e143acbc03a56d70001000366d1 description: Электронные подписи по дайджесту документа example: base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 UrgencyCode: type: string description: | Код срочности: * `OFFHOURS` - Продлённый операционный день; * `BESP` - Срочный платёж; * `NORMAL` - Стандартный операционный день example: NORMAL enum: - OFFHOURS - BESP - NORMAL Vat: required: - type type: object properties: rate: type: string description: Ставка НДС example: "0" type: type: string description: | Способ расчета НДС. Возможные значения: * `NO_VAT` - Не облагается НДС; * `INCLUDED` - НДС включен в сумму платежа; * `ONTOP` - НДС добавляется к сумме платежа; * `MANUAL` - Ручной ввод НДС; * `AGENT` - НДС исчисляется налоговым агентом example: NO_VAT enum: - INCLUDED - NO_VAT - MANUAL - ONTOP - AGENT description: Данные НДС example: rate: "0" type: NO_VAT ErrorConflict: required: - error type: object properties: error: type: string description: Код ошибки example: conflict error_description: type: string description: Сообщение об ошибке example: Request could not be processed because of conflict in the request description: Конфликт PaymentDocState: type: object properties: bankStatus: type: string description: Статус документа example: ACCEPTED bankComment: type: string description: Банковский комментарий к статусу документа example: Проверяем реквизиты платежа. После успешной проверки платёж отправим в течение банковского дня crucialFieldsHash: type: string description: Hash от ключевых полей документа example: 3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316 description: Статус платёжного документа example: bankStatus: ACCEPTED bankComment: Проверяем реквизиты платежа. После успешной проверки платёж отправим в течение банковского дня crucialFieldsHash: 3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316 PatchPaymentStateRequest: required: - bankStatus type: object properties: bankStatus: type: string description: | Статус документа. Возможные значения: * `PARTSIGNED` - Отправлен на подпись или частично подписан example: PARTSIGNED enum: - PARTSIGNED example: bankStatus: PARTSIGNED PaymentPrintForm: type: object properties: fileName: type: string description: Имя файла example: Платежное_поручение_№657073_11.10.2022.pdf content: type: string description: Содержимое файла example: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDIwMDA...PgpzdGFydHhyZWYKMTE4MDkKJSVFT0YK description: Печатная форма документа example: fileName: Платежное_поручение_№657073_11.10.2022.pdf content: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDIwMDA...PgpzdGFydHhyZWYKMTE4MDkKJSVFT0YK Status: type: string description: Статус обработки документа example: CREATED enum: - CREATED - SIGNED PaymentsCountResponse: required: - count type: object properties: count: type: integer description: Количество платежей format: int64 example: 100 example: count: 100 InvoiceRequest: required: - amount - date - externalId - payeeAccount - purpose type: object properties: amount: minimum: 0 exclusiveMinimum: true type: number description: Сумма платежа example: 1.01 date: type: string description: Дата составления документа в формате YYYY-MM-DD format: date example: 2018-12-31 deliveryKind: type: string description: Вид платежа example: электронно expirationDate: type: string description: Дата истечения заказа format: date-time example: 2022-09-12T19:15:51+03:00 externalId: type: string description: "Идентификатор документа, присвоенный партнером (UUID)" format: uuid example: 697e31f1-8df2-458e-8646-f77ea5bae8a2 operationCode: type: string description: | Код операции. Возможные значения: * `01` - Платёжное поручение enum: - "01" orderNumber: type: string description: Номер заказа example: "1" payeeAccount: pattern: "^\\d{20}$" type: string description: Счёт получателя платежа example: "40702810564564564531" payeeOrgIdHash: type: string description: Идентификатор получателя платежа example: bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732 paymentNumber: pattern: "^(?!0*$)\\d{1,6}$" type: string description: Номер платёжного поручения example: "1" priority: pattern: "^[1-5]{1}$" type: string description: Очередность платежа example: "5" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата заказа №1. НДС не облагается urgencyCode: $ref: '#/components/schemas/UrgencyCode_1' vat: $ref: '#/components/schemas/Vat_1' example: date: 2018-12-31T00:00:00.000+00:00 amount: 1.01 orderNumber: "1" purpose: Оплата заказа №1. НДС не облагается operationCode: "01" vat: rate: "0" type: NO_VAT deliveryKind: электронно externalId: 697e31f1-8df2-458e-8646-f77ea5bae8a2 urgencyCode: NORMAL priority: "5" payeeOrgIdHash: bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732 payeeAccount: "40702810564564564531" paymentNumber: "1" expirationDate: 2022-09-12T19:15:51+03:00 UrgencyCode_1: type: string description: | Код срочности. Возможные значения: * `NORMAL` - Стандартный операционный день; * `OFFHOURS` - Продлённый операционный день; * `BESP` - Срочный платёж example: NORMAL enum: - OFFHOURS - BESP - NORMAL Vat_1: required: - type type: object properties: rate: type: string description: Ставка НДС example: "0" type: type: string description: | Способ расчета НДС. Возможные значения: * `NO_VAT` - Не облагается НДС; * `INCLUDED` - НДС включен в сумму платежа; * `ONTOP` - НДС добавляется к сумме платежа; * `MANUAL` - Ручной ввод НДС; * `AGENT` - НДС исчисляется налоговым агентом. example: NO_VAT enum: - INCLUDED - NO_VAT - MANUAL - ONTOP - AGENT description: Данные НДС nullable: true example: rate: "0" type: NO_VAT InvoiceResponse: required: - amount - date - externalId - operationCode - payeeAccount - payeeBankBic - payeeName - priority - purpose type: object properties: amount: minimum: 0 exclusiveMinimum: true type: number description: Сумма платежа example: 1.01 bankComment: type: string description: Банковский комментарий к статусу документа bankStatus: type: string description: Статус документа example: CREATED crucialFieldsHash: type: string description: Hash от ключевых полей документа example: 925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50 date: type: string description: Дата составления документа в формате YYYY-MM-DD format: date example: 2018-12-31 deliveryKind: type: string description: "Вид платежа: электронно" example: электронно externalId: type: string description: "Идентификатор документа, присвоенный партнером (UUID)" format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 incomeTypeCode: pattern: "^\\d{1}$" type: string description: Код вида дохода получателей выплаты по 229-ФЗ number: pattern: "^(?!0*$)\\d{1,6}$" type: string description: Номер документа example: "1" operationCode: type: string description: "Код операции: 01" example: "01" payeeAccount: pattern: "^\\d{20}$" type: string description: Счёт получателя платежа example: "40702810564564564531" payeeBankBic: pattern: "^\\d{9}$" type: string description: БИК банка получателя платежа example: "040173745" payeeBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчет банка получателя платежа example: "30101810200000000593" payeeInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН получателя платежа example: "7723870785" payeeKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП получателя платежа example: "553453453" payeeName: maxLength: 160 minLength: 1 type: string description: Полное наименование получателя платежа example: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerAccount: pattern: "^\\d{20}$" type: string description: Счёт плательщика example: "40702810600010800068" payerBankBic: pattern: "^\\d{9}$" type: string description: БИК банка плательщика example: "044525225" payerBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчет банка плательщика example: "30101810400000000225" payerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика example: "7736576798" payerKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП плательщика example: "772201001" payerName: maxLength: 160 minLength: 1 type: string description: Полное наименование плательщика example: Общество с ограниченной ответственностью "Клиент" priority: pattern: "^[1-5]{1}$" type: string description: Очередность платежа example: "5" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата заказа №1. НДС не облагается urgencyCode: $ref: '#/components/schemas/UrgencyCode_1' vat: $ref: '#/components/schemas/Vat_1' description: Данные рублёвого платёжного поручения example: date: 2018-12-31T00:00:00.000+00:00 payerBankCorrAccount: "30101810400000000225" purpose: Оплата заказа №1. НДС не облагается bankComment: bankComment operationCode: "01" deliveryKind: электронно crucialFieldsHash: 925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50 number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerName: Общество с ограниченной ответственностью "Клиент" payeeBankCorrAccount: "30101810200000000593" amount: 1.01 payerKpp: "772201001" vat: rate: "0" type: NO_VAT externalId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 urgencyCode: NORMAL payerInn: "7736576798" priority: "5" payerAccount: "40702810600010800068" bankStatus: CREATED payeeBankBic: "040173745" payerBankBic: "044525225" incomeTypeCode: incomeTypeCode payeeInn: "7723870785" payeeKpp: "553453453" payeeAccount: "40702810564564564531" InvoiceBudgetRequest: required: - amount - date - departmentalInfo - externalId - payeeAccount - payeeBankBic - payeeInn - payeeKpp - payeeName - purpose type: object properties: amount: minimum: 0 exclusiveMinimum: true type: number description: Сумма платежа example: 100 date: type: string description: Дата составления документа в формате YYYY-MM-DD format: date example: 2022-04-01 deliveryKind: type: string description: Вид платежа example: электронно departmentalInfo: $ref: '#/components/schemas/InvoiceDepartmentalInfo' externalId: type: string description: "Идентификатор документа, присвоенный партнером (UUID)" format: uuid example: 697e31f1-8df2-458e-8646-f77ea5bae8a2 operationCode: type: string description: | Код операции. Возможные значения: * `01` - Платёжное поручение enum: - "01" payeeAccount: pattern: "^\\d{20}$" type: string description: Счёт получателя платежа example: "40702810564564564531" payeeBankBic: pattern: "^\\d{9}$" type: string description: БИК банка получателя платежа example: "040173745" payeeBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчёт банка получателя платежа example: "30101810800000000745" payeeInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН получателя платежа example: "7723870785" payeeKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП получателя платежа example: "553453453" payeeName: maxLength: 160 minLength: 1 type: string description: Полное наименование получателя платежа example: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП плательщика example: "772201001" paymentNumber: pattern: "^(?!0*$)\\d{1,6}$" type: string description: Номер платёжного поручения example: "1" priority: pattern: "^[1-5]{1}$" type: string description: Очерёдность платежа example: "5" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается urgencyCode: $ref: '#/components/schemas/UrgencyCode_1' example: date: 2022-04-01T00:00:00.000+00:00 amount: 100 departmentalInfo: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: МС.02.2022 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2022-03-25 uip: "0" purpose: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается operationCode: "01" payerKpp: "772201001" deliveryKind: электронно externalId: 697e31f1-8df2-458e-8646-f77ea5bae8a2 urgencyCode: NORMAL priority: "5" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeBankBic: "040173745" payeeInn: "7723870785" payeeBankCorrAccount: "30101810800000000745" payeeKpp: "553453453" payeeAccount: "40702810564564564531" paymentNumber: "1" InvoiceDepartmentalInfo: required: - docDate109 - docNumber108 - drawerStatus101 - kbk - oktmo - reasonCode106 - taxPeriod107 - uip type: object properties: uip: maxLength: 25 type: string description: Уникальный идентификатор платежа/начисления example: "0" drawerStatus101: pattern: "^\\d{2}$" type: string description: Показатель статуса налогоплательщика example: "01" kbk: pattern: "^(([0]{1})|(\\d{20}))$" type: string description: Код бюджетной классификации example: "18210102010011000110" oktmo: pattern: "^(([0]{1})|(\\d{8}))$" type: string description: Код OKTMO example: "45902000" reasonCode106: maxLength: 2 type: string description: Показатель основания платежа example: ТП taxPeriod107: pattern: "^(0|[0-9]{8}|([0-9]{2}|МС|КВ|ПЛ|ГД).[0-9]{2}.[0-9]{4})$" type: string description: Налоговый период или код таможенного органа example: МС.02.2022 docNumber108: maxLength: 15 type: string description: Номер налогового документа example: "000000000000001" docDate109: pattern: "^((\\d{4}-\\d{2}-\\d{2})|([0]{1,2}))$" type: string description: Дата налогового документа в формате YYYY-MM-DD example: 2022-03-25 description: "Реквизиты налогового, таможенного или иного бюджетного платежа" example: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: МС.02.2022 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2022-03-25 uip: "0" InvoiceBudgetResponse: required: - amount - date - departmentalInfo - externalId - operationCode - payeeAccount - payeeBankBic - payeeInn - payeeName - priority - purpose type: object properties: amount: minimum: 0 exclusiveMinimum: true type: number description: Сумма платежа example: 100 bankComment: type: string description: Банковский комментарий к статусу документа bankStatus: type: string description: Статус документа example: CREATED crucialFieldsHash: type: string description: Hash от ключевых полей документа example: 925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50 date: type: string description: Дата составления документа в формате YYYY-MM-DD format: date example: 2022-04-01 deliveryKind: type: string description: Вид платежа example: электронно departmentalInfo: $ref: '#/components/schemas/InvoiceDepartmentalInfo' externalId: type: string description: "Идентификатор документа, присвоенный партнером (UUID)" format: uuid example: 697e31f1-8df2-458e-8646-f77ea5bae8a2 number: type: string description: Номер документа example: "1" operationCode: type: string description: | Код операции. Возможные значения: * `01` - Платёжное поручение enum: - "01" payeeAccount: pattern: "^\\d{20}$" type: string description: Счёт получателя платежа example: "40702810564564564531" payeeBankBic: pattern: "^\\d{9}$" type: string description: БИК банка получателя платежа example: "040173745" payeeBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчёт банка получателя платежа example: "30101810800000000745" payeeInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН получателя платежа example: "7723870785" payeeKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП получателя платежа example: "553453453" payeeName: maxLength: 160 minLength: 1 type: string description: Полное наименование получателя платежа example: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП плательщика example: "772201001" priority: pattern: "^[1-5]{1}$" type: string description: Очерёдность платежа example: "5" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается urgencyCode: $ref: '#/components/schemas/UrgencyCode_1' example: date: 2022-04-01T00:00:00.000+00:00 amount: 100 departmentalInfo: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: МС.02.2022 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2022-03-25 uip: "0" purpose: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается bankComment: bankComment operationCode: "01" payerKpp: "772201001" deliveryKind: электронно externalId: 697e31f1-8df2-458e-8646-f77ea5bae8a2 urgencyCode: NORMAL crucialFieldsHash: 925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50 priority: "5" number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" bankStatus: CREATED payeeBankBic: "040173745" payeeInn: "7723870785" payeeBankCorrAccount: "30101810800000000745" payeeKpp: "553453453" payeeAccount: "40702810564564564531" RegistryPaymentsRequest: required: - payments - urgencyCode type: object properties: urgencyCode: $ref: '#/components/schemas/UrgencyCode_2' description: maxLength: 210 minLength: 1 type: string description: Описание реестра example: Описание реестра payments: type: array items: $ref: '#/components/schemas/RegistryPayment' description: Данные реестра платежей example: payments: - date: 2023-12-31T00:00:00.000+00:00 payerBankCorrAccount: "30101810200000000593" amount: 1.01 departmentalInfo: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: ГД.00.2021 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2021-12-14 uip: "0" paymentKind110: "0" purpose: Оплата заказа №1. НДС не облагается payerKpp: "772201001" deliveryKind: электронно payerInn: "7736576798" priority: "5" payerAccount: "40702810102300000001" number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerBankBic: "044525593" payeeBankBic: "040173745" incomeTypeCode: "2" payerName: Общество с ограниченной ответственностью "Клиент" payeeInn: "7723870785" payeeBankCorrAccount: "30101810800000000745" payeeKpp: "553453453" payeeAccount: "40702810564564564531" - date: 2023-12-31T00:00:00.000+00:00 payerBankCorrAccount: "30101810200000000593" amount: 1.01 departmentalInfo: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: ГД.00.2021 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2021-12-14 uip: "0" paymentKind110: "0" purpose: Оплата заказа №1. НДС не облагается payerKpp: "772201001" deliveryKind: электронно payerInn: "7736576798" priority: "5" payerAccount: "40702810102300000001" number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerBankBic: "044525593" payeeBankBic: "040173745" incomeTypeCode: "2" payerName: Общество с ограниченной ответственностью "Клиент" payeeInn: "7723870785" payeeBankCorrAccount: "30101810800000000745" payeeKpp: "553453453" payeeAccount: "40702810564564564531" urgencyCode: NORMAL description: Описание реестра UrgencyCode_2: type: string description: | Срочность платежей в реестре. Возможные значения: * `OFFHOURS` - Продлённый операционный день; * `BESP` - Срочный платёж; * `NORMAL` - Стандартный операционный день example: NORMAL enum: - OFFHOURS - BESP - NORMAL RegistryPayment: required: - amount - date - payeeAccount - payeeBankBic - payeeInn - payeeName - payerAccount - payerInn - purpose type: object properties: number: pattern: "^(?!0*$)\\d{1,6}$" type: string description: Номер документа example: "1" date: type: string description: Дата составления документа format: date example: 2023-12-31 deliveryKind: type: string description: Вид платежа example: электронно amount: minimum: 0 exclusiveMinimum: true type: number description: Сумма платежа example: 1.01 payerName: maxLength: 160 minLength: 1 type: string description: Полное наименование плательщика example: Общество с ограниченной ответственностью "Клиент" payerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика example: "7736576798" payerKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП плательщика example: "772201001" payerAccount: pattern: "^\\d{20}$" type: string description: Счёт плательщика example: "40702810102300000001" payerBankBic: pattern: "^\\d{9}$" type: string description: БИК банка плательщика example: "044525593" payerBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчет банка плательщика example: "30101810200000000593" payeeName: maxLength: 160 minLength: 1 type: string description: Полное наименование получателя платежа example: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН получателя платежа example: "7723870785" payeeKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП получателя платежа example: "553453453" payeeAccount: pattern: "^\\d{20}$" type: string description: Счёт получателя платежа example: "40702810564564564531" payeeBankBic: pattern: "^\\d{9}$" type: string description: БИК банка получателя платежа example: "040173745" payeeBankCorrAccount: pattern: "^\\d{20}$" type: string description: Корсчет банка получателя платежа example: "30101810800000000745" departmentalInfo: $ref: '#/components/schemas/DepartmentalInfo_2' incomeTypeCode: pattern: "^\\d{1}$" type: string description: Код вида дохода получателей выплаты по 229-ФЗ example: "2" priority: pattern: "^[1-5]{1}$" type: string description: Очерёдность платежа example: "5" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата заказа №1. НДС не облагается description: Данные рублёвого платёжного поручения example: date: 2023-12-31T00:00:00.000+00:00 payerBankCorrAccount: "30101810200000000593" amount: 1.01 departmentalInfo: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: ГД.00.2021 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2021-12-14 uip: "0" paymentKind110: "0" purpose: Оплата заказа №1. НДС не облагается payerKpp: "772201001" deliveryKind: электронно payerInn: "7736576798" priority: "5" payerAccount: "40702810102300000001" number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerBankBic: "044525593" payeeBankBic: "040173745" incomeTypeCode: "2" payerName: Общество с ограниченной ответственностью "Клиент" payeeInn: "7723870785" payeeBankCorrAccount: "30101810800000000745" payeeKpp: "553453453" payeeAccount: "40702810564564564531" DepartmentalInfo_2: type: object properties: uip: maxLength: 25 type: string description: Уникальный идентификатор платежа/начисления example: "0" drawerStatus101: pattern: "^\\d{2}$" type: string description: Показатель статуса налогоплательщика example: "01" kbk: pattern: "^(([0]{1})|(\\d{20}))$" type: string description: Код бюджетной классификации example: "18210102010011000110" oktmo: pattern: "^(([0]{1})|(\\d{8}))$" type: string description: Код OKTMO example: "45902000" reasonCode106: maxLength: 2 type: string description: Показатель основания платежа example: ТП taxPeriod107: maxLength: 10 type: string description: Налоговый период или код таможенного органа example: ГД.00.2021 docNumber108: maxLength: 15 type: string description: Номер налогового документа example: "000000000000001" docDate109: pattern: "^((\\d{4}-\\d{2}-\\d{2})|([0]{1,2}))$" type: string description: Дата налогового документа в формате YYYY-MM-DD example: 2021-12-14 paymentKind110: maxLength: 2 type: string description: Код выплат example: "0" description: "Реквизиты налогового, таможенного или иного бюджетного платежа" example: drawerStatus101: "01" oktmo: "45902000" kbk: "18210102010011000110" taxPeriod107: ГД.00.2021 docNumber108: "000000000000001" reasonCode106: ТП docDate109: 2021-12-14 uip: "0" paymentKind110: "0" RegistryPaymentsResponse: required: - registryId type: object properties: registryId: type: string description: Идентификатор реестра example: U102702240001208 description: type: string description: Описание реестра example: Описание реестра payerAccount: pattern: "^\\d{20}$" type: string description: Счёт списания example: "40702810102300000001" urgencyCode: $ref: '#/components/schemas/UrgencyCode_2' paymentsCount: type: integer description: Количество платежей реестра example: 2 totalAmount: type: number description: Общая сумма платежей в реестре example: 100 description: Успешный ответ example: payerAccount: "40702810102300000001" totalAmount: 100 paymentsCount: 2 registryId: U102702240001208 description: Описание реестра urgencyCode: NORMAL Registry: type: object properties: status: type: string description: | Статус реестра платежей. Принимает возможные значения: * `UPLOADING` - Загружается; * `UPLOADED` - Черновик; * `ON_SIGNING` - На подписании; * `SIGNED` - Подписан; * `PROCESSING` - На обработке; * `DONE` - Исполнен; * `PARTIALLY_DONE` - Исполнен частично; * `UPLOAD_ERROR` - Ошибка загрузки; * `ERROR` - Отклонён банком; * `DELETED` - Удалён; * `URGENCY_CHANGE` - Вносим изменения; * `EDIT_PAYMENTS` - Промежуточный статус во время копирования платежей в реестрах example: UPLOADED enum: - UPLOADING - UPLOADED - ON_SIGNING - SIGNED - PROCESSING - DONE - PARTIALLY_DONE - UPLOAD_ERROR - ERROR - DELETED - URGENCY_CHANGE - EDIT_PAYMENTS description: type: string description: Описание реестра example: Описание реестра payerName: type: string description: Полное наименование плательщика example: Общество с ограниченной ответственностью "Клиент" payerAccount: pattern: "^\\d{20}$" type: string description: Счёт списания example: "40702810102300000001" urgencyCode: $ref: '#/components/schemas/UrgencyCode_2' registryActualState: $ref: '#/components/schemas/RegistryState' states: type: array items: $ref: '#/components/schemas/PaymentState' isValidForSign: type: boolean description: Признак готовности реестра к подписанию description: Данные реестра example: payerAccount: "40702810102300000001" isValidForSign: true description: Описание реестра payerName: Общество с ограниченной ответственностью "Клиент" urgencyCode: NORMAL registryActualState: totalAmount: 7484.23 paymentsCount: 9 status: UPLOADED states: - amount: 7154.07 count: 3 status: DRAFT - amount: 7154.07 count: 3 status: DRAFT RegistryState: type: object properties: paymentsCount: type: integer description: Текущее количество платежей в реестре example: 9 totalAmount: type: number description: Текущая сумма платежей в реестре example: 7484.23 example: totalAmount: 7484.23 paymentsCount: 9 PaymentState: required: - amount - count - status type: object properties: count: type: integer description: Количество платежей в указанном статусе example: 3 amount: type: number description: Сумма платежей в указанном статусе example: 7154.07 status: $ref: '#/components/schemas/PaymentStatus' example: amount: 7154.07 count: 3 status: DRAFT PaymentStatus: type: string description: | Статус платежа. Принимает возможные значения: * `DRAFT` - Черновик; * `ON_SIGNING` - На подпись; * `TO_BE_SEND` - К отправке; * `PROCESSING` - На исполнении; * `DONE` - Исполнен; * `REJECTED` - Не исполнен; * `DECLINED` - Отклонён; * `DELETED` - Удалён; * `WITH_ERRORS` - С ошибками example: DRAFT enum: - DRAFT - ON_SIGNING - TO_BE_SEND - PROCESSING - DONE - REJECTED - DECLINED - DELETED - WITH_ERRORS UpdateRegistryStatusRequest: required: - status type: object properties: status: type: string description: | Статус реестра платежей. Принимает возможные значения: * `ON_SIGNING` - на подписании; * `PROCESSING` - на обработке example: ON_SIGNING example: status: ON_SIGNING RegistryWithContent: required: - payerAccount - status - urgencyCode type: object properties: status: type: string description: | Статус реестра платежей. Принимает возможные значения: * `ON_SIGNING` - На подписании; * `PROCESSING` - На обработке example: ON_SIGNING description: type: string description: Описание реестра example: Описание реестра payerAccount: pattern: "^\\d{20}$" type: string description: Счёт списания example: "40702810102300000001" urgencyCode: $ref: '#/components/schemas/UrgencyCode_2' content: type: string description: Содержимое документа в формате base64 example: YW1vdW50PTEwMC4wMApkYXRlPTIwMTgtMDUtMzEKZGVwYXJ0bWVudGFsSW5mby...NOdW1iZXIx= description: Данные реестра с контентом для подписи example: payerAccount: "40702810102300000001" description: Описание реестра urgencyCode: NORMAL content: YW1vdW50PTEwMC4wMApkYXRlPTIwMTgtMDUtMzEKZGVwYXJ0bWVudGFsSW5mby...NOdW1iZXIx= status: ON_SIGNING GetRegistryPaymentsResponse: required: - payments type: object properties: pagination: $ref: '#/components/schemas/Pagination_1' payments: type: array items: $ref: '#/components/schemas/RegistryPaymentStatus' example: pagination: offset: 0 limit: 10 totalCount: 1 payments: - date: 2023-12-31T00:00:00.000+00:00 amount: 1.01 purpose: Оплата заказа №1. НДС не облагается payerAccount: "40702810102300000001" number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeBankBic: "040173745" payeeInn: "7723870785" id: U031308240002351 payeeKpp: "553453453" payeeAccount: "40702810564564564531" status: DRAFT info: Сумма платежа должна состоять из цифр и быть больше 0 - date: 2023-12-31T00:00:00.000+00:00 amount: 1.01 purpose: Оплата заказа №1. НДС не облагается payerAccount: "40702810102300000001" number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeBankBic: "040173745" payeeInn: "7723870785" id: U031308240002351 payeeKpp: "553453453" payeeAccount: "40702810564564564531" status: DRAFT info: Сумма платежа должна состоять из цифр и быть больше 0 Pagination_1: type: object properties: limit: minimum: 1 type: integer description: Количество элементов example: 10 offset: minimum: 0 type: integer description: Смещение в результатах поиска example: 0 totalCount: type: integer description: "Количество элементов, удовлетворяющих запросу" example: 1 description: Параметры пагинации example: offset: 0 limit: 10 totalCount: 1 RegistryPaymentStatus: required: - amount - date - payeeAccount - payeeBankBic - payeeInn - payeeName - payerAccount - purpose type: object properties: id: type: string description: Идентификатор платежа example: U031308240002351 number: pattern: "^(?!0*$)\\d{1,6}$" type: string description: Номер документа example: "1" status: $ref: '#/components/schemas/PaymentStatus' info: type: string description: Информационное сообщение для пользователя example: Сумма платежа должна состоять из цифр и быть больше 0 date: type: string description: Дата составления документа format: date example: 2023-12-31 amount: minimum: 0 exclusiveMinimum: true type: number description: Сумма платежа example: 1.01 payerAccount: pattern: "^\\d{20}$" type: string description: Счет плательщика example: "40702810102300000001" payeeName: maxLength: 160 minLength: 1 type: string description: Полное наименование получателя платежа example: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН получателя платежа example: "7723870785" payeeKpp: pattern: "^(([0]{1})|(\\d{4}[A-Z0-9]{2}\\d{3}))$" type: string description: КПП получателя платежа example: "553453453" payeeAccount: pattern: "^\\d{20}$" type: string description: Счёт получателя платежа example: "40702810564564564531" payeeBankBic: pattern: "^\\d{9}$" type: string description: БИК банка получателя платежа example: "040173745" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата заказа №1. НДС не облагается description: Данные рублёвого платёжного поручения example: date: 2023-12-31T00:00:00.000+00:00 amount: 1.01 purpose: Оплата заказа №1. НДС не облагается payerAccount: "40702810102300000001" number: "1" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeBankBic: "040173745" payeeInn: "7723870785" id: U031308240002351 payeeKpp: "553453453" payeeAccount: "40702810564564564531" status: DRAFT info: Сумма платежа должна состоять из цифр и быть больше 0 RegistrySignRequest: required: - digestSignatures type: object properties: digestSignatures: type: array items: $ref: '#/components/schemas/Signature_1' example: digestSignatures: - signatureType: RSA base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 - signatureType: RSA base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 Signature_1: required: - base64Encoded - signatureType type: object properties: base64Encoded: minLength: 1 type: string description: "Значение электронной подписи, закодированное в Base64" example: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: minLength: 1 type: string description: "Идентификатор сертификата, использованного при создании ЭП" example: 61000366d11e143acbc03a56d70001000366d1 signatureType: type: string description: | Тип электронной подписи. Возможные значения: * `QES` - квалифицированная электронная подпись (КЭП); * `RSA` - подписание с помощью RSA-сертификата example: RSA enum: - QES - RSA description: Электронные подписи по дайджесту документа example: signatureType: RSA base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 RegistrySignResponse: required: - signatureId type: object properties: signatureId: type: string description: Идентификатор запроса на подписание example: 0937b8b1-b226-45f3-b93e-7ba9008db79a example: signatureId: 0937b8b1-b226-45f3-b93e-7ba9008db79a GetRegistrySignResponse: required: - status type: object properties: status: type: string description: | Статус реестра платежей. Принимает возможные значения: * `ACCEPTED` - Запрос принят и поставлен в очередь на обработку; * `IN_PROGRESS` - Запрос находится в обработке; * `PARTIALLY_SIGNED` - Часть подписей успешно наложена, либо переданной(-ых) подписи(-ей) недостаточно; * `SIGNED` - Реестр платежей успешно подписан; * `ERROR` - Произошла ошибка при обработке запроса example: PARTIALLY_SIGNED enum: - ACCEPTED - IN_PROGRESS - PARTIALLY_SIGNED - SIGNED - ERROR error: $ref: '#/components/schemas/UnrelatedError' digestSignatures: type: array items: $ref: '#/components/schemas/SignatureResponse' example: digestSignatures: - signatureType: RSA errorMessage: errorMessage errorCode: errorCode certificateUuid: 61000366d11e143acbc03a56d70001000366d1 status: SIGNED - signatureType: RSA errorMessage: errorMessage errorCode: errorCode certificateUuid: 61000366d11e143acbc03a56d70001000366d1 status: SIGNED error: code: code message: message status: PARTIALLY_SIGNED UnrelatedError: type: object properties: code: type: string description: Код ошибки message: type: string description: Сообщение об ошибке example: code: code message: message SignatureResponse: required: - signatureType - status type: object properties: certificateUuid: type: string description: "Идентификатор сертификата, использованного при создании ЭП" example: 61000366d11e143acbc03a56d70001000366d1 signatureType: type: string description: | Тип электронной подписи. Принимает возможные значения: * `QES` - квалифицированная электронная подпись (КЭП); * `RSA` - подписание с помощью RSA-сертификата example: RSA enum: - QES - RSA status: type: string description: | Статус подписания. Принимает возможные значения: * `SIGNED` - подпись успешно наложена; * `FAILED` - попытка наложения подписи завершилась с ошибкой enum: - SIGNED - FAILED errorCode: type: string description: Код ошибки при подписании errorMessage: type: string description: Сообщение об ошибке при подписании description: Электронные подписи по дайджесту документа example: signatureType: RSA errorMessage: errorMessage errorCode: errorCode certificateUuid: 61000366d11e143acbc03a56d70001000366d1 status: SIGNED EscrowBuildProject: type: object properties: buildingPermitNumber: type: string description: Номер РНС (разрешение на строительство) example: 61-310-998601-2022 regionCode: type: string description: Код региона example: "054" projectNumber: type: string description: Номер проекта строительства example: "162" settlement: type: string description: Наименование населенного пункта example: Новосибирск commercialName: type: string description: Коммерческое обозначение объекта example: ЖК ЗАПАДНЫЕ АЛЛЕИ city: type: string description: Город example: Новосибирск area: type: string description: Наименование района example: ОКТЯБРЬСКИЙ country: type: string description: Код страны example: RU buildingPermitDate: type: string description: Дата РНС format: date example: 2021-10-01 phases: type: array description: Этапы строительства items: $ref: '#/components/schemas/EscrowBuildProjectPhase' example: area: ОКТЯБРЬСКИЙ country: RU regionCode: "054" buildingPermitDate: 2021-10-01T00:00:00.000+00:00 city: Новосибирск projectNumber: "162" buildingPermitNumber: 61-310-998601-2022 phases: - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" settlement: Новосибирск commercialName: ЖК ЗАПАДНЫЕ АЛЛЕИ EscrowBuildProjectPhase: type: object properties: index: type: integer description: Порядковый номер этапа строительства в пределах проекта example: 1 name: type: string description: Краткое имя этапа строительства example: поз. 4.1 - 9-этажный 4-х секц дом street: type: string description: Улица объекта недвижимости example: 11-4 на земельном участке с к.н. 61:44:0073012:390 house: type: string description: Номер дома объекта недвижимости example: "4.1" building: type: string description: Номер строения\корпуса example: "2" termEscrowOrder: type: string description: Срок учета и блокирования депонированной суммы на счете эскроу по ДДУ format: date example: 2022-03-22 example: street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" FilterStatusesV0: type: string description: | Статусы заявок: * `VERIFICATION` - Пользователь внес все данные по заявке и нажал "Отправить заявку" * `CLIENT_CANCELLED` - Депонент изменил решение по открытию счета эскроу * `VERIFICATION_ERROR` - Депонент не прошел проверку (Отклонена банком) * `SIGNING` - Все проверки пройдены, эскроу-счет зарезервирован. Ожидается подписание заявления депонента в офисе Банка * `WAITING_DDU` - Депонент подписал заявление в офисе Банка, счет эскроу переведен в бух. режим, ожидается регистрация ДДУ застройщиком * `EXECUTED` - Заявление депонента подписано, получена отметка от застройщика о факте регистрации ДДУ enum: - VERIFICATION - CLIENT_CANCELLED - VERIFICATION_ERROR - SIGNING - WAITING_DDU - EXECUTED GetEscrowOrdersV0Response: type: object properties: pagination: $ref: '#/components/schemas/GetEscrowOrdersPagination' items: type: array items: $ref: '#/components/schemas/GetEscrowOrdersV0Items' description: Ответ на запрос получения списка заявок застройщика example: pagination: offset: 0 limit: 10 totalCount: 25 items: - escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-10T00:00:00.000+00:00 referenceID: EA10509220000013 status: null - escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-10T00:00:00.000+00:00 referenceID: EA10509220000013 status: null GetEscrowOrdersPagination: type: object properties: limit: type: integer description: Количество объектов на одной странице example: 10 offset: type: integer description: "Количество объектов в списке, которые необходимо пропустит\ ь" example: 0 totalCount: type: integer description: Общее количество записей example: 25 description: Информация о пагинации example: offset: 0 limit: 10 totalCount: 25 GetEscrowOrdersV0Items: type: object properties: referenceID: type: string description: Номер заявки на резервирование счета эскроу example: EA10509220000013 creationDate: type: string description: Дата создания заявки format: date example: 2021-12-10 status: $ref: '#/components/schemas/FilterStatusesV0' fullNameDepositor: type: string description: ФИО депонента example: Королёв Митрофан Гертрудович buildingPermitNumber: type: string description: Номер РНС example: 61-310-998601-2022 escrowAccount: $ref: '#/components/schemas/GetEscrowOrdersEscrowAccount' description: Заявка застройщика example: escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-10T00:00:00.000+00:00 referenceID: EA10509220000013 status: null GetEscrowOrdersEscrowAccount: type: object properties: amount: type: number description: Депонируемая сумма format: bigDecimal example: 6000000.12 currency: type: string description: Валюта example: RUR accountNumber: type: string description: Номер счета эскроу example: "40702810701300000761" description: Счет эскроу example: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" CreateEscrowOrderRequest: required: - depositor - equalityAgreement - escrowAccount - estateObject type: object properties: depositor: $ref: '#/components/schemas/CreateEscrowOrderDepositor' escrowAccount: $ref: '#/components/schemas/CreateEscrowOrderEscrowAccount' estateObject: $ref: '#/components/schemas/CreateEscrowOrderEstateObject' equalityAgreement: $ref: '#/components/schemas/CreateEscrowOrderEqualityAgreement' example: escrowAccount: amount: 112500.0 currency: RUR estateObject: flat: "1" buildProject: buildingPermitNumber: 61-310-998601-2022 phases: index: 1 type: APARTMENTS depositor: lastName: Федькин firstName: Ратибор birthdate: 1990-08-30T00:00:00.000+00:00 phoneNumber: "75453333435" identityDocumentNumber: "197343" dateIssuedId: 2020-01-01T00:00:00.000+00:00 identityDocumentType: "001" middleName: Васильевич identityDocumentSeries: "5516" equalityAgreement: date: 2020-01-01T00:00:00.000+00:00 number: "5555" CreateEscrowOrderDepositor: required: - birthdate - dateIssuedId - firstName - identityDocumentNumber - identityDocumentSeries - identityDocumentType - lastName - phoneNumber type: object properties: lastName: maxLength: 35 type: string description: Фамилия депонента example: Федькин firstName: maxLength: 35 type: string description: Имя депонента example: Ратибор middleName: maxLength: 35 type: string description: Отчество депонента example: Васильевич birthdate: type: string description: Дата рождения депонента format: date example: 1990-08-30 identityDocumentType: type: string description: | Тип ДУЛа: * `001` - Паспорт гражданина РФ * `002` - Загранпаспорт гражданина РФ enum: - "001" - "002" identityDocumentSeries: type: string description: Серия ДУЛ депонента example: "5516" identityDocumentNumber: type: string description: Номер ДУЛ депонента example: "197343" dateIssuedId: type: string description: Дата выдачи ДУЛ депонента format: date example: 2020-01-01 phoneNumber: pattern: "^(7\\d{10})$" type: string description: Мобильный телефон депонента example: "75453333435" description: Депонент example: lastName: Федькин firstName: Ратибор birthdate: 1990-08-30T00:00:00.000+00:00 phoneNumber: "75453333435" identityDocumentNumber: "197343" dateIssuedId: 2020-01-01T00:00:00.000+00:00 identityDocumentType: "001" middleName: Васильевич identityDocumentSeries: "5516" CreateEscrowOrderEscrowAccount: required: - amount - currency type: object properties: amount: maximum: 9999999999999.99 minimum: 1.0 type: number description: Депонируемая сумма format: bigDecimal example: 112500.0 currency: type: string description: | Валюта: * `RUR` - Рублевая валюта enum: - RUR description: Счет эскроу example: amount: 112500.0 currency: RUR CreateEscrowOrderEstateObject: required: - buildProject - flat - type type: object properties: type: type: string description: | Типы объектов недвижимости: * `APARTMENTS` - Апартаменты * `COMMERCIAL_PREMISES` - Коммерческое помещение * `FLAT` - Квартира * `GARAGE` - Гараж * `NON_RESIDENTIAL_PREMISES` - Нежилое помещение * `PANTRY` - Кладовая * `PARKING` - Машиноместо * `ROOM` - Комната * `RESIDENTIAL_PREMISES` - Жилой дом enum: - APARTMENTS - COMMERCIAL_PREMISES - FLAT - GARAGE - NON_RESIDENTIAL_PREMISES - PANTRY - PARKING - ROOM - RESIDENTIAL_PREMISES flat: maxLength: 35 type: string description: Номер квартиры объекта недвижимости example: "1" buildProject: $ref: '#/components/schemas/CreateEscrowOrderBuildProject' description: Объект строительства example: flat: "1" buildProject: buildingPermitNumber: 61-310-998601-2022 phases: index: 1 type: APARTMENTS CreateEscrowOrderBuildProject: required: - buildingPermitNumber - phases type: object properties: buildingPermitNumber: maxLength: 70 type: string description: Номер РНС (разрешение на строительство) example: 61-310-998601-2022 phases: $ref: '#/components/schemas/CreateEscrowOrderBuildProjectPhase' description: Информация об объекте строительства example: buildingPermitNumber: 61-310-998601-2022 phases: index: 1 CreateEscrowOrderBuildProjectPhase: required: - index type: object properties: index: type: integer description: Порядковый номер этапа строительства в пределах проекта example: 1 description: Этап строительства example: index: 1 CreateEscrowOrderEqualityAgreement: required: - date - number type: object properties: number: maxLength: 50 type: string description: Номер ДДУ example: "5555" date: type: string description: Дата подписания ДДУ format: date example: 2020-01-01 description: Договор Долевого Участия (ДДУ) example: date: 2020-01-01T00:00:00.000+00:00 number: "5555" CreateEscrowOrderResponse: required: - referenceID type: object properties: referenceID: type: string description: Номер заявки на резервирование счета эскроу example: EA10509220000013 example: referenceID: EA10509220000013 CreateEscrowOrderErrorConflict: required: - error type: object properties: error: type: string description: Код ошибки example: conflict error_description: type: string description: Сообщение об ошибке example: The data of the depositor is not uniquely defined FilterStatusesV1: type: string description: | Статусы заявок: * `VERIFICATION` - Пользователь внес все данные по заявке и нажал "Отправить заявку" * `CLIENT_CANCELLED` - Депонент изменил решение по открытию счета эскроу * `VERIFICATION_ERROR` - Депонент не прошел проверку (Отклонена банком) * `SIGNING` - Все проверки пройдены, эскроу-счет зарезервирован. Ожидается подписание заявления депонента в офисе Банка * `WAITING_DDU` - Депонент подписал заявление в офисе Банка, счет эскроу переведен в бух. режим, ожидается регистрация ДДУ застройщиком * `EXECUTED` - Заявление депонента подписано, получена отметка от застройщика о факте регистрации ДДУ * `DRAFT` - Пользователь сохранил черновик заявки enum: - VERIFICATION - CLIENT_CANCELLED - VERIFICATION_ERROR - SIGNING - WAITING_DDU - EXECUTED - DRAFT GetEscrowOrdersV1Response: type: object properties: pagination: $ref: '#/components/schemas/GetEscrowOrdersPagination' items: type: array items: $ref: '#/components/schemas/GetEscrowOrdersV1Items' description: Ответ на запрос получения списка заявок застройщика example: pagination: offset: 0 limit: 10 totalCount: 25 items: - escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-10T00:00:00.000+00:00 referenceID: EA10509220000013 status: null - escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-10T00:00:00.000+00:00 referenceID: EA10509220000013 status: null GetEscrowOrdersV1Items: type: object properties: referenceID: type: string description: Номер заявки на резервирование счета эскроу example: EA10509220000013 creationDate: type: string description: Дата создания заявки format: date example: 2021-12-10 status: $ref: '#/components/schemas/FilterStatusesV1' fullNameDepositor: type: string description: ФИО депонента example: Королёв Митрофан Гертрудович buildingPermitNumber: type: string description: Номер РНС example: 61-310-998601-2022 escrowAccount: $ref: '#/components/schemas/GetEscrowOrdersEscrowAccount' description: Заявка застройщика example: escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-10T00:00:00.000+00:00 referenceID: EA10509220000013 status: null GetEscrowOrderV0Response: type: object properties: referenceID: type: string description: Номер заявки на резервирование счета эскроу example: EA10808220000061 rejectReason: type: string description: Причина отказа банка example: "К сожалению, во время обработки произошла тех. ошибка." creationDate: type: string description: Дата создания заявки format: date example: 2021-12-31 status: $ref: '#/components/schemas/FilterStatusesV0' escrowAccount: $ref: '#/components/schemas/GetEscrowOrderEscrowAccount' depositor: $ref: '#/components/schemas/GetEscrowOrderDepositor' equalityAgreement: $ref: '#/components/schemas/GetEscrowOrderEqualityAgreement' estateObject: $ref: '#/components/schemas/GetEscrowOrderEstateObject' example: escrowAccount: amount: 8.008281904619307E11 currency: RUR accountNumber: "40824810906580000000" estateObject: flat: "234" buildProject: area: ОКТЯБРЬСКИЙ country: RU regionCode: "054" buildingPermitDate: 2021-10-01T00:00:00.000+00:00 city: Новосибирск projectNumber: "162" buildingPermitNumber: 61-310-998601-2022 phases: - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" settlement: Новосибирск commercialName: ЖК ЗАПАДНЫЕ АЛЛЕИ type: APARTMENTS rejectReason: "К сожалению, во время обработки произошла тех. ошибка." depositor: birthdate: 1998-11-03T00:00:00.000+00:00 phoneNumber: "79055485717" identityDocumentNumber: "615760" dateIssuedId: 2022-04-25T00:00:00.000+00:00 identityDocumentType: "001" fullName: Королёв Митрофан Гертрудович identityDocumentSeries: "8039" creationDate: 2021-12-31T00:00:00.000+00:00 referenceID: EA10808220000061 equalityAgreement: date: 2022-07-14T00:00:00.000+00:00 number: "234" isRegistered: false status: null GetEscrowOrderEscrowAccount: type: object properties: accountNumber: type: string description: Номер счета эскроу example: "40824810906580000000" amount: maximum: 9999999999999.99 minimum: 1.0 type: number description: Депонируемая сумма format: bigDecimal currency: type: string description: | Валюта: * `RUR` - Рублевая валюта enum: - RUR description: Счет эскроу example: amount: 8.008281904619307E11 currency: RUR accountNumber: "40824810906580000000" GetEscrowOrderDepositor: type: object properties: fullName: type: string description: ФИО Депонента example: Королёв Митрофан Гертрудович birthdate: type: string description: День рождения депонента format: date example: 1998-11-03 identityDocumentSeries: pattern: "^(\\d{2}|\\d{4})$" type: string description: Серия ДУЛ депонента example: "8039" identityDocumentNumber: pattern: "^(\\d{6}|\\d{7})$" type: string description: Номер ДУЛ депонента example: "615760" identityDocumentType: type: string description: | Тип ДУЛа: * `001` - Паспорт гражданина РФ * `002` - Загранпаспорт гражданина РФ enum: - "001" - "002" phoneNumber: type: string description: Номер телефона депонента example: "79055485717" dateIssuedId: type: string description: Дата выдачи ДУЛ депонента format: date example: 2022-04-25 description: Депонент example: birthdate: 1998-11-03T00:00:00.000+00:00 phoneNumber: "79055485717" identityDocumentNumber: "615760" dateIssuedId: 2022-04-25T00:00:00.000+00:00 identityDocumentType: "001" fullName: Королёв Митрофан Гертрудович identityDocumentSeries: "8039" GetEscrowOrderEqualityAgreement: type: object properties: number: type: string description: Номер ДДУ example: "234" date: type: string description: Дата ДДУ format: date example: 2022-07-14 isRegistered: type: boolean description: Регистрация ДДУ в Росреестре example: false description: Договор Долевого Участия (ДДУ) example: date: 2022-07-14T00:00:00.000+00:00 number: "234" isRegistered: false GetEscrowOrderEstateObject: type: object properties: type: type: string description: | Типы объектов недвижимости: * `APARTMENTS` - Апартаменты * `COMMERCIAL_PREMISES` - Коммерческое помещение * `FLAT` - Квартира * `GARAGE` - Гараж * `NON_RESIDENTIAL_PREMISES` - Нежилое помещение * `PANTRY` - Кладовая * `PARKING` - Машиноместо * `ROOM` - Комната * `RESIDENTIAL_PREMISES` - Жилой дом enum: - APARTMENTS - COMMERCIAL_PREMISES - FLAT - GARAGE - NON_RESIDENTIAL_PREMISES - PANTRY - PARKING - ROOM - RESIDENTIAL_PREMISES flat: type: string description: Номер квартиры объекта недвижимости (квартиры/комнаты/гаража) example: "234" buildProject: $ref: '#/components/schemas/EscrowBuildProject' description: Объект строительства example: flat: "234" buildProject: area: ОКТЯБРЬСКИЙ country: RU regionCode: "054" buildingPermitDate: 2021-10-01T00:00:00.000+00:00 city: Новосибирск projectNumber: "162" buildingPermitNumber: 61-310-998601-2022 phases: - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" settlement: Новосибирск commercialName: ЖК ЗАПАДНЫЕ АЛЛЕИ type: APARTMENTS GetEscrowOrderV1Response: type: object properties: referenceID: type: string description: Номер заявки на резервирование счета эскроу example: EA10808220000061 rejectReason: type: string description: Причина отказа банка example: "К сожалению, во время обработки произошла тех. ошибка." creationDate: type: string description: Дата создания заявки format: date example: 2021-12-31 status: $ref: '#/components/schemas/FilterStatusesV1' escrowAccount: $ref: '#/components/schemas/GetEscrowOrderEscrowAccount' depositor: $ref: '#/components/schemas/GetEscrowOrderDepositor' equalityAgreement: $ref: '#/components/schemas/GetEscrowOrderEqualityAgreement' estateObject: $ref: '#/components/schemas/GetEscrowOrderEstateObject' example: escrowAccount: amount: 8.008281904619307E11 currency: RUR accountNumber: "40824810906580000000" estateObject: flat: "234" buildProject: area: ОКТЯБРЬСКИЙ country: RU regionCode: "054" buildingPermitDate: 2021-10-01T00:00:00.000+00:00 city: Новосибирск projectNumber: "162" buildingPermitNumber: 61-310-998601-2022 phases: - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22T00:00:00.000+00:00 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" settlement: Новосибирск commercialName: ЖК ЗАПАДНЫЕ АЛЛЕИ type: APARTMENTS rejectReason: "К сожалению, во время обработки произошла тех. ошибка." depositor: birthdate: 1998-11-03T00:00:00.000+00:00 phoneNumber: "79055485717" identityDocumentNumber: "615760" dateIssuedId: 2022-04-25T00:00:00.000+00:00 identityDocumentType: "001" fullName: Королёв Митрофан Гертрудович identityDocumentSeries: "8039" creationDate: 2021-12-31T00:00:00.000+00:00 referenceID: EA10808220000061 equalityAgreement: date: 2022-07-14T00:00:00.000+00:00 number: "234" isRegistered: false status: null CancelOrderV1Response: required: - referenceID - status type: object properties: referenceID: type: string description: Номер заявки на резервирование счета эскроу status: type: string description: Статус заявки enum: - CLIENT_CANCELLED description: Ответ на запрос отмены заявки на резервирование счета эскроу example: referenceID: referenceID status: CLIENT_CANCELLED ExecuteEscrowOrderRequest: required: - equalityAgreement type: object properties: equalityAgreement: $ref: '#/components/schemas/ExecuteEscrowOrderEqualityAgreement' example: equalityAgreement: isRegistered: true ExecuteEscrowOrderEqualityAgreement: required: - isRegistered type: object properties: isRegistered: type: boolean description: Регистрация ДДУ в Росреестре example: true description: Договор Долевого Участия (ДДУ) example: isRegistered: true CreateFullOrderV1Request: title: CreateFullOrderRequest required: - depositor - equalityAgreement - escrowAccount - estateObject type: object properties: depositor: $ref: '#/components/schemas/CreateFullOrderV1Depositor' escrowAccount: $ref: '#/components/schemas/CreateEscrowOrderEscrowAccount' estateObject: $ref: '#/components/schemas/CreateEscrowOrderEstateObject' equalityAgreement: $ref: '#/components/schemas/CreateEscrowOrderEqualityAgreement' description: Запрос для создания заявки с расширенными параметрами example: escrowAccount: amount: 112500.0 currency: RUR estateObject: flat: "1" buildProject: buildingPermitNumber: 61-310-998601-2022 phases: index: 1 type: APARTMENTS depositor: lastName: Федькин birthdate: 1990-08-30T00:00:00.000+00:00 identityDocumentNumber: "615760" dateIssuedId: 1995-08-30T00:00:00.000+00:00 identityDocumentType: "001" firstName: Ратибор birthPlace: г. Москва managerContactEmail: manager@gmail.com phoneNumber: "79055485717" middleName: Васильевич managerContactPhoneNumber: "79055485717" regAddress: ул. Центральная identityDocumentSeries: "5516" equalityAgreement: date: 2020-01-01T00:00:00.000+00:00 number: "5555" CreateFullOrderV1Depositor: title: CreateEscrowOrderDepositor required: - birthPlace - birthdate - dateIssuedId - firstName - identityDocumentNumber - identityDocumentSeries - identityDocumentType - lastName - phoneNumber - regAddress type: object properties: lastName: maxLength: 35 type: string description: Фамилия депонента example: Федькин firstName: maxLength: 35 type: string description: Имя депонента example: Ратибор middleName: maxLength: 35 type: string description: Отчество депонента example: Васильевич birthdate: type: string description: День рождения депонента format: date example: 1990-08-30 identityDocumentType: type: string description: | Тип ДУЛа: * `001` - Паспорт гражданина РФ * `002` - Загранпаспорт гражданина РФ enum: - "001" - "002" identityDocumentSeries: pattern: "^(\\d{2}|\\d{4})$" type: string description: Серия ДУЛ депонента example: "5516" identityDocumentNumber: pattern: "^(\\d{6}|\\d{7})$" type: string description: Номер ДУЛ депонента example: "615760" dateIssuedId: type: string description: Дата выдачи ДУЛ депонента format: date example: 1995-08-30 birthPlace: type: string description: Место рождения example: г. Москва regAddress: type: string description: Адрес регистрации example: ул. Центральная managerContactPhoneNumber: type: string description: Контактный номер телефона менеджера клиента для уточнения данных о депоненте example: "79055485717" managerContactEmail: type: string description: Контактная адрес электронной почты менеджера клиента для уточнения данных о депоненте example: manager@gmail.com phoneNumber: type: string description: Мобильный телефон депонента example: "79055485717" description: Депонент example: lastName: Федькин birthdate: 1990-08-30T00:00:00.000+00:00 identityDocumentNumber: "615760" dateIssuedId: 1995-08-30T00:00:00.000+00:00 identityDocumentType: "001" firstName: Ратибор birthPlace: г. Москва managerContactEmail: manager@gmail.com phoneNumber: "79055485717" middleName: Васильевич managerContactPhoneNumber: "79055485717" regAddress: ул. Центральная identityDocumentSeries: "5516" CreateFullOrderV1Response: title: CreateFullOrderResponse required: - referenceID - status type: object properties: referenceID: type: string description: Номер заявки на резервирование счета эскроу status: $ref: '#/components/schemas/FilterStatusesV1' example: referenceID: referenceID status: null EscrowReportsBuildProjectsV1Response: title: EscrowReportsBuildProjectsV1Response type: object properties: organizationName: type: string description: Наименование застройщика example: Тестовый пользователь organizationFullName: type: string description: Полное наименование застройщика example: Тестовый пользователь Номер один buildProjects: type: array description: Информация об объектах строительства items: $ref: '#/components/schemas/EscrowReportsBuildProjectsV1ResponseBuildProject' example: organizationName: Тестовый пользователь buildProjects: - buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 commercialName: Тестовый жилой комплекс - buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 commercialName: Тестовый жилой комплекс organizationFullName: Тестовый пользователь Номер один EscrowReportsBuildProjectsV1ResponseBuildProject: title: EscrowReportsBuildProjectsV1ResponseBuildProject type: object properties: buildPermitNumber: type: string description: Номер РНС (разрешение на строительство) example: №599-35-92-2024 projectNumber: type: string description: Номер проекта строительства example: 503-302 commercialName: type: string description: Коммерческое обозначение объекта example: Тестовый жилой комплекс actualProjectCompletionDate: type: string description: Дата РНС example: 2024-02-10T00:00:00.000Z phases: type: array description: Этапы строительства items: $ref: '#/components/schemas/EscrowReportsBuildProjectsV1ResponseBuildProjectPhase' example: buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 commercialName: Тестовый жилой комплекс EscrowReportsBuildProjectsV1ResponseBuildProjectPhase: title: EscrowReportsBuildProjectsV1ResponseBuildProjectPhase type: object properties: index: type: integer description: Порядковый номер этапа строительства в пределах проекта example: 1 name: type: string description: Краткое имя этапа строительства example: Дом termEscrowOrder: type: string description: Срок учета и блокирования депонированной суммы на счете эскроу по ДДУ example: 2024-02-10T00:00:00.000Z example: termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 EscrowReportsGenerateReportV1Request: title: EscrowReportsGenerateReportV1Request required: - buildProjects - showAccountTransactions type: object properties: buildProjects: type: array description: Список объектов строительства застройщика items: $ref: '#/components/schemas/EscrowReportsGenerateReportV1RequestBuildProject' showAccountTransactions: type: boolean description: Признак отображения транзакций example: true example: buildProjects: - buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 commercialName: Тестовый жилой комплекс - buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 commercialName: Тестовый жилой комплекс showAccountTransactions: true EscrowReportsGenerateReportV1RequestBuildProject: title: EscrowReportsGenerateReportV1RequestBuildProject required: - buildPermitNumber - phases - projectNumber type: object properties: buildPermitNumber: type: string description: Номер РНС (разрешение на строительство) example: №599-35-92-2024 projectNumber: type: string description: Номер проекта строительства example: 503-302 commercialName: type: string description: Коммерческое обозначение объекта example: Тестовый жилой комплекс actualProjectCompletionDate: type: string description: Дата РНС example: 2024-02-10T00:00:00.000Z phases: type: array description: Этапы строительства items: $ref: '#/components/schemas/EscrowReportsGenerateReportV1RequestBuildProjectPhase' example: buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 - termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 commercialName: Тестовый жилой комплекс EscrowReportsGenerateReportV1RequestBuildProjectPhase: title: EscrowReportsGenerateReportV1RequestBuildProjectPhase required: - index type: object properties: index: type: integer description: Порядковый номер этапа строительства в пределах проекта example: 1 name: type: string description: Краткое имя этапа строительства example: Дом termEscrowOrder: type: string description: Срок учета и блокирования депонированной суммы на счете эскроу по ДДУ example: 2024-02-10T00:00:00.000Z example: termEscrowOrder: 2024-02-10T00:00:00.000Z name: Дом index: 1 EscrowReportsGenerateReportV1Response: title: EscrowReportsGenerateReportV1Response type: object properties: report: type: array description: Данные отчета items: $ref: '#/components/schemas/EscrowReportsGenerateReportV1ResponseReport' example: report: - pagination: - offset: 2 limit: 10 totalCount: 90 - offset: 2 limit: 10 totalCount: 90 escrowAccountInfo: - escrowAccountCurrentStatus: Пополнен deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 phaseDescription: Паркинг objectType: Комната buildProjectPhase: 2 assignmentAgreementDate: 2024-02-10T00:00:00.000Z commercialName: Тестовый жилой комплекс escrowAccountReservePlace: Онлайн buildPermitNumber: №599-35-92-2024 depositCompletionDate: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" developerManger: Иванов Иван Иванович incomingBalance: "0.00" deponentName: Сергеев Сергей Сергеевич transactions: - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" escrowAccountNumber: "40824810906580012508" outcomingBalance: "12600000.55" escrowAccountOpenPlace: Онлайн apartmentCost: "12600000.55" balanceChange: "12600000.55" shareAgreementDate: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: 2024-02-10T00:00:00.000Z escrowAccountOpenDate: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 - escrowAccountCurrentStatus: Пополнен deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 phaseDescription: Паркинг objectType: Комната buildProjectPhase: 2 assignmentAgreementDate: 2024-02-10T00:00:00.000Z commercialName: Тестовый жилой комплекс escrowAccountReservePlace: Онлайн buildPermitNumber: №599-35-92-2024 depositCompletionDate: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" developerManger: Иванов Иван Иванович incomingBalance: "0.00" deponentName: Сергеев Сергей Сергеевич transactions: - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" escrowAccountNumber: "40824810906580012508" outcomingBalance: "12600000.55" escrowAccountOpenPlace: Онлайн apartmentCost: "12600000.55" balanceChange: "12600000.55" shareAgreementDate: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: 2024-02-10T00:00:00.000Z escrowAccountOpenDate: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 commonInfo: - reportGenerationDate: 2024-02-10T00:00:00.000Z periodTo: 2024-02-10T00:00:00.000Z customerNameTo: Тестовая организация ИНН 0000000 periodFrom: 2022-02-10T00:00:00.000Z - reportGenerationDate: 2024-02-10T00:00:00.000Z periodTo: 2024-02-10T00:00:00.000Z customerNameTo: Тестовая организация ИНН 0000000 periodFrom: 2022-02-10T00:00:00.000Z - pagination: - offset: 2 limit: 10 totalCount: 90 - offset: 2 limit: 10 totalCount: 90 escrowAccountInfo: - escrowAccountCurrentStatus: Пополнен deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 phaseDescription: Паркинг objectType: Комната buildProjectPhase: 2 assignmentAgreementDate: 2024-02-10T00:00:00.000Z commercialName: Тестовый жилой комплекс escrowAccountReservePlace: Онлайн buildPermitNumber: №599-35-92-2024 depositCompletionDate: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" developerManger: Иванов Иван Иванович incomingBalance: "0.00" deponentName: Сергеев Сергей Сергеевич transactions: - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" escrowAccountNumber: "40824810906580012508" outcomingBalance: "12600000.55" escrowAccountOpenPlace: Онлайн apartmentCost: "12600000.55" balanceChange: "12600000.55" shareAgreementDate: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: 2024-02-10T00:00:00.000Z escrowAccountOpenDate: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 - escrowAccountCurrentStatus: Пополнен deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 phaseDescription: Паркинг objectType: Комната buildProjectPhase: 2 assignmentAgreementDate: 2024-02-10T00:00:00.000Z commercialName: Тестовый жилой комплекс escrowAccountReservePlace: Онлайн buildPermitNumber: №599-35-92-2024 depositCompletionDate: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" developerManger: Иванов Иван Иванович incomingBalance: "0.00" deponentName: Сергеев Сергей Сергеевич transactions: - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" escrowAccountNumber: "40824810906580012508" outcomingBalance: "12600000.55" escrowAccountOpenPlace: Онлайн apartmentCost: "12600000.55" balanceChange: "12600000.55" shareAgreementDate: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: 2024-02-10T00:00:00.000Z escrowAccountOpenDate: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 commonInfo: - reportGenerationDate: 2024-02-10T00:00:00.000Z periodTo: 2024-02-10T00:00:00.000Z customerNameTo: Тестовая организация ИНН 0000000 periodFrom: 2022-02-10T00:00:00.000Z - reportGenerationDate: 2024-02-10T00:00:00.000Z periodTo: 2024-02-10T00:00:00.000Z customerNameTo: Тестовая организация ИНН 0000000 periodFrom: 2022-02-10T00:00:00.000Z EscrowReportsGenerateReportV1ResponseReport: title: EscrowReportsGenerateReportV1ResponseReport type: object properties: pagination: type: array description: Пагинация для формирования отчета items: $ref: '#/components/schemas/EscrowReportsGenerateReportV1ResponseReportPagination' commonInfo: type: array description: Базовая информация отчета items: $ref: '#/components/schemas/EscrowReportsGenerateReportV1ResponseReportCommonInfo' escrowAccountInfo: type: array description: Массив данных с информацией о счетах items: $ref: '#/components/schemas/EscrowReportsGenerateReportV1ResponseReportEscrowAccountInfo' example: pagination: - offset: 2 limit: 10 totalCount: 90 - offset: 2 limit: 10 totalCount: 90 escrowAccountInfo: - escrowAccountCurrentStatus: Пополнен deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 phaseDescription: Паркинг objectType: Комната buildProjectPhase: 2 assignmentAgreementDate: 2024-02-10T00:00:00.000Z commercialName: Тестовый жилой комплекс escrowAccountReservePlace: Онлайн buildPermitNumber: №599-35-92-2024 depositCompletionDate: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" developerManger: Иванов Иван Иванович incomingBalance: "0.00" deponentName: Сергеев Сергей Сергеевич transactions: - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" escrowAccountNumber: "40824810906580012508" outcomingBalance: "12600000.55" escrowAccountOpenPlace: Онлайн apartmentCost: "12600000.55" balanceChange: "12600000.55" shareAgreementDate: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: 2024-02-10T00:00:00.000Z escrowAccountOpenDate: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 - escrowAccountCurrentStatus: Пополнен deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 phaseDescription: Паркинг objectType: Комната buildProjectPhase: 2 assignmentAgreementDate: 2024-02-10T00:00:00.000Z commercialName: Тестовый жилой комплекс escrowAccountReservePlace: Онлайн buildPermitNumber: №599-35-92-2024 depositCompletionDate: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" developerManger: Иванов Иван Иванович incomingBalance: "0.00" deponentName: Сергеев Сергей Сергеевич transactions: - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" escrowAccountNumber: "40824810906580012508" outcomingBalance: "12600000.55" escrowAccountOpenPlace: Онлайн apartmentCost: "12600000.55" balanceChange: "12600000.55" shareAgreementDate: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: 2024-02-10T00:00:00.000Z escrowAccountOpenDate: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 commonInfo: - reportGenerationDate: 2024-02-10T00:00:00.000Z periodTo: 2024-02-10T00:00:00.000Z customerNameTo: Тестовая организация ИНН 0000000 periodFrom: 2022-02-10T00:00:00.000Z - reportGenerationDate: 2024-02-10T00:00:00.000Z periodTo: 2024-02-10T00:00:00.000Z customerNameTo: Тестовая организация ИНН 0000000 periodFrom: 2022-02-10T00:00:00.000Z EscrowReportsGenerateReportV1ResponseReportPagination: title: EscrowReportsGenerateReportV1ResponseReportPagination type: object properties: limit: type: integer description: Количество возвращаемых записей example: 10 offset: type: integer description: Количество записей для смещения example: 2 totalCount: type: integer description: Общее количество записей example: 90 example: offset: 2 limit: 10 totalCount: 90 EscrowReportsGenerateReportV1ResponseReportCommonInfo: title: EscrowReportsGenerateReportV1ResponseReportCommonInfo type: object properties: customerNameTo: type: string description: Наименование организации застройщика example: Тестовая организация ИНН 0000000 periodTo: type: string description: Конечная дата периода для формирования отчета example: 2024-02-10T00:00:00.000Z periodFrom: type: string description: Начальная дата периода для формирования отчета example: 2022-02-10T00:00:00.000Z reportGenerationDate: type: string description: Дата формирования отчета example: 2024-02-10T00:00:00.000Z example: reportGenerationDate: 2024-02-10T00:00:00.000Z periodTo: 2024-02-10T00:00:00.000Z customerNameTo: Тестовая организация ИНН 0000000 periodFrom: 2022-02-10T00:00:00.000Z EscrowReportsGenerateReportV1ResponseReportEscrowAccountInfo: title: EscrowReportsGenerateReportV1ResponseReportEscrowAccountInfo type: object properties: buildPermitNumber: type: string description: Номер РНС example: №599-35-92-2024 commercialName: type: string description: Наименование проекта строительства example: Тестовый жилой комплекс buildProjectPhase: type: integer description: Порядковый номер этапа строительства в пределах проекта example: 2 phaseDescription: type: string description: Наименование этапа строительства example: Паркинг escrowAccountNumber: type: string description: Номер счета example: "40824810906580012508" escrowAccountCurrentStatus: type: string description: Текущий статус example: Пополнен escrowAccountOpenDate: type: string description: Дата открытия счета example: 2024-02-10T00:00:00.000Z apartmentCost: type: string description: Стоимость объекта по ДДУ в рублях example: "12600000.55" incomingBalance: type: string description: "Входящий остаток на начало периода, RUB" example: "0.00" outcomingBalance: type: string description: "Исходящий остаток на конец периода, RUB" example: "12600000.55" balanceChange: type: string description: "Изменение остатка за период отчета, RUB" example: "12600000.55" depositCompletionDate: type: string description: Дата завершения срока условного депонирования example: 2024-02-10T00:00:00.000Z deponentName: type: string description: ФИО депозитора example: Сергеев Сергей Сергеевич deponentINN: type: string description: ИНН депозитора example: "184514811334" shareAgreementNumber: type: string description: Данные договора об участии счета example: 22-444/111П-1234 shareAgreementDate: type: string description: Дата ДДУ example: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: type: string description: Номер договора переуступки example: ДУ 103-4 от 12.02.2023 assignmentAgreementDate: type: string description: Дата договора переуступки example: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: type: string description: Дата закрытия счета example: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: type: string description: Предоставлен зарегистрированный ДДУ example: "Y" escrowAccountReservePlace: type: string description: Место резервирования счёта эскроу example: Онлайн escrowAccountOpenPlace: type: string description: Место открытия счёта эскроу example: Онлайн developerManger: type: string description: "ФИО менеджера застройщика, который завел заявку на резерви\ рование счета" example: Иванов Иван Иванович objectType: type: string description: Вид помещения example: Комната transactions: type: array description: Массив проводок items: $ref: '#/components/schemas/EscrowReportsGenerateReportV1ResponseReportEscrowAccountInfoTransactions' example: escrowAccountCurrentStatus: Пополнен deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 phaseDescription: Паркинг objectType: Комната buildProjectPhase: 2 assignmentAgreementDate: 2024-02-10T00:00:00.000Z commercialName: Тестовый жилой комплекс escrowAccountReservePlace: Онлайн buildPermitNumber: №599-35-92-2024 depositCompletionDate: 2024-02-10T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" developerManger: Иванов Иван Иванович incomingBalance: "0.00" deponentName: Сергеев Сергей Сергеевич transactions: - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" escrowAccountNumber: "40824810906580012508" outcomingBalance: "12600000.55" escrowAccountOpenPlace: Онлайн apartmentCost: "12600000.55" balanceChange: "12600000.55" shareAgreementDate: 2024-02-10T00:00:00.000Z escrowAccountCloseDate: 2024-02-10T00:00:00.000Z escrowAccountOpenDate: 2024-02-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 EscrowReportsGenerateReportV1ResponseReportEscrowAccountInfoTransactions: title: EscrowReportsGenerateReportV1ResponseReportEscrowAccountInfoTransactions type: object properties: operationDate: type: string description: Дата ввода полупроводки example: 2024-02-10T00:00:00.000Z transactionAmount: type: string description: Определяет сумму транзакции со знаком в минимальных единицах валюты счета example: "150000.55" primaryDocumentDate: type: string description: Дата платежного документа по операции example: 2024-02-10T00:00:00.000Z primaryDocumentNumber: type: string description: Номер платежного документа» (первичного документа) по операции example: "350" bicBank: type: string description: БИК банка отправителя по операции example: "044525593" example: operationDate: 2024-02-10T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2024-02-10T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" ScoringAny: required: - borrower - dealId - partner type: object properties: dealId: pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" type: string description: "Идентификатор черновика заявки (UUID, 128-битный)" format: uuid example: c5f72949-0e9a-41bf-a16d-a34b938f41ef borrower: $ref: '#/components/schemas/Borrower' application: $ref: '#/components/schemas/Application' partner: $ref: '#/components/schemas/Partner' example: application: platformId: B2B partner: income: "12000234" startDateOfInteraction: 2022-05-01T00:00:00.000+00:00 twoPersonalIncomeTaxesInfo: retentionSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 paidSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 employeesQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 134 - date: 2022-05-01T00:00:00.000+00:00 quantity: 134 fullCostSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 sellerInventory: inventorySumAndQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 2 sum: 9000.25 - date: 2022-05-01T00:00:00.000+00:00 quantity: 2 sum: 9000.25 vat: counterparts: - date: 2022-05-01T00:00:00.000+00:00 quantity: 346 purchases: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 sales: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 quantity: 346 purchases: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 sales: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 totalTaxBaseList: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 purchaseAndSaleOperations: - date: 2022-05-01T00:00:00.000+00:00 quantity: 554000 - date: 2022-05-01T00:00:00.000+00:00 quantity: 554000 numberOfInteractionDays: 149 transportedGoodsInfo: deliveries: - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза feeList: - date: 2022-05-01T00:00:00.000+00:00 sum: 3000000.76 - date: 2022-05-01T00:00:00.000+00:00 sum: 3000000.76 insurancePremiumsInfo: mandatorySocialInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryMedicalInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryPensionInsuranceSurchargeSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryPensionInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 supplementarySocialSupportSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 procuredGoodsInfo: categories: - Категория 1 - Категория 2 profitTax: incomes: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 costs: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 totalProfits: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 delay: loans: - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 goods: - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 orderInfo: date: 2023-10-25T00:00:00.000+00:00 number: 2023-123-234-3459 ОТ amount: 328400 productCode: Рассрочка для партнёра returnUrl: success: https://partner.example.ru/success failure: https://partner.example.ru/failure sellerQuality: returnedQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 12 - date: 2022-05-01T00:00:00.000+00:00 quantity: 12 goodsConcentrationLevels: - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так sellerRatings: - date: 2022-05-01T00:00:00.000+00:00 rating: 3.98 - date: 2022-05-01T00:00:00.000+00:00 rating: 3.98 reasonForRefundList: - date: 2022-05-01T00:00:00.000+00:00 reason: Какая-то причина возврата или не выполнения заказа - date: 2022-05-01T00:00:00.000+00:00 reason: Какая-то причина возврата или не выполнения заказа calculationsInformation: currentInterestsSum: 110687 currentInterestsAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentFinesAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentTaxesSum: 5016161.68 paymentDetails: bankDetails: recipientAccount: "30101810200000000593" bankBIC: "044525593" bankCorrespondentAccount: "30101810200000000593" recipientName: АКЦИОНЕРНОЕ ОБЩЕСТВО АЛЬФА-БАНК bankName: "АО «Альфа-Банк», г. Москва" recipientINN: "5504036333" recipientKPP: "783801001" vat: true vatAmount: 1.239857567345E10 sixPersonalIncomeTaxesInfo: imposedKBKTaxes: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 retentionPITDateAndSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 paidKBKFines: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 paidKBKTaxes: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 paidKBKInterests: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 factIncomes: - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 imposedInterests: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 imposedFines: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 transactionsInfo: minSumTransactionMSB: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBMaxSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBAvgSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 15 - date: 2022-05-01T00:00:00.000+00:00 quantity: 15 premiumAccount: hasPremiumAccount: true dealId: c5f72949-0e9a-41bf-a16d-a34b938f41ef borrower: individual: legalInfo: ogrn: "305465110922043" inn: "770778659011" kpp: "770201001" contactPhone: +7(495)545-00-10 legal: legalInfo: ogrn: "1027739642281" inn: "7707786590" kpp: "770201001" contactPhone: +7(916)545-00-00 Borrower: type: object properties: individual: $ref: '#/components/schemas/Individual' legal: $ref: '#/components/schemas/Legal' description: Информация о заёмщике example: individual: legalInfo: ogrn: "305465110922043" inn: "770778659011" kpp: "770201001" contactPhone: +7(495)545-00-10 legal: legalInfo: ogrn: "1027739642281" inn: "7707786590" kpp: "770201001" contactPhone: +7(916)545-00-00 Individual: type: object properties: legalInfo: $ref: '#/components/schemas/IndividualInfo' description: Информация о заёмщике-ИП example: legalInfo: ogrn: "305465110922043" inn: "770778659011" kpp: "770201001" contactPhone: +7(495)545-00-10 IndividualInfo: required: - inn type: object properties: inn: pattern: "^\\d{12}$" type: string description: ИНН ИП nullable: false example: "770778659011" kpp: pattern: "^\\d{9}$" type: string description: КПП (код причины постановки на учёт) ИП nullable: false example: "770201001" ogrn: pattern: "^\\d{15}$" type: string description: ОГРН (основной государственный регистрационный номер) ИП nullable: false example: "305465110922043" contactPhone: pattern: "^\\+7\\(\\d{3}\\)\\d{3}-\\d{2}-\\d{2}$|^\\+7\\(\\d{4}\\)\\d{2}-\\\ d{2}-\\d{2}$" type: string description: Контактный номер телефон ИП example: +7(495)545-00-10 description: Информация о заёмщике example: ogrn: "305465110922043" inn: "770778659011" kpp: "770201001" contactPhone: +7(495)545-00-10 Legal: type: object properties: legalInfo: $ref: '#/components/schemas/LegalInfo' description: Информация о заёмщике-юр.лице example: legalInfo: ogrn: "1027739642281" inn: "7707786590" kpp: "770201001" contactPhone: +7(916)545-00-00 LegalInfo: required: - inn type: object properties: inn: pattern: "^\\d{10}$" type: string description: ИНН Юр.лица nullable: false example: "7707786590" kpp: pattern: "^\\d{9}$" type: string description: КПП (код причины постановки на учёт) Юр.лица nullable: false example: "770201001" ogrn: pattern: "^\\d{13}$" type: string description: ОГРН (основной государственный регистрационный номер) Юр.лица nullable: false example: "1027739642281" contactPhone: pattern: "^\\+7\\(\\d{3}\\)\\d{3}-\\d{2}-\\d{2}$|^\\+7\\(\\d{4}\\)\\d{2}-\\\ d{2}-\\d{2}$" type: string description: Контактный номер телефона юр.лица example: +7(916)545-00-00 description: Информация о заёмщике example: ogrn: "1027739642281" inn: "7707786590" kpp: "770201001" contactPhone: +7(916)545-00-00 Application: type: object properties: platformId: type: string description: Тип взаимодействия с партнером example: B2B description: Вспомогательная информация для приложения банка example: platformId: B2B Partner: type: object properties: numberOfInteractionDays: type: number description: Количество дней с даты начала работы с партнёром format: integer example: 149 startDateOfInteraction: type: string description: Дата начала работы с партнёром format: date example: 2022-05-01 orderInfo: $ref: '#/components/schemas/Order' paymentDetails: $ref: '#/components/schemas/Payment_1' income: type: string description: Выручка клиента за последние 12 месяцев в рублях example: "12000234" transactionsInfo: $ref: '#/components/schemas/TransactionsInfo' sellerInventory: $ref: '#/components/schemas/SellerInventory' sellerQuality: $ref: '#/components/schemas/SellerQuality' premiumAccount: $ref: '#/components/schemas/PremiumAccount' delay: $ref: '#/components/schemas/Delay' procuredGoodsInfo: $ref: '#/components/schemas/ProcuredGoodsInfo' feeList: type: array description: Оплата услуг партнёра items: $ref: '#/components/schemas/Fee' transportedGoodsInfo: $ref: '#/components/schemas/TransportedGoodsInfo' vat: $ref: '#/components/schemas/Vat_2' insurancePremiumsInfo: $ref: '#/components/schemas/InsurancePremiumsInfo' profitTax: $ref: '#/components/schemas/ProfitTax' twoPersonalIncomeTaxesInfo: $ref: '#/components/schemas/TwoPersonalIncomeTaxesInfo' sixPersonalIncomeTaxesInfo: $ref: '#/components/schemas/SixPersonalIncomeTaxesInfo' calculationsInformation: $ref: '#/components/schemas/CalculationsInformation' description: Информация о работе заёмщика с партнёром example: income: "12000234" startDateOfInteraction: 2022-05-01T00:00:00.000+00:00 twoPersonalIncomeTaxesInfo: retentionSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 paidSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 employeesQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 134 - date: 2022-05-01T00:00:00.000+00:00 quantity: 134 fullCostSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 sellerInventory: inventorySumAndQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 2 sum: 9000.25 - date: 2022-05-01T00:00:00.000+00:00 quantity: 2 sum: 9000.25 vat: counterparts: - date: 2022-05-01T00:00:00.000+00:00 quantity: 346 purchases: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 sales: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 quantity: 346 purchases: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 sales: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 totalTaxBaseList: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 purchaseAndSaleOperations: - date: 2022-05-01T00:00:00.000+00:00 quantity: 554000 - date: 2022-05-01T00:00:00.000+00:00 quantity: 554000 numberOfInteractionDays: 149 transportedGoodsInfo: deliveries: - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза feeList: - date: 2022-05-01T00:00:00.000+00:00 sum: 3000000.76 - date: 2022-05-01T00:00:00.000+00:00 sum: 3000000.76 insurancePremiumsInfo: mandatorySocialInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryMedicalInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryPensionInsuranceSurchargeSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryPensionInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 supplementarySocialSupportSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 procuredGoodsInfo: categories: - Категория 1 - Категория 2 profitTax: incomes: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 costs: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 totalProfits: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 delay: loans: - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 goods: - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 orderInfo: date: 2023-10-25T00:00:00.000+00:00 number: 2023-123-234-3459 ОТ amount: 328400 productCode: Рассрочка для партнёра returnUrl: success: https://partner.example.ru/success failure: https://partner.example.ru/failure sellerQuality: returnedQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 12 - date: 2022-05-01T00:00:00.000+00:00 quantity: 12 goodsConcentrationLevels: - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так sellerRatings: - date: 2022-05-01T00:00:00.000+00:00 rating: 3.98 - date: 2022-05-01T00:00:00.000+00:00 rating: 3.98 reasonForRefundList: - date: 2022-05-01T00:00:00.000+00:00 reason: Какая-то причина возврата или не выполнения заказа - date: 2022-05-01T00:00:00.000+00:00 reason: Какая-то причина возврата или не выполнения заказа calculationsInformation: currentInterestsSum: 110687 currentInterestsAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentFinesAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentTaxesSum: 5016161.68 paymentDetails: bankDetails: recipientAccount: "30101810200000000593" bankBIC: "044525593" bankCorrespondentAccount: "30101810200000000593" recipientName: АКЦИОНЕРНОЕ ОБЩЕСТВО АЛЬФА-БАНК bankName: "АО «Альфа-Банк», г. Москва" recipientINN: "5504036333" recipientKPP: "783801001" vat: true vatAmount: 1.239857567345E10 sixPersonalIncomeTaxesInfo: imposedKBKTaxes: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 retentionPITDateAndSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 paidKBKFines: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 paidKBKTaxes: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 paidKBKInterests: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 factIncomes: - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 imposedInterests: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 imposedFines: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 transactionsInfo: minSumTransactionMSB: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBMaxSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBAvgSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 15 - date: 2022-05-01T00:00:00.000+00:00 quantity: 15 premiumAccount: hasPremiumAccount: true Order: required: - amount - date - returnUrl type: object properties: productCode: type: string description: "Продукт Банка, который выбрал клиент" example: Рассрочка для партнёра number: type: string description: Номер договора партнёра с клиентом на осуществление заказа example: 2023-123-234-3459 ОТ date: type: string description: Дата заключения договора между клиентом и партнёром на осуществление заказа format: date example: 2023-10-25 amount: minimum: 0 type: number description: Сумма заказа в рублях format: integer example: 328400 returnUrl: $ref: '#/components/schemas/ReturnURL' description: Информация о заказе клиента у партнёра example: date: 2023-10-25T00:00:00.000+00:00 number: 2023-123-234-3459 ОТ amount: 328400 productCode: Рассрочка для партнёра returnUrl: success: https://partner.example.ru/success failure: https://partner.example.ru/failure ReturnURL: required: - failure - success type: object properties: success: type: string description: Ссылка редиректа при успешной операции example: https://partner.example.ru/success failure: type: string description: Ссылка редиректа при неуспешной операции example: https://partner.example.ru/failure description: Информация о ссылках для редиректа пользователя после успешной или неуспешной операции example: success: https://partner.example.ru/success failure: https://partner.example.ru/failure Payment_1: required: - vat type: object properties: vat: type: boolean description: Признак включённого/невключённого НДС example: true vatAmount: minimum: 0 type: number description: "Сумма включённого НДС в рублях. Передаётся, если `vat` рав\ ен `true`" format: float example: 12398575673.45 bankDetails: $ref: '#/components/schemas/Bank_1' description: Информация о реквизитах для проведения платежа партнёру example: bankDetails: recipientAccount: "30101810200000000593" bankBIC: "044525593" bankCorrespondentAccount: "30101810200000000593" recipientName: АКЦИОНЕРНОЕ ОБЩЕСТВО АЛЬФА-БАНК bankName: "АО «Альфа-Банк», г. Москва" recipientINN: "5504036333" recipientKPP: "783801001" vat: true vatAmount: 1.239857567345E10 Bank_1: required: - bankBIC - bankCorrespondentAccount - bankName - recipientAccount - recipientINN - recipientName type: object properties: bankName: type: string description: Название Банка получателя платежа nullable: false example: "АО «Альфа-Банк», г. Москва" bankBIC: type: string description: БИК Банка получателя nullable: false example: "044525593" bankCorrespondentAccount: type: string description: Кор.счёт Банка получателя nullable: false example: "30101810200000000593" recipientINN: pattern: "(^\\d{10}$)|(^\\d{12}$)" type: string description: ИНН получателя nullable: false example: "5504036333" recipientKPP: pattern: "^\\d{9}$" type: string description: КПП получателя nullable: false example: "783801001" recipientAccount: type: string description: Расчётный счёт получателя nullable: false example: "30101810200000000593" recipientName: type: string description: Наименование получателя nullable: false example: АКЦИОНЕРНОЕ ОБЩЕСТВО АЛЬФА-БАНК description: Банковские реквизиты получателя платежа example: recipientAccount: "30101810200000000593" bankBIC: "044525593" bankCorrespondentAccount: "30101810200000000593" recipientName: АКЦИОНЕРНОЕ ОБЩЕСТВО АЛЬФА-БАНК bankName: "АО «Альфа-Банк», г. Москва" recipientINN: "5504036333" recipientKPP: "783801001" TransactionsInfo: type: object properties: transactionsMSBSumList: type: array description: Сумма транзакций МСБ продавца с партнёром помесячно за последние 2-3 года items: $ref: '#/components/schemas/TransactionsAny' transactionsMSBQuantityList: type: array description: Кол-во транзакций МСБ продавца с партнёром помесячно за последние 2-3 года items: $ref: '#/components/schemas/QuantityTransactions' transactionsMSBAvgSumList: type: array description: Средние суммы транзакций МСБ продавца с партнёром помесячно за последние 2-3 года items: $ref: '#/components/schemas/TransactionsAny' minSumTransactionMSB: type: array description: Минимальная сумма одной транзакции МСБ продавца с партнёром помесячно за последние 2-3 года items: $ref: '#/components/schemas/TransactionsAny' transactionsMSBMaxSumList: type: array description: Максимальная сумма одной транзакции МСБ продавца с партнёром помесячно за последние 2-3 года items: $ref: '#/components/schemas/TransactionsAny' description: Транзакции продавца с партнёром example: minSumTransactionMSB: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBMaxSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBAvgSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 - date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 transactionsMSBQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 15 - date: 2022-05-01T00:00:00.000+00:00 quantity: 15 TransactionsAny: type: object properties: sum: type: number description: "Суммы (sum - общая, avgSum - средняя, minSum - минимальная\ , maxSum - максимальная) транзакций МСБ продавца с партнёром за месяц\ \ в рублях" format: float example: 1000.15 date: type: string description: Дата выполнения транзакции format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 1000.15 QuantityTransactions: type: object properties: quantity: type: number description: Кол-во транзакций МСБ продавца с партнёром за месяц format: integer example: 15 date: type: string description: "Дата, соответствующая n кол-ву партнёром" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 quantity: 15 SellerInventory: type: object properties: inventorySumAndQuantityList: type: array description: Объём запасов МСБ продавца на маркетплейсе в руб. помесячно за последние 2-3 года items: $ref: '#/components/schemas/InventorySumAndQuantityList' description: Запасы МСБ продавца example: inventorySumAndQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 2 sum: 9000.25 - date: 2022-05-01T00:00:00.000+00:00 quantity: 2 sum: 9000.25 InventorySumAndQuantityList: type: object properties: sum: type: number description: Объём запасов МСБ продавца на маркетплейсе за месяц в рублях format: float example: 9000.25 quantity: type: number description: Объём запасов МСБ продавца на маркетплейсе в шт. за месяц format: integer example: 2 date: type: string description: "Дата, соответствующая указанному объёму запасов МСБ" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 quantity: 2 sum: 9000.25 SellerQuality: type: object properties: sellerRatings: type: array description: Рейтинг продавца на маркетплейсе помесячно за последние 2-3 года items: $ref: '#/components/schemas/SellerRating' returnedQuantityList: type: array description: "Количество возвратов, не выполненных заказов помесячно за\ \ последние 2-3 года" items: $ref: '#/components/schemas/ReturnQuantity' reasonForRefundList: type: array description: "Причины возвратов, не выполненных заказов помесячно за пос\ ледние 2-3 года" items: $ref: '#/components/schemas/ReturnReasons' goodsConcentrationLevels: type: array description: Уровень концентрации продаваемых товаров – доля каждого товара в общем объёме продаж МСБ продавца (в руб.)/(в ед. товара) items: $ref: '#/components/schemas/ConcentrationLevelGoods' description: Качество торговли МСБ продавца example: returnedQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 12 - date: 2022-05-01T00:00:00.000+00:00 quantity: 12 goodsConcentrationLevels: - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так sellerRatings: - date: 2022-05-01T00:00:00.000+00:00 rating: 3.98 - date: 2022-05-01T00:00:00.000+00:00 rating: 3.98 reasonForRefundList: - date: 2022-05-01T00:00:00.000+00:00 reason: Какая-то причина возврата или не выполнения заказа - date: 2022-05-01T00:00:00.000+00:00 reason: Какая-то причина возврата или не выполнения заказа SellerRating: type: object properties: rating: type: number description: Рейтинг продавца на маркетплейсе за месяц в единицах оценивания format: float example: 3.98 date: type: string description: "Дата, соответствующая указанному рейтингу" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 rating: 3.98 ReturnQuantity: type: object properties: quantity: type: number description: Количество возвратов / не выполненных заказов за месяц format: integer example: 12 date: type: string description: "Дата, соответствующая указанному количеству возвратов / не\ \ выполненных заказов" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 quantity: 12 ReturnReasons: type: object properties: reason: type: string description: Причины возвратов/не выполненных заказов за месяц example: Какая-то причина возврата или не выполнения заказа date: type: string description: "Дата, соответствующая указанным причинам возвратов" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 reason: Какая-то причина возврата или не выполнения заказа ConcentrationLevelGoods: type: object properties: concentrationLevelOfSum: type: number description: Доля товара в общем объеме продаж (в рублях) МСБ продавца на дату запроса в % format: float example: 23.5 concentrationLevelOfQuantity: type: number description: Доля товара в общем объеме продаж (в количестве) МСБ продавца на дату запроса в % format: float example: 53.2 nameOfGood: type: string description: Наименование товара example: Товар называется так example: concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так PremiumAccount: type: object properties: hasPremiumAccount: type: boolean description: Наличие премиального аккаунта МСБ продавца на маркетплейсе на дату запроса example: true description: Информация о премиальном аккаунте example: hasPremiumAccount: true Delay: type: object properties: loans: type: array description: "Рассрочка, кредиты, прочие финансовые продукты" items: $ref: '#/components/schemas/DelayAny' goods: type: array description: "Купленные товары, логистические услуги" items: $ref: '#/components/schemas/DelayAny' description: "Просочка по рассрочке, кредитам, прочим финансовым продуктам М\ СБ с партнёром и/или по оплате за купленные товары, логистические услуги М\ СБ партнёру" example: loans: - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 goods: - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 - duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 DelayAny: type: object properties: overDueDate: type: string description: "Дата выхода в просрочку по рассрочке, кредитам, прочим фин\ ансовым продуктам МСБ с партнёром и/или по оплате за купленные товары\ , логистические услуги МСБ партнёру за месяц за последние 2-3 года" format: date example: 2022-05-01 duration: type: number description: "Кол-во дней просрочки по рассрочке, кредитам, прочим финан\ совым продуктам МСБ с партнёром и/или по оплате за купленные товары, л\ огистические услуги МСБ партнёру за месяц за последние 2-3 года" format: integer example: 12 sum: type: number description: "Сумма просрочки по рассрочке, кредитам, прочим финансовым\ \ продуктам МСБ с партнёром и/или по оплате за купленные товары, логис\ тические услуги МСБ партнёру за месяц за последние 2-3 года" format: float example: 10000 example: duration: 12 overDueDate: 2022-05-01T00:00:00.000+00:00 sum: 10000 ProcuredGoodsInfo: type: object properties: categories: type: array description: "Категории товаров, которые МСБ закупает у партнёра" example: - Категория 1 - Категория 2 items: type: string description: Закупаемые товары example: categories: - Категория 1 - Категория 2 Fee: type: object properties: sum: type: number description: Объёмы оплаты за логистические услуги МСБ через партнёра за месяц за последние 2-3 года в рублях format: float example: 3000000.76 date: type: string description: "Дата, согласно указанному объёму" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 3000000.76 TransportedGoodsInfo: type: object properties: deliveries: type: array items: $ref: '#/components/schemas/Deliveries' description: Информация о перевозимых грузах example: deliveries: - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза Deliveries: type: object properties: date: type: string description: "Дата, согласно указанному объёму перевозимых грузов" format: date transportedGoodsVolumeAndCategoryList: type: array items: $ref: '#/components/schemas/TransportedGoods' description: Информация о перевозимых грузах example: date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза TransportedGoods: type: object properties: volume: type: number description: Объёмы перевозимых грузов через партнёра за месяц в тонно-километрах format: float example: 3456.65 category: type: string description: Наименование категории перевозимых грузов за месяц example: Категория груза description: Информация по объёму и номенклатуре перевозимых грузов example: volume: 3456.65 category: Категория груза Vat_2: type: object properties: totalTaxBaseList: type: array description: Общая налоговая база по НДС поквартально за последние 2-3 года items: $ref: '#/components/schemas/TaxPurchasesSalesAny' counterparts: type: array description: Кол-во контрагентов МСБ клиента поквартально за последние 2-3 года items: $ref: '#/components/schemas/Counterparts' purchaseAndSaleOperations: type: array description: Кол-во операций по книгам покупок и продаж items: $ref: '#/components/schemas/OperationsPurchaseAndSale' description: "Информация о НДС, поквартально" example: counterparts: - date: 2022-05-01T00:00:00.000+00:00 quantity: 346 purchases: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 sales: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 quantity: 346 purchases: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 sales: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 totalTaxBaseList: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 purchaseAndSaleOperations: - date: 2022-05-01T00:00:00.000+00:00 quantity: 554000 - date: 2022-05-01T00:00:00.000+00:00 quantity: 554000 TaxPurchasesSalesAny: type: object properties: sum: type: number description: "Сумма (tax - общей налоговой базы по НДС, purchases - поку\ пок, sales - продаж) за квартал в руб." format: float example: 554000.55 date: type: string description: "Дата, соответствующая указанной сумме" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 Counterparts: type: object properties: quantity: type: number description: Кол-во контрагентов МСБ клиента за квартал format: integer example: 346 date: type: string description: "Дата, соответствующая указанному количеству контрагентов" format: date example: 2022-05-01 purchases: type: array description: Сумма покупок по каждому контрагенту поквартально за последние 2-3 года items: $ref: '#/components/schemas/TaxPurchasesSalesAny' sales: type: array description: Сумма продаж по каждому контрагенту поквартально за последние 2-3 года items: $ref: '#/components/schemas/TaxPurchasesSalesAny' example: date: 2022-05-01T00:00:00.000+00:00 quantity: 346 purchases: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 sales: - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 - date: 2022-05-01T00:00:00.000+00:00 sum: 554000.55 OperationsPurchaseAndSale: type: object properties: quantity: type: number description: Кол-во операций по книгам покупок и продаж за квартал в шт. format: integer example: 554000 date: type: string description: "Дата, соответствующая указанному количеству операций" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 quantity: 554000 InsurancePremiumsInfo: type: object properties: mandatoryPensionInsuranceSumList: type: array description: "Сумма страховых взносов на обязательное пенсионное страхов\ ание, подлежащая уплате поквартально за последние 2-3 года" items: $ref: '#/components/schemas/InsuranceAny' mandatoryMedicalInsuranceSumList: type: array description: "Сумма страховых взносов на обязательное медицинское страхо\ вание, подлежащая уплате поквартально за последние 2-3 года" items: $ref: '#/components/schemas/InsuranceAny' mandatoryPensionInsuranceSurchargeSumList: type: array description: "Сумма страховых взносов на обязательное пенсионное страхов\ ание по дополнительному тарифу, подлежащая уплате (может быть нескольк\ о КБК) поквартально за последние 2-3 года" items: $ref: '#/components/schemas/InsuranceAny' supplementarySocialSupportSumList: type: array description: "Сумма страховых взносов на дополнительное социальное обесп\ ечение, подлежащая уплате за расчётный (отчётный) период (может быть н\ есколько КБК) поквартально за последние 2-3 года" items: $ref: '#/components/schemas/InsuranceAny' mandatorySocialInsuranceSumList: type: array description: Сумма страховых взносов на обязательное социальное страхование на случай временной нетрудоспособности и в связи с материнством поквартально за последние 2-3 года items: $ref: '#/components/schemas/InsuranceAny' description: Расчёт по страховым взносам example: mandatorySocialInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryMedicalInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryPensionInsuranceSurchargeSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 mandatoryPensionInsuranceSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 supplementarySocialSupportSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 - date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 InsuranceAny: type: object properties: sum: type: number description: "Сумма страховых взносов (pension - обязательное пенсионное\ , medical - обязательное медицинское, surcharge - доп.тариф обязательн\ ого пенсионного, support - доп.социальное, social - обязательное социа\ льное), подлежащая уплате за квартал в руб." format: float example: 7579815.57 date: type: string description: "Дата, соответствующая указанной сумме" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 7579815.57 ProfitTax: type: object properties: incomes: type: array description: Доходы от реализации поквартально за последние 2-3 года items: $ref: '#/components/schemas/ProfitTaxAny' costs: type: array description: Убытки (расходы) поквартально за последние 2-3 года items: $ref: '#/components/schemas/ProfitTaxAny' totalProfits: type: array description: Итого прибыль (убыток) поквартально за последние 2-3 года items: $ref: '#/components/schemas/ProfitTaxAny' description: Налог на прибыль example: incomes: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 costs: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 totalProfits: - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 - date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 ProfitTaxAny: type: object properties: sum: type: number description: "Сумма (income - дохода, costs - убытков/расходов, total -\ \ итого) поквартально за квартал в руб." format: float example: 87770039.19 date: type: string description: "Дата, соответствующая указанной сумме" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 8.777003919E7 TwoPersonalIncomeTaxesInfo: type: object properties: fullCostSumList: type: array description: "Сумма НДФЛ, исчисленная по годам за последние 2-3 года" items: $ref: '#/components/schemas/SumPITAny' retentionSumList: type: array description: "Сумма НДФЛ, удержанная по годам за последние 2-3 года" items: $ref: '#/components/schemas/SumPITAny' paidSumList: type: array description: "Сумма НДФЛ, перечисленная по годам за последние 2-3 года" items: $ref: '#/components/schemas/SumPITAny' employeesQuantityList: type: array description: Численность сотрудников по годам за последние 2-3 года items: $ref: '#/components/schemas/QuantityEmployees' description: 2-НДФЛ example: retentionSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 paidSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 employeesQuantityList: - date: 2022-05-01T00:00:00.000+00:00 quantity: 134 - date: 2022-05-01T00:00:00.000+00:00 quantity: 134 fullCostSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 - date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 SumPITAny: type: object properties: sum: type: number description: "Сумма НДФЛ (cost - исчисленная, retention - удержанная, paid\ \ - перечисленная) за год в руб." format: float example: 58552.25 date: type: string description: "Дата, соответствующая указанной сумме" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 58552.25 QuantityEmployees: type: object properties: quantity: type: number description: Численность сотрудников по годам за последние 2-3 года format: integer example: 134 date: type: string description: "Дата, соответствующая указанному количеству" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 quantity: 134 SixPersonalIncomeTaxesInfo: type: object properties: factIncomes: type: array description: Дата фактически полученного дохода по годам за последние 2-3 года items: $ref: '#/components/schemas/IncomeRetentionAny' retentionPITDateAndSumList: type: array description: Дата и сумма удержанного НДФЛ по годам за последние 2-3 года items: $ref: '#/components/schemas/IncomeRetentionAny' imposedKBKTaxes: type: array description: Начисленные налоги по КБК за год по годам за последние 2-3 года items: $ref: '#/components/schemas/ImposedAny' imposedInterests: type: array description: Начисленные пени по КБК за год по годам за последние 2-3 года items: $ref: '#/components/schemas/ImposedAny' imposedFines: type: array description: Начисленные штрафы по КБК за год по годам за последние 2-3 года items: $ref: '#/components/schemas/ImposedAny' paidKBKTaxes: type: array description: Уплаченные налоги по КБК за год по годам за последние 2-3 года items: $ref: '#/components/schemas/PaidAny' paidKBKInterests: type: array description: Уплаченные пени по КБК за год по годам за последние 2-3 года items: $ref: '#/components/schemas/PaidAny' paidKBKFines: type: array description: Уплаченные штрафы по КБК за год по годам за последние 2-3 года items: $ref: '#/components/schemas/PaidAny' description: 6-НДФЛ example: imposedKBKTaxes: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 retentionPITDateAndSumList: - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 paidKBKFines: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 paidKBKTaxes: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 paidKBKInterests: - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 - date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 factIncomes: - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 - date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 imposedInterests: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 imposedFines: - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 - date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 IncomeRetentionAny: type: object properties: factDate: type: string description: "Фактическая дата (factIncome - получения дохода, dateAndSumRetentionPIT\ \ - удержания НДФЛ)" format: date example: 2022-05-28 sum: type: number description: "Сумма (factIncome - фактически полученного дохода, dateAndSumRetentionPIT\ \ - удержанного НДФЛ) за год в руб." format: float example: 247912.19 date: type: string description: "Дата, соответствующая указанной фактической дате" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 247912.19 factDate: 2022-05-28T00:00:00.000+00:00 ImposedAny: type: object properties: sum: type: number description: "Начисленные (taxes - налоги, interests - пени, fines - штр\ афы) по КБК за год в руб." format: float example: 33346.47 date: type: string description: "Дата, соответствующая указанной фактической дате" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 33346.47 PaidAny: type: object properties: sum: type: number description: "Уплаченные (taxes - налоги, interests - пени, fines - штра\ фы) по КБК за год в руб." format: float example: 9110687.53 date: type: string description: "Дата, соответствующая указанной фактической дате" format: date example: 2022-05-01 example: date: 2022-05-01T00:00:00.000+00:00 sum: 9110687.53 CalculationsInformation: type: object properties: currentInterestsSum: type: number description: Текущие пени на дату запроса в руб. format: float example: 110687 currentInterestsAndCategories: type: array description: Текущие пени (в разбивке по категориям) items: $ref: '#/components/schemas/InterestsFinesAny' currentTaxesSum: type: number description: Текущие штрафы на дату запроса в руб. format: float example: 5016161.68 currentFinesAndCategories: type: array description: Текущие штрафы (в разбивке по категориям) items: $ref: '#/components/schemas/InterestsFinesAny' description: Справка о состоянии расчётов example: currentInterestsSum: 110687 currentInterestsAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentFinesAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentTaxesSum: 5016161.68 InterestsFinesAny: type: object properties: sum: type: number description: "Текущие (interests - пени, fines - штрафы) в разбивке по к\ атегориям на дату запроса в руб." format: float example: 20299.1 category: type: string description: Категория текущих пени/штрафа example: Категория пени/штрафа example: sum: 20299.1 category: Категория пени/штрафа ScoringAnyResponse: required: - dealId type: object properties: dealId: type: string format: uuid example: c5f72949-0e9a-41bf-a16d-a34b938f41ef example: dealId: c5f72949-0e9a-41bf-a16d-a34b938f41ef StatusResponse: required: - dealId - inn - statusInfo type: object properties: dealId: pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" type: string description: Уникальный идентификатор сделки format: uuid example: aef72949-0e9a-41bf-a11d-abbbcccf1e22 inn: pattern: "^(\\d{10}|\\d{12})$" type: string description: Идентификационный номер налогоплательщика example: "7751231950" statusInfo: $ref: '#/components/schemas/StatusInfoObject' description: Данные статуса кредитной заявки example: statusInfo: status: ОТКЛОНЕНА statusExplanation: Пока не можем одобрить заявку dealId: aef72949-0e9a-41bf-a11d-abbbcccf1e22 inn: "7751231950" StatusInfoObject: required: - status - statusExplanation type: object properties: status: type: string description: Статус сделки example: ОТКЛОНЕНА enum: - РАССМОТРЕНИЕ ЗАЯВКИ - ПОДТВЕРЖДЕНИЕ УСЛОВИЙ - ПОДПИСАНИЕ - В РАБОТЕ - КРЕДИТ ОФОРМЛЕН - ОТКЛОНЕНА statusExplanation: type: string description: Пояснение к статусу example: Пока не можем одобрить заявку enum: - Подпишите согласие на обработку персональных данных - "Подтвердите условия и подпишите документы, чтобы получить кредит" - "Подпишите документы удобным способом, чтобы получить кредит" - "Проверяем документы — как будет готово решение, кредит появится в ваш\ их кредитных продуктах" - Сегодня кредит появится в ваших продуктах — им можно пользоваться сразу - Пока не можем одобрить заявку example: status: ОТКЛОНЕНА statusExplanation: Пока не можем одобрить заявку BonusNumbersResponse: required: - bonusNumbers type: object properties: bonusNumbers: type: array items: $ref: '#/components/schemas/BonusNumber' description: Бонусные номера карт example: bonusNumbers: - number: number typeLoyalty: typeLoyalty - number: number typeLoyalty: typeLoyalty BonusNumber: required: - number - typeLoyalty type: object properties: number: type: string description: Список бонусных номеров карт клиента typeLoyalty: type: string description: Тип лояльности description: Бонусный номер карты и соответствующий тип лояльности example: number: number typeLoyalty: typeLoyalty UserComplianceGetResponse: required: - checkPassed type: object properties: checkPassed: type: boolean description: | Признак прохождения проверки. Принимает возможные значения: * true - оказание услуги делегированной идентификации клиента возможно; * false - оказание услуги делегированной идентификация клиента невозможно, данные клиента неактуальны persData: $ref: '#/components/schemas/PersData' reasons: type: array description: "Причины, по которым проверка не пройдена (возвращаются тол\ ько при checkPassed = false)." items: $ref: '#/components/schemas/_______________________' description: Результаты проверки актуальности сведений клиента example: reasons: - description: description - description: description persData: identityDocumentNumber: identityDocumentNumber givenName: givenName citizenship: citizenship inn: inn birthDate: 2000-01-23 actualAddressDetails: zip: zip area: area country: country localityShortName: localityShortName housingNumber: housingNumber town: town city: city street: street houseNumber: houseNumber streetShortName: streetShortName region: region apartmentNumber: apartmentNumber birthPlace: birthPlace identityDocumentIssueDate: 2000-01-23 familyName: familyName name: name middleName: middleName identityDocumentAuthorityName: identityDocumentAuthorityName identityDocumentName: identityDocumentName snils: snils identityDocumentAuthorityCode: identityDocumentAuthorityCode identityDocumentSeries: identityDocumentSeries checkPassed: true PersData: type: object properties: givenName: type: string description: Имя клиента familyName: type: string description: Фамилия клиента middleName: type: string description: Отчество клиента name: type: string description: Полное имя клиента birthDate: type: string description: Дата рождения клиента (формат YYYY-MM-DD) format: date birthPlace: type: string description: Место рождения клиента citizenship: type: string description: Гражданство клиента inn: type: string description: ИНН клиента snils: type: string description: СНИЛС клиента identityDocumentName: type: string description: "Тип документа, удостоверяющего личность" identityDocumentSeries: type: string description: Серия документа identityDocumentNumber: type: string description: Номер документа identityDocumentAuthorityCode: type: string description: "Код подразделения, выдавшего документ" identityDocumentAuthorityName: type: string description: "Наименование органа, выдавшего документ" identityDocumentIssueDate: type: string description: Дата выдачи документа (формат YYYY-MM-DD) format: date actualAddressDetails: $ref: '#/components/schemas/ActualAddressDetails' description: Персональные данные клиента (возвращаются только при checkPassed = true). example: identityDocumentNumber: identityDocumentNumber givenName: givenName citizenship: citizenship inn: inn birthDate: 2000-01-23 actualAddressDetails: zip: zip area: area country: country localityShortName: localityShortName housingNumber: housingNumber town: town city: city street: street houseNumber: houseNumber streetShortName: streetShortName region: region apartmentNumber: apartmentNumber birthPlace: birthPlace identityDocumentIssueDate: 2000-01-23 familyName: familyName name: name middleName: middleName identityDocumentAuthorityName: identityDocumentAuthorityName identityDocumentName: identityDocumentName snils: snils identityDocumentAuthorityCode: identityDocumentAuthorityCode identityDocumentSeries: identityDocumentSeries ActualAddressDetails: type: object properties: country: type: string description: Страна проживания city: type: string description: Город проживания zip: type: string description: Почтовый индекс street: type: string description: Улица region: type: string description: Код региона (субъекта РФ) area: type: string description: Район или административный округ localityShortName: type: string description: Краткое название населённого пункта town: type: string description: "Населённый пункт (город, посёлок, деревня)" streetShortName: type: string description: "Краткое название улицы (например, «ул.», «пр-т»)" houseNumber: type: string description: Номер дома housingNumber: type: string description: Номер корпуса или строения apartmentNumber: type: string description: Номер квартиры description: Адрес проживания клиента example: zip: zip area: area country: country localityShortName: localityShortName housingNumber: housingNumber town: town city: city street: street houseNumber: houseNumber streetShortName: streetShortName region: region apartmentNumber: apartmentNumber ComplianceRequest: required: - callbackUri type: object properties: callbackUri: type: string description: | URI, на который будет отправлен результат асинхронной проверки format: uri example: https://partner.example.com/api/compliance/result example: callbackUri: https://partner.example.com/api/compliance/result OperationResponse: type: object properties: operationId: type: string description: Уникальный идентификатор операции на запрос проверки идентификации пользователя example: 22413cd0-11d7-4a1a-826d-a82470c18a83 example: operationId: 22413cd0-11d7-4a1a-826d-a82470c18a83 ErrorBadRequest_1: required: - error type: object properties: error: type: string description: | Код ошибки. Принимает возможные значения: - `invalid_request` - отсутствуют обязательные параметры или тело запроса; - `invalid_callbackUri` - передан некорректный callbackUri example: invalid_callbackUri error_description: type: string description: Описание ошибки example: The required field callbackUri is missing or has an invalid format description: Неверные или отсутствующие параметры или тело запроса OperationResponse_1: type: object properties: operationId: type: string description: Уникальный идентификатор операции на запрос упрощенной проверки идентификации пользователя example: 22413cd0-11d7-4a1a-826d-a82470c18a83 example: operationId: 22413cd0-11d7-4a1a-826d-a82470c18a83 ResponeWebhooks: type: object properties: limit: type: integer description: Количество объектов на одной странице offset: type: integer description: "Количество объектов в списке, которые необходимо пропустит\ ь" totalCount: type: integer description: Общее количество записей items: type: array description: Массив вебхуков items: $ref: '#/components/schemas/ResponeWebhook' description: Ответ на получение списка вебхуков example: offset: 6 limit: 0 totalCount: 1 items: - data: accounts: - accounts - accounts callbackUri: callbackUri statusDescriptions: - cause: Revocation of agreement description: The webhook is disabled due to the agreement being revoked in Alfa ID - cause: Revocation of agreement description: The webhook is disabled due to the agreement being revoked in Alfa ID id: id version: 5 enabled: true object: object - data: accounts: - accounts - accounts callbackUri: callbackUri statusDescriptions: - cause: Revocation of agreement description: The webhook is disabled due to the agreement being revoked in Alfa ID - cause: Revocation of agreement description: The webhook is disabled due to the agreement being revoked in Alfa ID id: id version: 5 enabled: true object: object ArrayWebhooks: type: array description: Массив вебхуков items: $ref: '#/components/schemas/ResponeWebhook' ResponeWebhook: type: object properties: id: type: string description: Идентифкатор записи object: type: string description: Объект enabled: type: boolean description: Статус вебхука (выключен/включен) callbackUri: type: string description: "URI партнера, на который будет отправляться вебхук" version: type: integer description: Версия выписки data: $ref: '#/components/schemas/Data_1' statusDescriptions: type: array description: Описание статусов вебхука items: $ref: '#/components/schemas/StatusDescription' description: Ответ по вебхуку example: data: accounts: - accounts - accounts callbackUri: callbackUri statusDescriptions: - cause: Revocation of agreement description: The webhook is disabled due to the agreement being revoked in Alfa ID - cause: Revocation of agreement description: The webhook is disabled due to the agreement being revoked in Alfa ID id: id version: 5 enabled: true object: object Data_1: type: object properties: accounts: type: array description: Объект items: type: string description: Список счетов example: accounts: - accounts - accounts StatusDescriptions: type: array description: Описание статусов вебхука items: $ref: '#/components/schemas/StatusDescription' StatusDescription: type: object properties: cause: type: string description: Причина выключения статуса example: Revocation of agreement description: type: string description: Описание причины example: The webhook is disabled due to the agreement being revoked in Alfa ID description: Ответ на получение списка вебхуков example: cause: Revocation of agreement description: The webhook is disabled due to the agreement being revoked in Alfa ID RequestPostWebhook: type: object properties: object: type: string description: Объект callbackUri: type: string description: "URI партнера, на который будет отправляться вебхук" version: type: integer description: Версия выписки data: $ref: '#/components/schemas/Data_1' description: Запрос на создание вебхука example: data: accounts: - accounts - accounts callbackUri: callbackUri version: 0 object: object RequestPutWebhook: type: object properties: object: type: string description: Объект callbackUri: type: string description: "URI партнера, на который будет отправляться вебхук. Редакт\ ировать можно только path, host должен оставаться неизменным" enabled: type: boolean description: Статус вебхука (выключен/включен) version: type: integer description: Версия выписки data: $ref: '#/components/schemas/Data_1' description: Запрос на редактирование вебхука example: data: accounts: - accounts - accounts callbackUri: callbackUri version: 0 enabled: true object: object PostWebhooksEvent: type: object properties: object: type: string description: Объект example: ul_transaction_default description: Запрос на создание транзакций example: object: ul_transaction_default ReceiptAndPayoutList: required: - company - digestSignatures - externalId - requisite type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a company: $ref: '#/components/schemas/ReceiptAndPayoutList_company' requisite: maxItems: 10000 minItems: 1 type: array description: Реквизиты выплаты items: $ref: '#/components/schemas/ReceiptAndPayoutList_requisite_inner' digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_inner' description: Выплаты самозанятым с регистрацией чека в ФНС и проведением платежа example: digestSignatures: - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a company: accountNumber: "40702810606050000022" requisite: - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a UUID: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a Vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" PayoutRequisite: required: - payoutTotalAmount - payoutType type: object properties: payoutType: $ref: '#/components/schemas/PayoutType' byAccount: $ref: '#/components/schemas/PayoutRequisite_byAccount' byPan: $ref: '#/components/schemas/PayoutRequisite_byPan' byPhone: $ref: '#/components/schemas/PayoutRequisite_byPhone' payoutTotalAmount: type: string description: Сумма выплаты example: "10.00" description: Платежные реквизиты получателя example: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" PayoutType: type: string description: | Тип выплаты: * `ACCOUNT` - Выплата по реквизитам счета получателя * `CARD` - Выплата на банковскую карту получателя * `PHONE` - Выплата через СБП по номеру телефона example: ACCOUNT enum: - ACCOUNT - CARD - PHONE AccountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" Phone: pattern: "^79\\d{9}$" type: string description: Телефон example: "79130000011" ReceiptRequisite: required: - incomeType - operateDate - receiptTotalAmount - requestDate - services type: object properties: customerVatin: maxLength: 12 minLength: 10 pattern: "^([0-9]{10}|[0-9]{12})$" type: string description: ИНН покупателя example: "5566778899" customerName: maxLength: 128 minLength: 1 type: string description: Наименование компании покупателя example: ООО Петуния incomeType: $ref: '#/components/schemas/IncomeType' operateDate: type: string description: "Дата расчета с самозанятым, которая будет указана в чеке" format: date-time example: 2023-01-18T13:36:42.703Z requestDate: type: string description: Дата запроса на формирование чека format: date-time example: 2023-01-18T13:36:42.703Z services: maxItems: 6 minItems: 1 type: array items: $ref: '#/components/schemas/ReceiptRequisite_services_inner' receiptTotalAmount: type: string description: Сумма чека example: "10.00" description: Реквизиты чека example: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния IncomeType: type: string description: | Тип дохода: * `FROM_INDIVIDUAL` - Доход от физического лица * `FROM_LEGAL_ENTITY` - Доход от юридического лица или ИП * `FROM_FOREIGN_AGENCY` - Доход от иностранной организации example: FROM_FOREIGN_AGENCY enum: - FROM_INDIVIDUAL - FROM_LEGAL_ENTITY - FROM_FOREIGN_AGENCY default: FROM_LEGAL_ENTITY DigestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_inner' ListResponse: required: - externalId - requestId type: object properties: requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a description: Ответ на запрос загрузки данных в систему example: requestId: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a ErrorBadRequest_2: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: invalid_request error_description: type: string description: Описание ошибки example: Authorization header is not present in request headers ErrorUnauthorized_1: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: invalid_token error_description: type: string description: Описание ошибки example: "The access token provided is expired, revoked, malformed, or invalid\ \ for other reasons" ErrorForbidden: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: insufficient_scope error_description: type: string description: Описание ошибки example: The request requires higher privileges than provided by the access token ErrorTooManyRequests: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: too_many_requests error_description: type: string description: Описание ошибки example: Too many requests ErrorInternal_1: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: internal_error error_description: type: string description: Описание ошибки example: Internal server error ErrorServiceUnavailable: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: service_unavailable error_description: type: string description: Описание ошибки example: Service Unavailable ReceiptList: required: - digestSignatures - externalId - requisite type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a requisite: maxItems: 10000 minItems: 1 type: array description: Реквизиты чека items: $ref: '#/components/schemas/ReceiptList_requisite_inner' digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_inner' description: Декларация дохода в ФНС с получением чека (без проведения платежа) example: digestSignatures: - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a requisite: - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a CheckSelfemployedStatusAndPayoutList: required: - company - digestSignatures - externalId - requisite type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a company: $ref: '#/components/schemas/CheckSelfemployedStatusAndPayoutList_company' requisite: maxItems: 10000 minItems: 1 type: array description: Реквизиты выплаты items: $ref: '#/components/schemas/CheckSelfemployedStatusAndPayoutList_requisite_inner' receiptRequisite: $ref: '#/components/schemas/CheckSelfemployedStatusAndPayoutList_receiptRequisite' digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_inner' description: Выплаты самозанятым с предварительной проверкой статуса самозанятого в ФНС example: digestSignatures: - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a receiptRequisite: receiptId: 200wr5cn4s externalId: 8658d934-9527-413b-b23c-d87bb1e9824a company: accountNumber: "40817810306050000000" requisite: - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a PayoutList: required: - company - digestSignatures - externalId - requisite type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a company: $ref: '#/components/schemas/ReceiptAndPayoutList_company' requisite: maxItems: 10000 minItems: 1 type: array description: Реквизиты выплаты items: $ref: '#/components/schemas/PayoutList_requisite_inner' digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_inner' description: "Выплаты ФЛ, незарегистрированным в системе, без проверки их ст\ атуса и декларации доходов" example: digestSignatures: - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a company: accountNumber: "40702810606050000022" requisite: - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a - selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a PersonalInformation: required: - name - surname - vatin type: object properties: vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" surname: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Фамилия example: Иванов name: maxLength: 64 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Имя example: Иван patronymic: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Отчество example: Иванoвич description: Персональные данные самозанятого example: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван PayoutListState: required: - createdDate - externalId - listStatus - pagination - requestId - statementList type: object properties: pagination: $ref: '#/components/schemas/Pagination_2' requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a createdDate: type: string description: Дата и время создания запроса в системе format: date-time listStatus: $ref: '#/components/schemas/PayoutListStatus' accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" error: $ref: '#/components/schemas/Error' statementList: minItems: 1 type: array description: Список чеков и выплат в системе items: $ref: '#/components/schemas/StatementList_inner' description: "Статус обработки выплат, загруженных в систему" example: pagination: offset: 0 limit: 1000 totalCount: 10000 createdDate: 2000-01-23T04:56:07.000+00:00 requestId: 8658d934-9527-413b-b23c-d87bb1e9824a statementList: - receiptLink: link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptId: 200wr5cn4s selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния errorRecord: - field: field message: error_description - field: field message: error_description payoutStatus: updatedDate: 2000-01-23T04:56:07.000+00:00 status: READY payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a receiptStatus: updatedDate: 2000-01-23T04:56:07.000+00:00 status: IN_PROGRESS - receiptLink: link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptId: 200wr5cn4s selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния errorRecord: - field: field message: error_description - field: field message: error_description payoutStatus: updatedDate: 2000-01-23T04:56:07.000+00:00 status: READY payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a receiptStatus: updatedDate: 2000-01-23T04:56:07.000+00:00 status: IN_PROGRESS externalId: 8658d934-9527-413b-b23c-d87bb1e9824a listStatus: IN_PROGRESS accountNumber: "40817810306050000000" error: error_description: error_description error: error_code Pagination_2: type: object properties: limit: maximum: 1000 minimum: 1 type: number description: Количество записей на одной странице example: 1000 default: 100 offset: minimum: 0 type: number description: "Количество записей в списке, которые были пропущены" example: 0 default: 0 totalCount: minimum: 0 type: number description: Общее количество записей example: 10000 default: 0 description: Данные пагинации example: offset: 0 limit: 1000 totalCount: 10000 PayoutListStatus: type: string description: | Статус исполнения загруженного списка выплат: * `NEW` - Принят для последующей обработки * `TOTAL_AMOUNT_CALCULATED` - Общая сумма подсчитана * `FAILED_SIGNATURE` - Подпись не прошла проверку * `OUT_OF_DATE` - Реестр отправлен после окончания операционного дня * `SUCCESS` - Реестр обработан успешно * `IN_PROGRESS` - В обработке * `BALANCE_CHECKED` - Баланса достаточно для выплат * `SIGNATURE_CHECKED` - Подпись проверена * `FAILED_COMPLIANCE` - Комплаенс проверка не была пройдена * `CLIENT_ACCOUNT_CHECKED` - Счет Клиента проверен в админ-модуле * `FAILED_ACCOUNT_CHECK` - Счет Клиента не прошел проверку в админ-модуле * `CLIENT_ACCOUNT_EQ_CHECKED` - Счет Клиента прошел проверку в Банке * `FAILED_ACCOUNT_EQ_CHECK` - Счет Клиента не прошел проверку в Банке * `TECHNICAL_ERROR` - Непредвиденная ошибка * `FAILED_BALANCE` - Недостаточно средств на счету для выполнения выплат * `ERROR` - Ошибка при обработке * `PAYOUT_TIME_CHECKED` - Проверка времени загрузки реестра выполнена example: IN_PROGRESS enum: - NEW - TOTAL_AMOUNT_CALCULATED - FAILED_SIGNATURE - OUT_OF_DATE - SUCCESS - IN_PROGRESS - BALANCE_CHECKED - SIGNATURE_CHECKED - FAILED_COMPLIANCE - CLIENT_ACCOUNT_CHECKED - FAILED_ACCOUNT_CHECK - CLIENT_ACCOUNT_EQ_CHECKED - FAILED_ACCOUNT_EQ_CHECK - TECHNICAL_ERROR - FAILED_BALANCE - ERROR - PAYOUT_TIME_CHECKED Error: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: error_code error_description: type: string description: Описание ошибки example: error_description description: Ошибки обработки загруженного списка example: error_description: error_description error: error_code StatementList: minItems: 1 type: array description: Список чеков и выплат в системе items: $ref: '#/components/schemas/StatementList_inner' ReceiptLink: required: - link type: object properties: receiptId: maxLength: 128 minLength: 1 type: string description: Идентификатор чека в ФНС example: 200wr5cn4s link: maxLength: 512 minLength: 1 type: string description: Ссылка на чек с сайта ФНС example: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print description: Референс чека example: link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptId: 200wr5cn4s ReceiptStatus: type: string description: | Статус чека в системе: * NEW - Принят для последующей обработки * READY - Успешно зарегистрирован * FAILED - Ошибка в процессе регистрации чека * CANCEL_REQUESTED - Запрос на аннулирование чека отправлен в ФНС * IN_PROGRESS - В процессе обработки * CANCEL_INCOME_REQUESTED_AUTOMATICALLY - Отправлен запрос в ФНС на аннулирование чека * CANCELED_AUTOMATICALLY - Аннулирован автоматически системой * FAILED_CANCEL - Ошибка аннулирования чека в ФНС * CHECK_REFUND - Проконтролируйте возврат суммы сторнированного дохода на счет * PARTNER_INFO - Чек был передан клиентом example: IN_PROGRESS enum: - NEW - READY - FAILED - CANCEL_REQUESTED - IN_PROGRESS - CANCEL_INCOME_REQUESTED_AUTOMATICALLY - CANCELED_AUTOMATICALLY - FAILED_CANCEL - CHECK_REFUND - PARTNER_INFO PayoutStatus: type: object properties: status: type: string description: | Статус выплаты в системе: * `NEW` - Принят для последующей обработки * `READY` - Выплата успешно исполнена * `FAILED` - Ошибка при исполнении выплаты * `IN_PROGRESS` - В обработке * `WAITING` - Ожидает поступления средств * `BIND_CHECKED` - Проверка привязки самозанятого к компании успешна * `SELFEMPLOYED_CHECKED` - Проверка самозанятого успешна * `BALANCE_CHECKED` - Баланса достаточно * `SELFEMPLOYED_TAXPAYER_CHECK` - Статус самозанятого проверяется в ФНС * `PAYMENT_IN_PROGRESS` - Выплата в обработке * `INCOME_REGISTRATION_REQUESTED` - Отправлен запрос в ФНС на регистрацию чека * `TECHNICAL_ERROR` - Техническая ошибка * `FAILED_SELFEMPLOYED_CHECK` - Самозанятый не имеет статус READY * `FAILED_SELFEMPLOYED_TAXPAYER_CHECK` - Самозанятый не прошел проверку статуса в ФНС * `FAILED_BIND_CHECK` - Самозанятый не привязан к компании * `FAILED_EQ_ACCOUNT_PAY` - Внутренняя ошибка выплаты в Банке * `REGISTRATION_RESTRICTIONS_IN_PROGRESS` - Статус самозанятого в процессе проверки в фнс * `FULL_NAME_CHECKED` - ФИО проверено * `FAILED_FULL_NAME_CHECK` - Проверка ФИО неуспешна * `PAYMENT_DEFERRED` - Проведение выплаты отложено * `AWAIT_EXTERNAL` - Внешний платеж ожидает исполнения enum: - NEW - READY - FAILED - IN_PROGRESS - WAITING - BIND_CHECKED - SELFEMPLOYED_CHECKED - BALANCE_CHECKED - SELFEMPLOYED_TAXPAYER_CHECK - PAYMENT_IN_PROGRESS - INCOME_REGISTRATION_REQUESTED - TECHNICAL_ERROR - FAILED_SELFEMPLOYED_CHECK - FAILED_SELFEMPLOYED_TAXPAYER_CHECK - FAILED_BIND_CHECK - FAILED_EQ_ACCOUNT_PAY - REGISTRATION_RESTRICTIONS_IN_PROGRESS - FULL_NAME_CHECKED - FAILED_FULL_NAME_CHECK - PAYMENT_DEFERRED - AWAIT_EXTERNAL updatedDate: type: string description: Дата и время обновления статуса чека в системе format: date-time example: READY ErrorRecord: minItems: 0 type: array description: Ошибки обработки записей списка items: $ref: '#/components/schemas/ErrorRecord_inner' ErrorNotFound_1: required: - error - error_description type: object properties: error: type: string description: Код ошибки example: unknown_endpoint error_description: type: string description: Описание ошибки example: Endpoint is not found or not active CancelReceiptList: required: - cancelReceipt - digestSignatures - externalId type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a cancelReceipt: maxItems: 10000 minItems: 1 type: array items: $ref: '#/components/schemas/CancelReceiptList_cancelReceipt_inner' digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_inner' description: Список аннулируемых чеков example: digestSignatures: - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a cancelReceipt: - vatin: "112233445566" receipt: - cancelReasonCode: REFUND receiptId: receiptId - cancelReasonCode: REFUND receiptId: receiptId - vatin: "112233445566" receipt: - cancelReasonCode: REFUND receiptId: receiptId - cancelReasonCode: REFUND receiptId: receiptId - vatin: "112233445566" receipt: - cancelReasonCode: REFUND receiptId: receiptId - cancelReasonCode: REFUND receiptId: receiptId - vatin: "112233445566" receipt: - cancelReasonCode: REFUND receiptId: receiptId - cancelReasonCode: REFUND receiptId: receiptId - vatin: "112233445566" receipt: - cancelReasonCode: REFUND receiptId: receiptId - cancelReasonCode: REFUND receiptId: receiptId CancelReasonCode: type: string description: | Код причины аннулирования чека: * `REGISTRATION_MISTAKE` - Чек сформирован ошибочно * `REFUND` - Возврат средств example: REFUND enum: - REGISTRATION_MISTAKE - REFUND PayoutResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination_2' payoutsList: minItems: 0 type: array items: $ref: '#/components/schemas/PayoutResponse_payoutsList_inner' description: "Информация о выплатах, загруженных в систему" example: pagination: offset: 0 limit: 1000 totalCount: 10000 payoutsList: - receiptLink: link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptId: 200wr5cn4s payerAccountNumber: "40817810306050000000" vatin: "112233445566" createdDate: 2000-01-23T04:56:07.000+00:00 payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния requestId: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a payoutStatus: READY payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a receiptStatus: IN_PROGRESS - receiptLink: link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptId: 200wr5cn4s payerAccountNumber: "40817810306050000000" vatin: "112233445566" createdDate: 2000-01-23T04:56:07.000+00:00 payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния requestId: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a payoutStatus: READY payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a receiptStatus: IN_PROGRESS SelfemployedList: required: - digestSignatures - externalId - selfemployed type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string selfemployed: maxItems: 10000 minItems: 1 type: array items: $ref: '#/components/schemas/Selfemployed' digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_1_inner' description: "Список самозанятых, добавляемых в систему" example: selfemployed: - birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru - birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru - birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru - birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru - birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru digestSignatures: - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: certificateUuid - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: certificateUuid - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: certificateUuid - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: certificateUuid - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: certificateUuid externalId: externalId UUID_1: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string Selfemployed: required: - address - birthDate - birthPlace - citizenship - passport - personalInformation - phone type: object properties: personalInformation: $ref: '#/components/schemas/PersonalInformation_1' phone: pattern: "^79\\d{9}$" type: string description: Телефон example: "79130000011" birthDate: type: string description: Дата рождения format: date example: 2000-03-02 birthPlace: maxLength: 128 minLength: 1 type: string description: Место рождения example: Г. Иркутск citizenship: $ref: '#/components/schemas/Citizenship' passport: $ref: '#/components/schemas/Selfemployed_passport' address: maxLength: 128 minLength: 1 type: string description: Адрес проживания example: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru idCard: $ref: '#/components/schemas/IdCard' description: Данные самозанятого example: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru PersonalInformation_1: required: - name - surname - vatin type: object properties: vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" surname: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Фамилия example: Иванов name: maxLength: 64 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Имя example: Иван patronymic: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Отчество example: Иванoвич description: Персональные данные самозанятого example: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван Citizenship: type: string description: | Гражданство: * `RU` - РФ * `BY` - Беларусь * `AM` - Армения * `KZ` - Казахстан * `KG` - Киргизия example: RU enum: - RU - BY - AM - KZ - KG Passport: required: - authority - codeOfIssue - dateOfIssue - number - series type: object properties: series: pattern: "^\\d{4}$" type: string description: Номер паспорта РФ example: "6953" number: pattern: "^\\d{6}$" type: string description: Номер паспорта РФ example: "987435" dateOfIssue: type: string description: Дата выдачи паспорта format: date example: 2022-03-02 codeOfIssue: pattern: "^\\d{3}-\\d{3}$" type: string description: "Код подразделения, выдавшего паспорт" example: 123-321 authority: maxLength: 128 minLength: 1 type: string description: "Орган, выдавший документ" example: ОВД Иркутской области по Г. Иркутску по Октябрьскому району description: Паспорт гражданина РФ. Передается если citizenship равен RU ForeignPassport: required: - authority - dateOfExpiry - dateOfIssue - number type: object properties: number: pattern: "^[a-zA-Z0-9\\s]{1,16}$" type: string description: Номер паспорта иностранного гражданина example: КВ133661 dateOfIssue: type: string description: Дата выдачи паспорта format: date example: 2022-03-02 dateOfExpiry: type: string description: Дата окончания действия паспорта format: date example: 2032-03-02 authority: maxLength: 128 minLength: 1 type: string description: "Орган, выдавший документ" example: УВД БОБРУЙСКОГО ГОРИСПОЛКОМА МОГИЛЕВСКОЙ ОБЛАСТИ description: "Паспорт иностранного гражданина. Передается если citizenship р\ авен BY, AM, KZ, KG" IdCard: required: - dateOfEffective - dateOfExpiry - number - type type: object properties: type: type: string description: | Тип документа, подтверждающего право проживания на территории РФ: * `residencePermit` - Вид на жительство * `residenceCertificate` - Документ удостоверяющий проживание * `migrationCard` - Миграционная карта enum: - migrationCard - residenceCertificate - residencePermit number: maxLength: 20 minLength: 1 type: string description: "Номер документа, подтверждающего право проживания" example: "1234567" dateOfEffective: type: string description: "Дата начала действия документа, подтверждающего право прож\ ивания" format: date example: 2022-03-02 dateOfExpiry: type: string description: "Дата окончания действия документа, подтверждающего право п\ роживания" format: date example: 2024-03-02 description: "Документ, подтверждающего право проживания на территории РФ. П\ ередается если citizenship равен AM, KZ, KG" example: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard DigestSignatures_1: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_1_inner' ListResponse_1: required: - externalId - requestId type: object properties: requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Ответ на запрос загрузки данных в систему example: requestId: requestId externalId: externalId SelfemployedListState: required: - createdDate - externalId - listStatus - pagination - requestId - selfemployedAccount type: object properties: pagination: $ref: '#/components/schemas/Pagination_2' requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string listStatus: $ref: '#/components/schemas/SelfEmployedListStatus' createdDate: type: string description: Дата и время создания запроса в системе format: date-time selfemployedAccount: minItems: 1 type: array description: Список самозанятых items: $ref: '#/components/schemas/SelfemployedAccount_inner' error: $ref: '#/components/schemas/Error' description: Статус добавления самозанятых в систему example: selfemployedAccount: - selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru createdDate: 2000-01-23T04:56:07.000+00:00 errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23T04:56:07.000+00:00 status: null - selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru createdDate: 2000-01-23T04:56:07.000+00:00 errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23T04:56:07.000+00:00 status: null pagination: offset: 0 limit: 1000 totalCount: 10000 createdDate: 2000-01-23T04:56:07.000+00:00 requestId: requestId externalId: externalId listStatus: IN_PROGRESS error: error_description: error_description error: error_code SelfEmployedListStatus: type: string description: | Статус обработки загруженного списка самозанятых: * 'NEW' - Принят для последующей обработки * 'SUCCESS' - Успешно обработан * 'ERROR' - Ошибка в процессе обработки * 'IN_PROGRESS' - В процессе обработки * 'TECHNICAL_ERROR' - Непредвиденная техническая ошибка * 'SIGNATURE_CHECKED' - Реестр прошел проверку подписи (промежуточный статус) example: IN_PROGRESS enum: - NEW - SUCCESS - ERROR - IN_PROGRESS - TECHNICAL_ERROR - SIGNATURE_CHECKED SelfemployedAccount: minItems: 1 type: array description: Список самозанятых items: $ref: '#/components/schemas/SelfemployedAccount_inner' SelfEmployedStatus: type: string description: | Статус самозанятого в системе: * NEW - Принят для последующей обработки * IN_PROGRESS - В процессе обработки * READY - Успешно добавлен * FAILED - Ошибка в процессе исполнения * FAILED_SIGNATURE - Подпись не валидна * FAILED_BIND - Самозанятым отклонен запрос на передачу прав Альфа-Банку * FAILED_REGISTRATION - Постановка на учет отклонена ФНС * FAILED_CHECK_TAXPAYER_STATUS - Получен непредвиденный ответ при проверке статуса в ФНС * FAILED_VERIFY - Ошибка в процессе проверки данных самозанятого * FAILED_AGREEMENT - Соглашение с Альфа-Банком не подписано самозанятым * TECHNICAL_ERROR - Техническая ошибка * BIND_REQUESTED - В процессе передачи прав - самозанятый должен подтвердить передачу прав Альфа-Банку в приложении ФНС Мой Налог * REGISTRATION_REQUESTED - В ФНС отправлен запрос на регистрацию * AGREEMENT_SIGNED - Соглашение подписано * PASSPORT_CHECKED - Паспорт проверен * CLIENT_DATA_CHECKED - Персональные данные проверены * TAXPAYER_STATUS_REQUESTED - В ФНС отправлен запрос на проверку статуса самозанятого * TAXPAYER_UNREGISTERED - Самозанятый снят с учета в ФНС * TAXPAYER_UNBOUND - Самозанятым не предоставлены права Альфа-Банку в ФНС * TAXPAYER_REGISTERED - Самозанятый поставлен на учет в ФНС * SIGNATURE_CHECKED - Подпись проверена * TAXPAYER_ALREADY_BOUND - Самозанятым предоставлены права Альфа-Банку в ФНС * TAXPAYER_ALREADY_REGISTERED - Самозанятый уже был поставлен на учет в ФНС enum: - NEW - IN_PROGRESS - READY - FAILED - FAILED_SIGNATURE - FAILED_BIND - FAILED_REGISTRATION - FAILED_CHECK_TAXPAYER_STATUS - FAILED_VERIFY - FAILED_AGREEMENT - TECHNICAL_ERROR - BIND_REQUESTED - REGISTRATION_REQUESTED - AGREEMENT_SIGNED - PASSPORT_CHECKED - CLIENT_DATA_CHECKED - TAXPAYER_STATUS_REQUESTED - TAXPAYER_UNREGISTERED - TAXPAYER_UNBOUND - TAXPAYER_REGISTERED - SIGNATURE_CHECKED - TAXPAYER_ALREADY_BOUND - TAXPAYER_ALREADY_REGISTERED ErrorRecord_1: minItems: 0 type: array description: Ошибки обработки записей списка items: $ref: '#/components/schemas/ErrorRecord_1_inner' RequestTaxpayerStatusList: required: - externalId - selfemployedVatinList type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string selfemployedVatinList: maxItems: 1 minItems: 1 type: array description: "Список ИНН самозанятых, ограниченный одной записью" items: $ref: '#/components/schemas/Vatin' description: Список самозанятых для запроса статуса в ФНС example: selfemployedVatinList: - "112233445566" externalId: externalId SelfemployedVatin: maxItems: 1 minItems: 1 type: array description: "Список ИНН самозанятых, ограниченный одной записью" items: $ref: '#/components/schemas/Vatin' TaxpayerListStatus: required: - externalId - pagination - requestId - taxpayerStatusList type: object properties: pagination: $ref: '#/components/schemas/Pagination_2' requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string taxpayerStatusList: minItems: 1 type: array items: $ref: '#/components/schemas/TaxpayerListStatus_taxpayerStatusList_inner' example: pagination: offset: 0 limit: 1000 totalCount: 10000 requestId: requestId externalId: externalId taxpayerStatusList: - vatin: "112233445566" status: TAXPAYER_BOUND - vatin: "112233445566" status: TAXPAYER_BOUND AccrualList: required: - externalId - selfemployedVatinList type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string selfemployedVatinList: maxItems: 100 minItems: 1 type: array description: Список ИНН самозанятых items: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" description: Список самозанятых для запроса данных о неоплаченных налоговых начислениях и задолжностях в ФНС example: selfemployedVatinList: - "112233445566" - "112233445566" - "112233445566" - "112233445566" - "112233445566" externalId: externalId SelfemployedVatinList: maxItems: 100 minItems: 1 type: array description: Список ИНН самозанятых items: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" AccrualAndDebtListStatus: required: - accrualList - externalId - pagination - requestId type: object properties: pagination: $ref: '#/components/schemas/Pagination_2' requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string accrualList: minItems: 1 type: array items: $ref: '#/components/schemas/AccrualAndDebtListStatus_accrualList_inner' error: $ref: '#/components/schemas/Error' description: Информация о неоплаченных налоговых начисления и задолженностях самозанятого example: pagination: offset: 0 limit: 1000 totalCount: 10000 requestId: requestId externalId: externalId error: error_description: error_description error: error_code accrualList: - vatin: "112233445566" ftsError: ftsError taxChargeList: - amount: "10.00" dueDate: 2022-03-02T00:00:00.000+00:00 paidAmount: "10.00" updatedAt: 2000-01-23T04:56:07.000+00:00 - amount: "10.00" dueDate: 2022-03-02T00:00:00.000+00:00 paidAmount: "10.00" updatedAt: 2000-01-23T04:56:07.000+00:00 krsbList: - penalty: 0.1 overpayment: 0 debt: 990 updatedAt: 2000-01-23T04:56:07.000+00:00 - penalty: 0.1 overpayment: 0 debt: 990 updatedAt: 2000-01-23T04:56:07.000+00:00 status: NEW - vatin: "112233445566" ftsError: ftsError taxChargeList: - amount: "10.00" dueDate: 2022-03-02T00:00:00.000+00:00 paidAmount: "10.00" updatedAt: 2000-01-23T04:56:07.000+00:00 - amount: "10.00" dueDate: 2022-03-02T00:00:00.000+00:00 paidAmount: "10.00" updatedAt: 2000-01-23T04:56:07.000+00:00 krsbList: - penalty: 0.1 overpayment: 0 debt: 990 updatedAt: 2000-01-23T04:56:07.000+00:00 - penalty: 0.1 overpayment: 0 debt: 990 updatedAt: 2000-01-23T04:56:07.000+00:00 status: NEW PaymentDocumentListStatus: title: PaymentDocumentListStaus required: - externalId - pagination - paymentDocumentListState - requestId type: object properties: pagination: $ref: '#/components/schemas/Pagination_2' requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string paymentDocumentListState: required: - status - vatin type: array properties: vatin: $ref: '#/components/schemas/Vatin' status: type: string description: | Статус получения данных из ФНС по самозанятому: * NEW - Принят для последующей обработки * SUCCESS - Успешно обработан * ERROR - Ошибка в процессе обработки * IN_PROGRESS - В процессе обработки example: NEW enum: - NEW - SUCCESS - ERROR - IN_PROGRESS ftsError: type: string description: Ошибка ФНС example: Not found paymentDocumentList: minItems: 0 type: array description: Список платежных документов items: required: - accrualType - adress - amount - code101 - code106 - code107 - code110 - createdAt - documentIndex - dueDate - internalId - kbk - name - oktmo - recipientAccount - recipientBank - recipientBankAccount - recipientBic - recipientKpp - recipientName - recipientVatin - taxpayerVatin type: object properties: accrualType: type: string description: | Тип начисления: * `TAX`– налоговое начисление * `DEBT` – задолженность * `PENALTY` – пеня example: TAX enum: - NEW - SUCCESS - IN_PROGRESS - ERROR documentIndex: type: string description: Индекс документа (УИН) name: type: string description: ФИО налогоплательщика adress: type: string description: Адрес места жительства налогоплательщика taxpayerVatin: type: string description: ИНН налогоплательщика amount: type: string description: Сумма к оплате example: "10.00" recipientBank: type: string description: Банк получателя recipientBic: type: string description: БИК банка получателя recipientBankAccount: type: string description: Счет банка получателя recipientName: type: string description: Получатель recipientAccount: type: string description: Счет получателя recipientVatin: type: string description: ИНН получателя recipientKpp: type: string description: КПП получателя kbk: type: string description: КБК налогового начисления или КРСБ oktmo: type: string description: ОКТМО налогового начисления или КРСБ code101: type: string description: Код для поля 101 example: "13" code106: type: string description: | Код для поля 106: * `ТП` – оплата по налогам за текущий период * `ЗД` – добровольное погашение задолженности по истекшим налоговым периодам code107: type: string description: Код для поля 107 example: 10.03.2023 code110: type: string description: Код для поля 110 example: "0" dueDate: type: string description: Срок оплаты format: date example: 2022-03-02 createdAt: type: string description: Дата/Время создания документа format: date-time internalId: type: number description: Внутренний идентификатор источника документа в ПП НПД error: $ref: '#/components/schemas/Error' description: "Данные платежных документов на оплату налоговых начислений, за\ долженности и пеней самозанятого" example: pagination: offset: 0 limit: 1000 totalCount: 10000 requestId: requestId externalId: externalId paymentDocumentListState: "" SelfemployedResponse: required: - pagination - selfemployedAccount type: object properties: pagination: $ref: '#/components/schemas/Pagination_2' selfemployedAccount: minItems: 1 type: array description: Список самозанятых items: $ref: '#/components/schemas/SelfemployedAccount_inner' description: "Информация о самозанятых, загруженных в систему" example: selfemployedAccount: - selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru createdDate: 2000-01-23T04:56:07.000+00:00 errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23T04:56:07.000+00:00 status: null - selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru createdDate: 2000-01-23T04:56:07.000+00:00 errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23T04:56:07.000+00:00 status: null pagination: offset: 0 limit: 1000 totalCount: 10000 SelfemployedInfo: required: - createdDate - selfemployed - status - updatedDate type: object properties: selfemployed: $ref: '#/components/schemas/Selfemployed' status: $ref: '#/components/schemas/SelfEmployedStatus' createdDate: type: string description: Дата и время обновления статуса самозанятого в системе format: date-time updatedDate: type: string description: Дата и время обновления статуса самозанятого в системе format: date-time errorRecord: minItems: 0 type: array description: Ошибки обработки записей списка items: $ref: '#/components/schemas/ErrorRecord_1_inner' description: Детальная информация о самозанятом example: selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru createdDate: 2000-01-23T04:56:07.000+00:00 errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23T04:56:07.000+00:00 status: null RequestSelfemployedVatin: required: - requestUniqueRights type: object properties: requestUniqueRights: type: boolean description: "Флаг проверки на уникальные права. `true` - запрашивается\ \ расширенный список прав с `TAX_PAYMENT`. `false` - запрашивается ста\ ндартный набор прав, без `TAX_PAYMENT`." example: true default: true TaxpayerAccountStatusRequest: required: - externalId - vatin type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" description: Запрос на получение информации о состоянии Лицевого счета НП НПД example: vatin: "112233445566" externalId: externalId TaxpayerAccountStatusResponse: type: object properties: bonusAmount: type: number description: Сумма бонусного счета example: 28.08 unpaidAmmount: type: number description: Общая сумма неоплаченных платежей example: 2916.5 debtAmount: type: number description: Сумма задолжности (включена в общая сумму неоплаченных платежей) example: 2916.5 description: Информация о состоянии Лицевого счета НП НПД example: unpaidAmmount: 2916.5 bonusAmount: 28.08 debtAmount: 2916.5 IncomeForPeriodRequest: required: - externalId - taxPeriodId - vatin type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string taxPeriodId: type: string description: ID налогового периода (YYYYMM) example: "202306" vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" description: Запрос на получение информации по доходу НП НПД за период example: vatin: "112233445566" taxPeriodId: "202306" externalId: externalId IncomeForPeriodResponse: type: object properties: status: type: string description: Статус запроса example: SUCCESS totalAmount: type: number description: Сумма зарегистрированного дохода за период example: 28.08 canceledTotalAmount: type: number description: Сумма сторнированного дохода за период example: 2916.5 tax: type: number description: Рассчитанный налог за период example: 2916.5 description: Информация по доходу НП НПД за период example: totalAmount: 28.08 canceledTotalAmount: 2916.5 tax: 2916.5 status: SUCCESS IncomeV2Request: required: - externalId - from - to - vatin type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" from: type: string description: "Дата, начиная с которой отображать зарегистрированные дохо\ ды" format: date-time example: 2023-06-30T00:00:00+03:00 to: type: string description: "Дата, до которой отображать зарегистрированные доходы" format: date-time example: 2023-06-30T23:59:59+03:00 pagination: $ref: '#/components/schemas/Pagination_2' description: Запрос на получение информации по зарегистрированным доходам с разбивкой по чекам example: vatin: "112233445566" pagination: offset: 0 limit: 1000 totalCount: 10000 externalId: externalId from: 2023-06-30T00:00:00+03:00 to: 2023-06-30T23:59:59+03:00 GetIncomeV2Response: type: object properties: receipts: type: array description: Список полученных чеков items: $ref: '#/components/schemas/ReceiptV2' description: Информации по зарегистрированным доходам с разбивкой по чекам example: receipts: - totalAmount: 25.04 customerVatin: customerVatin partnerCode: partnerCode incomeType: null cancelationTime: 2023-06-30T16:17:57.874Z taxPeriodId: "202306" link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print requestDate: 2023-06-30T16:17:57.874Z services: - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 receiptId: 200wr5cn4s operateDate: 2023-06-30T16:17:57.874Z taxToPay: 1.38 - totalAmount: 25.04 customerVatin: customerVatin partnerCode: partnerCode incomeType: null cancelationTime: 2023-06-30T16:17:57.874Z taxPeriodId: "202306" link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print requestDate: 2023-06-30T16:17:57.874Z services: - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 receiptId: 200wr5cn4s operateDate: 2023-06-30T16:17:57.874Z taxToPay: 1.38 ReceiptV2: type: object properties: receiptId: maxLength: 128 minLength: 1 type: string description: Идентификатор чека в ФНС example: 200wr5cn4s totalAmount: type: number description: Сумма чека example: 25.04 link: maxLength: 512 minLength: 1 type: string description: Ссылка на чек с сайта ФНС example: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print incomeType: $ref: '#/components/schemas/IncomeType_1' requestDate: type: string description: Дата запроса на формирование чека format: date-time example: 2023-06-30T16:17:57.874Z operateDate: type: string description: Дата расчета с самозаняты format: date-time example: 2023-06-30T16:17:57.874Z taxPeriodId: type: string description: "Налоговый период, в котором при расчете налога будет/был у\ чтен чек (формат, yyyyMM)" example: "202306" taxToPay: type: number description: Налог к уплате с данного чека (начисленный налог - использованный бонус) example: 1.38 partnerCode: type: string description: ID банка/платформы-партнера customerVatin: type: string description: ИНН поставщика данных(площадки третьего звена) cancelationTime: type: string description: Дата сторнирования format: date-time example: 2023-06-30T16:17:57.874Z services: type: array description: Список услуг items: $ref: '#/components/schemas/ReceiptV2_services_inner' description: Информация о выписанном чеке example: totalAmount: 25.04 customerVatin: customerVatin partnerCode: partnerCode incomeType: null cancelationTime: 2023-06-30T16:17:57.874Z taxPeriodId: "202306" link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print requestDate: 2023-06-30T16:17:57.874Z services: - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 receiptId: 200wr5cn4s operateDate: 2023-06-30T16:17:57.874Z taxToPay: 1.38 IncomeType_1: type: string description: | Тип дохода: * `FROM_INDIVIDUAL` - Доход от физического лица * `FROM_LEGAL_ENTITY` - Доход от юридического лица или ИП * `FROM_FOREIGN_AGENCY` - Доход от иностранной организации enum: - FROM_INDIVIDUAL - FROM_LEGAL_ENTITY - FROM_FOREIGN_AGENCY default: FROM_LEGAL_ENTITY AgreementPage: type: object properties: phone: pattern: "^79\\d{9}$" type: string description: Телефон example: "79130000011" activities: minItems: 1 type: array items: maxLength: 5 minLength: 1 type: string description: Идентификатор вида деятельности example: "17" regions: minItems: 1 type: array items: maxLength: 8 minLength: 8 type: string description: ОКТМО региона ведения деятельности example: "40000000" returnUrl: maxLength: 256 minLength: 1 type: string description: URL-адрес на который перенаправляется ФЛ после оформления соглашений description: Параметры генерации страницы онбординга для оформления самозанятым соглашений с Альфа-Банком example: regions: - "40000000" - "40000000" phone: "79130000011" activities: - "17" - "17" returnUrl: returnUrl AgreementPageUrl: required: - agreementPageId - agreementPageLink type: object properties: agreementPageId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string agreementPageLink: type: string description: Ссылка на страницу оформления соглашений example: https://alfabank.ru/agreement/97ae89a6-2813-4d4d-a2a6-4a10adba9e1f description: Результат генерации страницы онбординга по заданным параметрам example: agreementPageLink: https://alfabank.ru/agreement/97ae89a6-2813-4d4d-a2a6-4a10adba9e1f agreementPageId: agreementPageId Activities: minItems: 1 type: array description: Список видов деятельности items: $ref: '#/components/schemas/Activities_inner' Regions: minItems: 1 type: array description: Список регионов ведения деятельности items: $ref: '#/components/schemas/Regions_inner' SbpBanks: type: array items: $ref: '#/components/schemas/SbpBanks_inner' PoaNumber: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Номер МЧД example: e0b215fa-78eb-44ad-9fdb-08924ff64132 Vatin_1: maxLength: 12 minLength: 12 pattern: "^(([0-9]{10})|([0-9]{12}))?$" type: string description: ИНН самозанятого example: "112233445566" CreatePoaResponse: required: - requestUuid type: object properties: requestUuid: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Уникальный идентификатор запроса example: 6ce35d97-f061-4ecf-a333-c1da3d8d4618 description: Ответ на создание запроса выгрузки МЧД example: requestUuid: 6ce35d97-f061-4ecf-a333-c1da3d8d4618 requestUuid: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Уникальный идентификатор запроса example: 6ce35d97-f061-4ecf-a333-c1da3d8d4618 ErrorBadRequest_3: required: - error type: object properties: error: type: string description: Код ошибки example: invalid_request error_description: type: string description: | Возможные описания ошибки: * `Authorization header is not present in request headers` - Неверные входные параметры запроса; * `INN size must be between 10 and 15` - Неверная длина номера ИНН; * `Invalid UUID string` - Неверный формат номера МЧД; example: Invalid UUID string enum: - Authorization header is not present in request headers - INN size must be between 10 and 15 - Invalid UUID string description: Неверные входные параметры запроса GetPoaRequestStatusResponse: required: - detailedPoa - downloadingStatus - requestUuid type: object properties: requestUuid: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Уникальный идентификатор запроса example: 6ce35d97-f061-4ecf-a333-c1da3d8d4618 downloadingStatus: type: string description: | Статус запроса: * `PENDING` - Незавершенный; * `FAILED` - Неудачный; * `TIMEOUT` - Превысил время ожидания; * `COMPLETE` - Завершенный. example: COMPLETE enum: - PENDING - FAILED - TIMEOUT - COMPLETE detailedPoa: $ref: '#/components/schemas/DetailedPoa' description: Ответ на получение статуса запроса выгрузки МЧД example: requestUuid: 6ce35d97-f061-4ecf-a333-c1da3d8d4618 detailedPoa: number: e0b215fa-78eb-44ad-9fdb-08924ff64132 inn: "112233445566" downloadingStatus: COMPLETE DetailedPoa: required: - inn - number type: object properties: number: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Номер МЧД example: e0b215fa-78eb-44ad-9fdb-08924ff64132 inn: maxLength: 12 minLength: 12 pattern: "^(([0-9]{10})|([0-9]{12}))?$" type: string description: ИНН самозанятого example: "112233445566" description: Информация о МЧД example: number: e0b215fa-78eb-44ad-9fdb-08924ff64132 inn: "112233445566" RequestPoaNotFound: required: - error type: object properties: error: type: string description: Код ошибки example: entity_not_found error_description: type: string example: Detail POA with requestUuid=3e2af6ad-2eee-4687-a391-eb07ebfc0719 was not found. description: Идентификатор запроса для получения детальной МЧД не найден RequestDownloadError: required: - error type: object properties: error: type: string description: Код ошибки example: entity_not_found error_description: type: string description: | Возможные описания ошибки: * `Request(UUID: b15b88b2-b646-4ee6-b537-46e73d0b969d) for retrieving detailed POA not found` - requestUuid не найден; * `Poa file path not found, historyId: 4077, format: ZIP` - requestUuid не в статусе "Complete" example: "Request(UUID: b15b88b2-b646-4ee6-b537-46e73d0b969d) for retrieving\ \ detailed POA not found" enum: - "Request(UUID: b15b88b2-b646-4ee6-b537-46e73d0b969d) for retrieving detailed\ \ POA not found" - "Poa file path not found, historyId: 4077, format: ZIP" description: Идентификатор запроса для выгрузки МЧД не найден GetPoaStatusResponse: required: - endDate - id - issuerPublicKey - poaNumber - startDate - status type: object properties: id: type: string description: Хеш доверенности poaNumber: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Номер МЧД example: e0b215fa-78eb-44ad-9fdb-08924ff64132 startDate: type: string description: Дата начала действия доверенности format: date endDate: type: string description: Дата завершения действия доверенности format: date status: type: string description: | Статус доверенности: * `ACTIVE` - Активна; * `EXPIRED` - Истекла; * `REVOKED` - Аннулирована. issuerPublicKey: type: string description: Публичный ключ эмитента доверенности description: Ответ на запрос статуса МЧД example: endDate: 2000-01-23 poaNumber: e0b215fa-78eb-44ad-9fdb-08924ff64132 issuerPublicKey: issuerPublicKey id: id startDate: 2000-01-23 status: status PoaNotFound: required: - error type: object properties: error: type: string description: Код ошибки example: entity_not_found error_description: type: string example: Power of attorney with number e0b215fa-78eb-44ad-9fdb-08924ff64132 not found. description: Номер МЧД не найден GetAccounts: type: array items: $ref: '#/components/schemas/GetAccounts_inner' UUID_2: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 RequestResponse: required: - requestId - status type: object properties: requestId: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 status: $ref: '#/components/schemas/RequestStatus' example: requestId: ab9cbb96-360a-4462-a683-955cc29f7f54 status: null RequestStatus: type: string description: | Статус запроса: * `PENDING` - запрос в процессе обработки; * `FAILED` - обработка запроса завершилась ошибкой; * `COMPLETE` - обработка запроса завершилась успешно. enum: - PENDING - FAILED - COMPLETE BeneficiaryType: type: string description: | Тип бенефициара: * `FL_RESIDENT` - Физ. лицо, резидент; * `UL_RESIDENT` - Юр. лицо, резидент. enum: - FL_RESIDENT - UL_RESIDENT Date: type: string description: Дата format: date example: 2024-01-01 BeneficiaryListResponse: anyOf: - $ref: '#/components/schemas/BeneficiaryFlResidentResponse' - $ref: '#/components/schemas/BeneficiaryUlResidentResponse' BeneficiaryFlResidentResponse: required: - accountNumber - addresses - beneficiaryId - documents - isActive - isBeneficiary - isVpr - personalInformation - type type: object properties: beneficiaryId: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" isBeneficiary: type: boolean description: | Признак бенефициара: * `true` - является бенефициаром; * `false` - является универсальным реципиентом. isVpr: type: boolean description: | Признак ВПР: * `true` - является выгодоприобретателем; * `false` - не является выгодоприобретателем. type: $ref: '#/components/schemas/BeneficiaryType' personalInformation: $ref: '#/components/schemas/PersonalInformation_2' phoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru addresses: minItems: 1 type: array description: Адреса items: $ref: '#/components/schemas/Address_1' documents: minItems: 1 type: array description: Документы items: $ref: '#/components/schemas/Passport_1' isActive: type: boolean description: | Признак активности бенефициара: * `true` - активен; * `false` - деактивирован. PersonalInformation_2: required: - citizenship - firstName - lastName - snils - vatin type: object properties: vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН example: "112233445566" firstName: maxLength: 64 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string description: Имя example: Иван middleName: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string description: Отчество example: Иванoвич lastName: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string description: Фамилия example: Иванов citizenship: $ref: '#/components/schemas/Citizenship_1' birthDate: type: string description: Дата format: date example: 2024-01-01 birthPlace: maxLength: 128 minLength: 1 type: string description: Место рождения example: Г. Иркутск snils: pattern: "^(\\d{11})$" type: string description: СНИЛС description: Персональные данные Citizenship_1: type: string description: | Гражданство: * `RU` - РФ enum: - RU PhoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" Email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru Address_1: required: - address - type type: object properties: type: type: string description: | Тип адреса: * `REGISTRATION_ADDRESS` - адрес регистрации; * `LEGAL_ENTITY_ADDRESS` - адрес Юр.лица. enum: - REGISTRATION_ADDRESS - LEGAL_ENTITY_ADDRESS address: type: string description: Адрес description: Адрес бенефициара Passport_1: required: - division - issueDate - number - organization - serial - type type: object properties: type: $ref: '#/components/schemas/DocumentType' serial: pattern: "^\\d{4}$" type: string description: Серия паспорта РФ example: "6953" number: pattern: "^\\d{6}$" type: string description: Номер паспорта РФ example: "987435" issueDate: type: string description: Дата format: date example: 2024-01-01 division: pattern: "^\\d{3}-\\d{3}$" type: string description: "Код подразделения, выдавшего паспорт" example: 123-321 organization: maxLength: 128 minLength: 1 type: string description: "Орган, выдавший документ" example: ОВД Иркутской области по Г. Иркутску по Октябрьскому району description: Паспорт гражданина РФ. Передается если `citizenship` равен `RU` DocumentType: type: string description: Тип документа enum: - PASSPORT BeneficiaryUlResidentResponse: required: - accountNumber - addresses - beneficiaryId - isActive - isBeneficiary - isVpr - name - ogrn - registrationDate - type - vatin type: object properties: beneficiaryId: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" isBeneficiary: type: boolean description: | Признак бенефициара: * `true` - является бенефициаром; * `false` - является универсальным реципиентом. isVpr: type: boolean description: | Признак ВПР: * `true` - является выгодоприобретателем; * `false` - не является выгодоприобретателем. type: $ref: '#/components/schemas/BeneficiaryType' name: type: string description: Наименование организации phoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru addresses: type: array description: Адреса items: $ref: '#/components/schemas/Address_1' registrationDate: type: string description: Дата format: date example: 2024-01-01 vatin: pattern: "^(\\d{10})$" type: string description: ИНН ogrn: pattern: "^(\\d{13})$" type: string description: Основной государственный регистрационный номер isActive: type: boolean description: | Признак активности бенефициара: * `true` - активен; * `false` - деактивирован. BeneficiaryRequest: oneOf: - $ref: '#/components/schemas/BeneficiaryFlResidentRequest' - $ref: '#/components/schemas/BeneficiaryUlResidentRequest' BeneficiaryFlResidentRequest: required: - accountNumber - digestSignatures - isBeneficiary - type type: object properties: accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" isBeneficiary: type: boolean description: | Признак бенефициара: * `true` - является бенефициаром; * `false` - является универсальным реципиентом. type: $ref: '#/components/schemas/BeneficiaryType' personalInformation: $ref: '#/components/schemas/PersonalInformation_2' phoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru addresses: minItems: 1 type: array description: Адреса items: $ref: '#/components/schemas/Address_1' documents: minItems: 1 type: array description: Документы items: $ref: '#/components/schemas/Passport_1' digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' DigestSignatures_2: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' BeneficiaryUlResidentRequest: required: - accountNumber - digestSignatures - isBeneficiary - type type: object properties: accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" isBeneficiary: type: boolean description: | Признак бенефициара: * `true` - является бенефициаром; * `false` - является универсальным реципиентом. type: $ref: '#/components/schemas/BeneficiaryType' name: type: string description: Наименование организации phoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru addresses: type: array description: Адреса items: $ref: '#/components/schemas/Address_1' registrationDate: type: string description: Дата format: date example: 2024-01-01 vatin: pattern: "^(\\d{10})$" type: string description: ИНН ogrn: pattern: "^(\\d{13})$" type: string description: Основной государственный регистрационный digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' BeneficiaryResponse: oneOf: - $ref: '#/components/schemas/BeneficiaryFlResidentResponse' - $ref: '#/components/schemas/BeneficiaryUlResidentResponse' ChangeBeneficiaryRequest: oneOf: - $ref: '#/components/schemas/ChangeBeneficiaryFlResidentRequest' - $ref: '#/components/schemas/ChangeBeneficiaryUlResidentRequest' ChangeBeneficiaryFlResidentRequest: required: - digestSignatures - type type: object properties: type: $ref: '#/components/schemas/BeneficiaryType' personalInformation: $ref: '#/components/schemas/EditablePersonalInformation' phoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru addresses: minItems: 1 type: array description: Адреса items: $ref: '#/components/schemas/Address_1' documents: minItems: 1 type: array description: Документы items: $ref: '#/components/schemas/Passport_1' isActive: type: boolean description: Признак активности бенефициара digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' EditablePersonalInformation: type: object properties: firstName: maxLength: 64 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string description: Имя example: Иван middleName: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string description: Отчество example: Иванoвич lastName: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+][^0-9!\\@#$%^&*()_+=\\[\\]{};':\"~`±§\\\\|,.<>\\\ /\\n\\t?a-zA-Z]*$" type: string description: Фамилия example: Иванов birthDate: type: string description: Дата format: date example: 2024-01-01 birthPlace: maxLength: 128 minLength: 1 type: string description: Место рождения example: Г. Иркутск ChangeBeneficiaryUlResidentRequest: required: - digestSignatures - type type: object properties: type: $ref: '#/components/schemas/BeneficiaryType' name: type: string description: Наименование организации phoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" email: maxLength: 136 minLength: 6 pattern: "^[a-zA-Z0-9_\\-\\.]{1,64}@[a-zA-Z0-9_-]{1,64}\\.[a-zA-Z]{2,6}$" type: string description: Адрес электронной почты example: IvanovIvan@mail.ru addresses: type: array description: Адреса items: $ref: '#/components/schemas/Address_1' registrationDate: type: string description: Дата format: date example: 2024-01-01 isActive: type: boolean description: Признак активности бенефициара digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' RequisiteRequest: oneOf: - $ref: '#/components/schemas/AccountRequest' - $ref: '#/components/schemas/PhoneRequest' - $ref: '#/components/schemas/PanRequest' AccountRequest: required: - accountNumber - bik - digestSignatures - type type: object properties: type: $ref: '#/components/schemas/RequisiteType' accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" bik: pattern: "^([0-9]{9})$" type: string description: БИК банка example: "044525593" isMain: type: boolean description: "Признак основного платежных реквизитов бенефициара. По умо\ лчанию для первых добавленных реквизитов — `true`, для следующих — `false`." digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' RequisiteType: type: string description: "Тип платежного реквизита: * `ACCOUNT_NUMBER` - реквизиты счета\ ; * `CARD_NUMBER` - номер карты (токен); * `PHONE_NUMBER` - номер телефона\ ." enum: - ACCOUNT_NUMBER - PHONE_NUMBER - CARD_NUMBER Bik: pattern: "^([0-9]{9})$" type: string description: БИК банка example: "044525593" PhoneRequest: required: - digestSignatures - phoneNumber - type type: object properties: type: $ref: '#/components/schemas/RequisiteType' phoneNumber: pattern: "^(\\79)([0-9]{9})$" type: string description: Телефон example: "79130000011" isMain: type: boolean description: "Признак основного платежных реквизитов бенефициара. По умо\ лчанию для первых добавленных реквизитов — `true`, для следующих — `false`." digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' PanRequest: required: - pan - type type: object properties: type: $ref: '#/components/schemas/RequisiteType' pan: type: string description: Токен номера карты example: wS7fElYo8VWeJ8KelaJ0XA== isMain: type: boolean description: "Признак основного платежных реквизитов бенефициара. По умо\ лчанию для первых добавленных реквизитов — `true`, для следующих — `false`." digestSignatures: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/DigestSignatures_2_inner' PanNumber: type: string description: Токен номера карты example: wS7fElYo8VWeJ8KelaJ0XA== RequisiteResponse: oneOf: - $ref: '#/components/schemas/AccountResponse_1' - $ref: '#/components/schemas/PhoneResponse' - $ref: '#/components/schemas/PanResponse' AccountResponse_1: required: - id - isActive - isMain type: object properties: id: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 isMain: type: boolean description: | Признак основных реквизитов: * `true` - основные; * `false` - не основные. isActive: type: boolean description: | Признак активности реквизитов: * `true` - активны; * `false` - деактивированы. PhoneResponse: required: - id - isActive - isMain type: object properties: id: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 isMain: type: boolean description: | Признак основных реквизитов: * `true` - основные; * `false` - не основные. isActive: type: boolean description: | Признак активности реквизитов: * `true` - активны; * `false` - деактивированы. PanResponse: required: - id - isActive - isMain type: object properties: id: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 isMain: type: boolean description: | Признак основных реквизитов: * `true` - основные; * `false` - не основные. isActive: type: boolean description: | Признак активности реквизитов: * `true` - активны; * `false` - деактивированы. RequisiteSignRequest: type: object properties: isMain: type: boolean description: | Признак основных реквизитов: * `true` - основные; * `false` - не основные. isActive: type: boolean description: | Признак активности реквизитов: * `true` - активны; * `false` - деактивированы. example: isMain: true isActive: true BalanceResponse: required: - accountNumber - balance - beneficiaryId - date type: object properties: beneficiaryId: type: string description: Уникальный идентификатор format: uuid example: ab9cbb96-360a-4462-a683-955cc29f7f54 accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" date: type: string description: Дата format: date example: 2024-01-01 balance: type: string description: Сумма example: "10.00" example: date: 2024-01-01T00:00:00.000+00:00 balance: "10.00" accountNumber: "40817810306050000000" beneficiaryId: ab9cbb96-360a-4462-a683-955cc29f7f54 Amount_1: type: string description: Сумма example: "10.00" Accounts_1: title: Счета required: - accounts type: object properties: accounts: title: Массив счетов type: array items: $ref: '#/components/schemas/Account_2' default: [] example: accounts: - number: number dateCreated: 2000-01-23 balance: amount: 1 holds: 6 currency: currency minorUnits: 0 mnemonic: mnemonic typeDescription: typeDescription type: type status: null - number: number dateCreated: 2000-01-23 balance: amount: 1 holds: 6 currency: currency minorUnits: 0 mnemonic: mnemonic typeDescription: typeDescription type: type status: null Account_2: title: Объект счёта required: - balance - dateCreated - mnemonic - number - status - type type: object properties: mnemonic: type: string description: Наименование счёта number: type: string description: Номер счёта type: type: string description: Тип счёта typeDescription: type: string description: Описание типа счёта status: $ref: '#/components/schemas/AccountStatus_1' dateCreated: type: string description: Дата открытия счёта format: date balance: $ref: '#/components/schemas/AccountBalance' example: number: number dateCreated: 2000-01-23 balance: amount: 1 holds: 6 currency: currency minorUnits: 0 mnemonic: mnemonic typeDescription: typeDescription type: type status: null AccountStatus_1: title: Статус счёта type: string enum: - ACTIVE - INACTIVE AccountBalance: title: Баланс счёта required: - amount - currency - holds - minorUnits type: object properties: currency: type: string description: Валюта счёта (ISO 4217 Code) minorUnits: type: integer description: Количество минорных единиц holds: type: integer description: Сумма холдов (резервов) в минорных единицах format: int64 amount: type: integer description: Сумма денежных средств в минорных единицах format: int64 example: amount: 1 holds: 6 currency: currency minorUnits: 0 AccountRequisites: title: Реквизиты счёта required: - accountNumber - bankName - clientInfo type: object properties: clientInfo: $ref: '#/components/schemas/ClientInfo_1' accountNumber: type: string description: Номер счёта клиента bankName: type: string description: Полное наименование Банка bic: type: string description: БИК Банка inn: type: string description: ИНН Банка kpp: type: string description: КПП Банка swift: type: string description: SWIFT код Банка correspondentAccountNumber: type: string description: Корреспондентский счёт correspondentBanks: type: array description: Массив банков-корреспондентов (для SWIFT переводов) items: $ref: '#/components/schemas/CorrespondentBank' example: correspondentBanks: - correspondentBankAccountNumber: correspondentBankAccountNumber correspondentBankName: correspondentBankName correspondentSwift: correspondentSwift - correspondentBankAccountNumber: correspondentBankAccountNumber correspondentBankName: correspondentBankName correspondentSwift: correspondentSwift inn: inn correspondentAccountNumber: correspondentAccountNumber clientInfo: translitFirstName: translitFirstName firstName: firstName lastName: lastName translitPatronymicName: translitPatronymicName patronymicName: patronymicName translitLastName: translitLastName bankName: bankName kpp: kpp accountNumber: accountNumber bic: bic swift: swift ClientInfo_1: title: Информация по клиенту required: - firstName - lastName type: object properties: firstName: type: string description: Имя lastName: type: string description: Фамилия patronymicName: type: string description: Отчество translitFirstName: type: string description: Транслитерация имени (для валютных счетов) translitLastName: type: string description: Транслитерация фамилии (для валютных счетов) translitPatronymicName: type: string description: Транслитерация отчества (для валютных счетов) example: translitFirstName: translitFirstName firstName: firstName lastName: lastName translitPatronymicName: translitPatronymicName patronymicName: patronymicName translitLastName: translitLastName CorrespondentBank: title: Банк-корреспондент required: - correspondentBankAccountNumber - correspondentSwift type: object properties: correspondentBankAccountNumber: type: string description: Номер счёта в Банке-корреспонденте correspondentBankName: type: string description: Полное наименование Банка-корреспондента correspondentSwift: type: string description: SWIFT-код Банка-корреспондента example: correspondentBankAccountNumber: correspondentBankAccountNumber correspondentBankName: correspondentBankName correspondentSwift: correspondentSwift Cards: title: Карты required: - cards type: object properties: cards: title: Массив карт type: array items: $ref: '#/components/schemas/Card' default: [] example: cards: - paymentSystem: paymentSystem typeDescription: typeDescription type: type title: title isCredit: true maskedNumber: maskedNumber isPrimary: true cardId: cardId isVirtual: true state: isClosed: true isBlocked: true isActive: true isPinInstalled: true issueDate: 2000-01-23 account: number: number status: status expirationDate: expirationDate - paymentSystem: paymentSystem typeDescription: typeDescription type: type title: title isCredit: true maskedNumber: maskedNumber isPrimary: true cardId: cardId isVirtual: true state: isClosed: true isBlocked: true isActive: true isPinInstalled: true issueDate: 2000-01-23 account: number: number status: status expirationDate: expirationDate Card: title: Объект карты required: - account - cardId - expirationDate - isCredit - isPrimary - isVirtual - issueDate - maskedNumber - paymentSystem - state - status - type - typeDescription type: object properties: cardId: type: string description: Идентификатор карты maskedNumber: type: string description: Маскированный номер карты type: type: string description: Тип карты typeDescription: type: string description: Тип продукта карты status: type: string description: Статус карты issueDate: type: string description: Дата выпуска карты format: date expirationDate: type: string description: Срок действия карты format: year-month title: type: string description: Наименование карты isPrimary: type: boolean description: Признак основной карты isVirtual: type: boolean description: Признак виртуальной карты isCredit: type: boolean description: Признак кредитной карты account: $ref: '#/components/schemas/CardAccount' paymentSystem: type: string state: $ref: '#/components/schemas/CardState' example: paymentSystem: paymentSystem typeDescription: typeDescription type: type title: title isCredit: true maskedNumber: maskedNumber isPrimary: true cardId: cardId isVirtual: true state: isClosed: true isBlocked: true isActive: true isPinInstalled: true issueDate: 2000-01-23 account: number: number status: status expirationDate: expirationDate CardAccount: title: Счет карты required: - number type: object properties: number: type: string description: Номер счёта к которому привязана карта example: number: number CardState: type: object properties: isActive: type: boolean isBlocked: type: boolean isClosed: type: boolean isPinInstalled: type: boolean example: isClosed: true isBlocked: true isActive: true isPinInstalled: true CardActions: required: - actions type: object properties: actions: type: array items: $ref: '#/components/schemas/CardAction' default: [] example: actions: - available: true actionId: null title: title - available: true actionId: null title: title CardAction: required: - actionId type: object properties: actionId: $ref: '#/components/schemas/CardActionId' title: type: string available: type: boolean example: available: true actionId: null title: title CardActionId: type: string enum: - CARD_BLOCK - CARD_UNBLOCK - CARD_PIN_CHANGE CardActionConfirmBody: required: - actionId - password - reference type: object properties: actionId: $ref: '#/components/schemas/CardActionId' password: type: string reference: type: string example: reference: reference password: password actionId: null CardActionCreateBody: required: - actionId type: object properties: actionId: $ref: '#/components/schemas/CardActionId' example: actionId: null CardActionCreateResponse: required: - auth - passwordLength - reference type: object properties: reference: type: string auth: $ref: '#/components/schemas/BlockActionConfirmationType' passwordLength: type: integer example: reference: reference auth: null passwordLength: 0 BlockActionConfirmationType: type: string enum: - SMSPWD - AM Tariffs: title: Тарифы по карте required: - conditions type: object properties: conditions: $ref: '#/components/schemas/CardConditions' example: conditions: isSalaryCard: true isCombo: true cardServiceFee: fee: 0.8008281904610115 feePeriod: null CardConditions: title: Условия обслуживания по карте required: - cardServiceFee type: object properties: cardServiceFee: $ref: '#/components/schemas/CardServiceFee' isSalaryCard: type: boolean description: Признак зарплатной карты isCombo: type: boolean description: Признак комбинированной карты example: isSalaryCard: true isCombo: true cardServiceFee: fee: 0.8008281904610115 feePeriod: null CardServiceFee: title: Комиссия за обслуживание required: - fee - feePeriod type: object properties: fee: type: number description: Размер комиссии feePeriod: $ref: '#/components/schemas/FeePeriod' example: fee: 0.8008281904610115 feePeriod: null FeePeriod: title: Тип комиссии за обслуживание type: string enum: - MONTHLY - YEARLY Subscriptions: title: Уведомления по операциям required: - subscriptionCard - subscriptionTariffs type: object properties: subscriptionCard: $ref: '#/components/schemas/SubscriptionCard' subscriptionTariffs: title: Список тарифов на услугу Альфа-чек доступных пользователю type: array items: $ref: '#/components/schemas/SubscriptionTariff' default: [] example: subscriptionCard: type: type ips: ips subscriptionTariffs: - isContactPhoneRequired: true name: name isSelected: true id: id priceAmount: "{}" - isContactPhoneRequired: true name: name isSelected: true id: id priceAmount: "{}" SubscriptionCard: title: Информация о карте required: - ips - type type: object properties: ips: type: string description: Название карты в рамках ips (международной системы платежей) type: type: string description: Тип карты example: type: type ips: ips SubscriptionTariffs: title: Список тарифов на услугу Альфа-чек доступных пользователю type: array items: $ref: '#/components/schemas/SubscriptionTariff' default: [] SubscriptionTariff: title: Тариф на услугу Альфа-чек required: - id - isContactPhoneRequired - isSelected - name type: object properties: id: type: string description: Идентификатор тарифа name: type: string description: Наименование тарифа priceAmount: title: Стоимость тарифа type: object format: commons.Amount isSelected: type: boolean description: Признак выбора тарифа isContactPhoneRequired: type: boolean description: Признак необходимости указания номера телефона example: isContactPhoneRequired: true name: name isSelected: true id: id priceAmount: "{}" OperationsHistory: title: История операций required: - operations type: object properties: operations: title: Массив операций type: array items: $ref: '#/components/schemas/OperationHistoryItem' default: [] example: operations: - dateTime: 2000-01-23T04:56:07.000+00:00 amount: "{}" loyalty: amount: "{}" title: title percent: 0.8008281904610115 fee: 6.027456183070403 isAnotherClient: false terminal: number: number city: city countryCode: countryCode name: name title: title mcc: mcc type: type cashout: false reference: reference sender: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName accountNumber: accountNumber maskedCardNumber: maskedCardNumber recipient: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName comment: comment id: id category: name: name id: id direction: null status: null - dateTime: 2000-01-23T04:56:07.000+00:00 amount: "{}" loyalty: amount: "{}" title: title percent: 0.8008281904610115 fee: 6.027456183070403 isAnotherClient: false terminal: number: number city: city countryCode: countryCode name: name title: title mcc: mcc type: type cashout: false reference: reference sender: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName accountNumber: accountNumber maskedCardNumber: maskedCardNumber recipient: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName comment: comment id: id category: name: name id: id direction: null status: null OperationHistoryItem: title: Объект с информацией по операции required: - amount - cashout - dateTime - direction - fee - id - isAnotherClient - title type: object properties: id: type: string description: Идентификатор операции dateTime: type: string description: Дата и время операции format: date-time title: type: string description: Заголовок операции amount: title: Сумма операции type: object description: Сумма операции format: commons.Amount comment: type: string description: Комментарий к операции mcc: type: string description: MCC код операции category: $ref: '#/components/schemas/OperationCategory' direction: $ref: '#/components/schemas/OperationDirection' loyalty: $ref: '#/components/schemas/OperationLoyalty' status: $ref: '#/components/schemas/OperationStatus' type: type: string description: Тип операции terminal: $ref: '#/components/schemas/SellingPointTerminal' sender: $ref: '#/components/schemas/OperationSender' recipient: $ref: '#/components/schemas/OperationRecipient' fee: type: number description: Комиссия по операции reference: type: string description: Поле для связки сопоставления поля умной шины NIMB и сервиса LOYALTY STATEMENT API isAnotherClient: type: boolean description: "Признак того, что операция выполнена другим клиентом" default: false cashout: type: boolean description: Признак снятия наличности в банкомате default: false example: dateTime: 2000-01-23T04:56:07.000+00:00 amount: "{}" loyalty: amount: "{}" title: title percent: 0.8008281904610115 fee: 6.027456183070403 isAnotherClient: false terminal: number: number city: city countryCode: countryCode name: name title: title mcc: mcc type: type cashout: false reference: reference sender: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName accountNumber: accountNumber maskedCardNumber: maskedCardNumber recipient: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName comment: comment id: id category: name: name id: id direction: null status: null OperationCategory: title: Объект программы лояльности required: - id - name type: object properties: id: type: string description: Идентификатор категории name: type: string description: Наименование категории example: name: name id: id OperationDirection: title: Направление движения денежных средств type: string description: "Направление движения денежных средств: INCOME - приход/пополне\ ние, EXPENSE - расход/списание" enum: - EXPENSE - INCOME OperationLoyalty: title: Объект программы лояльности type: object properties: title: type: string description: Заголовок бонусной программы / программы лояльности percent: type: number description: Процент от суммы amount: title: Сумма по программе type: object description: Сумма по программе format: commons.Amount example: amount: "{}" title: title percent: 0.8008281904610115 OperationStatus: title: Статус операции type: string description: "Статус операции: null - входящая операция или статус не опреде\ лен SUCCESS - операция выполнена успешна HOLD - операция в обработке FAILED\ \ - операция не выполнена" enum: - HOLD - SUCCESS - FAILED SellingPointTerminal: title: Объект терминал точки продаж type: object properties: number: type: string description: Номер терминала точки продаж name: type: string description: Имя точки продаж city: type: string description: Город точки продаж (код) countryCode: type: string description: Страна точки продаж (код) example: number: number city: city countryCode: countryCode name: name OperationSender: title: Объект отправитель перевода type: object properties: name: type: string description: Отправитель перевода accountNumber: type: string description: Номер счёта отправителья перевода / клиента bankBik: type: string description: БИК банка отправителя bankName: type: string description: Название банка отправителя phoneNumber: type: string description: Номер телефона отправителя maskedCardNumber: type: string description: Номер карты (маскированный) отправителя example: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName accountNumber: accountNumber maskedCardNumber: maskedCardNumber OperationRecipient: title: Объект получатель перевода type: object properties: name: type: string description: Получатель перевода bankBik: type: string description: БИК банка получателя bankName: type: string description: Название банка получателя phoneNumber: type: string description: Номер телефона получателя example: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName OperationDetails: title: Объект с информацией по операции required: - amount - cashout - dateTime - direction - fee - id - isAnotherClient - title type: object properties: id: type: string description: Идентификатор операции dateTime: type: string description: Дата и время операции format: date-time title: type: string description: Заголовок операции amount: title: Сумма операции type: object description: Сумма операции format: commons.Amount comment: type: string description: Комментарий к операции mcc: type: string description: MCC код операции category: $ref: '#/components/schemas/OperationCategory' direction: $ref: '#/components/schemas/OperationDirection' loyalty: $ref: '#/components/schemas/OperationLoyalty' status: $ref: '#/components/schemas/OperationStatus' type: type: string description: Тип операции terminal: $ref: '#/components/schemas/SellingPointTerminal' sender: $ref: '#/components/schemas/OperationSender' recipient: $ref: '#/components/schemas/OperationRecipient' fee: type: number description: Комиссия по операции reference: type: string description: Поле для связки сопоставления поля умной шины NIMB и сервиса LOYALTY STATEMENT API isAnotherClient: type: boolean description: "Признак того, что операция выполнена другим клиентом" default: false cashout: type: boolean description: Признак снятия наличности в банкомате default: false example: dateTime: 2000-01-23T04:56:07.000+00:00 amount: "{}" loyalty: amount: "{}" title: title percent: 0.8008281904610115 fee: 0.8008281904610115 isAnotherClient: false terminal: number: number city: city countryCode: countryCode name: name title: title mcc: mcc type: type cashout: false reference: reference sender: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName accountNumber: accountNumber maskedCardNumber: maskedCardNumber recipient: bankBik: bankBik phoneNumber: phoneNumber name: name bankName: bankName comment: comment id: id category: name: name id: id direction: null status: null AccountReportRequest: required: - accountIds - dateBegin - dateEnd type: object properties: accountIds: type: array description: "Массив выбранных счетов, по которым заказывается справка" items: type: string default: [] dateBegin: type: string format: date dateEnd: type: string format: date example: dateBegin: 2000-01-23 accountIds: - accountIds - accountIds dateEnd: 2000-01-23 AccountIds: type: array description: "Массив выбранных счетов, по которым заказывается справка" items: type: string default: [] Report: required: - date - id - status - type type: object properties: id: type: string description: Идентификатор отчета example: 62c4f39c5f1503000128a5e2 date: type: string description: Дата формирования объекта заказа format: date-time type: $ref: '#/components/schemas/Report_type' status: $ref: '#/components/schemas/Report_status' description: Объект справки example: date: 2000-01-23T04:56:07.000+00:00 id: 62c4f39c5f1503000128a5e2 type: code: code description: description title: title status: code: NEW title: title CreditProductReportRequest: required: - accountIds - dateBegin - dateEnd - operationsHistory type: object properties: accountIds: type: array description: "Массив выбранных счетов, по которым заказывается справка" items: type: string default: [] dateBegin: type: string format: date dateEnd: type: string format: date agreementNumber: type: string description: Номер кредитного договора example: F0TCRC20S19031508353 operationsHistory: type: boolean description: Детальная информация по депозиту example: true example: dateBegin: 2000-01-23 accountIds: - accountIds - accountIds operationsHistory: true dateEnd: 2000-01-23 agreementNumber: F0TCRC20S19031508353 AccountBalanceEngReportRequest: required: - accountIds type: object properties: accountIds: type: array description: "Массив выбранных счетов, по которым заказывается справка" items: type: string default: [] customNameTranscription: type: string example: accountIds: - accountIds - accountIds customNameTranscription: customNameTranscription AccountBalanceRurReportRequest: required: - accountIds type: object properties: accountIds: type: array description: "Массив выбранных счетов, по которым заказывается справка" items: type: string default: [] example: accountIds: - accountIds - accountIds DepositReportRequest: required: - accountIds type: object properties: accountIds: type: array description: "Массив выбранных счетов, по которым заказывается справка" items: type: string default: [] example: accountIds: - accountIds - accountIds Limits: title: Лимиты required: - day - month - oneTime type: object properties: oneTime: type: object additionalProperties: $ref: '#/components/schemas/Section' description: Единовременно day: type: object additionalProperties: $ref: '#/components/schemas/Section' description: В день month: type: object additionalProperties: $ref: '#/components/schemas/Section' description: В месяц example: month: key: title: title limits: key: rest: "{}" max: "{}" isPersonal: true title: title type: null turnover: "{}" oneTime: key: title: title limits: key: rest: "{}" max: "{}" isPersonal: true title: title type: null turnover: "{}" day: key: title: title limits: key: rest: "{}" max: "{}" isPersonal: true title: title type: null turnover: "{}" Section: title: Группа лимитов required: - limits - title type: object properties: title: type: string description: Название limits: type: object additionalProperties: $ref: '#/components/schemas/Limit' example: title: title limits: key: rest: "{}" max: "{}" isPersonal: true title: title type: null turnover: "{}" Limit: title: Лимит required: - isPersonal - max - rest - title - turnover - type type: object properties: title: type: string description: Название max: title: Максимум type: object format: commons-AmountDto rest: title: Остаток type: object format: commons-AmountDto turnover: title: Оборот type: object format: commons-AmountDto type: $ref: '#/components/schemas/LimitType' isPersonal: type: boolean description: Признак персонального лимита example: rest: "{}" max: "{}" isPersonal: true title: title type: null turnover: "{}" LimitType: title: Тип лимита type: string enum: - UNLIMITED - GENERAL - NON_RENEWABLE UserLimitsGetResponse: required: - limits type: object properties: limits: type: array items: $ref: '#/components/schemas/UserLimit' example: limits: - null - null UserLimit: allOf: - $ref: '#/components/schemas/UserLimitSeed' - $ref: '#/components/schemas/UserLimit_allOf' UserLimitSeed: type: object properties: activity: $ref: '#/components/schemas/Activity' validity: $ref: '#/components/schemas/Validity' coveredOperations: type: array items: $ref: '#/components/schemas/CoveredOperation' limits: $ref: '#/components/schemas/LimitValues' example: activity: from: 2000-01-23 to: 2000-01-23 coveredOperations: - null - null validity: null limits: single: "{}" rest: "{}" max: "{}" turnover: "{}" Activity: required: - from - to type: object properties: from: type: string format: date x-alfa-constraints: jsonFormat: pattern: dd-MM-yyyy to: type: string format: date x-alfa-constraints: jsonFormat: pattern: dd-MM-yyyy example: from: 2000-01-23 to: 2000-01-23 Validity: type: string enum: - wholePeriod - daily - weekly - monthly CoveredOperations: type: array items: $ref: '#/components/schemas/CoveredOperation' CoveredOperation: type: string enum: - allDebits - onlineShopping - cashWithdrawals LimitValues: required: - max - single type: object properties: single: type: object format: commons-AmountDto max: type: object format: commons-AmountDto rest: type: object format: commons-AmountDto turnover: type: object format: commons-AmountDto description: "Значение на одну операцию,максимальное значение, остаток и обо\ рот за период" example: single: "{}" rest: "{}" max: "{}" turnover: "{}" CountriesRestrictions: type: object properties: restrictionType: $ref: '#/components/schemas/RestrictionType' list: type: array items: $ref: '#/components/schemas/Country' RestrictionType: type: string enum: - all - including - excluding Country: type: object properties: isoCode: type: string description: type: string UserLimitId: required: - id type: object properties: id: type: integer example: id: 0 LoyaltyAccount: title: Бонусный счёт required: - accountNumber - typeDescription - typeId type: object properties: accountNumber: title: Номер бонусного счёта type: string typeId: title: Идентификатор типа бонусного счёта type: string typeDescription: title: Наименование/описание типа бонусного счёта type: string balanceAmount: allOf: - title: Баланс счёта type: object description: Баланс счёта format: commons.Amount example: typeId: typeId typeDescription: typeDescription accountNumber: accountNumber balanceAmount: "" LoyaltyFilter: title: Фильтр истории начислений required: - endDate - references - startDate type: object properties: startDate: title: Дата начала type: string format: date endDate: title: Дата окончания type: string format: date references: title: Массив референсов транзакций type: array items: type: string default: [] example: references: - references - references endDate: 2000-01-23 startDate: 2000-01-23 LoyaltyTransaction: title: Транзакция required: - account - cashbackAmount - title type: object properties: title: title: Наименование операции type: string account: title: Номер счёта type: string reference: title: Референс (идентификатор) операции type: string cashbackPercent: title: Процент кэшбека type: number cashbackAmount: allOf: - title: Сумма бонуса type: object description: Сумма бонуса format: commons.Amount example: reference: reference cashbackAmount: "" cashbackPercent: 0.8008281904610115 title: title account: account AccountCashback: title: Информация о начислениях по бонусному счету клиента required: - cashbackAccount - cashbackForecast - cashbackStatistic - overallCashback type: object properties: cashbackAccount: $ref: '#/components/schemas/CashbackAccount' cashbackForecast: $ref: '#/components/schemas/CashbackForecast' cashbackStatistic: $ref: '#/components/schemas/CashbackStatistic' overallCashback: $ref: '#/components/schemas/OverallCashback' example: cashbackStatistic: payments: - period: period amount: "" status: null - period: period amount: "" status: null cashbackAccount: typeId: typeId typeDescription: typeDescription accountNumber: accountNumber balanceAmount: "" overallCashback: amount: "" description: description cashbackForecast: totalIntermediatePeriodAmount: payOutDate: 2000-01-23 amount: "" totalActivePeriodAmount: payOutDate: 2000-01-23 amount: "" CashbackAccount: title: Бонусный счёт required: - accountNumber - typeDescription - typeId type: object properties: accountNumber: title: Номер бонусного счёта type: string typeId: title: Идентификатор типа бонусного счёта type: string typeDescription: title: Наименование/описание типа бонусного счёта type: string balanceAmount: allOf: - title: Баланс счёта type: object description: Баланс счёта format: commons.Amount example: typeId: typeId typeDescription: typeDescription accountNumber: accountNumber balanceAmount: "" CashbackForecast: title: Прогноз начислений кешбэка required: - totalActivePeriodAmount type: object properties: totalActivePeriodAmount: $ref: '#/components/schemas/TotalActivePeriodAmount' totalIntermediatePeriodAmount: $ref: '#/components/schemas/TotalIntermediatePeriodAmount' example: totalIntermediatePeriodAmount: payOutDate: 2000-01-23 amount: "" totalActivePeriodAmount: payOutDate: 2000-01-23 amount: "" TotalActivePeriodAmount: title: Кешбэк за текущий расчетный период required: - amount - payOutDate type: object properties: amount: allOf: - title: Кол-во начисленного кешбэка type: object description: Кол-во начисленного кешбэка format: commons.Amount payOutDate: title: Дата начисления кешбэка type: string format: date example: payOutDate: 2000-01-23 amount: "" TotalIntermediatePeriodAmount: title: Прогноз начисления кешбэка за следующий расчетный период required: - amount - payOutDate type: object properties: amount: allOf: - title: Кол-во начисленного кешбэка type: object description: Кол-во начисленного кешбэка format: commons.Amount payOutDate: title: Дата начисления кешбэка type: string format: date example: payOutDate: 2000-01-23 amount: "" CashbackStatistic: title: График начислений кешбэка required: - payments type: object properties: payments: title: Массив с графиком начислений type: array items: $ref: '#/components/schemas/Payment_2' default: [] example: payments: - period: period amount: "" status: null - period: period amount: "" status: null Payment_2: title: Объект графика начислений. Начисление кешбэка за указанный период. required: - amount - period - status type: object properties: period: title: Месяц и год периода type: string status: $ref: '#/components/schemas/PaymentStatus_1' amount: allOf: - title: Кол-во начисленного кешбэка type: object description: Кол-во начисленного кешбэка format: commons.Amount example: period: period amount: "" status: null PaymentStatus_1: title: "Статус периода начисления: PAST (для предыдущих месяцев), PRESENT (д\ ля текущего месяца)" type: string enum: - PAST - PRESENT OverallCashback: title: Общий кешбэк за все время required: - amount - description type: object properties: amount: allOf: - title: Кол-во начисленного кешбэка type: object description: Кол-во начисленного кешбэка format: commons.Amount description: title: Период начисления кешбэка type: string example: amount: "" description: description CreateFormRequest: required: - embossingName - firstName - lastName - middleName - mobilePhone - passportBirthDate - sex - sopdConfirmed type: object properties: embossingName: type: string description: Имя на дебетовой карте example: PETROV IVAN firstName: type: string description: Имя example: Иван lastName: type: string description: Фамилия example: Петров middleName: type: string description: Отчество example: Викторович mobilePhone: type: string description: Мобильный телефон example: "9012345678" email: type: string description: Адрес электронной почты example: example@yandex.ru passportBirthDate: type: string description: Дата рождения format: date example: 1990-09-15 previousFormId: type: string description: formId предыдущей заявки (чтобы помечать её как удаленную) example: AAAA16686C43888CE05CCCAC163B298F sex: type: string description: Пол enum: - f - m sopdConfirmed: type: boolean description: Флаг согласия на обработку персональных данных example: true description: Данные для формирования заявки для заказа карты example: firstName: Иван lastName: Петров mobilePhone: "9012345678" sex: f passportBirthDate: 1990-09-15T00:00:00.000+00:00 embossingName: PETROV IVAN middleName: Викторович sopdConfirmed: true email: example@yandex.ru previousFormId: AAAA16686C43888CE05CCCAC163B298F CreateFormResponse: required: - formId - status type: object properties: formId: type: string description: Идентификатор заявки example: 55A42D1698400C9EE0543863BB4C2866 draftId: type: string description: Идентификатор черновика заявки example: 5DCD7E06A44C463781A87CC3302F0E1D payload: $ref: '#/components/schemas/DebitCardPayload' productType: type: string description: Тип продукта example: DC status: type: string description: Статус-результат обработки заявки example: APPROVAL_REJECT description: Подтверждение получения данных заявки Банком example: formId: 55A42D1698400C9EE0543863BB4C2866 draftId: 5DCD7E06A44C463781A87CC3302F0E1D payload: requireCodeWord: true userStatus: - DT - DT cardId: RR packageId: T04 contractId: PDRR cause: NOT_REQUESTED subscription: "200" url: https://testjmb.alfabank.ru/alfaform-dc-short-ui/draft?draftId=344101726FFB44BAB62DAFEC3824D0C0 cashback: - month: 2024-05-01T00:00:00.000+00:00 status: "200" - month: 2024-05-01T00:00:00.000+00:00 status: "200" productType: DC status: APPROVAL_REJECT DebitCardPayload: type: object properties: cardId: type: string description: "Идентификатор карты, которую заказал пользователь" example: RR packageId: type: string description: Пакет услуг клиента example: T04 contractId: type: string description: Карточный контракт пользователя example: PDRR userStatus: type: array description: "Название клиентского пути. Принимает возможные значения: DT\ \ - клиент ЦТ; NODT - действующий клиент, дополнительно может быть ука\ зано FAMILY - клиент Семейного Банка" items: uniqueItems: true type: string enum: - DT - NODT - FAMILY url: type: string description: Ссылка на черновик заявки example: https://testjmb.alfabank.ru/alfaform-dc-short-ui/draft?draftId=344101726FFB44BAB62DAFEC3824D0C0 subscription: type: string description: Подписка (ответ МАПЛ) example: "200" cashback: type: array description: Список ответов МАПЛ на запрашиваемые категории кешбэка по месяцам items: $ref: '#/components/schemas/DebitCardCashback' cause: type: string description: Дополнительные данные не запрашивались (ответ оркестратора) example: NOT_REQUESTED description: Дополнительная информация по запросу example: requireCodeWord: true userStatus: - DT - DT cardId: RR packageId: T04 contractId: PDRR cause: NOT_REQUESTED subscription: "200" url: https://testjmb.alfabank.ru/alfaform-dc-short-ui/draft?draftId=344101726FFB44BAB62DAFEC3824D0C0 cashback: - month: 2024-05-01T00:00:00.000+00:00 status: "200" - month: 2024-05-01T00:00:00.000+00:00 status: "200" DebitCardCashback: required: - month - status type: object properties: month: type: string description: "Месяц, на который выбраны категории" format: date example: 2024-05-01 status: type: string description: Статус ответа МАПЛа example: "200" example: month: 2024-05-01T00:00:00.000+00:00 status: "200" ServiceError: required: - error type: object properties: error: type: string description: Код ошибки example: invalid_request error_description: type: string description: Сообщение об ошибке example: "The request is missing a required parameter, includes an unsupported\ \ parameter or parameter value, repeats the same parameter, uses more\ \ than one method for including an access token, or is otherwise malformed" description: Ошибка от сервиса VerifyPassportRequest: required: - passportFullNumber type: object properties: passportFullNumber: type: string description: Серия и номер паспорта example: "4015678904" description: Подтверждение паспортных данных example: passportFullNumber: "4015678904" VerifyPassportResponse: required: - formId - status type: object properties: formId: type: string description: Идентификатор заявки example: 55A42D1698400C9EE0543863BB4C2866 draftId: type: string description: Идентификатор черновика заявки example: 5DCD7E06A44C463781A87CC3302F0E1D payload: $ref: '#/components/schemas/DebitCardPayload' productType: type: string description: Тип продукта example: DC status: type: string description: Статус-результат обработки заявки example: APPROVAL_REJECT description: Паспортные данные получены Банком example: formId: 55A42D1698400C9EE0543863BB4C2866 draftId: 5DCD7E06A44C463781A87CC3302F0E1D payload: requireCodeWord: true userStatus: - DT - DT cardId: RR packageId: T04 contractId: PDRR cause: NOT_REQUESTED subscription: "200" url: https://testjmb.alfabank.ru/alfaform-dc-short-ui/draft?draftId=344101726FFB44BAB62DAFEC3824D0C0 cashback: - month: 2024-05-01T00:00:00.000+00:00 status: "200" - month: 2024-05-01T00:00:00.000+00:00 status: "200" productType: DC status: APPROVAL_REJECT PhaseId: type: string description: Этап процесса enum: - CREATION - COMPLETION VerifySmsRequest: required: - smsCode type: object properties: smsCode: type: string description: SMS-код для подтверждения действия example: "41851" description: Отправка SMS кода подтверждения example: smsCode: "41851" VerifySmsFormCreationResponse: required: - formId - status type: object properties: formId: type: string description: Идентификатор заявки example: 55A42D1698400C9EE0543863BB4C2866 draftId: type: string description: Идентификатор черновика заявки example: 5DCD7E06A44C463781A87CC3302F0E1D payload: $ref: '#/components/schemas/DebitCardPayload' productType: type: string description: Тип продукта example: DC status: type: string description: Статус-результат обработки заявки example: SUCCESS description: SMS код для подтверждения оформления заявки успешно получен Банком VerifySmsFormCompletionResponse: required: - status type: object properties: status: type: string description: Статус-результат обработки заявки example: SUCCESS description: SMS код для завершения оформления заявки успешно получен Банком ResendSmsCreationResponse: required: - formId - status type: object properties: formId: type: string description: Идентификатор заявки example: 55A42D1698400C9EE0543863BB4C2866 draftId: type: string description: Идентификатор черновика заявки example: 5DCD7E06A44C463781A87CC3302F0E1D payload: $ref: '#/components/schemas/DebitCardPayload' productType: type: string description: Тип продукта example: DC status: type: string description: Статус-результат обработки заявки example: APPROVAL_REJECT description: Повторный запрос SMS для подтверждения создания заявки ResendSmsCompletionResponse: required: - status type: object properties: payload: $ref: '#/components/schemas/DebitCardPayload' status: type: string description: Статус-результат обработки заявки example: NEED_SMS description: Повторный запрос SMS для подтверждения завершения оформления заявки TooManyRequests: required: - error type: object properties: error: type: string description: Код ошибки example: too_many_requests error_description: type: string description: Сообщение об ошибке example: "The client application has surpassed its rate limit, or number\ \ of requests they can send in a given period of time - number of sent\ \ SMSes isn't less than 3" description: Превышено количество обращений в единицу времени к сервису dt-product-api CheckDraftResponse: required: - formId - requestBrokerageAccount - requestCodeWord type: object properties: formId: type: string description: Идентификатор заявки example: 55A42D1698400C9EE0543863BB4C2866 requestCodeWord: type: boolean description: Наличие кодового слова example: true requestBrokerageAccount: type: boolean description: Признак отображения на интерфейсе панели открытия брокерского счёта example: false userStatus: type: array description: "Название клиентского пути. Принимает возможные значения: DT\ \ - клиент ЦТ; NODT - действующий клиент, дополнительно может быть ука\ зано FAMILY - клиент Семейного Банка" items: uniqueItems: true type: string enum: - DT - NODT - FAMILY description: Получен статус заявки example: formId: 55A42D1698400C9EE0543863BB4C2866 requestCodeWord: true userStatus: - DT - DT requestBrokerageAccount: false DeliveryTypesResponse: required: - courier - offices - onlyCourierDelivery type: object properties: onlyCourierDelivery: type: boolean description: Признак доступности только курьерской доставки example: true courier: $ref: '#/components/schemas/Courier' offices: $ref: '#/components/schemas/Offices' description: Получен способы доставки по заданным географическим параметрам example: courier: latitude: 55.659348 cityId: 21 cardAttributes: namedCardEnabled: false unnamedCardEnabled: true longitude: 37.472996 offices: address: "пр-кт Вернадского, д.119" distance: 2121 city: fiasId: 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 kladrId: "\t7700000000000" name: Москва clientAvailability: OPENED pid: "0610" title: ДО «ЮГО-ЗАПАДНАЯ» prodType: "'pointone', 'pointtwo', 'serviceoffice'" uuid: 83e92bd6-60cd-4924-91a0-571a635c3244 constraints: - date: с 10.02.2023 по 12.02.2023 times: "пн-ср: 10:00-18:00" - date: с 10.02.2023 по 12.02.2023 times: "пн-ср: 10:00-18:00" schedule: "'пн-пт: 10:00-20:00', 'сб: 10:00-18:00','вс: выходной'" temporarySchedule: - date: с 10.02.2023 по 12.02.2023 times: - times - times - date: с 10.02.2023 по 12.02.2023 times: - times - times embossingEnabled: true metro: - distance: 604 lineId: 1 lineName: Сокольническая lineColor: E42313 id: "1.162" title: Юго-Западная - distance: 604 lineId: 1 lineName: Сокольническая lineColor: E42313 id: "1.162" title: Юго-Западная mnemonic: MOES addressOfficial: "197022, г. Санкт-Петербург, Каменноостровский пр-кт, д\ . 42 Б, лит. А" cardAttributes: namedCardEnabled: false unnamedCardEnabled: true anyOfficeUnnamedEnabled: false onlyCourierDelivery: true Courier: required: - cardAttributes - cityId - latitude - longitude type: object properties: cardAttributes: $ref: '#/components/schemas/CardAttributes' cityId: type: integer description: Код города доставки example: 21 latitude: type: number description: Широта example: 55.659348 longitude: type: number description: Долгота example: 37.472996 description: Параметры курьерской доставки example: latitude: 55.659348 cityId: 21 cardAttributes: namedCardEnabled: false unnamedCardEnabled: true longitude: 37.472996 CardAttributes: required: - namedCardEnabled - unnamedCardEnabled type: object properties: unnamedCardEnabled: type: boolean description: Признак доступности неименной карты example: true namedCardEnabled: type: boolean description: Признак доступности именной карты example: false description: Атрибуты карты и ее доступности example: namedCardEnabled: false unnamedCardEnabled: true Offices: required: - address - cardAttributes - city - clientAvailability - distance - embossingEnabled - mnemonic - pid - prodType - schedule - title - uuid type: object properties: pid: type: string description: Внутрибанковский цифровой код (идентификатор) офиса example: "0610" uuid: type: string description: Идентификатор доставки в офис example: 83e92bd6-60cd-4924-91a0-571a635c3244 mnemonic: type: string description: Мнемоника офиса example: MOES title: type: string description: Наименование офиса example: ДО «ЮГО-ЗАПАДНАЯ» address: type: string description: Адрес офиса example: "пр-кт Вернадского, д.119" addressOfficial: type: string description: Юридический адрес офиса example: "197022, г. Санкт-Петербург, Каменноостровский пр-кт, д. 42 Б,\ \ лит. А" cardAttributes: $ref: '#/components/schemas/Offices_cardAttributes' metro: type: array items: $ref: '#/components/schemas/Metro' clientAvailability: type: string description: Признак доступности офиса enum: - OPENED - CLOSED - CONSULT - PERMANENTLY_LOCKED - TEMPORARILY_LOCKED embossingEnabled: type: boolean description: Признак возможности эмбоссирования карты example: true prodType: type: array description: Список характеристик (сервисов) офиса example: "'pointone', 'pointtwo', 'serviceoffice'" items: type: string enum: - pointone - pointtwo - serviceoffice - clientoffice - cashmas - safe - disabled - cashgbp - cashchf - momentcard - wifi - partner - overdraft - cashop - officembip - pilot - dc - cc - pil - mortgage - investment - share - courier - bio schedule: type: array description: Расписание работы офиса (дни недели и время) example: "'пн-пт: 10:00-20:00', 'сб: 10:00-18:00','вс: выходной'" items: type: string temporarySchedule: type: array description: Временное расписание работы офиса items: $ref: '#/components/schemas/TemporarySchedule' constraints: type: array description: Ограничения в работе отделения items: $ref: '#/components/schemas/OfficeConstraint' distance: type: number description: "Расстояние от адреса клиента до офиса, м." example: 2121 city: $ref: '#/components/schemas/City' description: Список офисов доступных в указанном радиусе для получения карты example: address: "пр-кт Вернадского, д.119" distance: 2121 city: fiasId: 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 kladrId: "\t7700000000000" name: Москва clientAvailability: OPENED pid: "0610" title: ДО «ЮГО-ЗАПАДНАЯ» prodType: "'pointone', 'pointtwo', 'serviceoffice'" uuid: 83e92bd6-60cd-4924-91a0-571a635c3244 constraints: - date: с 10.02.2023 по 12.02.2023 times: "пн-ср: 10:00-18:00" - date: с 10.02.2023 по 12.02.2023 times: "пн-ср: 10:00-18:00" schedule: "'пн-пт: 10:00-20:00', 'сб: 10:00-18:00','вс: выходной'" temporarySchedule: - date: с 10.02.2023 по 12.02.2023 times: - times - times - date: с 10.02.2023 по 12.02.2023 times: - times - times embossingEnabled: true metro: - distance: 604 lineId: 1 lineName: Сокольническая lineColor: E42313 id: "1.162" title: Юго-Западная - distance: 604 lineId: 1 lineName: Сокольническая lineColor: E42313 id: "1.162" title: Юго-Западная mnemonic: MOES addressOfficial: "197022, г. Санкт-Петербург, Каменноостровский пр-кт, д.\ \ 42 Б, лит. А" cardAttributes: namedCardEnabled: false unnamedCardEnabled: true anyOfficeUnnamedEnabled: false Metro: required: - distance - id - lineColor - lineId - lineName - title type: object properties: id: type: string description: Идентификатор станции метро example: "1.162" title: type: string description: Наименование станции метро example: Юго-Западная distance: type: integer description: "Расстояние до офиса, м." example: 604 lineId: type: integer description: Идентификатор линии метро example: 1 lineColor: type: string description: Цвет линии метро example: E42313 lineName: type: string description: Наименование линии метро example: Сокольническая description: Список ближайших к офису станций метро example: distance: 604 lineId: 1 lineName: Сокольническая lineColor: E42313 id: "1.162" title: Юго-Западная TemporarySchedule: type: object properties: date: type: string description: Даты работы в рамках временного расписания example: с 10.02.2023 по 12.02.2023 times: type: array description: Время работы в рамках временного расписания items: type: string description: Временное расписание работы офиса example: date: с 10.02.2023 по 12.02.2023 times: - times - times OfficeConstraint: type: object properties: date: type: string description: Даты работы example: с 10.02.2023 по 12.02.2023 times: type: string description: Время работы example: "пн-ср: 10:00-18:00" description: Ограничения в работе отделения example: date: с 10.02.2023 по 12.02.2023 times: "пн-ср: 10:00-18:00" City: required: - fiasId - kladrId - name type: object properties: name: type: string description: Наименование города отделения example: Москва fiasId: type: string description: Код ФИАС (Федеральная информационная адресная система) города отделения example: 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 kladrId: type: string description: Код КЛАДР города отделения example: "\t7700000000000" description: Город расположения офиса example: fiasId: 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 kladrId: "\t7700000000000" name: Москва TimeSlotsResponse: required: - availableDates - uuid type: object properties: uuid: type: string description: Идентификатор заявки example: 07a91616-53e1-4ee1-8045-0544e4590a18 availableDates: type: array description: Список дат с доступными тайм-слотами items: $ref: '#/components/schemas/AvailableDates' description: Полученные тайм-слоты для доставки карты example: availableDates: - date: 2023-08-03T00:00:00.000+00:00 slots: - isAvailable: true slotTo: 11:00 express: false slotFrom: 10:00 - isAvailable: true slotTo: 11:00 express: false slotFrom: 10:00 - date: 2023-08-03T00:00:00.000+00:00 slots: - isAvailable: true slotTo: 11:00 express: false slotFrom: 10:00 - isAvailable: true slotTo: 11:00 express: false slotFrom: 10:00 uuid: 07a91616-53e1-4ee1-8045-0544e4590a18 AvailableDates: type: object properties: date: type: string description: Дата доступных тайм-слотов format: date example: 2023-08-03 slots: type: array description: Список слотов items: $ref: '#/components/schemas/Slots' description: Список дат с доступными тайм-слотами example: date: 2023-08-03T00:00:00.000+00:00 slots: - isAvailable: true slotTo: 11:00 express: false slotFrom: 10:00 - isAvailable: true slotTo: 11:00 express: false slotFrom: 10:00 Slots: type: object properties: isAvailable: type: boolean description: Признак доступности слота example: true slotFrom: type: string description: Время начала слота example: 10:00 slotTo: type: string description: Время завершения слота example: 11:00 express: type: boolean description: Признак экспресс-доставки example: false description: Список слотов example: isAvailable: true slotTo: 11:00 express: false slotFrom: 10:00 BookTimeSlotRequest: required: - deliveryDate - express - slotFrom - slotTo - uuid type: object properties: deliveryDate: type: string description: Дата тайм-слота format: date example: 2023-08-03 express: type: boolean description: Признак экспресс-доставки example: false slotFrom: type: string description: Время начала слота example: 10:00 slotTo: type: string description: Время окончания слота example: 11:00 uuid: type: string description: Идентификатор доставки example: 07a91616-53e1-4ee1-8045-0544e4590a18 description: Список слотов example: express: false slotTo: 11:00 deliveryDate: 2023-08-03T00:00:00.000+00:00 uuid: 07a91616-53e1-4ee1-8045-0544e4590a18 slotFrom: 10:00 FormConfirmationRequest: required: - isUnnamedCard type: object properties: codeWord: type: string description: Кодовое слово example: Код1 isUnnamedCard: type: boolean description: Признак заказа неименной карты example: true deliveryUuid: type: string description: Идентификатор доставки example: 304ad059-ae73-459c-9195-acf353589657 courierDelivery: $ref: '#/components/schemas/CourierDelivery' officeDelivery: $ref: '#/components/schemas/OfficeDelivery' currency: type: string description: Код валюты example: RUR description: Тайм-слот забронирован для доставки карты example: codeWord: Код1 isUnnamedCard: true courierDelivery: date: 2023-08-12T00:00:00.000+00:00 address: "г. Москва, ул. Анохина, д. 9" comment: Возможно не работает домофон slotTo: 11:00 express: true brokerageAccountRequired: true slotFrom: 10:00 deliveryUuid: 304ad059-ae73-459c-9195-acf353589657 officeDelivery: obtainingOffice: "392" currency: RUR CourierDelivery: required: - address - date - express - slotFrom - slotTo type: object properties: address: type: string description: Адрес доставки example: "г. Москва, ул. Анохина, д. 9" comment: type: string description: Комментарий для сотрудника example: Возможно не работает домофон date: type: string description: Дата доставки format: date example: 2023-08-12 slotFrom: type: string description: Время начала слота доставки example: 10:00 slotTo: type: string description: Время окончания слота доставки example: 11:00 express: type: boolean description: Признак экспресс-доставки example: true brokerageAccountRequired: type: boolean description: Признак необходимости открытия брокерского счета (для передачи в Логистику) example: true description: Детали курьерской доставки example: date: 2023-08-12T00:00:00.000+00:00 address: "г. Москва, ул. Анохина, д. 9" comment: Возможно не работает домофон slotTo: 11:00 express: true brokerageAccountRequired: true slotFrom: 10:00 OfficeDelivery: required: - obtainingOffice type: object properties: obtainingOffice: type: string description: Внутрибанковский цифровой код офиса example: "392" description: Детали доставки в офис банка example: obtainingOffice: "392" FormConfirmationResponse: required: - status type: object properties: status: type: string description: Статус-результат обработки заявки example: SUCСESS description: Детали доставки в офис банка example: status: SUCСESS GetAccountsResponse: type: object properties: Data: $ref: '#/components/schemas/GetAccountsResponse_Data' example: Data: Account: - accountId: accountId Owner: cityOfBirth: cityOfBirth identification: identification: identification schemeName: RU.CBR.TXID postalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine mobileNumber: mobileNumber name: name countryOfResidence: countryOfResidence birthDate: birthDate Servicer: PostalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine OrganizationIdentification: - identification: identification schemeName: RU.CBR.TXID - identification: identification schemeName: RU.CBR.TXID name: name BankIdentification: - identification: identification schemeName: RU.CBR.BICFI - identification: identification schemeName: RU.CBR.BICFI CorrespondentAccount: identification: identification schemeName: RU.CBR.BBAN accountDescription: accountDescription accountType: null currency: currency status: null AccountDetails: - identification: identification name: name schemeName: RU.CBR.BBAN - identification: identification name: name schemeName: RU.CBR.BBAN - accountId: accountId Owner: cityOfBirth: cityOfBirth identification: identification: identification schemeName: RU.CBR.TXID postalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine mobileNumber: mobileNumber name: name countryOfResidence: countryOfResidence birthDate: birthDate Servicer: PostalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine OrganizationIdentification: - identification: identification schemeName: RU.CBR.TXID - identification: identification schemeName: RU.CBR.TXID name: name BankIdentification: - identification: identification schemeName: RU.CBR.BICFI - identification: identification schemeName: RU.CBR.BICFI CorrespondentAccount: identification: identification schemeName: RU.CBR.BBAN accountDescription: accountDescription accountType: null currency: currency status: null AccountDetails: - identification: identification name: name schemeName: RU.CBR.BBAN - identification: identification name: name schemeName: RU.CBR.BBAN Account_3: required: - accountDescription - accountId - accountType - currency - status type: object properties: accountId: type: string status: $ref: '#/components/schemas/AccountStatus_2' currency: type: string accountType: $ref: '#/components/schemas/AccountType_1' accountDescription: type: string AccountDetails: type: array items: $ref: '#/components/schemas/AccountDetailsEntry' Owner: $ref: '#/components/schemas/Owner' Servicer: $ref: '#/components/schemas/BranchAndFinancialInstitutionInformation_1' example: accountId: accountId Owner: cityOfBirth: cityOfBirth identification: identification: identification schemeName: RU.CBR.TXID postalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine mobileNumber: mobileNumber name: name countryOfResidence: countryOfResidence birthDate: birthDate Servicer: PostalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine OrganizationIdentification: - identification: identification schemeName: RU.CBR.TXID - identification: identification schemeName: RU.CBR.TXID name: name BankIdentification: - identification: identification schemeName: RU.CBR.BICFI - identification: identification schemeName: RU.CBR.BICFI CorrespondentAccount: identification: identification schemeName: RU.CBR.BBAN accountDescription: accountDescription accountType: null currency: currency status: null AccountDetails: - identification: identification name: name schemeName: RU.CBR.BBAN - identification: identification name: name schemeName: RU.CBR.BBAN AccountStatus_2: type: string enum: - Enabled - Disabled AccountType_1: type: string enum: - Business - Personal AccountDetailsEntry: required: - identification - schemeName type: object properties: name: type: string schemeName: type: string enum: - RU.CBR.BBAN - RU.CBR.EPID - RU.CBR.PAN - RU.CBR.MTEL - RU.CBR.ORID identification: type: string example: identification: identification name: name schemeName: RU.CBR.BBAN Owner: required: - identification - name type: object properties: name: type: string mobileNumber: type: string countryOfResidence: type: string cityOfBirth: type: string birthDate: type: string format: DateTime identification: $ref: '#/components/schemas/Identification' postalAddress: $ref: '#/components/schemas/PostalAddress_1' example: cityOfBirth: cityOfBirth identification: identification: identification schemeName: RU.CBR.TXID postalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine mobileNumber: mobileNumber name: name countryOfResidence: countryOfResidence birthDate: birthDate Identification: required: - identification - schemeName type: object properties: schemeName: type: string enum: - RU.CBR.TXID - RU.CBR.LEI - RU.CBR.PASP - RU.CBR.CLID - RU.CBR.QRST - RU.CBR.TAXT - RU.CBR.OGRN - RU.CBR.SNILS - RU.CBR.PAN - RU.CBR.MTEL - RU.CBR.BBAN identification: type: string example: identification: identification schemeName: RU.CBR.TXID PostalAddress_1: type: object properties: addressType: $ref: '#/components/schemas/AddressType' addressLine: type: array items: type: string streetName: type: string buildingNumber: type: string postCode: type: string townName: type: string countrySubDivision: type: string country: type: string example: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine AddressType: type: string enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement BranchAndFinancialInstitutionInformation_1: required: - BankIdentification - name type: object properties: name: type: string BankIdentification: type: array items: $ref: '#/components/schemas/BankIdentification' OrganizationIdentification: type: array items: $ref: '#/components/schemas/OrganizationIdentification' CorrespondentAccount: $ref: '#/components/schemas/CorrespondentAccount' PostalAddress: $ref: '#/components/schemas/PostalAddress_1' example: PostalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine OrganizationIdentification: - identification: identification schemeName: RU.CBR.TXID - identification: identification schemeName: RU.CBR.TXID name: name BankIdentification: - identification: identification schemeName: RU.CBR.BICFI - identification: identification schemeName: RU.CBR.BICFI CorrespondentAccount: identification: identification schemeName: RU.CBR.BBAN BankIdentification: required: - identification - schemeName type: object properties: schemeName: type: string enum: - RU.CBR.BICFI - RU.CBR.BIC identification: type: string example: identification: identification schemeName: RU.CBR.BICFI OrganizationIdentification: required: - identification - schemeName type: object properties: schemeName: type: string enum: - RU.CBR.TXID - RU.CBR.LEI - RU.CBR.TAXT - RU.CBR.OGRN - RU.CBR.OKPO identification: type: string example: identification: identification schemeName: RU.CBR.TXID CorrespondentAccount: required: - identification - schemeName type: object properties: schemeName: type: string enum: - RU.CBR.BBAN - RU.CBR.EPID - RU.CBR.PAN - RU.CBR.MTEL - RU.CBR.ORID identification: type: string example: identification: identification schemeName: RU.CBR.BBAN OBRUErrorResponse_1: required: - Errors - code - message type: object properties: code: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Высокоуровневый текстовый код ошибки, необходимый для клас\ сификации" example: "400" message: maxLength: 500 minLength: 1 pattern: "^[\\w\\W]{1,500}$" type: string description: "Краткое сообщение об ошибке. Например, «что-то не так с пр\ едоставленными параметрами запроса»" example: Bad Request Errors: maxItems: 50 minItems: 1 type: array items: $ref: '#/components/schemas/OBRUError_1' additionalProperties: false description: Контейнер с детализацией ошибки OBRUError_1: required: - errorCode - message type: object properties: errorCode: $ref: '#/components/schemas/OBRUErrorResponseErrorCode' message: maxLength: 500 minLength: 1 pattern: "^[\\w\\W]{1,500}$" type: string description: Описание ошибки example: Обязательное поле не указано path: maxLength: 500 minLength: 1 pattern: "^[\\w\\W]{1,500}$" type: string description: "Путь к элементу с ошибкой в JSON объекте. Рекомендуемое, н\ о не обязательное поле" example: Data.Model.Object.name url: type: string description: "URL для помощи в устранении проблемы, Также через URL можн\ о предоставлять дополнительную информацию" format: uri example: https://example.com/error-description additionalProperties: false description: Контейнер с ошибкой BalanceResponse_1: maxProperties: 3 minProperties: 3 required: - Data type: object properties: Data: $ref: '#/components/schemas/BalanceResponse_1_Data' Links: $ref: '#/components/schemas/AccountResponse_Links' Meta: $ref: '#/components/schemas/BalanceResponse_1_Meta' additionalProperties: false description: Ответ на запрос об остатке на счете example: Meta: null Links: self: https://sb.example.ru/v1.3/example Data: null DataBalanceResponse: type: object properties: Balance: maxItems: 50 minItems: 0 type: array items: $ref: '#/components/schemas/Balance' additionalProperties: false description: Полезная нагрузка ответа на запрос об остатке на счете Balance: required: - Amount - accountId - creditDebitIndicator - dateTime - type type: object properties: accountId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации ресурса счета" example: this-is-a-slug-format-account-id type: description: Тип остатка allOf: - $ref: '#/components/schemas/BalanceType_1' Amount: $ref: '#/components/schemas/Balance_Amount' creditDebitIndicator: description: Определяет является остаток кредитовым или дебетовым allOf: - $ref: '#/components/schemas/CreditDebitCode' dateTime: description: "Дата, на которую рассчитан остаток" allOf: - $ref: '#/components/schemas/ISODateTime' CreditLine: maxItems: 50 minItems: 0 type: array description: Кредитная линия items: $ref: '#/components/schemas/OBRUCreditLine' additionalProperties: false description: Остаток на счете x-openapiru-object-type-contract: true BalanceType_1: type: string description: Тип остатка enum: - ClosingAvailable - ClosingBooked - ClosingCleared - Expected - OpeningAvailable - OpeningBooked - OpeningCleared - PreviouslyClosedBooked ActiveOrHistoricCurrencyAndAmount_1: required: - amount - currency type: object properties: amount: description: Сумма денежных средств allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' currency: description: "Код валюты, соответствующий международному стандарту ISO 4217" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' additionalProperties: false description: Сумма денежных средств и код валюты OBRUCreditLine: required: - Amount - included type: object properties: included: type: boolean description: Показывает включена или нет кредитная линия в расчет остатка example: false Amount: $ref: '#/components/schemas/OBRUCreditLine_Amount' additionalProperties: false description: "Набор элементов, используемых для предоставления подробной инф\ ормации о кредитной линии" TransactionResponse: maxProperties: 3 minProperties: 3 required: - Data type: object properties: Data: $ref: '#/components/schemas/TransactionResponse_Data' Links: $ref: '#/components/schemas/StatementResponse_Links' Meta: $ref: '#/components/schemas/BalanceResponse_1_Meta' additionalProperties: false description: Ответ на запрос информации об операциях по счету example: Meta: null Links: null Data: null DataTransactionResponse: type: object properties: Transaction: maxItems: 50 minItems: 0 type: array description: Список операций по счету items: $ref: '#/components/schemas/TransactionHistory' additionalProperties: false description: Полезная нагрузка ответа на запрос об операциях по счету TransactionHistory: required: - BankTransactionCode - accountId - bookingDateTime - creditDebitIndicator - status - transactionId type: object properties: transactionId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации рессурса операции по счету" accountId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации ресурса accounts" groupId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный идентификатор, используемый для идентификации г\ руппы связанных операций по счету" transactionInformation: pattern: "^[\\w\\W]{1,240}$" type: string description: Сообщение отправителя получателю денежных средств example: Сообщение отправителя получателю денежных средств Amount: $ref: '#/components/schemas/TransactionHistory_Amount' creditDebitIndicator: description: Определяет является ли операция дебетовая или кредитовая example: Debit allOf: - $ref: '#/components/schemas/CreditDebitCode' status: description: Статус операции по счету example: AcceptedSettlementCompleted allOf: - $ref: '#/components/schemas/TransactionStatusCode' BankTransactionCode: $ref: '#/components/schemas/TransactionHistory_BankTransactionCode' bookingDateTime: description: "Дата и время, когда запись об операции по счету публикуетс\ я на счете в бухгалтерской книге обслуживающей организации. Использует\ ся стандарт ISO8601" allOf: - $ref: '#/components/schemas/ISODateTime' valueDateTime: description: "Дата и время, когда активы становятся доступными владельцу\ \ счета в случае ввода кредита или перестают быть доступными владельцу\ \ счета в случае ввода дебетовой операции по счету" allOf: - $ref: '#/components/schemas/ISODateTime' ChargeAmount: $ref: '#/components/schemas/TransactionHistory_ChargeAmount' InstructedAmount: $ref: '#/components/schemas/TransactionHistory_InstructedAmount' Debtor: $ref: '#/components/schemas/TransactionHistory_Debtor' DebtorAgent: $ref: '#/components/schemas/ReportEntry_DebtorAgent' DebtorAccount: $ref: '#/components/schemas/TransactionHistory_DebtorAccount' CreditorAgent: $ref: '#/components/schemas/ReportEntry_CreditorAgent' CreditorAccount: $ref: '#/components/schemas/TransactionHistory_CreditorAccount' Creditor: $ref: '#/components/schemas/TransactionHistory_Creditor' CardTransaction: $ref: '#/components/schemas/TransactionHistory_CardTransaction' RemittanceInformation: $ref: '#/components/schemas/TransactionHistory_RemittanceInformation' additionalProperties: false description: Операция по счету ActiveOrHistoricCurrencyAndAmount_2: required: - amount - currency type: object properties: amount: description: Сумма денежных средств allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' currency: description: "Код валюты, соответствующий международному стандарту ISO 4217" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' additionalProperties: false description: Сумма денежных средств и код валюты CardTransaction: type: object properties: Card: $ref: '#/components/schemas/PaymentCard' Transaction: $ref: '#/components/schemas/CardTransaction_Transaction' additionalProperties: false description: "Предоставляет данные по карте (номер, платежная система), терм\ иналу (номер, идентификатор) и транзакционные данные, используемые для уни\ кальной идентификации операции по карте" PaymentCard: type: object properties: cardScheme: $ref: '#/components/schemas/CardSchemeNameCode' additionalCardData: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: "Дополнительные сведения, специфичные для эмитента карты" example: Дополнительные сведения PaymentCardData: $ref: '#/components/schemas/PlainCardData' additionalProperties: false description: Данные по платежной карте CardIndividualTransaction: type: object properties: authorizationCode: maxLength: 35 minLength: 3 pattern: "^[\\w\\W]{3,35}$" type: string description: Код авторизации операции example: "1234" additionalProperties: false description: "Сведения об отдельной операции по карте, записанные на POI-тер\ минале (точке взаимодействия)" AccountPaymentCardsResponse: type: object properties: Data: $ref: '#/components/schemas/AccountPaymentCardsResponse_Data' Links: $ref: '#/components/schemas/Links_1' Meta: $ref: '#/components/schemas/Meta_1' additionalProperties: false description: Список платежных карт и их идентификаторы example: Meta: totalPages: 1 Links: next: https://sb.example.ru/v1.3/example?page=1 last: https://sb.example.ru/v1.3/example?page=1 prev: https://sb.example.ru/v1.3/example?page=1 self: https://sb.example.ru/v1.3/example?page=1 first: https://sb.example.ru/v1.3/example?page=1 Data: PaymentCard: - null - null - null - null - null AccountPaymentCardsData: required: - PaymentCardData - accountId - cardScheme - paymentCardId - paymentCardName - paymentCardType type: object properties: accountId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации ресурса Счета" example: this-is-a-slug-format-account-id paymentCardId: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации платежной карты" example: this-is-a-slug-format-payment-card-id paymentCardType: type: string description: Тип платежной карты example: debit enum: - debit - credit paymentCardName: maxLength: 64 minLength: 1 pattern: "^[\\w\\W]{1,64}$" type: string description: "Наименование, ассоциированное с платежной картой конечного\ \ Пользователя" example: Экономная карта PaymentCardData: $ref: '#/components/schemas/PlainCardData2' cardScheme: $ref: '#/components/schemas/CardSchemeNameCode' iconUrl: maxLength: 2048 minLength: 1 pattern: "^[\\w\\W]{1,2048}$" type: string description: URL-адрес для получения информации в виде значка (icon) example: https://mybank.ru/products/debit-card/mybrend.ico designUrl: maxLength: 2048 minLength: 1 pattern: "^[\\w\\W]{1,2048}$" type: string description: URL-адрес для получения информации в виде изображения example: https://mybank.ru/products/debit-card/mybrend.png description: "Информация о платежной карте, связанной со сетом клиента" PlainCardData2: required: - PAN - cardStatus - expiryDate type: object properties: PAN: pattern: "^[0-9]{4}$" type: string description: "Маскированный учетный номер карты (PAN) или номер карты, о\ граниченный последними 4 цифрами." example: "0001" effectiveDate: description: "Дата, начиная с которой карту можно использовать" example: 12/2021 allOf: - $ref: '#/components/schemas/ISOYearMonth' expiryDate: description: Дата окончания срока действия карты example: 12/2025 allOf: - $ref: '#/components/schemas/ISOYearMonth' cardStatus: type: string description: |- Статус доступности карты: - pending - Карта выпущена но еще не активирована Пользователем - active - Доступны все активные операции - blocked - Все операции по карте заблокированы example: active enum: - pending - active - blocked additionalProperties: false description: "Конфиденциальные данные платежной карты, ассоциированной со сч\ етом" CardSchemeNameCode: type: string description: Наименование платежной системы или схемы карты example: MIR enum: - MIR - AmericanExpress - Diners - Discover - MasterCard - VISA - ArCa - BELKART - ELCART - JCB - UnionPay x-enum-descriptions: - Российская национальная платежная система - Международная платежная система AmericanExpress - Международная платежная система Diners - Международная платежная система Discover - Международная платежная система MasterCard - Международная платежная система VISA - Армянская национальная платежная система ArCa - Белорусская национальная платежная система BELKART - Киргизская национальная платежная система ELCART - Платежная система Японии JCB - Национальная платежная система Китая UnionPay x-enum-varnames: - MIR - AmericanExpress - Diners - Discover - MasterCard - VISA - ArCa - BELKART - ELCART - JCB - UnionPay ReportRequest: required: - date - type type: object properties: type: type: string description: | Код типа отчета: * `1` - Агрегированный отчет; * `2` - Детализированный отчет example: "2" enum: - "1" - "2" date: type: string description: "Дата, на которую необходимо сформировать отчет" format: date example: 2022-07-30 shops: type: array description: "Коды магазинов, по которым нужна детализированная информац\ ия" example: - F76E - F82A - F11C - F52B items: type: string example: date: 2022-07-30T00:00:00.000+00:00 shops: - F76E - F82A - F11C - F52B type: "2" ReportResponse: type: object properties: reqId: type: string description: Идентификатор запроса на создание отчета format: uuid example: 34eb7e7e-66db-42fa-9b81-544fed77c871 example: reqId: 34eb7e7e-66db-42fa-9b81-544fed77c871 RegTerminalRequest: required: - accountNumber - legalId - merchantId type: object properties: legalId: pattern: ".{12}" type: string description: Регистрационный номер ЮЛ в СБП example: LA0000004756 merchantId: pattern: ".{12}" type: string description: Регистрационный номер магазина в СБП example: MA0000002752 accountNumber: pattern: "^\\d{20}" type: string description: Номер счета в Банке-участнике СБП example: "40702810102300000001" status: type: string description: | Статус терминала: * `Open` - открыт, доступен для выполнения операций; * `Close` - закрыт, выполнение операций невозможно; * `Block` - заблокирован, выполнение операций невозможно. example: Open enum: - Open - Close - Block example: merchantId: MA0000002752 legalId: LA0000004756 accountNumber: "40702810102300000001" status: Open RegTerminalResponse: required: - status type: object properties: termNo: pattern: "^\\d{10}" type: string description: Идентификатор терминала example: "9008056701" status: type: string description: | Статус обработки запроса: * `Rejected` - отказ в обработке; * `Postponed` - отложен; * `Accepted` - принят к обработке; * `Executed` - исполнен. example: Executed enum: - Rejected - Postponed - Accepted - Executed example: termNo: "9008056701" status: Executed MerchantInfoResponse: type: object properties: merchantId: pattern: ".{12}" type: string description: Регистрационный номер ТСП в СБП example: MA0000002752 brandName: type: string description: Название магазина example: Технониколь mcc: type: string description: MCC-код магазина example: "4816" qrType: type: string description: Тип QR-кода example: static status: type: string description: Код текущего статуса ТСП example: "2" address: $ref: '#/components/schemas/Address_2' terminals: type: array items: $ref: '#/components/schemas/Terminal' description: Информация о ТСП example: brandName: Технониколь address: zip: "125362" settlementType: г. country: RU streetType: ул. street: Подмосковная region: "45" house: "21" settlement: Москва merchantId: MA0000002752 qrType: static mcc: "4816" terminals: - termNo: "9008056701" status: "1" - termNo: "9008056701" status: "1" status: "2" Address_2: type: object properties: zip: type: string description: Индекс example: "125362" country: type: string description: Код страны example: RU region: type: string description: Код региона по ОКТМО (первые два символа) example: "45" settlementType: type: string description: Тип населенного пункта example: г. settlement: type: string description: Наименование населенного пункта example: Москва streetType: type: string description: Тип улицы example: ул. street: type: string description: Наименование улицы example: Подмосковная house: type: string description: Номер дома example: "21" description: Информация о фактическом адресе example: zip: "125362" settlementType: г. country: RU streetType: ул. street: Подмосковная region: "45" house: "21" settlement: Москва Terminal: type: object properties: termNo: pattern: "^\\d{10}" type: string description: Идентификатор терминала example: "9008056701" status: type: string description: | Код текущего статуса терминала: * `1` - Открыт; * `2` - Закрыт; * `3` - Заблокирован. example: "1" enum: - "1" - "2" - "3" description: Данные о терминале example: termNo: "9008056701" status: "1" LegalInfoResponse: type: object properties: legalId: type: string description: Регистрационный номер ЮЛ в СБП example: LA0000004756 lastName: type: string description: Фамилия firstName: type: string description: Имя middleName: type: string description: Отчество name: type: string description: Наименование ЮЛ example: ООО "ТехноНИКОЛЬ-Строительные Системы" type: type: string description: Организационно-правовая форма ЮЛ example: ООО inn: type: string description: ИНН ЮЛ example: "7706812159" kpp: type: string description: КПП ЮЛ (отсутствует в случае ИП) example: "770501001" ogrn: type: string description: ОГРН ЮЛ example: "1147746831352" contractNumber: type: string description: Номер договора на обслуживание example: СБПС2В-20200911 contractDate: type: string description: Дата заключения договора на обслуживание format: date example: 2020-09-11 status: type: string description: Код текущего статуса ЮЛ example: "2" address: $ref: '#/components/schemas/Address_2' accounts: type: array items: $ref: '#/components/schemas/Account_4' merchants: type: array items: $ref: '#/components/schemas/Merchant' example: ogrn: "1147746831352" lastName: lastName contractDate: 2020-09-11T00:00:00.000+00:00 address: zip: "125362" settlementType: г. country: RU streetType: ул. street: Подмосковная region: "45" house: "21" settlement: Москва legalId: LA0000004756 inn: "7706812159" contractNumber: СБПС2В-20200911 kpp: "770501001" type: ООО firstName: firstName name: ООО "ТехноНИКОЛЬ-Строительные Системы" middleName: middleName accounts: - forB2C: "1" accountNumber: "40702810102300000001" type: LegalAct memberId: "600000000015" - forB2C: "1" accountNumber: "40702810102300000001" type: LegalAct memberId: "600000000015" merchants: - merchantId: "9008056701" status: "1" - merchantId: "9008056701" status: "1" status: "2" Account_4: type: object properties: memberId: type: string description: Идентификатор Банка участника СБП example: "600000000015" accountNumber: type: string description: Номер счета example: "40702810102300000001" type: type: string description: Тип счета example: LegalAct forB2C: type: string description: Признак счета для отправки переводов B2C example: "1" description: Информация о счете ЮЛ example: forB2C: "1" accountNumber: "40702810102300000001" type: LegalAct memberId: "600000000015" Merchant: type: object properties: merchantId: pattern: "^\\d{10}" type: string description: Идентификатор ТСП example: "9008056701" status: type: string description: | Код текущего статуса ТСП: * `1` - Новый; * `2` - Зарегистрирован; * `3` - На удаление. example: "1" enum: - "1" - "2" - "3" description: Данные о ТСП example: merchantId: "9008056701" status: "1" OneTimePaymentUrlRequest: required: - amount - client - merchantId - name - payeeAccount - paymentPurpose - takeTax type: object properties: client: $ref: '#/components/schemas/ClientB2B' name: maxLength: 140 minLength: 1 type: string description: Наименование платежной ссылки example: Ссылка для оплаты ИП Иванов И.П. payeeAccount: pattern: "^\\d{20}$" type: string description: Счет зачисления example: "40702810100010000001" merchantId: pattern: "^.{12}$" type: string description: Идентификатор ТСП example: MF0000000001 amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 ttl: maximum: 129600 minimum: 1 type: integer description: Срок жизни платежной ссылки в минутах example: 4320 default: 4320 paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 redirectUrl: maxLength: 1024 type: string description: Ссылка для перехода после выполнения платежа example: https://exampletsp.io/qwertyui takeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 uip: maxLength: 35 minLength: 1 type: string description: Уникальный идентификатор платежа example: 281000670LSS7DN18SJQDNP4B05KLJL2 payerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика example: "3664069397" example: amount: 1000000 redirectUrl: https://exampletsp.io/qwertyui merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. client: partnerId: 214 b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c payerInn: "3664069397" paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 ttl: 4320 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 takeTax: true ClientB2B: required: - b2bClientId - partnerId type: object properties: b2bClientId: type: string description: "Идентификатор клиента, от имени которого выполняется запро\ с" format: uuid example: 021be5ed-6312-4982-a4e9-2a2cc44bc88c partnerId: type: integer description: Идентификатор партнера format: int64 example: 214 description: Контекст клиента example: partnerId: 214 b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c TakeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true PaymentUrl: required: - image - merchantId - name - payeeAccount - qrcId - qrcType - registrationDate - takeTax type: object properties: qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платёжной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: type: string description: Платёжная ссылка example: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM name: maxLength: 140 minLength: 1 type: string description: Наименование платёжной ссылки example: Ссылка для оплаты ИП Иванов И.П. payeeAccount: pattern: "^\\d{20}$" type: string description: Счет зачисления example: "40702810100010000001" merchantId: pattern: "^.{12}$" type: string description: Идентификатор ТСП example: MF0000000001 amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 qrcType: $ref: '#/components/schemas/QrcType' paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 takeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 image: type: string description: Изображение base64encoded. В формате image/png example: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= lastPayment: $ref: '#/components/schemas/LastPayment' uip: maxLength: 35 minLength: 1 type: string description: Уникальный идентификатор платежа example: 281000670LSS7DN18SJQDNP4B05KLJL2 registrationDate: type: string description: Дата и время регистрации платежной ссылки в формате ISO 8601 format: date-time example: 2022-01-10T12:33:25Z expirationDate: type: string description: Дата и время истечения срока жизни платежной ссылки в формате ISO 8601 format: date-time example: 2022-01-13T12:33:25Z description: Информация о платёжной ссылке example: image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= amount: 1000000 takeTax: true qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. registrationDate: 2022-01-10T12:33:25Z lastPayment: payerAccount: "40702810901400001130" amount: 1000000 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" currency: null paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 timestamp: 2022-05-26T09:09:32Z paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: null expirationDate: 2022-01-13T12:33:25Z QrcType: type: string description: | Тип платежной ссылки: * `ONETIME` - Одноразовая платёжная ссылка; * `REUSABLE` - Многоразовая платёжная ссылка enum: - ONETIME - REUSABLE LastPayment: required: - amount - currency - payerAccount - payerInfo - paymentPurpose - taxAmount - timestamp type: object properties: amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 payerAccount: pattern: "^\\d{20}$" type: string description: Счет списания платежа example: "40702810901400001130" currency: $ref: '#/components/schemas/Currency' timestamp: type: string description: Дата и время выполнения Операции СБП B2B в формате ISO 8601 format: date-time example: 2022-05-26T09:09:32Z payerInfo: $ref: '#/components/schemas/ClientInfo_2' description: Информация о последнем входящем платеже example: payerAccount: "40702810901400001130" amount: 1000000 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" currency: null paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 timestamp: 2022-05-26T09:09:32Z Currency: type: string description: Код валюты платежа enum: - RUR - RUB ClientInfo_2: required: - bankCorrAccount - bankName - bik - inn - name type: object properties: name: maxLength: 140 minLength: 1 type: string description: Наименование ЮЛ плательщика/получателя example: OOO Ромашка inn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика/получателя example: "911006876365" bik: pattern: "^\\d{9}$" type: string description: БИК банка плательщика/получателя example: "044525593" accountType: maxLength: 4 minLength: 4 type: string description: Тип идентификатора номера счета плательщика example: BBAN bankName: maxLength: 50 minLength: 1 type: string description: Наименование банка плательщика/получателя example: АО "АЛЬФА-БАНК" bankCorrAccount: pattern: "^\\d{20}$" type: string description: Корреспондентский счет банка плательщика/получателя example: "30101810200000000593" description: Информация о плательщике или получателе example: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" ReusablePaymentUrlRequest: required: - client - merchantId - name - payeeAccount - takeTax type: object properties: client: $ref: '#/components/schemas/ClientB2B' name: maxLength: 140 minLength: 1 type: string description: Наименование платежной ссылки example: Ссылка для оплаты ИП Иванов И.П. payeeAccount: pattern: "^\\d{20}$" type: string description: Счет зачисления example: "40702810100010000001" merchantId: pattern: "^.{12}$" type: string description: Идентификатор ТСП example: MF0000000001 amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 redirectUrl: maxLength: 1024 type: string description: Ссылка для перехода после выполнения платежа example: https://exampletsp.io/qwertyui takeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 payerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика example: "3664069397" example: amount: 1000000 redirectUrl: https://exampletsp.io/qwertyui merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. client: partnerId: 214 b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c payerInn: "3664069397" paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 takeTax: true PostBatchPaymentUrlRequest: required: - client - paymentUrls type: object properties: client: $ref: '#/components/schemas/ClientB2B' paymentUrls: type: array items: $ref: '#/components/schemas/BatchPaymentUrlRequest' description: Данные запроса на регистрацию массива платёжных ссылок example: client: partnerId: 214 b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c paymentUrls: - amount: 1000000 redirectUrl: https://exampletsp.io/qwertyui merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. payerInn: "3664069397" paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 ttl: 4320 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: ONETIME takeTax: true - amount: 1000000 redirectUrl: https://exampletsp.io/qwertyui merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. payerInn: "3664069397" paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 ttl: 4320 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: ONETIME takeTax: true BatchPaymentUrlRequest: required: - merchantId - name - payeeAccount - qrcType - takeTax type: object properties: name: maxLength: 140 minLength: 1 type: string description: "Наименование платежной ссылки, уникальное в рамках одного\ \ массива" example: Ссылка для оплаты ИП Иванов И.П. payeeAccount: pattern: "^\\d{20}$" type: string description: Счет зачисления example: "40702810100010000001" merchantId: pattern: "^.{12}$" type: string description: Идентификатор ТСП example: MF0000000001 amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 qrcType: example: ONETIME allOf: - $ref: '#/components/schemas/QrcType' ttl: maximum: 129600 minimum: 1 type: integer description: Срок жизни одноразовой платёжной ссылки в минутах example: 4320 default: 4320 paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 redirectUrl: maxLength: 1024 type: string description: Ссылка для перехода после выполнения платежа example: https://exampletsp.io/qwertyui takeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 uip: maxLength: 35 minLength: 1 type: string description: Уникальный идентификатор платежа для одноразовой платёжной ссылки example: 281000670LSS7DN18SJQDNP4B05KLJL2 payerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика example: "3664069397" description: "Данные платёжной ссылки, регистрируемой в массиве" example: amount: 1000000 redirectUrl: https://exampletsp.io/qwertyui merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. payerInn: "3664069397" paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 ttl: 4320 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: ONETIME takeTax: true PostBatchPaymentUrlResponse: type: object properties: batchId: type: string description: Идентификатор массива платёжных ссылок example: a7631fbb-f94f-4c17-1e13-626b4e25585c example: batchId: a7631fbb-f94f-4c17-1e13-626b4e25585c GetPaymentUrlsResponse: required: - paymentUrls type: object properties: pagination: $ref: '#/components/schemas/Pagination_1' paymentUrls: type: array items: $ref: '#/components/schemas/PaymentUrl' example: pagination: offset: 0 limit: 10 totalCount: 1 paymentUrls: - image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= amount: 1000000 takeTax: true qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. registrationDate: 2022-01-10T12:33:25Z lastPayment: payerAccount: "40702810901400001130" amount: 1000000 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" currency: null paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 timestamp: 2022-05-26T09:09:32Z paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: null expirationDate: 2022-01-13T12:33:25Z - image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= amount: 1000000 takeTax: true qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. registrationDate: 2022-01-10T12:33:25Z lastPayment: payerAccount: "40702810901400001130" amount: 1000000 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" currency: null paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 timestamp: 2022-05-26T09:09:32Z paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: null expirationDate: 2022-01-13T12:33:25Z UpdateStatusPaymentUrls: required: - client - paymentUrls type: object properties: client: $ref: '#/components/schemas/ClientB2B' paymentUrls: type: array items: $ref: '#/components/schemas/PaymentUrlStatuses' description: Данные запроса на обновление статусов платёжных ссылок example: client: partnerId: 214 b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c paymentUrls: - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM isActive: true - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM isActive: true PaymentUrlStatuses: required: - isActive - qrcId type: object properties: qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платёжной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM isActive: type: boolean description: Статус платёжной ссылки example: true example: qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM isActive: true GetBatchPaymentUrlResponse: required: - paymentUrls type: object properties: pagination: $ref: '#/components/schemas/Pagination_1' status: type: string description: | Статус регистрации массива платёжных ссылок. Принимает возможные значения: * `IN_PROGRESS` - В обработке; * `COMPLETE` - Регистрация выполнена example: COMPLETE enum: - IN_PROGRESS - COMPLETE paymentUrls: type: array items: $ref: '#/components/schemas/BatchPaymentUrlResponse' example: pagination: offset: 0 limit: 10 totalCount: 1 paymentUrls: - image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= amount: 1000000 registrationStatus: REGISTERED redirectUrl: https://exampletsp.io/qwertyui errorDescription: "Возникла ошибка при регистрации QR со стороны НСПК: {Т\ екст ошибки от НСПК}." payerInn: "3664069397" ttl: 4320 takeTax: true qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. registrationDate: 2022-01-10T12:33:25Z paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: ONETIME expirationDate: 2022-01-13T12:33:25Z - image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= amount: 1000000 registrationStatus: REGISTERED redirectUrl: https://exampletsp.io/qwertyui errorDescription: "Возникла ошибка при регистрации QR со стороны НСПК: {Т\ екст ошибки от НСПК}." payerInn: "3664069397" ttl: 4320 takeTax: true qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. registrationDate: 2022-01-10T12:33:25Z paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: ONETIME expirationDate: 2022-01-13T12:33:25Z status: COMPLETE BatchPaymentUrlResponse: required: - name - payeeAccount - qrcType - registrationStatus - takeTax type: object properties: qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платежной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: type: string description: Платежная ссылка example: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM name: maxLength: 140 minLength: 1 type: string description: Наименование платежной ссылки example: Ссылка для оплаты ИП Иванов И.П. payeeAccount: pattern: "^\\d{20}$" type: string description: Счет зачисления example: "40702810100010000001" merchantId: pattern: "^.{12}$" type: string description: Идентификатор ТСП example: MF0000000001 amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 ttl: maximum: 129600 minimum: 1 type: integer description: Срок жизни одноразовой платёжной ссылки в минутах example: 4320 default: 4320 qrcType: example: ONETIME allOf: - $ref: '#/components/schemas/QrcType' paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 redirectUrl: maxLength: 1024 type: string description: Ссылка для перехода после выполнения платежа example: https://exampletsp.io/qwertyui takeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 image: type: string description: Изображение base64encoded. В формате image/png example: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= uip: maxLength: 35 minLength: 1 type: string description: Уникальный идентификатор платежа example: 281000670LSS7DN18SJQDNP4B05KLJL2 payerInn: pattern: "^((\\d{10})|(\\d{12}))$" type: string description: ИНН плательщика example: "3664069397" registrationDate: type: string description: Дата и время регистрации платежной ссылки в формате ISO 8601 format: date-time example: 2022-01-10T12:33:25Z expirationDate: type: string description: Дата и время истечения срока жизни платежной ссылки в формате ISO 8601 format: date-time example: 2022-01-13T12:33:25Z registrationStatus: type: string description: | Статус регистрации платёжной ссылки. Принимает возможные значения: * `REGISTERED` - Платёжная ссылка зарегистрирована; * `ERROR` - Ошибка при регистрации платёжной ссылки example: REGISTERED enum: - REGISTERED - ERROR errorDescription: type: string description: Описание ошибки при регистрации платёжной ссылки example: "Возникла ошибка при регистрации QR со стороны НСПК: {Текст оши\ бки от НСПК}." description: Информация о платежной ссылке example: image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= amount: 1000000 registrationStatus: REGISTERED redirectUrl: https://exampletsp.io/qwertyui errorDescription: "Возникла ошибка при регистрации QR со стороны НСПК: {Те\ кст ошибки от НСПК}." payerInn: "3664069397" ttl: 4320 takeTax: true qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM merchantId: MF0000000001 name: Ссылка для оплаты ИП Иванов И.П. registrationDate: 2022-01-10T12:33:25Z paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: ONETIME expirationDate: 2022-01-13T12:33:25Z PaymentUrlData: required: - address - brandName - legalId - legalName - mcc - memberId - merchantId - qrcId - qrcType - takeTax type: object properties: qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платежной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM qrcType: $ref: '#/components/schemas/QrcType' legalId: pattern: "^.{12}$" type: string description: Регистрационный номер ЮЛ или ИП (Получателя) example: LF0000000001 legalName: maxLength: 512 type: string description: Сокращенное наименование ЮЛ или ИП example: ООО "Кофейня у Артёма" memberId: pattern: "^.{12}$" type: string description: Идентификатор Банка Получателя example: "100000000001" brandName: maxLength: 35 type: string description: Торговое наименование ТСП example: Кофейня у Артёма payeeAccount: pattern: "^\\d{20}$" type: string description: Номер счета получателя платежа example: "40702810100010000001" merchantId: pattern: "^.{12}$" type: string description: Идентификатор ТСП example: MF0000000001 amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 address: maxLength: 140 minLength: 1 type: string description: Фактический адрес ТСП example: "г. Воронеж, ул. Лисюкова, д.5, стр.1" mcc: pattern: "^\\d{4}$" type: string description: MCC-код example: "4122" fraudScore: maxLength: 16 minLength: 16 type: string description: Идентификатор подозрительной операции Агента ТСП example: "0000000000000000" inn: type: string description: ИНН Получателя (ЮЛ или ИП) example: "4285733785" redirectUrl: maxLength: 1024 type: string description: Ссылка для перехода после выполнения платежа example: https://exampletsp.io/qwertyui agentId: pattern: "^.{12}$" type: string description: "Идентификатор Агента ТСП, который зарегистрировал платежну\ ю ссылку СБП (Банк Получателя)" example: A00000000001 takeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 uip: maxLength: 35 minLength: 1 type: string description: Уникальный идентификатор платежа example: 281000670LSS7DN18SJQDNP4B05KLJL2 description: Данные платёжной ссылки СБП example: brandName: Кофейня у Артёма amount: 1000000 fraudScore: "0000000000000000" agentId: A00000000001 address: "г. Воронеж, ул. Лисюкова, д.5, стр.1" redirectUrl: https://exampletsp.io/qwertyui legalId: LF0000000001 inn: "4285733785" mcc: "4122" takeTax: true qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM legalName: ООО "Кофейня у Артёма" merchantId: MF0000000001 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810100010000001" taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 qrcType: null memberId: "100000000001" GetIncomingPaymentsResponse: required: - payments type: object properties: pagination: $ref: '#/components/schemas/Pagination_1' payments: type: array items: $ref: '#/components/schemas/IncomingPayment' example: pagination: offset: 0 limit: 10 totalCount: 1 payments: - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810901400001289" amount: 1000000 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 currency: null paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 payeeAccount: "40702810901400001130" recipientInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" timestamp: 2022-05-26T09:09:32Z - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810901400001289" amount: 1000000 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 currency: null paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 payeeAccount: "40702810901400001130" recipientInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" timestamp: 2022-05-26T09:09:32Z IncomingPayment: required: - amount - payerInfo - paymentPurpose - qrcId - recipientInfo - timestamp type: object properties: qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платежной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM nspkTransactionId: maxLength: 32 type: string description: Идентификатор операции НСПК example: B467FC50C59A469A9898AB7B05EE3F07 amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 payeeAccount: pattern: "^\\d{20}$" type: string description: Счет зачисления платежа example: "40702810901400001130" payerAccount: pattern: "^\\d{20}$" type: string description: Счет списания example: "40702810901400001289" currency: $ref: '#/components/schemas/Currency' timestamp: type: string description: Дата и время выполнения Операции СБП B2B format: date-time example: 2022-05-26T09:09:32Z payerInfo: $ref: '#/components/schemas/ClientInfo_2' recipientInfo: $ref: '#/components/schemas/ClientInfo_2' description: Информация о входящем платеже example: qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810901400001289" amount: 1000000 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 currency: null paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 payeeAccount: "40702810901400001130" recipientInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" timestamp: 2022-05-26T09:09:32Z GetOutgoingPaymentsResponse: required: - payments type: object properties: pagination: $ref: '#/components/schemas/Pagination_1' payments: type: array items: $ref: '#/components/schemas/OutgoingPayment' example: pagination: offset: 0 limit: 10 totalCount: 1 payments: - amount: 1000000 qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810901400001130" outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 currency: null commission: 100 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 recipientInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" status: COMPLETE timestamp: 2022-05-26T09:09:32Z - amount: 1000000 qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810901400001130" outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 currency: null commission: 100 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 recipientInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" status: COMPLETE timestamp: 2022-05-26T09:09:32Z OutgoingPayment: required: - amount - currency - outgoingPaymentId - payerAccount - payerInfo - paymentPurpose - qrcId - recipientInfo - status - taxAmount type: object properties: outgoingPaymentId: type: string description: Идентификатор платежа в СБП B2B format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платежной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM nspkTransactionId: maxLength: 32 type: string description: Идентификатор операции НСПК example: B467FC50C59A469A9898AB7B05EE3F07 status: type: string description: Статус платежа example: COMPLETE enum: - SENDING_MESSAGE - COMPLETE amount: minimum: 1 type: integer description: Сумма перевода в копейках format: int64 example: 1000000 taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 currency: $ref: '#/components/schemas/Currency' payerAccount: pattern: "^\\d{20}$" type: string description: Счет списания платежа example: "40702810901400001130" paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 timestamp: type: string description: Дата и время выполнения Операции СБП B2B format: date-time example: 2022-05-26T09:09:32Z commission: maxLength: 15 type: integer description: Сумма комиссии в копейках example: 100 payerInfo: $ref: '#/components/schemas/ClientInfo_2' recipientInfo: $ref: '#/components/schemas/ClientInfo_2' description: Информация об исходящем платеже example: amount: 1000000 qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810901400001130" outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 payerInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 currency: null commission: 100 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 recipientInfo: bik: "044525593" bankCorrAccount: "30101810200000000593" accountType: BBAN name: OOO Ромашка inn: "911006876365" bankName: АО "АЛЬФА-БАНК" status: COMPLETE timestamp: 2022-05-26T09:09:32Z OneStepExecuteOutgoingPayment: required: - amount - client - digestSignatures - payerAccount - paymentPurpose - qrcId - takeTax type: object properties: client: $ref: '#/components/schemas/ClientB2B' qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платежной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: pattern: "^\\d{20}$" type: string description: Счет списания example: "40702810100010000001" amount: minimum: 1 type: integer description: Сумма к зачислению в копейках format: int64 example: 1000000 paymentPurpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Оплата по договору №123456789 от 01.09.2001 takeTax: type: boolean description: | Информация о взимании НДС. Возможные значения: * `true` - облагается НДС; * `false` - не облагается НДС example: true taxAmount: minimum: 0 type: integer description: Сумма НДС в копейках format: int64 example: 200000 digestSignatures: type: array items: $ref: '#/components/schemas/Signature_2' description: Данные для формирования и проведения платежа example: qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810100010000001" amount: 1000000 digestSignatures: - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 - poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 client: partnerId: 214 b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c paymentPurpose: Оплата по договору №123456789 от 01.09.2001 taxAmount: 200000 takeTax: true Signature_2: required: - base64Encoded - signatureType type: object properties: base64Encoded: minLength: 1 type: string description: "Значение электронной подписи, закодированное в Base64" example: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: minLength: 1 type: string description: Серийный номер сертификата example: 61000366d11e143acbc03a56d70001000366d1 signatureType: type: string description: Тип электронной подписи (РСА или КЭП) example: RSA enum: - KEP - RSA poaNumber: minLength: 1 type: string description: Номер машиночитаемой доверенности example: DOVER_CBR_7702235133_20211102_1 example: poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 OneStepExecuteOutgoingPaymentResponse: required: - outgoingPaymentId - qrcId - status type: object properties: outgoingPaymentId: type: string description: Идентификатор платежа в СБП B2B format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платежной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM status: type: string description: | Статус платежа: * `SENDING_MESSAGE` - платёж в обработке; * `DRAFT` - черновик платежа зарегистрирован; * `COMPLETE` - платёж выполнен; * `ERROR` - платёж отклонен example: COMPLETE enum: - SENDING_MESSAGE - DRAFT - COMPLETE - ERROR commission: maxLength: 15 type: integer description: Сумма комиссии в копейках example: 100 description: Информация о статусе исходящего платежа с указанием комиссии example: qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 commission: 100 status: COMPLETE OutgoingPaymentStatus: required: - outgoingPaymentId - qrcId - status type: object properties: outgoingPaymentId: type: string description: Идентификатор платежа в СБП B2B format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 qrcId: maxLength: 32 minLength: 1 type: string description: Идентификатор платежной ссылки example: AD1000038AQ1FG409KGACUQU5QRSH3FM status: type: string description: | Статус платежа: * `SENDING_MESSAGE` - Платёж в обработке; * `DRAFT` - Черновик платежа зарегистрирован; * `COMPLETE` - Платёж выполнен; * `ERROR` - Платёж отклонен example: COMPLETE enum: - SENDING_MESSAGE - DRAFT - COMPLETE - ERROR description: Информация о статусе исходящего платежа example: qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 status: COMPLETE inline_response_200: type: object properties: merchantId: type: string example: merchantId: merchantId BusinessException: title: BusinessException required: - detail - instance - status - title - type type: object properties: type: type: string description: Код возникшей ошибки detail: type: string description: Детализация ошибки instance: type: string description: Урл по которому произошла ошибка status: type: integer description: Код ошибки title: type: string description: Описание ошибки description: Информация о возникшей бизнес-ошибке payments_search_body: type: object properties: qrIds: type: array items: type: string PaymentInfoArray: type: array description: Массив платежей items: $ref: '#/components/schemas/PaymentInfo' PaymentInfo: type: object properties: account: type: string amount: type: number currency: type: string operationDate: type: string format: date-time paymentId: type: string paymentStatus: type: string enum: - SUCCESS - DECLINED - IN_PROGRESS qrId: type: string example: operationDate: 2000-01-23T04:56:07.000+00:00 amount: 0.8008281904610115 paymentId: paymentId qrId: qrId currency: currency account: account paymentStatus: SUCCESS LinkDetail: type: object properties: address: type: string description: Адрес магазина или точки amount: type: number description: Сумма оплаты bik: type: string description: БИК банка получателя brandName: type: string description: Торговое наименование магазина или точки inn: type: string description: ИНН получателя legalName: type: string description: Наименование ЮЛ или ИП — получателя платежа merchantId: type: string description: Идентификатор мерчанта paymentPurpose: type: string description: Назначение платежа qrId: type: string description: Идентификатор зарегистрированной ссылки в СБП qrType: type: string description: "Тип ссылки: '01' — многоразовая, '02' — одноразовая" receiverAccount: type: string description: Счет получателя takeTax: type: boolean description: Признак взимания НДС totalTaxAmount: type: number description: Сумма НДС uip: type: string description: Уникальный идентификатор платежа description: Информация о зарегистрированной платежной ссылке example: amount: 0.8008281904610115 brandName: brandName address: address bik: bik inn: inn qrId: qrId receiverAccount: receiverAccount takeTax: true legalName: legalName merchantId: merchantId qrType: qrType paymentPurpose: paymentPurpose totalTaxAmount: 6.027456183070403 uip: uip ReusableLinkRequest: required: - account - currency - merchantId - takeTax type: object properties: account: type: string description: Счет ЮЛ или ИП в банке amount: type: number description: Сумма оплаты (необязательно — может быть задана плательщиком) currency: type: string description: Код валюты по ISO-4217 merchantId: type: string description: Идентификатор ТСП в СБП paymentPurpose: type: string description: Назначение платежа redirectUrl: type: string description: Ссылка возврата из банка в систему ТСП takeTax: type: boolean description: Признак взимания НДС totalTaxAmount: type: number description: Сумма НДС description: Запрос на регистрацию многоразовой платежной ссылки example: amount: 0.8008281904610115 redirectUrl: redirectUrl merchantId: merchantId currency: currency paymentPurpose: paymentPurpose totalTaxAmount: 6.027456183070403 account: account takeTax: true LinkResponse: type: object properties: payload: type: string description: Платежная ссылка для генерации QR-кода qrId: type: string description: Идентификатор зарегистрированной ссылки description: Ответ на регистрацию платежной ссылки example: payload: payload qrId: qrId OneTimeLinkRequest: required: - account - amount - currency - merchantId - orderId - paymentPurpose - takeTax type: object properties: account: type: string description: Счет ЮЛ или ИП в банке amount: type: number description: Сумма оплаты currency: type: string description: Код валюты по ISO-4217 merchantId: type: string description: Идентификатор ТСП в СБП orderId: type: string description: "UUID оплаты, используется для идемпотентности" paymentPurpose: type: string description: Назначение платежа qrTtl: type: number description: Срок действия QR-кода в минутах redirectUrl: type: string description: Ссылка возврата из банка в систему ТСП takeTax: type: boolean description: Признак взимания НДС totalTaxAmount: type: number description: "Сумма НДС, если takeTax = true" uip: type: string description: Уникальный идентификатор платежа description: Запрос на регистрацию одноразовой платежной ссылки example: amount: 0.8008281904610115 redirectUrl: redirectUrl merchantId: merchantId orderId: orderId qrTtl: 6.027456183070403 currency: currency paymentPurpose: paymentPurpose totalTaxAmount: 1.4658129805029452 uip: uip account: account takeTax: true PhonePaymentReportResponse: title: PhonePaymentReportResponse required: - client - payments type: object properties: client: $ref: '#/components/schemas/BasePaymentResponse' payments: type: array items: $ref: '#/components/schemas/PhonePaymentReport' example: payments: - eqTrnId: eqTrnId amount: 6.027456183070403 feeAccount: feeAccount modifyDate: 2000-01-23T04:56:07.000+00:00 errorDescription: errorDescription payPackage: payPackage nameCheck: true inn: inn transactionId: transactionId nspkStatus: nspkStatus sequence: sequence feeAmount: 1.4658129805029452 nspkBankName: nspkBankName nspkTransactionId: nspkTransactionId phone: phone name: middle: middle last: last first: first orderInfo: date: 2000-01-23T04:56:07.000+00:00 number: number recipientAccount: recipientAccount recipientBic: recipientBic account: account nspkName: middle: middle last: last first: first createDate: 2000-01-23T04:56:07.000+00:00 - eqTrnId: eqTrnId amount: 6.027456183070403 feeAccount: feeAccount modifyDate: 2000-01-23T04:56:07.000+00:00 errorDescription: errorDescription payPackage: payPackage nameCheck: true inn: inn transactionId: transactionId nspkStatus: nspkStatus sequence: sequence feeAmount: 1.4658129805029452 nspkBankName: nspkBankName nspkTransactionId: nspkTransactionId phone: phone name: middle: middle last: last first: first orderInfo: date: 2000-01-23T04:56:07.000+00:00 number: number recipientAccount: recipientAccount recipientBic: recipientBic account: account nspkName: middle: middle last: last first: first createDate: 2000-01-23T04:56:07.000+00:00 client: b2cClientId: b2cClientId partnerId: 0 BasePaymentResponse: title: BasePaymentResponse required: - partnerId type: object properties: b2cClientId: type: string description: "Идентификатор клиента, от имени которого интегратором отпр\ авляется платеж" partnerId: type: integer description: Идентификатор партнера format: int64 example: b2cClientId: b2cClientId partnerId: 0 PhonePaymentReport: required: - account - amount - createDate - feeAmount - inn - modifyDate - nspkBankName - payPackage - phone - sequence - transactionId type: object properties: account: type: string description: Счет списания отправителя inn: type: string description: ИНН отправителя transactionId: type: string description: Уникальный идентификатор транзакции sequence: type: string description: Идентификатор платежа плательщика внутри пакета payPackage: type: string description: Идентификатор пакета nspkTransactionId: type: string description: | Код транзакции НСПК nspkBankName: type: string description: Наименование банка получателя nspkName: $ref: '#/components/schemas/FioNspk' name: $ref: '#/components/schemas/Fio' nameCheck: type: boolean description: Переданный в запросе флаг необходимости проверки совпадения переданного ФИО получателя и зарегестрированного ФИО получателя в НСПК eqTrnId: type: string description: Идентификатор платежа в банке-отправителе (EQ) orderInfo: $ref: '#/components/schemas/PhonePaymentReport_orderInfo' phone: type: string description: Телефон получателя amount: type: number description: Сумма платежа feeAccount: type: string description: Счет списания комиссии feeAmount: type: number description: Сумма комиссии платежа createDate: type: string description: Дата/время создания платежа format: date-time modifyDate: type: string description: Дата/время изменения платежа format: date-time nspkStatus: type: string description: Статус платежа в НСПК errorDescription: type: string description: Описание ошибки платежа example: eqTrnId: eqTrnId amount: 6.027456183070403 feeAccount: feeAccount modifyDate: 2000-01-23T04:56:07.000+00:00 errorDescription: errorDescription payPackage: payPackage nameCheck: true inn: inn transactionId: transactionId nspkStatus: nspkStatus sequence: sequence feeAmount: 1.4658129805029452 nspkBankName: nspkBankName nspkTransactionId: nspkTransactionId phone: phone name: middle: middle last: last first: first orderInfo: date: 2000-01-23T04:56:07.000+00:00 number: number recipientAccount: recipientAccount recipientBic: recipientBic account: account nspkName: middle: middle last: last first: first createDate: 2000-01-23T04:56:07.000+00:00 FioNspk: type: object properties: last: type: string description: Фамилия first: type: string description: Имя middle: type: string description: Отчество description: ФИО получателя в НСПК example: middle: middle last: last first: first Fio: type: object properties: last: type: string description: Фамилия first: type: string description: Имя middle: type: string description: Отчество description: ФИО получателя example: middle: middle last: last first: first Error_1: required: - error - error_description type: object properties: error: type: string description: Код ошибки error_description: type: string description: Описание ошибки PhonePaymentRequest: required: - account - client - inn - payments - signedBody - total type: object properties: signedBody: type: string description: Подписанное ЭЦП тело запроса client: $ref: '#/components/schemas/BasePaymentResponse' inn: type: string description: ИНН отправителя account: pattern: "\\d{20}" type: string description: Номер счета отправителя total: type: number description: Общая сумма платежей в пакете nameCheck: type: boolean description: Флаг необходимости проверки совпадения переданного ФИО получателя и зарегестрированного ФИО получателя в НСПК payments: type: array items: $ref: '#/components/schemas/PhonePaymentRequestRecipient' example: total: 0.8008281904610115 nameCheck: true payments: - sequence: sequence amount: 6.027456183070403 nspkBankId: nspkBankId phone: phone name: middle: middle last: last first: first ric: 1 paymentDescription: paymentDescription - sequence: sequence amount: 6.027456183070403 nspkBankId: nspkBankId phone: phone name: middle: middle last: last first: first ric: 1 paymentDescription: paymentDescription inn: inn client: b2cClientId: b2cClientId partnerId: 0 signedBody: signedBody account: account PhonePaymentRequestRecipient: required: - amount - nspkBankId - paymentDescription - phone - ric - sequence type: object properties: name: $ref: '#/components/schemas/Fio' amount: type: number description: Сумма платежа nspkBankId: type: string description: ID банка получателя phone: type: string description: Телефон получателя sequence: type: string description: |- Идентификатор платежа внутри пакета. Формируется потребителем сервиса b2cpay. paymentDescription: type: string description: Описание платежа ric: type: integer description: Код вида дохода example: sequence: sequence amount: 6.027456183070403 nspkBankId: nspkBankId phone: phone name: middle: middle last: last first: first ric: 1 paymentDescription: paymentDescription PhonePaymentResponse: required: - client - payPackage - payments type: object properties: client: $ref: '#/components/schemas/BasePaymentResponse' payPackage: type: string description: Уникальный идентификатор пакета платежей payments: type: array items: $ref: '#/components/schemas/PhonePaymentResponseRecipient' example: payPackage: payPackage payments: - feeAmount: 6.027456183070403 sequence: sequence amount: 0.8008281904610115 phone: phone nameCheck: true name: middle: middle last: last first: first ric: 1 transactionId: transactionId createDate: 2000-01-23T04:56:07.000+00:00 paymentDescription: paymentDescription - feeAmount: 6.027456183070403 sequence: sequence amount: 0.8008281904610115 phone: phone nameCheck: true name: middle: middle last: last first: first ric: 1 transactionId: transactionId createDate: 2000-01-23T04:56:07.000+00:00 paymentDescription: paymentDescription client: b2cClientId: b2cClientId partnerId: 0 PhonePaymentResponseRecipient: required: - amount - createDate - feeAmount - paymentDescription - phone - ric - sequence - transactionId type: object properties: amount: type: number description: Сумма платежа feeAmount: type: number description: Сумма комиссии платежа transactionId: type: string description: Уникальный идентификатор транзакции phone: type: string description: Телефон получателя sequence: type: string description: Идентификатор платежа от внешней системы. Повторяет пришедший в запросе параметр Sequence createDate: type: string description: Дата/Время создания платежа format: date-time paymentDescription: type: string description: Описание платежа name: $ref: '#/components/schemas/Fio' nameCheck: type: boolean description: Переданный в запросе флаг необходимости проверки совпадения переданного ФИО получателя и зарегестрированного ФИО получателя в НСПК ric: type: integer description: Код вида дохода example: feeAmount: 6.027456183070403 sequence: sequence amount: 0.8008281904610115 phone: phone nameCheck: true name: middle: middle last: last first: first ric: 1 transactionId: transactionId createDate: 2000-01-23T04:56:07.000+00:00 paymentDescription: paymentDescription PhonePaymentCheckRequest: required: - client - payments type: object properties: client: $ref: '#/components/schemas/BasePaymentResponse' nameCheck: type: boolean description: Флаг необходимости проверки совпадения переданного ФИО получателя и зарегестрированного ФИО получателя в НСПК payments: type: array items: $ref: '#/components/schemas/PhonePaymentCheckRecipient' example: nameCheck: true payments: - amount: 0.8008281904610115 nspkBankId: nspkBankId phone: phone name: middle: middle last: last first: first - amount: 0.8008281904610115 nspkBankId: nspkBankId phone: phone name: middle: middle last: last first: first client: b2cClientId: b2cClientId partnerId: 0 PhonePaymentCheckRecipient: required: - amount - nspkBankId - phone type: object properties: amount: type: number description: Сумма платежа nspkBankId: type: string description: ID банка получателя phone: type: string description: Телефон получателя name: $ref: '#/components/schemas/Fio' example: amount: 0.8008281904610115 nspkBankId: nspkBankId phone: phone name: middle: middle last: last first: first PhonePaymentCheckResponse: required: - checkId - client type: object properties: checkId: type: string description: "Уникальный идентификатор запроса на проверку, по которому\ \ в дальнейшем возможно получение статуса проверки" client: $ref: '#/components/schemas/BasePaymentResponse' example: client: b2cClientId: b2cClientId partnerId: 0 checkId: checkId PhonePaymentCheckStatusResponse: title: PhonePaymentCheckStatusResponse required: - client - payments type: object properties: client: $ref: '#/components/schemas/BasePaymentResponse' payments: type: array items: $ref: '#/components/schemas/PhonePaymentCheckStatusRecipient' example: payments: - amount: 0.8008281904610115 nspkBankId: nspkBankId phone: phone nameCheck: true name: middle: middle last: last first: first error: error nspkName: middle: middle last: last first: first status: status - amount: 0.8008281904610115 nspkBankId: nspkBankId phone: phone nameCheck: true name: middle: middle last: last first: first error: error nspkName: middle: middle last: last first: first status: status client: b2cClientId: b2cClientId partnerId: 0 PhonePaymentCheckStatusRecipient: required: - amount - nspkBankId - phone - status type: object properties: amount: type: number description: Сумма платежа nspkBankId: type: string description: ID банка получателя nspkName: $ref: '#/components/schemas/FioNspk' name: $ref: '#/components/schemas/Fio' nameCheck: type: boolean description: Переданный в запросе флаг необходимости проверки совпадения переданного ФИО получателя и зарегестрированного ФИО получателя в НСПК phone: type: string description: Телефон получателя status: type: string description: Результат проверки возможности отправки платежа по реквизитам error: type: string description: Ошибка example: amount: 0.8008281904610115 nspkBankId: nspkBankId phone: phone nameCheck: true name: middle: middle last: last first: first error: error nspkName: middle: middle last: last first: first status: status BanksResponse: title: BanksResponse required: - bankId - bankName type: object properties: bankId: type: string description: Идентификатор банка НСПК bankName: type: string description: Наименование банка НСПК example: bankId: bankId bankName: bankName ClientInnResponse: title: ClientInnResponse required: - client - inn type: object properties: client: $ref: '#/components/schemas/BasePaymentResponse' inn: type: string description: ИНН клиента из запроса example: inn: inn client: b2cClientId: b2cClientId partnerId: 0 CreditOffers: title: Кредитные предложения required: - offers type: object properties: offers: title: Массив предложений type: array items: $ref: '#/components/schemas/CreditOffer' default: [] example: offers: - creditProduct: cardInfo: gracePeriod: 5 limit: 5.637376656633329 currency: currency creditInfo: period: 1 rate: 6.027456183070403 webViewUrl: webViewUrl id: 0.8008281904610115 title: title - creditProduct: cardInfo: gracePeriod: 5 limit: 5.637376656633329 currency: currency creditInfo: period: 1 rate: 6.027456183070403 webViewUrl: webViewUrl id: 0.8008281904610115 title: title CreditOffer: title: Объект кредитного предложения required: - id - title type: object properties: id: type: number description: Идентификатор кредитного предложения format: decimal title: type: string description: Тип предложения webViewUrl: type: string description: Ссылка на открытие кредитного предложения в мобильном приложении creditProduct: $ref: '#/components/schemas/CreditProduct' example: creditProduct: cardInfo: gracePeriod: 5 limit: 5.637376656633329 currency: currency creditInfo: period: 1 rate: 6.027456183070403 webViewUrl: webViewUrl id: 0.8008281904610115 title: title CreditProduct: title: Кредитный продукт type: object properties: creditInfo: $ref: '#/components/schemas/CreditInfo' cardInfo: $ref: '#/components/schemas/CardInfo' limit: type: number description: Лимит по кредитному предложению format: double currency: type: string description: Валюта example: cardInfo: gracePeriod: 5 limit: 5.637376656633329 currency: currency creditInfo: period: 1 rate: 6.027456183070403 CreditInfo: title: Информация о кредитном предложении type: object properties: rate: type: number description: Ставка format: decimal period: type: integer description: Срок example: period: 1 rate: 6.027456183070403 CardInfo: title: Данные по картам type: object properties: gracePeriod: type: integer description: Грейс-период example: gracePeriod: 5 GetStatisOrDynamicQRc: required: - qrcType - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 currency: $ref: '#/components/schemas/Currency_1' qrcType: type: string description: | Тип запрашиваемого QR-кода: * `01` - для статического QR-кода; * `02` - для динамического QR-кода. example: "02" enum: - "01" - "02" paymentPurpose: type: string description: Назначение платежа example: Назначение платежа ttl: maximum: 129600 minimum: 1 type: integer description: Срок жизни платежной ссылки в минутах example: 4320 default: 4320 queryData: $ref: '#/components/schemas/QueryData' subscriptionPurpose: type: string description: Цель привязки счета example: Подписка на оплату интернета 500р./мес. redirectUrl: type: string description: Cсылка для автоматического возврата в приложение или на сайт ТСП example: https://exampletsp.io/qwertyui messageId: type: string description: Уникальный идентификатор сообщения example: amount: 10000 redirectUrl: https://exampletsp.io/qwertyui queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status messageId: messageId currency: RUR termNo: "9008056701" paymentPurpose: Назначение платежа subscriptionPurpose: Подписка на оплату интернета 500р./мес. ttl: 4320 qrcType: "02" Currency_1: type: string description: | Код валюты: `RUR` - рубли example: RUR enum: - RUR QueryData: type: object properties: notificationUrl: type: string description: Полный URL для получения уведомления о финальном статусе операции example: http://10.8.18.33:9017/sbp-payment/agent/status description: Данные запроса example: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status GetQRcResponse: required: - image - payload - payrrn - qrcId - status - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "90080567" payload: type: string description: Платёжная ссылка example: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B image: type: string description: Изображение QR-кода в формате Base64 example: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAAQA/w…...YII payrrn: type: string description: Референсный идентификатор запроса example: "000000020512" qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AS1000670LSS7DN18SJQDNP4B05KLJL2 status: type: string description: Статус регистрации Платёжной или Информационной ссылки СБП example: CREATED example: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAAQA/w…...YII payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B payrrn: "000000020512" termNo: "90080567" status: CREATED GetQRcStatusResponse: required: - amount - creditDatePos - payrrn - qrcId - status - termNo - trxDT - trxId type: object properties: creditDatePos: type: string description: "Дата операции, установленная Банком" format: date example: 2022-12-19 termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 currency: $ref: '#/components/schemas/Currency_1' payrrn: type: string description: Референсный идентификатор запроса example: "000000020512" qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AS1000670LSS7DN18SJQDNP4B05KLJL2 status: type: string description: | Статус оплаты QR-кода в НСПК: * `NTST` - операции по QR-коду не существует; * `RCVD` - операция в обработке; * `ACWP` - операция завершена успешно; * `RJCT` - операция отклонена. example: ACWP enum: - NTST - RCVD - ACWP - RJCT trxId: type: string description: Уникальный идентификатор платежа в НСПК example: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 trxDT: type: string description: Дата и время отменяемого платежа format: date-time example: 2022-12-19T07:40:28Z example: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 amount: 10000 trxDT: 2022-12-19T07:40:28Z creditDatePos: 2022-12-19T00:00:00.000+00:00 payrrn: "000000020512" currency: RUR termNo: "9008056701" trxId: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 status: ACWP GetQRcSubscriptionRequest: required: - queryData - subscriptionPurpose - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" subscriptionPurpose: type: string description: Цель привязки счета example: Подписка на оплату интернета 500р./мес. ttl: maximum: 129600 minimum: 1 type: integer description: Срок жизни платежной ссылки в минутах example: 4320 default: 4320 queryData: $ref: '#/components/schemas/GetQRcSubscriptionRequest_queryData' redirectUrl: type: string description: Содержит ссылку для автоматического возврата в приложение или на интернет страницу example: https://exampletsp.io/qwertyui example: redirectUrl: https://exampletsp.io/qwertyui queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status termNo: "9008056701" subscriptionPurpose: Подписка на оплату интернета 500р./мес. ttl: 4320 GetQRcSubscriptionRequest_queryData: required: - notificationUrl type: object properties: notificationUrl: type: string description: Полный URL для получения уведомления о финальном статусе операции example: http://10.8.18.33:9017/sbp-payment/agent/status description: Данные запроса example: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status GetQRcSubscriptionResponse: required: - payload - payrrn - qrcId type: object properties: qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AS1000670LSS7DN18SJQDNP4B05KLJL2 payload: type: string description: Платежная ссылка example: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B payrrn: type: string description: Референсный идентификатор запроса example: "000000020512" example: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B payrrn: "000000020512" PaymentFromBindedAccountRequest: required: - amount - currency - paymentPurpose - senderMemberId - subscriptionToken - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 currency: $ref: '#/components/schemas/Currency_1' paymentPurpose: type: string description: Назначение платежа example: Назначение платежа ttl: maximum: 129600 minimum: 1 type: integer description: Срок жизни платежной ссылки в минутах example: 4320 default: 4320 queryData: $ref: '#/components/schemas/QueryData' redirectUrl: type: string description: Cсылка для автоматического возврата в приложение или на сайт ТСП example: https://exampletsp.io/qwertyui subscriptionToken: type: string description: Идентификатор Привязки счета example: 70LSS7DN18SJQRS10006DNPKLJL24B05 senderMemberId: type: string description: Идентификатор банка Плательщика example: "100000000001" messageId: type: string description: Уникальный идентификатор сообщения description: Платеж с привязанного счета example: amount: 10000 redirectUrl: https://exampletsp.io/qwertyui subscriptionToken: 70LSS7DN18SJQRS10006DNPKLJL24B05 queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status messageId: messageId currency: RUR termNo: "9008056701" paymentPurpose: Назначение платежа ttl: 4320 senderMemberId: "100000000001" PaymentFromBindedAccountResponse: required: - image - payload - payrrn - qrcId - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "90080567" payload: type: string description: Платёжная ссылка example: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B image: type: string description: Изображение QR-кода в формате Base64 example: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAAQA/w…...YII payrrn: type: string description: Референсный идентификатор запроса example: "000000020512" qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AS1000670LSS7DN18SJQDNP4B05KLJL2 example: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAAQA/w…...YII payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B payrrn: "000000020512" termNo: "90080567" QRcRefundRequest: required: - amount - currency - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" payrrn: type: string description: Референсный идентификатор запроса example: "000000020512" qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AD100074066RHM939FE9OQKR0TQ63HB6 originalTrxId: type: string description: Идентификатор исходной операции СБП C2B example: A003610425360300b4ubOp6511E4F998 originalTrxDT: type: string description: Дата и время отменяемого платежа format: date-time example: 2022-12-19T07:40:28Z amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 currency: $ref: '#/components/schemas/Currency_1' queryData: $ref: '#/components/schemas/QueryData' messageId: type: string description: Уникальный идентификатор сообщения example: qrcId: AD100074066RHM939FE9OQKR0TQ63HB6 originalTrxId: A003610425360300b4ubOp6511E4F998 amount: 10000 queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status payrrn: "000000020512" messageId: messageId currency: RUR termNo: "9008056701" originalTrxDT: 2022-12-19T07:40:28Z QRcRefundResponse: required: - amount - currency - payrrn - termNo - trxDT - trxId type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 currency: $ref: '#/components/schemas/Currency_1' payrrn: type: string description: Референсный идентификатор запроса example: "000000020512" trxId: type: string description: Референсный идентификатор операции example: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 trxDT: type: string description: Дата и время платежа format: date-time example: 2022-12-19T07:40:28Z messageId: type: string description: Уникальный идентификатор сообщения example: amount: 10000 trxDT: 2022-12-19T07:40:28Z payrrn: "000000020512" messageId: messageId currency: RUR termNo: "9008056701" trxId: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 GetQRcRefundStatusResponse: required: - amount - originalQRcId - originalTrxId - payerId - status - termNo - trxDT - trxId type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" batchId: type: string description: Уникальный идентификатор смены amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 url: type: string description: Полный URL для получения уведомления о финальном статусе операции example: http://10.8.18.33:9017/sbp-payment/agent/status originalQRcId: pattern: "^.{32}$" type: string description: Идентификатор зарегистрированной платёжной ссылки СБП example: AS1000670LSS7DN18SJQDNP4B05KLJL2 originalTrxId: type: string description: Уникальный идентификатор платежа в НСПК example: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 payerId: type: string description: Маскированный номер телефона получателя (плательщика в исходной операции C2B) example: '*******5526' status: type: string description: | Статус операции возврата СБП: * `NTST` - статус операции неизвестен; * `ACWP` - операция завершена успешно; * `RJCT` - операция отклонена. example: ACWP enum: - NTST - ACWP - RJCT trxId: type: string description: Уникальный идентификатор операции возврата в НСПК example: 1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2 trxDT: type: string description: Дата и время выполнения операции СБП format: date-time example: 2020-07-28T11:45:31Z messageId: type: string description: Уникальный идентификатор сообщения description: Статус запроса возврата средств по операции СБП example: originalQRcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 originalTrxId: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 amount: 10000 trxDT: 2020-07-28T11:45:31Z payerId: '*******5526' messageId: messageId termNo: "9008056701" batchId: batchId trxId: 1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2 url: http://10.8.18.33:9017/sbp-payment/agent/status status: ACWP CashQRcsRegistrationRequest: type: object properties: mediaType: type: string description: Формат получаемого файла example: image/png width: type: string description: Ширина изображения QR-кода example: "200" height: type: string description: Высота изображения QR-кода example: "200" redirectUrl: type: string description: Содержит ссылку для автоматического возврата в приложение или на сайт ТСП example: https://exampletsp.io/qwertyui qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AS1000670LSS7DN18SJQDNP4B05KLJL2 example: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 redirectUrl: https://exampletsp.io/qwertyui width: "200" mediaType: image/png height: "200" CashQRcsRegistrationResponse: required: - payload - qrcId - status - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AS1000670LSS7DN18SJQDNP4B05KLJL2 payload: type: string description: Платежная ссылка example: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B status: type: string description: "Статус кассовой ссылки, полученный из НСПК" example: CREATED image: $ref: '#/components/schemas/Image' example: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 image: mediaType: image/png content: iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAArvElEQVR4Xu2d/bOvVXne/ /B2Pwbvw1OqlrAAAAAElFTkSuQmCC payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B termNo: "9008056701" status: CREATED Image: type: object properties: mediaType: type: string description: Формат получаемого файла example: image/png content: type: string description: Base64-кодированные данные файла изображения QR-кода example: iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAArvElEQVR4Xu2d/bOvVXne/ /B2Pwbvw1OqlrAAAAAElFTkSuQmCC example: mediaType: image/png content: iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAArvElEQVR4Xu2d/bOvVXne/ /B2Pwbvw1OqlrAAAAAElFTkSuQmCC CashQRcsActivationRequest: required: - amount type: object properties: amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 currency: $ref: '#/components/schemas/Currency_1' paymentPurpose: type: string description: Назначение платежа example: "Капучино 300 мл 1 шт., булочка 1 шт." ttl: maximum: 20 minimum: 1 type: integer description: Период использования кассовой ссылки в минутах example: 5 default: 5 queryData: $ref: '#/components/schemas/QueryData' example: amount: 10000 queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status currency: RUR paymentPurpose: "Капучино 300 мл 1 шт., булочка 1 шт." ttl: 5 CashQRcsActivationResponse: required: - amount - paramsId - payrrn - qrcId - termNo type: object properties: termNo: type: string description: Уникальный идентификатор терминала example: "9008056701" paramsId: type: string description: Идентификатор параметров ссылки СБП example: AP5GK3L276DN8PDR8ON1LF4RVOL44444 qrcId: pattern: "^.{32}$" type: string description: Идентификатор QR-кода example: AS1000670LSS7DN18SJQDNP4B05KLJL2 amount: maximum: 100000000 minimum: 1 type: integer description: Сумма операции СБП C2B в копейках example: 10000 currency: $ref: '#/components/schemas/Currency_1' paymentPurpose: type: string description: Назначение платежа example: Назначение платежа payrrn: type: string description: Референсный идентификатор запроса example: "000000020512" example: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 amount: 10000 paramsId: AP5GK3L276DN8PDR8ON1LF4RVOL44444 payrrn: "000000020512" currency: RUR termNo: "9008056701" paymentPurpose: Назначение платежа CreateAccountsApplicationRequest: required: - applicationCreatedAt - applicationId - bic - contractNumber - currency - registryCreatedAt - registryNumber - rowsCount type: object properties: applicationId: maxLength: 35 type: string description: Внешний идентификатор заявления на открытие личного счета applicationCreatedAt: type: string description: Дата создания запроса format: date-time registryNumber: type: string description: Номер реестра registryCreatedAt: type: string description: Дата создания реестра format: date-time currency: type: string description: Валюта зарплаты enum: - RUR contractNumber: type: string description: Номер договора зарплатного проекта bic: type: string description: БИК organization: $ref: '#/components/schemas/OrganizationRequest' rowsCount: type: integer description: Количество сотрудников employees: type: array items: $ref: '#/components/schemas/EmployeeRequest' example: registryNumber: registryNumber rowsCount: 0 organization: country: country address: address inn: inn fullname: fullname accountNumber: accountNumber registryCreatedAt: 2000-01-23T04:56:07.000+00:00 contractNumber: contractNumber applicationCreatedAt: 2000-01-23T04:56:07.000+00:00 currency: RUR applicationId: applicationId employees: - bankBranchOfficeCode: bankBranchOfficeCode lastName: lastName bankBranchCode: bankBranchCode bkiSharingAllowed: true cardInfo: embossedText: firstName: firstName lastName: lastName salutation: salutation salaryType: salaryType type: type currencyCode: currencyCode identityDocument: number: number series: series issuerName: issuerName typeName: typeName issuerCode: issuerCode issueDate: 2000-01-23 typeCode: typeCode employmentDate: 2000-01-23 sex: sex citizenship: citizenship birthDate: 2000-01-23 npp: npp firstName: firstName birthPlace: cityShort: cityShort locationFull: locationFull cityFull: cityFull regionFull: regionFull districtFull: districtFull regionShort: regionShort locationShort: locationShort districtShort: districtShort mobileBank: mobileBank personnelNumber: personnelNumber mobilePhone: mobilePhone salaryAmount: 6.027456183070403 populationCategory: populationCategory middleName: middleName position: position salaryCurrencyCode: salaryCurrencyCode paymentDate: 2000-01-23 contactPhone: contactPhone resident: true - bankBranchOfficeCode: bankBranchOfficeCode lastName: lastName bankBranchCode: bankBranchCode bkiSharingAllowed: true cardInfo: embossedText: firstName: firstName lastName: lastName salutation: salutation salaryType: salaryType type: type currencyCode: currencyCode identityDocument: number: number series: series issuerName: issuerName typeName: typeName issuerCode: issuerCode issueDate: 2000-01-23 typeCode: typeCode employmentDate: 2000-01-23 sex: sex citizenship: citizenship birthDate: 2000-01-23 npp: npp firstName: firstName birthPlace: cityShort: cityShort locationFull: locationFull cityFull: cityFull regionFull: regionFull districtFull: districtFull regionShort: regionShort locationShort: locationShort districtShort: districtShort mobileBank: mobileBank personnelNumber: personnelNumber mobilePhone: mobilePhone salaryAmount: 6.027456183070403 populationCategory: populationCategory middleName: middleName position: position salaryCurrencyCode: salaryCurrencyCode paymentDate: 2000-01-23 contactPhone: contactPhone resident: true bic: bic OrganizationRequest: required: - accountNumber - address - country - fullname - inn type: object properties: fullname: type: string description: Полное название country: type: string description: Страна address: type: string description: Адрес inn: type: string description: ИНН accountNumber: type: string description: Номер счета example: country: country address: address inn: inn fullname: fullname accountNumber: accountNumber EmployeeRequest: required: - bankBranchCode - bankBranchOfficeCode - birthDate - citizenship - firstName - lastName - mobileBank - mobilePhone - npp - resident - salaryCurrencyCode - sex type: object properties: npp: type: string description: НПП сотрудника (Идентификатор строки заявки на открытие ЛС для одного сотрудника) lastName: type: string description: Фамилия firstName: type: string description: Имя middleName: type: string description: Отчество bankBranchCode: type: string description: Отделение банка bankBranchOfficeCode: type: string description: Филиал отделения банка birthDate: type: string description: Дата рождения format: date sex: type: string description: Пол position: type: string description: Должность salaryCurrencyCode: type: string description: Код валюты зарплаты resident: type: boolean description: Резидент citizenship: type: string description: Гражданство populationCategory: type: string description: Категория населения mobilePhone: type: string description: Мобильный телефон mobileBank: type: string description: Мобильный банк bkiSharingAllowed: type: boolean description: Разрешение передачи информации в бюро кредитных историй (БКИ) для овердрафтных карт personnelNumber: type: string description: Табельный номер employmentDate: type: string description: Дата приёма на работу format: date salaryAmount: type: number description: Сумма зарплаты paymentDate: type: string description: Дата выплаты format: date contactPhone: type: string description: Контактный телефон cardInfo: $ref: '#/components/schemas/CardInfoRequest' identityDocument: $ref: '#/components/schemas/IdentityDocumentRequest' birthPlace: $ref: '#/components/schemas/BirthPlaceRequest' example: bankBranchOfficeCode: bankBranchOfficeCode lastName: lastName bankBranchCode: bankBranchCode bkiSharingAllowed: true cardInfo: embossedText: firstName: firstName lastName: lastName salutation: salutation salaryType: salaryType type: type currencyCode: currencyCode identityDocument: number: number series: series issuerName: issuerName typeName: typeName issuerCode: issuerCode issueDate: 2000-01-23 typeCode: typeCode employmentDate: 2000-01-23 sex: sex citizenship: citizenship birthDate: 2000-01-23 npp: npp firstName: firstName birthPlace: cityShort: cityShort locationFull: locationFull cityFull: cityFull regionFull: regionFull districtFull: districtFull regionShort: regionShort locationShort: locationShort districtShort: districtShort mobileBank: mobileBank personnelNumber: personnelNumber mobilePhone: mobilePhone salaryAmount: 6.027456183070403 populationCategory: populationCategory middleName: middleName position: position salaryCurrencyCode: salaryCurrencyCode paymentDate: 2000-01-23 contactPhone: contactPhone resident: true CardInfoRequest: type: object properties: type: type: string description: Наименование карточного продукта currencyCode: type: string description: Код валюты карты embossedText: $ref: '#/components/schemas/CardInfoRequest_embossedText' salaryType: type: string description: Признак зарплатной карты 0 – незарплатная; 1 – зарплатная с оплатой предприятием; 2 – 100% оплата держателем карты; 3 – долевая оплата и предприятием и держателем карты description: Информация о карте example: embossedText: firstName: firstName lastName: lastName salutation: salutation salaryType: salaryType type: type currencyCode: currencyCode IdentityDocumentRequest: required: - issueDate - issuerCode - issuerName - number - series - typeCode - typeName type: object properties: typeName: type: string description: Название типа документа typeCode: type: string description: Код типа документа series: type: string description: Серия number: type: string description: Номер issueDate: type: string description: Дата выдачи format: date issuerName: type: string description: Кем выдан issuerCode: type: string description: Код подразделения description: Сведения о документе удостоверяющем личность example: number: number series: series issuerName: issuerName typeName: typeName issuerCode: issuerCode issueDate: 2000-01-23 typeCode: typeCode BirthPlaceRequest: type: object properties: regionFull: type: string description: Регион (полн.) regionShort: type: string description: Регион (сокр.) districtFull: type: string description: Район (полн.) districtShort: type: string description: Район (сокр.) cityFull: type: string description: Город (полн.) cityShort: type: string description: Город (сокр.) locationFull: type: string description: Населенный пункт (полн.) locationShort: type: string description: Населенный пункт (сокр.) description: Сведения о месте рождения example: cityShort: cityShort locationFull: locationFull cityFull: cityFull regionFull: regionFull districtFull: districtFull regionShort: regionShort locationShort: locationShort districtShort: districtShort CreateAccountsApplicationResponse: required: - applicationCreatedAt - applicationId - contractNumber - orderType - registryCreatedAt - registryNumber - status type: object properties: orderType: type: string description: Тип заявки applicationId: maxLength: 35 type: string description: Внешний ID запроса applicationCreatedAt: type: string description: Дата создания запроса format: date-time registryNumber: type: string description: Номер реестра registryCreatedAt: type: string description: Дата создания реестра format: date-time status: type: string description: Статус сообщения (заявки на открытие ЛС) statusDescription: type: string description: Описание статуса сообщения (заявки на открытие ЛС) contractNumber: type: string description: Номер договора зарплатного проекта organization: $ref: '#/components/schemas/OrganizationResponse' rowsCount: type: integer description: Количество сотрудников employees: type: array items: $ref: '#/components/schemas/EmployeeResponse' example: orderType: orderType statusDescription: statusDescription registryNumber: registryNumber rowsCount: 0 organization: country: country inn: inn fullname: fullname registryCreatedAt: 2000-01-23T04:56:07.000+00:00 contractNumber: contractNumber applicationCreatedAt: 2000-01-23T04:56:07.000+00:00 applicationId: applicationId employees: - lastName: lastName firstName: firstName middleName: middleName account: number: number statusDescription: statusDescription status: status npp: npp - lastName: lastName firstName: firstName middleName: middleName account: number: number statusDescription: statusDescription status: status npp: npp status: status OrganizationResponse: required: - country - fullname - inn type: object properties: fullname: type: string description: Полное название country: type: string description: Страна inn: type: string description: ИНН example: country: country inn: inn fullname: fullname EmployeeResponse: required: - firstName - lastName - npp type: object properties: npp: type: string description: НПП сотрудника (Идентификатор строки заявки на открытие ЛС для одного сотрудника) lastName: type: string description: Фамилия firstName: type: string description: Имя middleName: type: string description: Отчество account: $ref: '#/components/schemas/AccountResponse_2' example: lastName: lastName firstName: firstName middleName: middleName account: number: number statusDescription: statusDescription status: status npp: npp AccountResponse_2: required: - number - status type: object properties: number: type: string description: Открытый лицевой счёт сотрудника status: type: string description: Статус открытия ЛС сотрудника statusDescription: type: string description: Описание статуса открытия ЛС сотрудника example: number: number statusDescription: statusDescription status: status GetAccountsApplicationResponse: required: - applicationCreatedAt - applicationId - contractNumber - orderType - registryCreatedAt - registryNumber - status type: object properties: orderType: type: string description: Тип заявки applicationId: type: string description: Внешний ID запроса applicationCreatedAt: type: string description: Дата создания запроса format: date-time registryNumber: type: string description: Номер реестра registryCreatedAt: type: string description: Дата создания реестра format: date-time status: type: string description: Статус сообщения (заявки на открытие ЛС) statusDescription: type: string description: Описание статуса сообщения (заявки на открытие ЛС) contractNumber: type: string description: Номер договора зарплатного проекта organization: $ref: '#/components/schemas/OrganizationResponse' rowsCount: type: integer description: Количество сотрудников employees: type: array items: $ref: '#/components/schemas/EmployeeResponse_1' example: orderType: orderType statusDescription: statusDescription registryNumber: registryNumber rowsCount: 0 organization: country: country inn: inn fullname: fullname registryCreatedAt: 2000-01-23T04:56:07.000+00:00 contractNumber: contractNumber applicationCreatedAt: 2000-01-23T04:56:07.000+00:00 applicationId: applicationId employees: - lastName: lastName firstName: firstName middleName: middleName account: number: number statusDescription: statusDescription status: status npp: npp - lastName: lastName firstName: firstName middleName: middleName account: number: number statusDescription: statusDescription status: status npp: npp status: status EmployeeResponse_1: required: - firstName - lastName - npp type: object properties: npp: type: string description: НПП сотрудника (Идентификатор строки заявки на открытие ЛС для одного сотрудника) lastName: type: string description: Фамилия firstName: type: string description: Имя middleName: type: string description: Отчество account: $ref: '#/components/schemas/AccountResponse_2' example: lastName: lastName firstName: firstName middleName: middleName account: number: number statusDescription: statusDescription status: status npp: npp CreatePayrollApplicationRequest: required: - admissionValue - applicationCreatedAt - applicationId - bic - contractNumber - payrollId - registryCreatedAt - registryNumber - rowsCount - totalAmount type: object properties: applicationId: maxLength: 35 type: string description: Внешний ID запроса applicationCreatedAt: type: string description: Дата создания запроса format: date-time totalAmount: type: number description: Общая сумма к выплате payrollId: maxLength: 35 type: string description: Идентификатор ведомости admissionValue: type: string description: Код зачисления registryNumber: type: string description: Номер реестра registryCreatedAt: type: string description: Дата создания реестра format: date contractNumber: type: string description: Номер договора зарплатного проекта bic: type: string description: БИК organization: $ref: '#/components/schemas/OrganizationRequest_1' rowsCount: type: integer description: Количество сотрудников employees: type: array items: $ref: '#/components/schemas/EmployeeRequest_1' example: totalAmount: 0.8008281904610115 registryNumber: registryNumber rowsCount: 6 organization: inn: inn fullname: fullname accountNumber: accountNumber registryCreatedAt: 2000-01-23 contractNumber: contractNumber applicationCreatedAt: 2000-01-23T04:56:07.000+00:00 admissionValue: admissionValue payrollId: payrollId applicationId: applicationId employees: - bankBranchOfficeCode: bankBranchOfficeCode lastName: lastName firstName: firstName retentionAmount: 5.637376656633329 bankBranchCode: bankBranchCode amount: 5.962133916683182 bankBic: bankBic middleName: middleName currency: RUR rowNumber: 1.4658129805029452 accountNumber: accountNumber rowId: rowId - bankBranchOfficeCode: bankBranchOfficeCode lastName: lastName firstName: firstName retentionAmount: 5.637376656633329 bankBranchCode: bankBranchCode amount: 5.962133916683182 bankBic: bankBic middleName: middleName currency: RUR rowNumber: 1.4658129805029452 accountNumber: accountNumber rowId: rowId bic: bic OrganizationRequest_1: required: - accountNumber - fullname - inn type: object properties: fullname: type: string description: Полное название inn: type: string description: ИНН accountNumber: type: string description: Номер счета example: inn: inn fullname: fullname accountNumber: accountNumber EmployeeRequest_1: required: - accountNumber - amount - bankBranchCode - bankBranchOfficeCode - currency - firstName - lastName - rowId - rowNumber type: object properties: rowId: maxLength: 35 type: string description: Идентификатор строки ведомости (внутренний) rowNumber: type: number description: Номер строки в ведомости в банк lastName: type: string description: Фамилия firstName: type: string description: Имя middleName: type: string description: Отчество bankBranchCode: type: string description: Отделение банка bankBranchOfficeCode: type: string description: Филиал отделения банка bankBic: type: string description: "БИК банка, в котором открыт счёт, в случае, если он отлича\ ется от банка зарплатного проекта" accountNumber: type: string description: Номер лицевого счета amount: type: number description: К выплате currency: type: string description: Цифровой код валюты enum: - RUR retentionAmount: type: number description: Удержание с зарплаты (Взыскание) example: bankBranchOfficeCode: bankBranchOfficeCode lastName: lastName firstName: firstName retentionAmount: 5.637376656633329 bankBranchCode: bankBranchCode amount: 5.962133916683182 bankBic: bankBic middleName: middleName currency: RUR rowNumber: 1.4658129805029452 accountNumber: accountNumber rowId: rowId CreatePayrollApplicationResponse: required: - applicationCreatedAt - applicationId type: object properties: applicationId: maxLength: 35 type: string description: Внешний ID запроса applicationCreatedAt: type: string format: date-time originalMessage: $ref: '#/components/schemas/CreatePayrollApplicationResponse_originalMessage' payroll: $ref: '#/components/schemas/CreatePayrollApplicationResponse_payroll' example: applicationCreatedAt: 2000-01-23T04:56:07.000+00:00 payroll: reason: reason id: id accrual: reason: reason id: id updatedAt: 2000-01-23T04:56:07.000+00:00 status: status status: status applicationId: applicationId originalMessage: createdAt: 2000-01-23T04:56:07.000+00:00 reason: reason id: id status: status GetPayrollApplicationResponse: required: - applicationCreatedAt - applicationId type: object properties: applicationId: type: string description: Внешний ID запроса applicationCreatedAt: type: string description: Дата создания запроса format: date-time originalMessage: $ref: '#/components/schemas/CreatePayrollApplicationResponse_originalMessage' payroll: $ref: '#/components/schemas/GetPayrollApplicationResponse_payroll' example: applicationCreatedAt: 2000-01-23T04:56:07.000+00:00 payroll: reason: reason id: id accrual: reason: reason id: id updatedAt: 2000-01-23T04:56:07.000+00:00 status: status status: status applicationId: applicationId originalMessage: createdAt: 2000-01-23T04:56:07.000+00:00 reason: reason id: id status: status ClientSubscriptions: type: array items: $ref: '#/components/schemas/ClientSubscription' ClientSubscription: type: object properties: serviceCode: type: string description: Код подключенного сервиса state: type: string description: Статуc подписки (старый) activatedAt: type: string description: Дата и время активации подписки в формате timestamp format: date-time nextFeeAt: type: string description: Дата следующего платежа по подписке в формате YYYY-MM-DD format: date disabledAt: type: string description: Дата фактического отключения подписки в формате YYYY-MM-DD format: date clientDisabledAt: type: string description: Дата отключения подписки клиентом в формате YYYY-MM-DD format: date extendedState: type: string description: "Расширенный статус подписки, для отображения экранов проло\ нгации на обновленных версиях" example: nextFeeAt: 2000-01-23 serviceCode: serviceCode clientDisabledAt: 2000-01-23 activatedAt: 2000-01-23T04:56:07.000+00:00 extendedState: extendedState state: state disabledAt: 2000-01-23 DeliveryPageResponse: type: object properties: pagination: $ref: '#/components/schemas/SimplePage' items: $ref: '#/components/schemas/DeliveryResponse' example: pagination: offset: 0 limit: 1000 totalCount: 10000 items: clientFio: Иванов И. И. productionTypeCode: Неименная documents: - Паспорт regionName: Москва externalId: bf1d1b2f-9ebe-4bf1-8b8f-6f6f6f6f6f6f viewCard: MIR Classic PW Ins brokerageAccountRequired: false smartRepeated: false creationDate: 2025-01-01T00:00:00Z courierFio: Иванов И. И. productCode: CC cityName: Москва deliveryAddress: Ленина 45 clientSES: false slotTo: 12:00 comment: Комментарий processType: Детский банк. ИА Родитель + Ребёнок deliveryDate: 2025-01-15T00:00:00Z slotFrom: 10:00 statusCode: В работе DeliveryResponse: type: object properties: externalId: type: string description: Cквозной код заявки внешних систем example: bf1d1b2f-9ebe-4bf1-8b8f-6f6f6f6f6f6f productCode: type: string description: Код продукта example: CC smartRepeated: type: boolean description: Признак умного повтора при заполнении заявки example: false productionTypeCode: type: string description: Тип производства карты example: Неименная creationDate: type: string description: Дата создания заявки format: date-time example: 2025-01-01T00:00:00Z deliveryDate: type: string description: Дата доставки format: date-time example: 2025-01-15T00:00:00Z slotFrom: pattern: HH:mm type: string description: Начало слота доставки example: 10:00 slotTo: pattern: HH:mm type: string description: Конец слота доставки example: 12:00 statusCode: type: string description: "Статус продукта в доставке, в зависимости от даты доставки\ \ продукта сотрудником" example: В работе clientFio: type: string description: Фио клиента example: Иванов И. И. regionName: type: string description: Наименование региона example: Москва cityName: type: string description: Наименование города example: Москва deliveryAddress: type: string description: Адрес example: Ленина 45 courierFio: type: string description: Фио курьера example: Иванов И. И. viewCard: type: string description: Категория карты example: MIR Classic PW Ins clientSES: type: boolean description: Наличие простой электронной подписи клиента example: false comment: type: string description: Комментарий example: Комментарий brokerageAccountRequired: type: boolean description: Признак наличия брокерского счета example: false processType: type: string description: Название процесса example: Детский банк. ИА Родитель + Ребёнок documents: type: array description: Список документов example: - Паспорт items: type: string description: Тип документа description: Информация о доставке example: clientFio: Иванов И. И. productionTypeCode: Неименная documents: - Паспорт regionName: Москва externalId: bf1d1b2f-9ebe-4bf1-8b8f-6f6f6f6f6f6f viewCard: MIR Classic PW Ins brokerageAccountRequired: false smartRepeated: false creationDate: 2025-01-01T00:00:00Z courierFio: Иванов И. И. productCode: CC cityName: Москва deliveryAddress: Ленина 45 clientSES: false slotTo: 12:00 comment: Комментарий processType: Детский банк. ИА Родитель + Ребёнок deliveryDate: 2025-01-15T00:00:00Z slotFrom: 10:00 statusCode: В работе OrderActionDto: required: - type type: object properties: createdAt: type: string description: Дата и время перехода Заказа в описываемое состояние. ISO 8601. format: date-time type: type: string description: "Тип состояния заказа, соответствует action и определяет пе\ редаваемый набор параметров" enum: - confirmed - rejected - deliver - cancellinginprocess - cancelled - error - atlastmile - pickedup - inprocess - participantchanged - providerchanged - channelchanged - renotified - inprocesswarning expireAt: type: string description: | Дата-Время истечения максимального срока хранения Заказа на последнем логистическом плече. ISO 8601. format: date-time cancelledBy: $ref: '#/components/schemas/OrderCancelledAllOfCancelledByDto' reason: type: string description: | Причина отмены или отклонения заказа example: Невозможно принять заказ cancelledAt: type: string description: | Дата и время отмены заказа. ISO 8601. format: date-time channelId: type: integer description: | Идентификатор канала format: int64 example: 1 providerId: type: integer description: | Идентификатор провайдера format: int64 example: 1 confirmedAt: type: string description: | Дата и время подтверждения заказа. ISO 8601. format: date-time tracking: type: array description: | Массив объектов с информацией от провайдера для отслеживания заказа items: $ref: '#/components/schemas/TrackingDto' providerStateDescription: type: string description: | Человеко-читаемое описание текущего состояния на стороне провайдера example: Заказ передан в сортировку initiator: $ref: '#/components/schemas/OrderCreatedAllOfInitiatorDto' deliveredAt: type: string description: | Дата и время доставки заказа. ISO 8601 format: date-time reportedBy: $ref: '#/components/schemas/OrderErrorAllOfReportedByDto' message: type: string description: | Детализация ошибки example: Заказ утерян beginPointParticipant: $ref: '#/components/schemas/ParticipantDto' endPointParticipant: $ref: '#/components/schemas/ParticipantDto' rejectedBy: $ref: '#/components/schemas/OrderRejectedAllOfRejectedByDto' rejectedAt: type: string description: | Дата и время отклонения заказа. ISO 8601 format: date-time channel: $ref: '#/components/schemas/OrderStateDto_channel' example: reason: Невозможно принять заказ providerStateDescription: Заказ передан в сортировку cancelledAt: 2000-01-23T04:56:07.000+00:00 initiator: name: ПО Снабжение beginPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK channel: sms: "79999999999" email: email@gmail.com cancelledBy: name: 5Post type: provider type: confirmed expireAt: 2000-01-23T04:56:07.000+00:00 reportedBy: name: 5Post type: system message: Заказ утерян tracking: - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= deliveredAt: 2000-01-23T04:56:07.000+00:00 createdAt: 2000-01-23T04:56:07.000+00:00 rejectedBy: name: 5Post type: provider providerId: 1 rejectedAt: 2000-01-23T04:56:07.000+00:00 endPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK confirmedAt: 2000-01-23T04:56:07.000+00:00 channelId: 1 OrderCancelledAllOfCancelledByDto: type: object properties: name: type: string description: | Название субъекта, отменившего Заказ example: 5Post type: type: string description: | Тип отменившего (провайдер, система и т.д.) example: provider description: | Информация о том, кто отменил Заказ example: name: 5Post type: provider TrackingDto: required: - name - value type: object properties: name: type: string description: | Название идентификатора отслеживания example: Штрихкод format: type: string description: | Формат идентификатора enum: - BARCODE - QR - TRACKING_NUMBER - LABEL - CODE128 value: type: array description: | Значение идентификатора в формате base64 example: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= items: type: string format: byte example: name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= OrderCreatedAllOfInitiatorDto: type: object properties: name: type: string description: | Название инициатора Заказа example: ПО Снабжение description: | Информация об инициаторе создания Заказа example: name: ПО Снабжение OrderErrorAllOfReportedByDto: type: object properties: name: type: string description: | Название источника ошибки example: 5Post type: type: string description: | Тип источника ошибки (провайдер, система и т.д.) example: system description: | Информация о том, кто сообщил об ошибке example: name: 5Post type: system ParticipantDto: required: - id - name - type type: object properties: id: type: integer description: | Идентификатор участника format: int64 readOnly: true example: 35 type: type: string description: | Тип участника example: SVK enum: - INDIVIDUAL - SVK - SPD - LEGAL_ENTITY name: type: string example: Иванов Иван Иванович example: name: Иванов Иван Иванович id: 35 type: SVK OrderRejectedAllOfRejectedByDto: type: object properties: name: type: string description: | Название субъекта, отклонившего Заказ example: 5Post type: type: string description: | Тип отклонившего (провайдер, система и т.д.) example: provider example: name: 5Post type: provider OrderStateDto_channel: type: object properties: sms: type: string description: "Номер телефона для SMS в международном формате (например,\ \ +79999999999)" example: "79999999999" email: type: string description: Адрес электронной почты format: email example: email@gmail.com description: | Мапа, содержащая информацию о каналах для связи. Доступные каналы: sms (номер телефона), email (адрес электронной почты). example: sms: "79999999999" email: email@gmail.com ErrorDto: required: - error type: object properties: error: type: string description: | Код ошибки error_description: type: string description: | Описание ошибки ErrorScope_1: required: - error type: object properties: error: type: string description: | Код ошибки. Принимает возможные значения: * 'insufficient_scope` - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; * `insufficient_privileges` - у пользователя нет прав на просмотр счёта; * `access_denied` - доступ к счёту запрещён example: insufficient_scope error_description: type: string description: Описание ошибки example: The request requires higher privileges than provided by the access token description: "У пользователя нет прав на использование запрашиваемого сервис\ а, доступ к которому не предусмотрен настройками scope" ProviderLocationDto: required: - address - coordinates - id - name - type type: object properties: id: type: string description: | Идентификатор локации в формате UUIDv7. Если возвращается значение "00000000-0000-0000-0000-000000000000" - точка отправления не определена readOnly: true example: 019a150b-5a59-7883-8d22-79890fd909d6 name: type: string description: Наименование локации example: Постамат 5Post type: type: string description: | Тип локации example: parcel_locker enum: - parcel_locker - shop address: type: string description: Полный адрес example: "Москва г, ул Калинина, д 5" coordinates: $ref: '#/components/schemas/Coordinates' description: type: string description: Описание постамата example: Постамат на улице Калинина externalId: type: string description: Идентификатор постамата на стороне провайдера example: 019a150b-5a59-7883-8d22-79890fd909d6 example: address: "Москва г, ул Калинина, д 5" name: Постамат 5Post coordinates: latitude: 0.8008281904610115 longitude: 6.027456183070403 description: Постамат на улице Калинина externalId: 019a150b-5a59-7883-8d22-79890fd909d6 id: 019a150b-5a59-7883-8d22-79890fd909d6 type: parcel_locker discriminator: propertyName: type Coordinates: required: - latitude - longitude type: object properties: latitude: type: number description: Широта format: double longitude: type: number description: Долгота format: double description: Объект с информацией о координатах адреса example: latitude: 0.8008281904610115 longitude: 6.027456183070403 LocationIds: type: object properties: ids: maxItems: 1000 minItems: 1 type: array description: | Массив идентификаторов локаций в формате UUIDv7 items: maxLength: 1000 minLength: 1 type: string example: ids: - ids - ids - ids - ids - ids OrderDto: required: - beginPoint - endPoint - parcel type: object properties: id: type: string description: | Идентификатор заказа readOnly: true providerId: type: integer format: int64 readOnly: true channelId: type: integer format: int64 readOnly: true limits: $ref: '#/components/schemas/OrderLimitsDto' parcel: $ref: '#/components/schemas/ParcelDto' beginPoint: $ref: '#/components/schemas/LogisticPointDto' endPoint: $ref: '#/components/schemas/LogisticPointDto' states: type: array description: | Массив объектов с информацией о состояниях заказа readOnly: true items: $ref: '#/components/schemas/OrderStateDto' example: endPoint: phone: phone locationId: locationId from: 2000-01-23T04:56:07.000+00:00 to: 2000-01-23T04:56:07.000+00:00 participant: name: Иванов Иван Иванович id: 35 type: SVK email: email parcel: amount: 7 length: 3 width: 2 externalIds: key: externalIds weight: 7 description: description value: 4 height: 9 beginPoint: phone: phone locationId: locationId from: 2000-01-23T04:56:07.000+00:00 to: 2000-01-23T04:56:07.000+00:00 participant: name: Иванов Иван Иванович id: 35 type: SVK email: email providerId: 0 id: id channelId: 6 limits: whiteListChannelIds: - 1 - 1 blackListChannelIds: - 5 - 5 whiteListProviderIds: - 5 - 5 blackListProviderIds: - 2 - 2 states: - actual: false reason: Невозможно принять заказ providerStateDescription: Заказ передан в сортировку cancelledAt: 2000-01-23T04:56:07.000+00:00 initiator: name: ПО Снабжение beginPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK channel: sms: "79999999999" email: email@gmail.com cancelledBy: name: 5Post type: provider type: created expireAt: 2000-01-23T04:56:07.000+00:00 reportedBy: name: 5Post type: system message: Заказ утерян tracking: - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= deliveredAt: 2000-01-23T04:56:07.000+00:00 createdAt: 2000-01-23T04:56:07.000+00:00 rejectedBy: name: 5Post type: provider providerId: 1 rejectedAt: 2000-01-23T04:56:07.000+00:00 endPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK confirmedAt: 2000-01-23T04:56:07.000+00:00 channelId: 1 - actual: false reason: Невозможно принять заказ providerStateDescription: Заказ передан в сортировку cancelledAt: 2000-01-23T04:56:07.000+00:00 initiator: name: ПО Снабжение beginPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK channel: sms: "79999999999" email: email@gmail.com cancelledBy: name: 5Post type: provider type: created expireAt: 2000-01-23T04:56:07.000+00:00 reportedBy: name: 5Post type: system message: Заказ утерян tracking: - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= deliveredAt: 2000-01-23T04:56:07.000+00:00 createdAt: 2000-01-23T04:56:07.000+00:00 rejectedBy: name: 5Post type: provider providerId: 1 rejectedAt: 2000-01-23T04:56:07.000+00:00 endPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK confirmedAt: 2000-01-23T04:56:07.000+00:00 channelId: 1 OrderLimitsDto: type: object properties: whiteListChannelIds: type: array description: | Массив со списком идентификаторов каналов. Заказ может быть обработан только через указанные каналы доставки. items: type: integer format: int64 blackListChannelIds: type: array description: | Массив со списком идентификаторов каналов. Запрещено использовать каналы доставки с переданными идентификаторами. items: type: integer format: int64 whiteListProviderIds: type: array description: | Массив со списком идентификаторов провайдеров. Заказ могут обслуживать только провайдеры, чьи идентификаторы были переданы. items: type: integer format: int64 blackListProviderIds: type: array description: | Массив со списком идентификаторов провайдеров. Запрещено назначать на заказ провайдеров с переданными идентификаторами. items: type: integer format: int64 description: | Объект с информацией об ограничениях заказа на доставку. Не учитывается провайдером, т.к. провайдер получает только доступные ему Заказы. example: whiteListChannelIds: - 1 - 1 blackListChannelIds: - 5 - 5 whiteListProviderIds: - 5 - 5 blackListProviderIds: - 2 - 2 ParcelDto: required: - description - height - length - weight - width type: object properties: weight: type: integer description: | Вес посылки в миллиграммах format: int32 height: type: integer description: | Высота посылки в миллиметрах format: int32 length: type: integer description: | Длина посылки в миллиметрах format: int32 width: type: integer description: | Ширина посылки в миллиметрах format: int32 description: type: string description: | Описание посылки value: type: integer description: | Объявленная ценность посылки format: int32 amount: type: integer description: | Количество товаров в посылке format: int32 externalIds: type: object additionalProperties: type: string description: | Внутри объекта находятся идентификаторы Заказа в Инициаторе заказа в формате ключ-значение (мапа) description: | Объект с информацией о доставляемой посылке example: amount: 7 length: 3 width: 2 externalIds: key: externalIds weight: 7 description: description value: 4 height: 9 LogisticPointDto: required: - from - locationId - participant - phone - to type: object properties: locationId: type: string description: | Идентификатор локации в формате UUIDv7 from: type: string description: | Начало временного интервала (дата и время в формате ISO 8601) format: date-time to: type: string description: | Конец временного интервала (дата и время в формате ISO 8601) format: date-time participant: $ref: '#/components/schemas/ParticipantDto' phone: type: string description: | Номер телефона для связи с получателем/отправителем заказа email: type: string description: | Email-адрес для связи с получателем/отправителем заказа example: phone: phone locationId: locationId from: 2000-01-23T04:56:07.000+00:00 to: 2000-01-23T04:56:07.000+00:00 participant: name: Иванов Иван Иванович id: 35 type: SVK email: email OrderStateDto: required: - actual - type type: object properties: createdAt: type: string description: Дата и время перехода Заказа в описываемое состояние. ISO 8601. format: date-time type: type: string description: "Тип состояния заказа, соответствует action и определяет пе\ редаваемый набор параметров" enum: - created - confirmed - rejected - delivered - cancellinginprocess - cancelled - error - atlastmile - pickedup - inprocess - participantchanged - providerchanged - channelchanged - renotified - inprocesswarning actual: type: boolean description: Признак актуальности состояния (true - текущее состояние) example: false expireAt: type: string description: | Дата-Время истечения максимального срока хранения Заказа на последнем логистическом плече. ISO 8601. format: date-time cancelledBy: $ref: '#/components/schemas/OrderCancelledAllOfCancelledByDto' reason: type: string description: | Причина отмены или отклонения заказа example: Невозможно принять заказ cancelledAt: type: string description: | Дата и время отмены заказа. ISO 8601. format: date-time channelId: type: integer description: | Идентификатор канала format: int64 example: 1 providerId: type: integer description: | Идентификатор провайдера format: int64 example: 1 confirmedAt: type: string description: | Дата и время подтверждения заказа. ISO 8601. format: date-time tracking: type: array description: | Массив объектов с информацией от провайдера для отслеживания заказа items: $ref: '#/components/schemas/TrackingDto' providerStateDescription: type: string description: | Человеко-читаемое описание текущего состояния на стороне провайдера example: Заказ передан в сортировку initiator: $ref: '#/components/schemas/OrderCreatedAllOfInitiatorDto' deliveredAt: type: string description: | Дата и время доставки заказа. ISO 8601 format: date-time reportedBy: $ref: '#/components/schemas/OrderErrorAllOfReportedByDto' message: type: string description: | Детализация ошибки example: Заказ утерян beginPointParticipant: $ref: '#/components/schemas/ParticipantDto' endPointParticipant: $ref: '#/components/schemas/ParticipantDto' rejectedBy: $ref: '#/components/schemas/OrderRejectedAllOfRejectedByDto' rejectedAt: type: string description: | Дата и время отклонения заказа. ISO 8601 format: date-time channel: $ref: '#/components/schemas/OrderStateDto_channel' example: actual: false reason: Невозможно принять заказ providerStateDescription: Заказ передан в сортировку cancelledAt: 2000-01-23T04:56:07.000+00:00 initiator: name: ПО Снабжение beginPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK channel: sms: "79999999999" email: email@gmail.com cancelledBy: name: 5Post type: provider type: created expireAt: 2000-01-23T04:56:07.000+00:00 reportedBy: name: 5Post type: system message: Заказ утерян tracking: - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= - name: Штрихкод format: BARCODE value: - 0J/RgNC40LLQtdGCLCDQvNC40YAg0LzRgtC30YHQtdC70Lg= deliveredAt: 2000-01-23T04:56:07.000+00:00 createdAt: 2000-01-23T04:56:07.000+00:00 rejectedBy: name: 5Post type: provider providerId: 1 rejectedAt: 2000-01-23T04:56:07.000+00:00 endPointParticipant: name: Иванов Иван Иванович id: 35 type: SVK confirmedAt: 2000-01-23T04:56:07.000+00:00 channelId: 1 ComplianceResponse: required: - result type: object properties: result: type: boolean description: Результат проверки комплаенса example: result: true requestUuid_1: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Идентификатор в формате UUID example: 0521cc44-ae0f-4e73-9b16-a1630d50e444 PaymentStatusResponse: required: - status type: object properties: status: type: string description: | Статус платежного поручения: * `NEW` - Новое; * `SENT` - Отправлено; * `ERROR` - Ошибка; * `RECEIVED` - Получено; * `VERIFICATION` - На проверке; * `REJECTED` - Отклонено; * `EXECUTION` - На исполнении; * `EXECUTED` - Исполнено; * `OVERDUE` - Просрочено; * `PARTIALLY_PAID` - Частично оплачено; * `PAID` - Оплачено; * `CLOSED` - Закрыто. enum: - NEW - SENT - ERROR - RECEIVED - VERIFICATION - REJECTED - EXECUTION - EXECUTED - OVERDUE - PARTIALLY_PAID - PAID - CLOSED description: Статус платежного поручения example: status: NEW CreatePaymentRequest: required: - compensationPeriod - creditorInfo - currencyCode - externalId - monetaryClaimAmount - orderType - paymentPurpose - principalInfo type: object properties: externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string description: Идентификатор в формате UUID example: 0521cc44-ae0f-4e73-9b16-a1630d50e444 principalInfo: $ref: '#/components/schemas/PrincipalInfo' creditorInfo: $ref: '#/components/schemas/CreditorInfo' orderType: type: string description: Тип платежного поручения example: BUDGET enum: - BUDGET - NONBUDGET compensationPeriod: type: string description: Период компенсации (в днях) example: "365" paymentPurpose: type: string description: Назначение платежа example: Оплата за услуги currencyCode: type: string description: | Код валюты: * `RUR` - Российский рубль; * `CNY` - Юань; * `UZS` - Узбекский сум; * `TRY` - Турецкая лира; * `KZT` - Тенге; * `TJS` - Сомони; * `KGS` - Сом; * `MDL` - Молдавский лей; * `JPY` - Йена; * `INR` - Индийская рупия; * `EUR` - Евро; * `USD` - Доллар США; * `AED` - Дирхам ОАЭ; * `BYN` - Белорусский рубль; * `AMD` - Армянский драм; * `AZN` - Азербайджанский манат. example: RUB enum: - RUR - CNY - UZS - TRY - KZT - TJS - KGS - MDL - JPY - INR - EUR - USD - AED - BYN - AMD - AZN monetaryClaimAmount: type: number description: Сумма поручения (денежного требования) example: 150077.88 monetaryClaimId: type: string description: Идентификатор денежного требования (опционально) example: claim-123 contractNumber: type: string description: Номер контракта (опционально) example: "12345" contractDate: type: string description: Дата контракта (опционально) format: date example: 2023-05-10 fixedRatePercentage: type: number description: Фиксированная ставка (% годовых) (опционально) example: 5.5 floatRatePercentage: type: number description: Надбавка плавающей ставки (% пунктов) (опционально) example: 1.25 paymentPriority: type: string description: Очередность платежа (опционально) example: "5" payerStatus: type: string description: Статус плательщика (опционально) example: "101" accrualUniqueId: type: string description: "Уникальный идентификатор начисления, УИН (опционально)" example: 22-1234567890 taxPaymentCode: type: string description: Код основания налогового платежа (опционально) example: "106" taxPeriod: type: string description: Налоговый период (опционально) example: "2021" baseDocumentType: type: string description: Документ-основание (опционально) example: Счет baseDocumentDate: type: string description: Дата документа-основания (опционально) example: 2023-04-01 kbk: type: string description: КБК кредитора (опционально) example: "18210102010011000110" oktmo: type: string description: ОКТМО кредитора (опционально) example: "45384000" description: Запрос на сохранение платежного поручения example: orderType: BUDGET monetaryClaimId: claim-123 contractDate: 2023-05-10T00:00:00.000+00:00 compensationPeriod: "365" taxPeriod: "2021" monetaryClaimAmount: 150077.88 floatRatePercentage: 1.25 externalId: 0521cc44-ae0f-4e73-9b16-a1630d50e444 contractNumber: "12345" fixedRatePercentage: 5.5 creditorInfo: ogrn: "1027700132195" name: ООО Кредитор inn: "7707083893" bankBIC: "044525225" bankCorrAccountNumber: "30101810400000000225" kpp: "773601001" bankName: Банк Пример accountNumber: "40702810500000000001" principalInfo: name: ООО Виктория inn: "7707083893" kpp: "773601001" paymentPriority: "5" payerStatus: "101" accrualUniqueId: 22-1234567890 baseDocumentType: Счет taxPaymentCode: "106" oktmo: "45384000" kbk: "18210102010011000110" paymentPurpose: Оплата за услуги baseDocumentDate: 2023-04-01 currencyCode: RUB PrincipalInfo: required: - inn - name type: object properties: name: type: string description: Наименование принципала example: ООО Виктория inn: type: string description: ИНН принципала example: "7707083893" kpp: type: string description: КПП принципала (опционально) example: "773601001" description: Данные принципала example: name: ООО Виктория inn: "7707083893" kpp: "773601001" CreditorInfo: required: - accountNumber - bankBIC - bankCorrAccountNumber - bankName - inn - name type: object properties: name: type: string description: Наименование кредитора example: ООО Кредитор inn: type: string description: ИНН кредитора example: "7707083893" kpp: type: string description: КПП кредитора (опционально) example: "773601001" ogrn: type: string description: ОГРН кредитора (опционально) example: "1027700132195" bankName: type: string description: Наименование банка кредитора example: Банк Пример bankBIC: type: string description: БИК банка кредитора example: "044525225" bankCorrAccountNumber: type: string description: Корреспондентский счет банка кредитора example: "30101810400000000225" accountNumber: type: string description: Расчетный счет кредитора example: "40702810500000000001" description: Данные кредитора example: ogrn: "1027700132195" name: ООО Кредитор inn: "7707083893" bankBIC: "044525225" bankCorrAccountNumber: "30101810400000000225" kpp: "773601001" bankName: Банк Пример accountNumber: "40702810500000000001" SavePaymentResponse: required: - externalId - paymentId type: object properties: externalId: type: string description: Идентификатор платежного поручения в ERP системе format: uuid example: f47ac10b-58cc-4372-a567-0e02b2c3d479 paymentId: type: string description: Идентификатор платежного поручения в банке format: uuid description: Ответ при сохранении платежного поручения example: paymentId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479 RegisterStatusResponse: required: - status type: object properties: status: type: string description: | Статус реестра: * `NEW` - Новое; * `SENT` - Отправлено; * `ERROR` - Ошибка; * `RECEIVED` - Загружено; * `VERIFICATION` - На проверке; * `EXECUTION` - В работе; * `EXECUTED` - Исполнено; * `OVERDUE` - Просрочено; * `PAID` - Оплачено; * `REJECTED` - Отклонено; * `CLOSED` - Закрыто. enum: - NEW - SENT - ERROR - RECEIVED - VERIFICATION - EXECUTION - EXECUTED - OVERDUE - PAID - REJECTED - CLOSED description: Статус реестра платежных поручений example: status: NEW CreateRegisterRequest: required: - paymentIds - plannedExecutionDate - totalSum type: object properties: totalSum: type: number description: Общая сумма по всем платежным поручениям example: 100000.01 plannedExecutionDate: type: string description: "Плановая дата исполнения поручения, заполняется при создан\ ии реестра поручений" format: date example: 2024-02-15 paymentIds: maxItems: 1000 minItems: 1 type: array description: массив уникальных идентификаторов платежных поручений items: $ref: '#/components/schemas/requestUuid_1' description: Данные для создания и обработки платежных поручений example: totalSum: 100000.01 paymentIds: - 0521cc44-ae0f-4e73-9b16-a1630d50e444 - 0521cc44-ae0f-4e73-9b16-a1630d50e444 - 0521cc44-ae0f-4e73-9b16-a1630d50e444 - 0521cc44-ae0f-4e73-9b16-a1630d50e444 - 0521cc44-ae0f-4e73-9b16-a1630d50e444 plannedExecutionDate: 2024-02-15T00:00:00.000+00:00 SaveRegisterResponse: required: - file - id type: object properties: id: type: string description: Идентификатор реестра format: uuid example: 76ec6909-dacd-47af-a71d-9db02a3679a7 file: type: string description: Base64-кодированный файл example: SGVsbG8sIFdvcmxkIQ== registerNumber: type: integer description: Номер реестра format: int32 example: 13791 description: Ответ при сохранении реестра платежных поручений example: file: SGVsbG8sIFdvcmxkIQ== id: 76ec6909-dacd-47af-a71d-9db02a3679a7 registerNumber: 13791 SignRegisterRequest: required: - digestSignatures - registerId type: object properties: registerId: type: string description: Идентификатор реестра format: uuid digestSignatures: $ref: '#/components/schemas/DigestSignatures_3' description: Запрос на подписание реестра платежных поручений example: digestSignatures: base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 registerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 DigestSignatures_3: required: - base64Encoded - certificateUuid type: object properties: base64Encoded: type: string description: Подпись принципала в формате Base64 example: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: type: string description: Идентификатор сертификата format: uuid example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 description: Данные подписи принципала example: base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 SignRegisterResponse: type: object properties: message: type: string description: Успешное подписание реестра example: message: message UpdateOrderRequest: required: - orderId - status type: object properties: quantity: type: integer description: Количество лимитов списание которых отменяем по данному orderId (extnum) format: int64 example: 5 orderId: type: string description: Внешний уникальный идентификатор операции снятия лимитов example: ST1057RQKDD partnerName: type: string description: Название организации-партнера которая запрашивает списание example: ST status: type: string description: Новый статус заказа example: L example: quantity: 5 orderId: ST1057RQKDD partnerName: ST status: L UpdateOrderResponse: type: object properties: quantity: type: integer description: Количество оставшихся действующих списаний по данному extnum (внешний orderId) format: int64 orderId: type: string description: Внешний референс запроса partnerName: type: string description: Название организации-партнера которая запрашивает редактирование status: type: string description: Новый статус заказа example: quantity: 0 orderId: orderId partnerName: partnerName status: status CreateOrderRequest: required: - quantity type: object properties: quantity: type: integer description: Кол-во лимитов к списанию format: int64 example: 4 partnerName: type: string description: Название организации-партнера которая запрашивает списание example: ST createdAt: type: string description: Дата создания заказа на списание format: date-time example: 2024-01-11T23:19:09.224Z example: createdAt: 2024-01-11T23:19:09.224Z quantity: 4 partnerName: ST CreateOrderResponse: type: object properties: quantity: type: integer description: Количество лимитов снятых по запросу format: int64 orderId: type: string description: Внешний референс запроса partnerName: type: string description: Название организации-партнера которая запрашивает списание createdAt: type: string description: Дата создания заказа на списание format: date-time example: createdAt: 2000-01-23T04:56:07.000+00:00 quantity: 0 orderId: orderId partnerName: partnerName ErrorLowBalance: required: - error type: object properties: error: type: string description: Код ошибки example: operation_refused error_description: type: string example: "Unable to process: low balance" description: Недостаточно кол-во лимитов для осуществления компенсации GetBalanceResponse: type: object properties: quantity: type: integer description: Баланс лимитов БЗ format: int64 customerSP: type: string description: Пакет услуг клиента example: quantity: 0 customerSP: customerSP CreateLoungeReportRequest: type: object properties: id: type: string description: Уникальный идентификатор события в системе партнера format: uuid alfaData: $ref: '#/components/schemas/AlfaDataDto' count: $ref: '#/components/schemas/CountDto' category: type: string description: Тип услуги enum: - BUSINESS_LOUNGE - VIP_LOUNGE - FAST_TRACK usingArea: type: string description: Регион услуги enum: - DOMESTIC - INTERNATIONAL - ALFA requestDateTime: type: string description: Дата и время создания услуги (utc 0) format: date-time eventDateTime: type: string description: Дата и время создания события услуги (utc 0) format: date-time service: $ref: '#/components/schemas/ServiceDto' price: $ref: '#/components/schemas/PriceDto' transactionType: type: string description: Тип оформления услуги enum: - FREE - PAID eventStatus: type: string description: Тип события по услуге enum: - CREATED - EXECUTED - CANCELLED - TRANSPORT_HUB_CANCELLED - EXPIRED - PAID example: transactionType: FREE eventDateTime: 2000-01-23T04:56:07.000+00:00 requestDateTime: 2000-01-23T04:56:07.000+00:00 service: country: country travelType: DOMESTIC transportHub: transportHub name: name id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: ARRIVAL price: total: 5.637376656633329 baby: 9.301444243932576 adult: 2.3021358869347655 child: 7.061401241503109 eventStatus: CREATED alfaData: orderId: orderId userId: userId count: request: 0 baby: 5 adult: 6 child: 1 usingArea: DOMESTIC id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 category: BUSINESS_LOUNGE AlfaDataDto: type: object properties: userId: type: string description: Внешний идентификатор клиента банка (ФЛ) orderId: type: string description: Внешний номер заказа format: "uuid," example: orderId: orderId userId: userId CountDto: type: object properties: request: type: integer description: Кол-во гостей в запросе на услугу format: int32 adult: type: integer description: Кол-во взрослых в событии услуги format: int32 child: type: integer description: Кол-во детей в событии услуги format: int32 baby: type: integer description: Кол-во младенцев в событии услуги format: int32 example: request: 0 baby: 5 adult: 6 child: 1 ServiceDto: type: object properties: id: type: string description: Id услуги format: uuid name: type: string description: Название услуги transportHub: type: string description: Название аэропорта country: type: string description: Название страны type: type: string description: Тип услуги enum: - ARRIVAL - DEPARTURE - GENERAL travelType: type: string description: Тип поездки enum: - DOMESTIC - INTERNATIONAL - GENERAL example: country: country travelType: DOMESTIC transportHub: transportHub name: name id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: ARRIVAL PriceDto: type: object properties: total: type: number description: Итоговая стоимость с учетом кол-ва гостей adult: type: number description: Стоимость за 1 взрослого child: type: number description: Стоимость за 1 ребенка baby: type: number description: Стоимость за 1 младенца example: total: 5.637376656633329 baby: 9.301444243932576 adult: 2.3021358869347655 child: 7.061401241503109 LoungeReportResponse: type: object properties: createdId: type: string description: Идентификатор созданного ресурса example: createdId: createdId getInitialPlacementListResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination_3' items: $ref: '#/components/schemas/DFAInitial' description: Ответ метода example: pagination: offset: 10 limit: 10 totalCount: 100 items: statusDate: 2023-08-03T14:17:51.525Z dfaExtraInfoList: 1 ЦФА = 1 кв.м dfaHybridAssetAddress: г. Москва dfaStartDate: 2023-02-01T00:00:00Z companyIssuerName: АО Вольт companyIssuerEmail: volt@mail.ru dfaSecondaryStartDate: 2023-08-03T14:17:51.525Z dfaParValue: 100000 dfaBorrowerOgrn: "6131238182674" dfaId: BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaDebtPaymentPeriodComment: комментарий dfaMinNumber: 1 dfaBankAccount: "47422810800000000038" dfaMinValue: 1000000 dfaHardcapEnd: 15 dfaRestrictionValue: 44650800 dfaName: ALFB-1-SB-082023-00001 subtitle: Структурная облигация dfaMinSellPrice: 50000 dfaHybridPaymentDeadline: В рублях в течение 3-х рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА placementLink: https://testdfa.alfabank.ru/retail-investor/webview/dfa/BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP status: PRESALE dfaDocConditionsKey: /dfa/docs/74450795-de9d-40ee-895f-1945c53886fb dfaSecondaryQualificationPersonRequirements: QUALIFIED_ONLY dfaPriceStep: 100 dfaRedemptionDate: 2027-08-18T00:00:00.000+00:00 icon: https://testdfa.alfabank.ru:9010/dfa/icons/750ad7ea-3158-4966-afab-643ae3f8cd7f dfaDocIconName: sample.jpg contractVersion: 53 buyPlacementLink: https://testdfa.alfabank.ru/retail-investor/webview/dfa/buy?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaLoanStartDate: 2023-08-03T14:17:51.525Z dfaPrettyName: Лабиринт dfaDocPresentationKey: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 dfaProductVariety: Цифровые обязательства dfaSubType: Структурная облигация companyIssuerInn: "0514564365" dfaQualificationCompanyRequirements: ALL dfaIssuerFee: 3.0 dfaSaleEndDate: 2023-08-03T14:17:51.525Z dfaMaxBuyPrice: 1000000 dfaMaxValue: 1000000 dfaDocPresentationName: Презентация.pdf availableOnSecondaryMarket: true dfaLoanEndDate: 2023-08-03T14:17:51.525Z dfaTotalAmount: 10000 dfaType: MONEY_CLAIM companyIssuerOgrn: "1130731080666" dfaMaxNumber: 7 dfaBorrowerName: Иванов Иван Иванович dfaMaxRate: 15.3 dfaDocIconKey: /dfa/icons/d82ffa63-bda0-4e56-92e7-522829a721ba dfaHybridAssetDeadline: В течение 10 рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА dfaDocs: - preferences: noDuplicates: false isRequired: false formats: PDF visibility: COMPANY name: Презентация description: Презентация выпуска singleFile: false id: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe files: - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba order: 1 - preferences: noDuplicates: false isRequired: false formats: PDF visibility: COMPANY name: Презентация description: Презентация выпуска singleFile: false id: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe files: - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba order: 1 dfaNpdPaymentPeriodComment: комментарий dfaLoanAmount: Отсутствует dfaDebtAccrualPeriodComment: комментарий dfaAvailableForIssuer: true redemptionRule: BY_AMORTIZATION dfaRateRangeEnable: true dfaMaxSellPrice: 500000 dfaEndDate: 2023-02-01T00:00:00Z dfaRestriction: true companyIssuerAddress: "Октябрьская улица 123, д.18" creationDate: 2023-08-03T14:17:51.525Z placementOneLink: https://testdfa.alfabank.ru/mobile/goto/dfa_webview_with_two_parameters?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaSecondaryQualificationCompanyRequirements: QUALIFIED_ONLY companyIssuerSite: volt.ru dfaDebtPaymentPeriod: EOP dfaDebtAccrualPeriod: EOP background: '#36363A' dfaHybridSelectedTypes: - "[\"CASH\"]" - "[\"CASH\"]" dfaLifeTime: "10000" dfaLoanRate: 10.6 dfaDocConditionsName: Презентация.pdf companyIssuerId: 8rJg73mcacMn5p6Fmpsre1Jk3rwU4yz7UzDpFfGyShH4 dfaSecondarySellerFee: 1.3 exchangeContractVersion: 54 dfaReleaseDecisionKey: docs/5f5537b4-d633-4c1b-8e9f-4d3406162246 description: Участие от 10 000Р title: АЛЬФА-БАНК dfaLoanNumber: "654321" profitOnDfa: 0 tokensaleHardcap: true dfaInvestorFee: 1.1 dfaNpdAccrualPeriodComment: комментарий dfaMinRate: 5.7 dfaBorrowerInn: "369930244602" dfaRateAmount: "13.2" buyPlacementOneLink: https://test-alfa-mobile.alfabank.ru/mobile/goto/dfa_id_buy_dc?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaMinBuyPrice: 100000 dfaLoanRateType: FIXED dfaReleaseDecisionName: Презентация.pdf refAsset: blocks: - isRequired: true visibility: COMPANY name: external parameters: - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: true visibility: COMPANY name: external parameters: - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" name: Структурная облигация dfaQualificationPersonRequirements: ALL dfaNpdAccrualPeriod: EOP dfaRateType: FIXED dfaSecondaryBuyerFee: 1.2 dfaCurrency: RUB dfaNpdPaymentPeriod: EOP Pagination_3: type: object properties: offset: type: number description: "Количество объектов в списке, которые необходимо пропустит\ ь" example: 10 limit: type: number description: Количество объектов на одной странице example: 10 totalCount: type: number description: Общее количество записей example: 100 description: Пагинация example: offset: 10 limit: 10 totalCount: 100 DFAInitial: required: - background - buyPlacementLink - buyPlacementOneLink - companyIssuerAddress - companyIssuerEmail - companyIssuerId - companyIssuerInn - companyIssuerName - companyIssuerOgrn - companyIssuerSite - creationDate - description - dfaBankAccount - dfaCurrency - dfaDebtAccrualPeriod - dfaDebtPaymentPeriod - dfaDocConditionsKey - dfaDocConditionsName - dfaDocIconKey - dfaDocIconName - dfaDocPresentationKey - dfaDocPresentationName - dfaEndDate - dfaId - dfaIssuerFee - dfaMaxNumber - dfaMinNumber - dfaName - dfaParValue - dfaProductVariety - dfaSaleEndDate - dfaStartDate - dfaTotalAmount - dfaType - icon - placementLink - placementOneLink - redemptionRule - status - statusDate - subtitle - title - tokensaleHardcap type: object properties: title: type: string description: Заголовок размещения example: АЛЬФА-БАНК subtitle: type: string description: Подзаголовок example: Структурная облигация description: type: string description: Описание example: Участие от 10 000Р icon: type: string description: Ссылка на изображение иконки format: url example: https://testdfa.alfabank.ru:9010/dfa/icons/750ad7ea-3158-4966-afab-643ae3f8cd7f background: type: string description: Цвет фона example: '#36363A' placementLink: type: string description: Прямая ссылка на карточку размещения format: url example: https://testdfa.alfabank.ru/retail-investor/webview/dfa/BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP buyPlacementLink: type: string description: Прямая ссылка на покупку размещения format: url example: https://testdfa.alfabank.ru/retail-investor/webview/dfa/buy?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP buyPlacementOneLink: type: string description: Ссылка редиректа на покупку размещения через АМ/АО format: url example: https://test-alfa-mobile.alfabank.ru/mobile/goto/dfa_id_buy_dc?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP placementOneLink: type: string description: Ссылка редиректа на размещения через АМ/АО format: url example: https://testdfa.alfabank.ru/mobile/goto/dfa_webview_with_two_parameters?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaId: type: string description: Уникальный идентификатор ЦФА example: BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaName: type: string description: Наименование ЦФА example: ALFB-1-SB-082023-00001 dfaType: type: string description: | Тип ЦФА. Принимает возможные значения: * `MONEY_CLAIM` - денежное требование; * `HYBRID_ASSET` - гибридный актив; * `MONEY_CLAIM_CREDIT` - денежное требование по кредитному договору example: MONEY_CLAIM enum: - MONEY_CLAIM - HYBRID_ASSET - MONEY_CLAIM_CREDIT dfaQualificationPersonRequirements: type: string description: | Требования к квалификации инвестора ФЛ. Принимает возможные значения: * `ALL` - все; * `QUALIFIED_ONLY` - квалифицированный инвестор; * `UNQUALIFIED_LIMIT` - доступно для неквалифицированных инвесторов с ограничением по сумме example: ALL enum: - ALL - QUALIFIED_ONLY - UNQUALIFIED_LIMIT dfaQualificationCompanyRequirements: type: string description: | Требования к квалификации инвестора ЮЛ. Принимает возможные значения: * `ALL` - все; * `QUALIFIED_ONLY` - квалифицированный инвестор; * `UNQUALIFIED_LIMIT` - доступно для неквалифицированных инвесторов с ограничением по сумме example: ALL enum: - ALL - QUALIFIED_ONLY - UNQUALIFIED_LIMIT dfaBankAccount: type: string description: Номер счёта эмитента example: "47422810800000000038" companyIssuerId: type: string description: Уникальный идентификатор эмитента example: 8rJg73mcacMn5p6Fmpsre1Jk3rwU4yz7UzDpFfGyShH4 companyIssuerName: type: string description: Полное наименование эмитента example: АО Вольт companyIssuerOgrn: type: string description: ОГРН эмитента example: "1130731080666" companyIssuerAddress: type: string description: Юридический адрес эмитента example: "Октябрьская улица 123, д.18" companyIssuerEmail: type: string description: Email эмитента format: email example: volt@mail.ru companyIssuerSite: type: string description: Сайт эмитента example: volt.ru companyIssuerInn: type: string description: ИНН эмитента example: "0514564365" dfaParValue: type: integer description: Цена одного ЦФА в минорных единицах format: int64 example: 100000 dfaCurrency: type: string description: | Валюта ЦФА. Принимает возможные значения: * `EUR` - евро; * `USD` - американский доллар; * `RUB` - российский рубль example: RUB dfaRestriction: type: boolean description: Ограничение объема выпуска в денежном выражении example: true dfaRestrictionValue: type: integer description: Сумма ограничения выпуска format: int64 example: 44650800 dfaRateType: type: string description: | Тип процентной ставки. Принимает возможные значения: * `FIXED` - фиксированная; * `FLOAT` - переменная; * `BARRIER` - барьерная; * `NONE` - отсутствует example: FIXED dfaRateAmount: type: string description: Размер фиксированной процентной ставки (%) или информация о базовом активе example: "13.2" dfaNpdPaymentPeriod: type: string description: | Периодичность выплаты НПД. Принимает возможные значения: * `D` - ежедневно; * `M` - ежемесячно; * `Y` - ежегодно; * `Q` - ежеквартально; * `EOP` - в конце срока; * `None` - отсутствует; * `O` - другое example: EOP enum: - D - M - "Y" - Q - EOP - NONE - O dfaNpdPaymentPeriodComment: type: string description: Комментарий к периодичности выплат НПД example: комментарий dfaNpdAccrualPeriod: type: string description: | Периодичность начисления НПД. Принимает возможные значения: * `D` - ежедневно; * `M` - ежемесячно; * `Y` - ежегодно; * `Q` - ежеквартально; * `EOP` - в конце срока; * `None` - отсутствует; * `O` - другое example: EOP enum: - D - M - "Y" - Q - EOP - NONE - O dfaNpdAccrualPeriodComment: type: string description: Комментарий к периодичности начислений НПД example: комментарий dfaDebtAccrualPeriod: type: string description: | Периодичность начисления основного долга. Принимает возможные значения: * `D` - ежедневно; * `M` - ежемесячно; * `Y` - ежегодно; * `Q` - ежеквартально; * `EOP` - в конце срока; * `None` - отсутствует; * `O` - другое example: EOP enum: - D - M - "Y" - Q - EOP - NONE - O dfaDebtAccrualPeriodComment: type: string description: Комментарий к периодичности начислений ОД example: комментарий dfaDebtPaymentPeriod: type: string description: | Периодичность выплаты основного долга. Принимает возможные значения: * `D` - ежедневно; * `M` - ежемесячно; * `Y` - ежегодно; * `Q` - ежеквартально; * `EOP` - в конце срока; * `None` - отсутствует; * `O` - другое example: EOP enum: - D - M - "Y" - Q - EOP - NONE - O dfaDebtPaymentPeriodComment: type: string description: Комментарий к периодичности выплат ОД example: комментарий dfaRedemptionDate: type: string description: Дата погашения ЦФА format: date example: 2027-08-18 status: type: string description: | Статус смарт-контракта. Принимает возможные значения: * `PRESALE` - размещение/сбор заявок example: PRESALE statusDate: type: string description: Дата изменения статуса format: date-time example: 2023-08-03T14:17:51.525Z dfaMinValue: type: integer description: Минимальный объём выпуска ЦФА в валюте выпуска (минорные единицы) format: int64 example: 1000000 dfaMaxValue: type: integer description: Максимальный объём выпуска ЦФА в валюте выпуска (минорные единицы) format: int64 example: 1000000 dfaMinNumber: type: integer description: Минимальный объём выпуска ЦФА в штуках format: int64 example: 1 dfaMaxNumber: type: integer description: Максимальный объём выпуска ЦФА в штуках format: int64 example: 7 dfaRateRangeEnable: type: boolean description: Принимать предложения о процентной ставке от инвесторов example: true dfaMinRate: type: number description: "Минимальная ставка, %" format: double example: 5.7 dfaMaxRate: type: number description: "Максимальная ставка, %" format: double example: 15.3 dfaStartDate: type: string description: Дата начала первичного размещения format: date-time example: 2023-02-01T00:00:00Z dfaEndDate: type: string description: Дата начала окончания размещения format: date-time example: 2023-02-01T00:00:00Z dfaSaleEndDate: type: string description: Дата закрытия книги предварительных заявок format: date-time example: 2023-08-03T14:17:51.525Z dfaDocIconName: type: string description: Наименование иконки example: sample.jpg deprecated: true dfaDocIconKey: type: string description: Иконка. *Рекомендуемое использование:* Используйте ссылку из поля icon example: /dfa/icons/d82ffa63-bda0-4e56-92e7-522829a721ba deprecated: true dfaDocConditionsName: type: string description: Условия первичного размещения. Имя файла example: Презентация.pdf dfaDocConditionsKey: type: string description: Условия первичного размещения. Ключ в MinIO example: /dfa/docs/74450795-de9d-40ee-895f-1945c53886fb dfaDocPresentationKey: type: string description: Прямая ссылка на документ презентации. *Рекомендуемое использование:* Используйте ссылку из массива dfaDocs.files.url вместо данной example: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 deprecated: true dfaDocPresentationName: type: string description: Презентация. Наименование документа example: Презентация.pdf deprecated: true dfaReleaseDecisionKey: type: string description: Итоговое решение о выпуске. Ключ в MinIO example: docs/5f5537b4-d633-4c1b-8e9f-4d3406162246 deprecated: true dfaReleaseDecisionName: type: string description: Итоговое решение о выпуске. Наименование документа example: Презентация.pdf deprecated: true dfaInvestorFee: type: number description: "Комиссия инвестора на первичном рынке, %" format: double example: 1.1 dfaSecondaryBuyerFee: type: number description: "Комиссия покупателя на вторичном рынке, %" format: double example: 1.2 dfaSecondarySellerFee: type: number description: "Комиссия продавца на вторичном рынке, %" format: double example: 1.3 tokensaleHardcap: type: boolean description: Признак достигнутого завершения сбора заявок на это размещение example: true availableOnSecondaryMarket: type: boolean description: Доступность ЦФА на вторичном рынке example: true dfaPriceStep: type: integer description: Шаг цены для ЦФА на вторичном рынке. Указывается в минорных единицах (копейках) format: int64 example: 100 dfaBorrowerName: type: string description: Наименование заёмщика example: Иванов Иван Иванович dfaBorrowerInn: type: string description: ИНН заёмщика example: "369930244602" dfaBorrowerOgrn: type: string description: ОГРН заёмщика example: "6131238182674" dfaLoanNumber: type: string description: Номер кредитного договора example: "654321" dfaLoanAmount: type: string description: Задолженность по КД example: Отсутствует dfaLoanRateType: type: string description: Тип процентной ставки. example: FIXED dfaLoanRate: type: number description: "Значение ставки, %" format: double example: 10.6 dfaLoanStartDate: type: string description: Дата начала срока действия КД format: date-time example: 2023-08-03T14:17:51.525Z dfaLoanEndDate: type: string description: Дата окончания срока действия КД format: date-time example: 2023-08-03T14:17:51.525Z dfaMinBuyPrice: type: integer description: Минимальная цена покупки format: int64 example: 100000 dfaMaxBuyPrice: type: integer description: Максимальная цена покупки format: int64 example: 1000000 dfaMinSellPrice: type: integer description: Минимальная цена продажи format: int64 example: 50000 dfaMaxSellPrice: type: integer description: Максимальная цена продажи format: int64 example: 500000 profitOnDfa: type: integer description: Доход на ЦФА format: int64 contractVersion: type: integer description: Версия контракта format: int64 example: 53 exchangeContractVersion: type: integer description: Изменение версии контракта format: int64 example: 54 creationDate: type: string description: Дата создания записи format: date-time example: 2023-08-03T14:17:51.525Z dfaTotalAmount: type: integer description: "Фактическое количество ЦФА, приобретенное инвесторами в вы\ пуске" format: int64 example: 10000 dfaIssuerFee: type: number description: "Комиссия оператора для эмитента, %" format: double example: 3.0 dfaHybridSelectedTypes: type: array items: type: string description: | Выбранные типы погашения ЦФА. Принимает возможные значения: * `CASH` - в виде денежных средств; * `ASSET` - в виде передачи физического актива example: "[\"CASH\"]" dfaHybridPaymentDeadline: type: string description: Срок перечисления денежных средств example: В рублях в течение 3-х рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА dfaHybridAssetDeadline: type: string description: Срок получения гибридного актива example: В течение 10 рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА dfaHybridAssetAddress: type: string description: Адрес получения гибридного актива example: г. Москва dfaSecondaryQualificationPersonRequirements: type: string description: | Требования к квалификации инвестора ФЛ на вторичном рынке. Принимает возможные значения: * `ALL` - все; * `QUALIFIED_ONLY` - квалифицированный инвестор; * `UNQUALIFIED_LIMIT` - доступно для неквалифицированных инвесторов с ограничением по сумме example: QUALIFIED_ONLY enum: - ALL - QUALIFIED_ONLY - UNQUALIFIED_LIMIT dfaSecondaryQualificationCompanyRequirements: type: string description: | Требования к квалификации инвестора ЮЛ на вторичном рынке. Принимает возможные значения: * `ALL` - все; * `QUALIFIED_ONLY` - квалифицированный инвестор; * `UNQUALIFIED_LIMIT` - доступно для неквалифицированных инвесторов с ограничением по сумме example: QUALIFIED_ONLY enum: - ALL - QUALIFIED_ONLY - UNQUALIFIED_LIMIT dfaHardcapEnd: type: integer description: Остаток до хардкапа format: int64 example: 15 dfaSecondaryStartDate: type: string description: Дата выхода ЦФА на вторичный рынок format: date-time example: 2023-08-03T14:17:51.525Z dfaAvailableForIssuer: type: boolean description: Флаг доступности вторичного рынка для эмитента example: true redemptionRule: type: string description: | Условие погашения ЦФА. Принимает возможные значения: * `BY_LAST_ACCRUAL` - по факту исполнения последнего начисления ОД по графику без учета амортизации ЦФА; * `BY_AMORTIZATION` - по факту исполнения очередного начисления ОД по графику при котором амортизационная стоимость ЦФА стала равна 0 example: BY_AMORTIZATION enum: - BY_LAST_ACCRUAL - BY_AMORTIZATION dfaProductVariety: type: string description: Наименование типа продукта для покупателя example: Цифровые обязательства dfaSubType: type: string description: Подтип ЦФА example: Структурная облигация dfaPrettyName: type: string description: Маркетинговое наименование ЦФА example: Лабиринт dfaExtraInfoList: type: string description: "Доп инфа по цфа. В зависимсоти от размещения может отображ\ аться процентная ставка, КС +0,5%, 1 ЦФА = 1 кв.м, 1 ЦФА = 0.1 карат" example: 1 ЦФА = 1 кв.м dfaLifeTime: type: string description: Время жизни ЦФА example: "10000" refAsset: $ref: '#/components/schemas/refAsset' dfaDocs: type: array description: Массив групп документов по эмиссии (кроме изображения ЦФА) items: $ref: '#/components/schemas/DFADoc' description: Массив объектов результата example: statusDate: 2023-08-03T14:17:51.525Z dfaExtraInfoList: 1 ЦФА = 1 кв.м dfaHybridAssetAddress: г. Москва dfaStartDate: 2023-02-01T00:00:00Z companyIssuerName: АО Вольт companyIssuerEmail: volt@mail.ru dfaSecondaryStartDate: 2023-08-03T14:17:51.525Z dfaParValue: 100000 dfaBorrowerOgrn: "6131238182674" dfaId: BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaDebtPaymentPeriodComment: комментарий dfaMinNumber: 1 dfaBankAccount: "47422810800000000038" dfaMinValue: 1000000 dfaHardcapEnd: 15 dfaRestrictionValue: 44650800 dfaName: ALFB-1-SB-082023-00001 subtitle: Структурная облигация dfaMinSellPrice: 50000 dfaHybridPaymentDeadline: В рублях в течение 3-х рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА placementLink: https://testdfa.alfabank.ru/retail-investor/webview/dfa/BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP status: PRESALE dfaDocConditionsKey: /dfa/docs/74450795-de9d-40ee-895f-1945c53886fb dfaSecondaryQualificationPersonRequirements: QUALIFIED_ONLY dfaPriceStep: 100 dfaRedemptionDate: 2027-08-18T00:00:00.000+00:00 icon: https://testdfa.alfabank.ru:9010/dfa/icons/750ad7ea-3158-4966-afab-643ae3f8cd7f dfaDocIconName: sample.jpg contractVersion: 53 buyPlacementLink: https://testdfa.alfabank.ru/retail-investor/webview/dfa/buy?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaLoanStartDate: 2023-08-03T14:17:51.525Z dfaPrettyName: Лабиринт dfaDocPresentationKey: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 dfaProductVariety: Цифровые обязательства dfaSubType: Структурная облигация companyIssuerInn: "0514564365" dfaQualificationCompanyRequirements: ALL dfaIssuerFee: 3.0 dfaSaleEndDate: 2023-08-03T14:17:51.525Z dfaMaxBuyPrice: 1000000 dfaMaxValue: 1000000 dfaDocPresentationName: Презентация.pdf availableOnSecondaryMarket: true dfaLoanEndDate: 2023-08-03T14:17:51.525Z dfaTotalAmount: 10000 dfaType: MONEY_CLAIM companyIssuerOgrn: "1130731080666" dfaMaxNumber: 7 dfaBorrowerName: Иванов Иван Иванович dfaMaxRate: 15.3 dfaDocIconKey: /dfa/icons/d82ffa63-bda0-4e56-92e7-522829a721ba dfaHybridAssetDeadline: В течение 10 рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА dfaDocs: - preferences: noDuplicates: false isRequired: false formats: PDF visibility: COMPANY name: Презентация description: Презентация выпуска singleFile: false id: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe files: - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba order: 1 - preferences: noDuplicates: false isRequired: false formats: PDF visibility: COMPANY name: Презентация description: Презентация выпуска singleFile: false id: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe files: - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba order: 1 dfaNpdPaymentPeriodComment: комментарий dfaLoanAmount: Отсутствует dfaDebtAccrualPeriodComment: комментарий dfaAvailableForIssuer: true redemptionRule: BY_AMORTIZATION dfaRateRangeEnable: true dfaMaxSellPrice: 500000 dfaEndDate: 2023-02-01T00:00:00Z dfaRestriction: true companyIssuerAddress: "Октябрьская улица 123, д.18" creationDate: 2023-08-03T14:17:51.525Z placementOneLink: https://testdfa.alfabank.ru/mobile/goto/dfa_webview_with_two_parameters?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaSecondaryQualificationCompanyRequirements: QUALIFIED_ONLY companyIssuerSite: volt.ru dfaDebtPaymentPeriod: EOP dfaDebtAccrualPeriod: EOP background: '#36363A' dfaHybridSelectedTypes: - "[\"CASH\"]" - "[\"CASH\"]" dfaLifeTime: "10000" dfaLoanRate: 10.6 dfaDocConditionsName: Презентация.pdf companyIssuerId: 8rJg73mcacMn5p6Fmpsre1Jk3rwU4yz7UzDpFfGyShH4 dfaSecondarySellerFee: 1.3 exchangeContractVersion: 54 dfaReleaseDecisionKey: docs/5f5537b4-d633-4c1b-8e9f-4d3406162246 description: Участие от 10 000Р title: АЛЬФА-БАНК dfaLoanNumber: "654321" profitOnDfa: 0 tokensaleHardcap: true dfaInvestorFee: 1.1 dfaNpdAccrualPeriodComment: комментарий dfaMinRate: 5.7 dfaBorrowerInn: "369930244602" dfaRateAmount: "13.2" buyPlacementOneLink: https://test-alfa-mobile.alfabank.ru/mobile/goto/dfa_id_buy_dc?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaMinBuyPrice: 100000 dfaLoanRateType: FIXED dfaReleaseDecisionName: Презентация.pdf refAsset: blocks: - isRequired: true visibility: COMPANY name: external parameters: - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: true visibility: COMPANY name: external parameters: - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" name: Структурная облигация dfaQualificationPersonRequirements: ALL dfaNpdAccrualPeriod: EOP dfaRateType: FIXED dfaSecondaryBuyerFee: 1.2 dfaCurrency: RUB dfaNpdPaymentPeriod: EOP refAsset: required: - name type: object properties: name: type: string description: Наименование актива example: Структурная облигация blocks: type: array description: Массив блоков актива items: $ref: '#/components/schemas/refAssetBlock' description: Объект с данными об активе example: blocks: - isRequired: true visibility: COMPANY name: external parameters: - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: true visibility: COMPANY name: external parameters: - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" name: Структурная облигация refAssetBlock: required: - isRequired - name - parameters - visibility type: object properties: name: type: string description: Наименование блока example: external isRequired: type: boolean description: Флаг обязательности блока example: true visibility: type: array example: COMPANY items: type: string description: | Кому блок отображается в карточке. Принимает возможные значения: * `ALL` - Все; * `NOBODY` - никто; * `COMPANY` - юридическое лицо; * `PERSON` - физическое лицо parameters: type: array description: Массив параметров блока items: $ref: '#/components/schemas/refAssetBlockParam' description: Блок с данными об активе example: isRequired: true visibility: COMPANY name: external parameters: - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" - isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" refAssetBlockParam: required: - isRequired - name - value - visibility type: object properties: name: type: string description: Наименование параметра example: title value: type: string description: Значение параметра example: "1,7% (20,4% годовых)" isRequired: type: boolean description: Флаг обязательности example: false visibility: type: array example: COMPANY items: type: string description: | Кому блок отображается в карточке. Принимает возможные значения: * `ALL` - все; * `NOBODY` - никто; * `COMPANY` - юридическое лицо; * `PERSON` - физическое лицо description: Параметры блока example: isRequired: false visibility: COMPANY name: title value: "1,7% (20,4% годовых)" DFADoc: type: object properties: order: type: number description: "Порядок блока документов, заданный при создании решения" example: 1 preferences: $ref: '#/components/schemas/DFADocPreferences' files: type: array description: Массив документов (файлов) в группе. Может содержать до 10 items: $ref: '#/components/schemas/DFADocFile' description: Документ по эмиссии example: preferences: noDuplicates: false isRequired: false formats: PDF visibility: COMPANY name: Презентация description: Презентация выпуска singleFile: false id: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe files: - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba - name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba order: 1 DFADocPreferences: required: - formats - id - isRequired - name - visibility type: object properties: id: type: string description: Идентификатор типа документов example: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe name: type: string description: Название типа документов example: Презентация isRequired: type: boolean description: Обязательность типа документов example: false visibility: type: array example: COMPANY items: type: string description: | Доступность документа для отображения в карточке ЦФА по типам инвесторов. Принимает возможные значения: * `ISSUER` - эмитент ЦФА; * `PERSON` - физическое лицо; * `COMPANY` - юридическое лицо; * Пустой массив formats: type: array example: PDF items: type: string description: | Типы файлов, доступные для документа. Принимает возможные значения: * `PDF` - PDF-файл; * `PNG` - PNG-файл description: type: string description: Описание типа документа example: Презентация выпуска singleFile: type: boolean description: "Признак, что файл может быть только 1 в группе" example: false noDuplicates: type: boolean description: "Признак, что группа не может дублироваться в рамках ЦФА" example: false description: Объект с атрибутами группы документа example: noDuplicates: false isRequired: false formats: PDF visibility: COMPANY name: Презентация description: Презентация выпуска singleFile: false id: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe DFADocFile: required: - key - name - url type: object properties: id: type: string description: "id файла, сгенерированного при загрузке " example: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 name: type: string description: Наименование документа example: Презентация.pdf url: type: string description: Прямая ссылка для получения документа example: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: type: string description: Ключ в MinIO example: docs/55ac2445-19fc-44d5-94c8-764a827764ba description: Объект с атрибутами группы документа example: name: Презентация.pdf id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba ResponseCertificates: type: array description: Ответ на запрос получения всех сертификатов items: $ref: '#/components/schemas/ResponseCertificates_inner' RequestAddCertificate: type: object properties: type: type: string example: ENCRYPTION enum: - ENCRYPTION - SIGNATURE - TLS certificateBody: type: string example: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= description: Запрос на добавление сертификата example: type: ENCRYPTION certificateBody: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= ResponseCertificate: required: - algorithm - beginDateTime - certificateBody - clientId - expireDateTime - fingerprint - id - ownerName - serialNumber - status - type type: object properties: id: type: string example: 9610bc6b-f06b-41b6-bae9-6bb5b06a54dd clientId: type: string example: 4aa56f35-abb1-4ebe-9697-389cca4a4475 ownerName: type: string example: Иванов Иван Иванович fingerprint: type: string example: 333773d77ef05aa9f7b7bae8e2779418b2aedb6a organizationName: type: string nullable: true example: ООО 'Рога и Копыта' beginDateTime: type: string format: date-time example: 2023-07-28T15:11:14Z expireDateTime: type: string format: date-time example: 2025-06-19T11:48:06Z status: type: string example: ACTIVE enum: - ACTIVE - REVOKED - DELETED certificateBody: type: string example: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= type: type: string example: ENCRYPTION enum: - ENCRYPTION - SIGNATURE - TLS algorithm: type: string example: RS256 enum: - RS256 - GOST serialNumber: type: string example: "2163173489423972678179275487230070851350268586" description: Ответ на запрос получения / добавления / обновления статуса сертификата example: expireDateTime: 2025-06-19T11:48:06Z clientId: 4aa56f35-abb1-4ebe-9697-389cca4a4475 serialNumber: "2163173489423972678179275487230070851350268586" ownerName: Иванов Иван Иванович organizationName: ООО 'Рога и Копыта' fingerprint: 333773d77ef05aa9f7b7bae8e2779418b2aedb6a id: 9610bc6b-f06b-41b6-bae9-6bb5b06a54dd beginDateTime: 2023-07-28T15:11:14Z type: ENCRYPTION status: ACTIVE certificateBody: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= algorithm: RS256 RequestChangeCertificate: required: - op - path - value type: object properties: op: type: string example: replace enum: - replace path: type: string example: /status enum: - /status value: type: string example: REVOKED enum: - ACTIVE - REVOKED description: Запрос обновления статуса сертификата example: op: replace path: /status value: REVOKED claims-resolved: title: Обработанные на стороне Партнера обращения required: - employeeReply - resolution - resolutionDate type: object properties: resolution: type: string description: | Решение по обращению - POSITIVE - Позитивное решение - NEGATIVE - Негативное решение - WITHIN_BANK_COMPETENCE - Решение в компетенции Банка enum: - POSITIVE - NEGATIVE - WITHIN_BANK_COMPETENCE orderId: maxLength: 36 type: string description: Номер заказа партнера resolutionDate: type: string description: Дата и время решения обращения на стороне Партнера (UTC+3) format: date-time clientReply: maxLength: 4000 type: string description: "Ответ для клиента, если необходимо" nullable: true employeeReply: maxLength: 4000 type: string description: Ответ для сотрудника PostOrderTravel: required: - content - dateTime - externalId - totalSum - type type: object properties: externalId: type: string description: Идентификатор заказа в системе партнера example: "3248901" accountType: type: string description: Тип бонусного счета для оплаты example: Мили ruleId: type: integer description: Идентификатор типа правила example: 12 type: $ref: '#/components/schemas/Type' dateTime: type: string description: Дата format: date-time example: 2023-10-05T14:30:00Z totalSum: type: number description: Общая сумма заказа в рублях example: 254.1 bonusPayment: maxItems: 3 type: array description: Массив с объектами оплаты бонусной частью items: $ref: '#/components/schemas/BonusPaymentItems' cashPayment: maxItems: 30 type: array description: Массив с объектами оплаты денежной частью items: $ref: '#/components/schemas/CashPaymentItems' content: $ref: '#/components/schemas/ContentTravel' reportData: $ref: '#/components/schemas/ReportData' description: Тело запроса для создания заказа партнерами из бизнес линии Travel ExternalId: type: string description: Идентификатор заказа в системе партнера example: "3248901" AccountType_2: type: string description: Тип бонусного счета для оплаты example: Мили RuleId: type: integer description: Идентификатор типа правила example: 12 Type: type: string description: Тип заказа * `AVIA` - Авиа заказ; * `RAILWAY` - ЖД заказ; * `HOTEL` - Отель; * `TOUR` - Заказ тура; example: AVIA enum: - AVIA - RAILWAY - HOTEL - TOUR DateTime: type: string description: Дата format: date-time example: 2023-10-05T14:30:00Z TotalSum: type: number description: Общая сумма заказа в рублях example: 254.1 BonusPayment: maxItems: 3 type: array description: Массив с объектами оплаты бонусной частью items: $ref: '#/components/schemas/BonusPaymentItems' BonusPaymentItems: required: - sum - sumRubEquivalent - type type: object properties: type: $ref: '#/components/schemas/BonusType' sumRubEquivalent: type: number description: Сумма оплаты бонусными единицами в рублевом эквиваленте example: 1000 sum: type: number description: Сумма оплаты example: 500 comment: type: string description: Комментарий к оплате бонусной частью nullable: true example: Оплачиваю часть милями description: Объект с данными бонусной части оплаты заказа BonusType: type: integer description: | Тип бонусной операции: - **0** — Оплата основного заказа - **1** — Фиксированная ставка - **2** — Процент от суммы - **3** — Комиссия третьих лиц format: int32 example: 0 enum: - 0 - 1 - 2 - 3 SumRubEquivalent: type: number description: Сумма оплаты бонусными единицами в рублевом эквиваленте example: 1000 Sum: type: number description: Сумма оплаты example: 500 Comment: type: string description: Комментарий к оплате бонусной частью nullable: true example: Оплачиваю часть милями CashPayment: maxItems: 30 type: array description: Массив с объектами оплаты денежной частью items: $ref: '#/components/schemas/CashPaymentItems' CashPaymentItems: required: - currency - sum - type type: object properties: type: type: string description: Тип оплаты рублями example: Оплата комиссии в пользу 3-их лиц sum: type: number description: Сумма оплаты example: 500 currency: maxLength: 3 type: string description: Валюта оплаты example: RUB additionalProperties: false description: Объект с данными денежной части оплаты заказа CashType: type: string description: Тип оплаты рублями example: Оплата комиссии в пользу 3-их лиц Currency_2: maxLength: 3 type: string description: Валюта оплаты example: RUB ContentTravel: required: - reservationSource - travelers type: object properties: utilizationDate: type: string description: Дата утилизации тура format: date-time example: 2023-10-05T14:30:00Z reservationSource: $ref: '#/components/schemas/ReservationSource' additionalServices: maxItems: 50 type: array description: Массив с объектами доп.услуг items: $ref: '#/components/schemas/AdditionalServicesItems' tripType: $ref: '#/components/schemas/TripType' segments: maxItems: 50 type: array description: Массив с сегментами перелета/жд переезда items: $ref: '#/components/schemas/SegmentsTravelItems' hotel: $ref: '#/components/schemas/Hotel' tour: $ref: '#/components/schemas/Tour' travelers: $ref: '#/components/schemas/Travelers' additionalProperties: false description: | Содержимое заказа для партнеров бизнес линии "Travel". Поддерживаемые типы заказов: - AVIA - авиабилеты - RAILWAY - железнодорожные билеты - HOTEL - бронирование отелей - TOUR - пакетные туры UtilizationDate: type: string description: Дата утилизации тура format: date-time example: 2023-10-05T14:30:00Z ReservationSource: type: string description: Источник бронирования * `WEBVIEW` - вебвью; * `SITE` - сайт; example: WEBVIEW enum: - WEBVIEW - SITE AdditionalServices: maxItems: 50 type: array description: Массив с объектами доп.услуг items: $ref: '#/components/schemas/AdditionalServicesItems' AdditionalServicesItems: required: - currency - name - sum - type type: object properties: name: type: string description: Наименование доп.услуги example: Выбор места type: type: string description: Тип доп.услуги example: place_choice sum: type: number description: Сумма оплаты example: 500 currency: maxLength: 3 type: string description: Валюта оплаты example: RUB additionalProperties: false description: Содержимое доп.услуги Name: type: string description: Наименование доп.услуги example: Выбор места AdditionalServiceType: type: string description: Тип доп.услуги example: place_choice TripType: type: string description: Тип путешествия * `OW` - в одну сторону; * `RT` - туда обратно; * `CX` - сложный маршрут; example: OW enum: - OW - RT - CX SegmentsTravel: maxItems: 50 type: array description: Массив с сегментами перелета/жд переезда items: $ref: '#/components/schemas/SegmentsTravelItems' SegmentsTravelItems: required: - arrival - departure - type type: object properties: class: type: string description: Класс билета example: A type: type: string description: Тип рейса/тип поезда example: REGULAR sequence: type: integer description: Последовательность example: 1 number: type: string description: Номер рейса/поезда example: P-06-28921 supplier: type: string description: Название перевозчика example: Ural Airlines direction: type: string description: Направление example: "0" departure: $ref: '#/components/schemas/Departure' arrival: $ref: '#/components/schemas/Arrival' luggage: maxItems: 50 type: array description: Массив с информацией о багаже items: $ref: '#/components/schemas/LuggageItems' additionalProperties: false description: Содержимое перелета или жд переезда Class: type: string description: Класс билета example: A SegmentType: type: string description: Тип рейса/тип поезда example: REGULAR Sequence: type: integer description: Последовательность example: 1 SegmentNumber: type: string description: Номер рейса/поезда example: P-06-28921 Supplier: type: string description: Название перевозчика example: Ural Airlines Direction: type: string description: Направление example: "0" Departure: required: - city - country - point type: object properties: dateTime: type: string description: Дата format: date-time example: 2023-10-05T14:30:00Z city: type: string description: Код города отправления/прибытия example: MOW country: type: string description: Код страны отправления/прибытия example: RUS point: type: string description: Код аэропорта/вокзала отправления/прибытия example: VKO additionalProperties: false description: Объект с содержимым деталей вылета City_1: type: string description: Код города отправления/прибытия example: MOW Country_1: type: string description: Код страны отправления/прибытия example: RUS Point: type: string description: Код аэропорта/вокзала отправления/прибытия example: VKO Arrival: required: - city - country - point type: object properties: dateTime: type: string description: Дата format: date-time example: 2023-10-05T14:30:00Z city: type: string description: Код города отправления/прибытия example: MOW country: type: string description: Код страны отправления/прибытия example: RUS point: type: string description: Код аэропорта/вокзала отправления/прибытия example: VKO additionalProperties: false description: Объект с содержимым деталей прилета Luggage: maxItems: 50 type: array description: Массив с информацией о багаже items: $ref: '#/components/schemas/LuggageItems' LuggageItems: required: - amount - type - weight type: object properties: type: type: string description: Тип багажа example: Wheeled Duffel Bags amount: type: integer description: Количество багажа example: 5 weight: type: number description: Вес багажа example: 10 width: type: number description: Ширина багажа example: 10 length: type: number description: Длина багажа example: 5 height: type: number description: Высота багажа example: 5 additionalProperties: false description: Содержимое багажа LuggageType: type: string description: Тип багажа example: Wheeled Duffel Bags Amount_2: type: integer description: Количество багажа example: 5 Weight: type: number description: Вес багажа example: 10 Width: type: number description: Ширина багажа example: 10 Length: type: number description: Длина багажа example: 5 Height: type: number description: Высота багажа example: 5 Hotel: required: - checkInDate - checkOutDate - city - country - name - roomType type: object properties: name: type: string description: Наименование отеля example: Горный пик roomType: type: string description: Тип комнаты example: Номер эконом с 1 двуспальной кроватью checkInDate: type: string description: Дата заезда format: date-time example: 2020-10-12T12:00:00Z checkOutDate: type: string description: Дата выезда format: date-time example: 2020-10-14T15:00:00Z city: type: string description: Код города отеля example: MOW country: type: string description: Код города страны отеля example: RUS stars: type: integer description: Количество звезд отеля example: 4 mealType: type: string description: Тип питания example: halfBoardDinner additionalProperties: false description: Содержимое заказа отеля HotelName: type: string description: Наименование отеля example: Горный пик RoomType: type: string description: Тип комнаты example: Номер эконом с 1 двуспальной кроватью CheckInDate: type: string description: Дата заезда format: date-time example: 2020-10-12T12:00:00Z CheckOutDate: type: string description: Дата выезда format: date-time example: 2020-10-14T15:00:00Z HotelCity: type: string description: Код города отеля example: MOW HotelCountry: type: string description: Код города страны отеля example: RUS Stars: type: integer description: Количество звезд отеля example: 4 MealType: type: string description: Тип питания example: halfBoardDinner Tour: required: - operator type: object properties: operator: type: string description: Оператор тура example: SpaceTravel provider: type: string description: Провайдер тура example: Travel additionalProperties: false description: Объект с содержимым данныых о заказе тура Operator: type: string description: Оператор тура example: SpaceTravel Provider: type: string description: Провайдер тура example: Travel Travelers: required: - adults - children - infants type: object properties: adults: type: integer description: Количество взрослых example: 2 children: type: integer description: Количество детей example: 1 infants: type: integer description: Количество младенцев example: 1 additionalProperties: false description: Объект с данными о путешественниках Adults: type: integer description: Количество взрослых example: 2 Children: type: integer description: Количество детей example: 1 Infants: type: integer description: Количество младенцев example: 1 ReportData: type: object properties: bookingType: type: string description: Тип бронирования example: GDS startPrice: type: number description: Цена нетто example: 255.55 markup: type: number description: Маркап example: 255.96 aviakassaFee: type: number description: Комиссия авиакассы example: 100000 supplierFee: type: number description: Комиссия поставщика example: 555657 gdsBonus: type: number description: Комиссия GDS example: 1000 comissionFee: type: number description: Комиссионное вознаграждение example: 5898 passengers: maxItems: 50 type: array description: Массив с билетами и идентификаторами пассажиров items: $ref: '#/components/schemas/PassengersItems' flights: maxItems: 50 type: array description: Массив с данными для аналитики по перелету items: $ref: '#/components/schemas/FlightsItems' additionalProperties: true description: Объект с данными для аналитики BookingType: type: string description: Тип бронирования example: GDS StartPrice: type: number description: Цена нетто example: 255.55 Markup: type: number description: Маркап example: 255.96 AviakassaFee: type: number description: Комиссия авиакассы example: 100000 SupplierFee: type: number description: Комиссия поставщика example: 555657 GdsBonus: type: number description: Комиссия GDS example: 1000 ComissionFee: type: number description: Комиссионное вознаграждение example: 5898 Passengers: maxItems: 50 type: array description: Массив с билетами и идентификаторами пассажиров items: $ref: '#/components/schemas/PassengersItems' PassengersItems: type: object properties: id: type: integer description: Идентификатор пассажира example: 756 ticketNumber: type: string description: номер билета example: E584 additionalProperties: true description: Объект с билетами и идентификаторами пассажиров PassengerId: type: integer description: Идентификатор пассажира example: 756 TicketNumber: type: string description: номер билета example: E584 Flights: maxItems: 50 type: array description: Массив с данными для аналитики по перелету items: $ref: '#/components/schemas/FlightsItems' FlightsItems: type: object properties: flightNumber: type: string description: номер рейса example: ST006 locator: type: string description: локатор example: 26W4GS additionalProperties: true description: Объект с с данными для аналитики по перелету FlightNumber: type: string description: номер рейса example: ST006 Locator: type: string description: локатор example: 26W4GS SuccessResponseCreateOrder: type: object properties: orderId: maxLength: 50 type: string description: Идентификатор заказа в банке example: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: maxLength: 50 type: string description: Статус созданного заказа example: Created OrderId: maxLength: 50 type: string description: Идентификатор заказа в банке example: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 StatusCreate: maxLength: 50 type: string description: Статус созданного заказа example: Created SuccessResponseAlreadyOrder: type: object properties: orderId: maxLength: 50 type: string description: Идентификатор заказа в банке example: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: maxLength: 50 type: string description: Статус созданного заказа example: Order already exists example: orderId: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: Order already exists Status_1: maxLength: 50 type: string description: Статус созданного заказа example: Order already exists ErrorBadGateway: type: object properties: error: type: string description: Ошибка example: bad_gateway error_description: type: string description: Описание ошибки example: Can't hold miles description: Ошибка с сообщением BadGatewayError: type: string description: Ошибка example: bad_gateway BadGatewayDescription: type: string description: Описание ошибки example: Can't hold miles PostOrderAfisha: required: - content - dateTime - externalId - totalSum - type type: object properties: externalId: type: string description: Идентификатор заказа в системе партнера example: "3248901" accountType: type: string description: Тип бонусного счета для оплаты example: Мили ruleId: type: integer description: Идентификатор типа правила example: 12 type: $ref: '#/components/schemas/AfishaType' dateTime: type: string description: Дата format: date-time example: 2023-10-05T14:30:00Z totalSum: type: number description: Общая сумма заказа в рублях example: 254.1 bonusPayment: maxItems: 3 type: array description: Массив с объектами оплаты бонусной частью items: $ref: '#/components/schemas/BonusPaymentItems' cashPayment: maxItems: 30 type: array description: Массив с объектами оплаты денежной частью items: $ref: '#/components/schemas/CashPaymentItems' content: $ref: '#/components/schemas/AfishaContent' description: Тело запроса для создания заказа партнерами из бизнес линии Afisha AfishaType: type: string description: Тип заказа * `EVENT` - Мероприятие; example: EVENT enum: - EVENT AfishaContent: required: - address - city - country - date - eventId - eventName - venue type: object properties: eventName: type: string description: Наименование мероприятия example: Концерт A Studio eventId: type: string description: Идентификатор мероприятия в системе партнера example: AST_P_007 venue: type: string description: Название площадки мероприятия example: Зеленый театр country: type: string description: Код страны мероприятия/доставки покупки example: RUS city: type: string description: Код города мероприятия/доставки покупки example: MOW date: type: string description: Дата и время мероприятия/доставки покупки format: date-time example: 2029-10-05T14:30:00Z address: type: string description: Адрес мероприятия/доставки покупки example: "Г.Москва, 123134, улица Народного Ополчения" tickets: maxItems: 100 type: array description: Массив с билетами items: $ref: '#/components/schemas/TicketsItems' description: Объект c типом заказа event EventName: type: string description: Наименование мероприятия example: Концерт A Studio EventId: type: string description: Идентификатор мероприятия в системе партнера example: AST_P_007 Venue: type: string description: Название площадки мероприятия example: Зеленый театр PurchaseCountry: type: string description: Код страны мероприятия/доставки покупки example: RUS PurchaseCity: type: string description: Код города мероприятия/доставки покупки example: MOW PurchaseDate: type: string description: Дата и время мероприятия/доставки покупки format: date-time example: 2029-10-05T14:30:00Z Address_3: type: string description: Адрес мероприятия/доставки покупки example: "Г.Москва, 123134, улица Народного Ополчения" Tickets: maxItems: 100 type: array description: Массив с билетами items: $ref: '#/components/schemas/TicketsItems' TicketsItems: type: object properties: seat: type: string description: Место example: "32" row: type: string description: Ряд example: "10" sector: type: string description: Сектор example: B8 description: Состав объекта с билетами Seat: type: string description: Место example: "32" Row: type: string description: Ряд example: "10" Sector: type: string description: Сектор example: B8 PutOrderTravel: required: - changeReason - content - dateTime - externalId - totalSum - type type: object properties: externalId: type: string description: Идентификатор заказа в системе партнера example: "3248901" type: $ref: '#/components/schemas/Type' dateTime: type: string description: Дата format: date-time example: 2023-10-05T14:30:00Z totalSum: type: number description: Общая сумма заказа в рублях example: 254.1 ruleId: type: integer description: Идентификатор типа правила example: 12 changeReason: $ref: '#/components/schemas/ChangeReason' transaction: maxItems: 20 type: array description: Массив с транзакциями items: $ref: '#/components/schemas/TransactionItems' accountType: type: string description: Тип бонусного счета для оплаты example: Мили bonusPayment: maxItems: 3 type: array description: Массив с объектами оплаты бонусной частью items: $ref: '#/components/schemas/BonusPaymentItems' cashPayment: maxItems: 30 type: array description: Массив с объектами оплаты денежной частью items: $ref: '#/components/schemas/CashPaymentItems' content: $ref: '#/components/schemas/ContentTravel' reportData: $ref: '#/components/schemas/ReportData' description: Тело запроса для обновления заказа партнерами из бизнес линии Travel ChangeReason: type: string description: Причина изменения в заказе * `ADDITIONAL_SERVICES` - доп.услуги; * `EXCHANGE` - обмен; * `CHANGE_TIMETABLE` - изменение расписания; * `PARTLY_REFUNDED` - частичный возврат; example: CHANGE_TIMETABLE enum: - ADDITIONAL_SERVICES - EXCHANGE - CHANGE_TIMETABLE - PARTLY_REFUNDED Transaction: maxItems: 20 type: array description: Массив с транзакциями items: $ref: '#/components/schemas/TransactionItems' TransactionItems: required: - currency - dateTime - maskedCardNumber - rrn - sum type: object properties: sum: type: number description: Сумма оплаты в рублях example: 800 currency: maxLength: 3 type: string description: Валюта оплаты example: RUB maskedCardNumber: maxLength: 20 type: string description: Маскированный номер карты example: 12345678******78912 rrn: maxLength: 255 type: string description: Уникальный идентификатор банковской транзакции example: "1498745362575217925125545565" tokenCode: maxLength: 20 type: string description: Номер токена полученный при оплате через GooglePay/ApplePay example: "65941241914" dateTime: type: string description: Дата и время транзакции по МСК format: date-time example: 2023-10-05T14:30:00Z cashback: $ref: '#/components/schemas/Cashback' description: Объект с содержимым транзакции PaymentSum: type: number description: Сумма оплаты в рублях example: 800 MaskedCardNumber: maxLength: 20 type: string description: Маскированный номер карты example: 12345678******78912 Rrn: maxLength: 255 type: string description: Уникальный идентификатор банковской транзакции example: "1498745362575217925125545565" TokenCode: maxLength: 20 type: string description: Номер токена полученный при оплате через GooglePay/ApplePay example: "65941241914" PaymentDateTime: type: string description: Дата и время транзакции по МСК format: date-time example: 2023-10-05T14:30:00Z Cashback: required: - totalSum type: object properties: totalSum: type: number description: Общая сумма кэшбека example: 1850 cashbackDetailList: maxItems: 100 type: array description: Массив с детальной информацией о кэшбеке items: $ref: '#/components/schemas/CashbackDetailListItems' description: Данные о кэшбеке example: totalSum: 1850 cashbackDetailList: - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 TotalSumCashback: type: number description: Общая сумма кэшбека example: 1850 CashbackDetailList: maxItems: 100 type: array description: Массив с детальной информацией о кэшбеке items: $ref: '#/components/schemas/CashbackDetailListItems' CashbackDetailListItems: type: object properties: contentId: type: string description: ИД товарной категории example: "12" sum: type: number description: Суммарный кэшбек за категорию example: 800.0 description: Объект с детальной информацией о кэшбеке example: contentId: "12" sum: 800.0 ContentId: type: string description: ИД товарной категории example: "12" CashSum: type: number description: Суммарный кэшбек за категорию example: 800.0 ErrorIncorrectStatus: type: object properties: error: type: string description: Ошибка example: incorrect_status error_description: type: string description: Описание ошибки example: Incorrect Status description: Ошибка с сообщением IncorrectError: type: string description: Ошибка example: incorrect_status IncorrectStatusDescription: type: string description: Описание ошибки example: Incorrect Status PostConfirmationRequest: type: object properties: comment: type: string description: Комментарий к подтверждению example: Подтвердить paymentTransaction: maxItems: 20 type: array description: Массив с транзакциями items: $ref: '#/components/schemas/PaymentTransactionItems' cashback: $ref: '#/components/schemas/Cashback' example: comment: Подтвердить paymentTransaction: - dateTime: 2023-10-05T14:30:00Z tokenCode: "65941241914" sum: 800 currency: RUB maskedCardNumber: 12345678******78912 rrn: "1498745362575217925125545565" - dateTime: 2023-10-05T14:30:00Z tokenCode: "65941241914" sum: 800 currency: RUB maskedCardNumber: 12345678******78912 rrn: "1498745362575217925125545565" - dateTime: 2023-10-05T14:30:00Z tokenCode: "65941241914" sum: 800 currency: RUB maskedCardNumber: 12345678******78912 rrn: "1498745362575217925125545565" - dateTime: 2023-10-05T14:30:00Z tokenCode: "65941241914" sum: 800 currency: RUB maskedCardNumber: 12345678******78912 rrn: "1498745362575217925125545565" - dateTime: 2023-10-05T14:30:00Z tokenCode: "65941241914" sum: 800 currency: RUB maskedCardNumber: 12345678******78912 rrn: "1498745362575217925125545565" cashback: totalSum: 1850 cashbackDetailList: - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 - contentId: "12" sum: 800.0 ConfirmationComment: type: string description: Комментарий к подтверждению example: Подтвердить PaymentTransaction: maxItems: 20 type: array description: Массив с транзакциями items: $ref: '#/components/schemas/PaymentTransactionItems' PaymentTransactionItems: required: - currency - dateTime - maskedCardNumber - rrn - sum type: object properties: sum: type: number description: Сумма оплаты в рублях example: 800 currency: maxLength: 3 type: string description: Валюта оплаты example: RUB maskedCardNumber: maxLength: 20 type: string description: Маскированный номер карты example: 12345678******78912 rrn: maxLength: 255 type: string description: Уникальный идентификатор банковской транзакции example: "1498745362575217925125545565" tokenCode: maxLength: 20 type: string description: Номер токена полученный при оплате через GooglePay/ApplePay example: "65941241914" dateTime: type: string description: Дата и время транзакции по МСК format: date-time example: 2023-10-05T14:30:00Z description: Информация об оплате example: dateTime: 2023-10-05T14:30:00Z tokenCode: "65941241914" sum: 800 currency: RUB maskedCardNumber: 12345678******78912 rrn: "1498745362575217925125545565" SuccessResponseConfirmOrder: type: object properties: orderId: maxLength: 50 type: string description: Идентификатор заказа в банке example: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: maxLength: 50 type: string description: Статус подтвержденного заказа example: Confirmed StatusConfirm: maxLength: 50 type: string description: Статус подтвержденного заказа example: Confirmed SuccessConfirmAlreadyOrder: type: object properties: orderId: maxLength: 50 type: string description: Идентификатор заказа в банке example: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: type: string description: Статус подтвержденного заказа example: Order already confirmed example: orderId: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: Order already confirmed StatusAlreadyConfirmed: type: string description: Статус подтвержденного заказа example: Order already confirmed PatchDeactivateRequest: required: - accountType - sum - sumRubEquivalent type: object properties: accountType: type: string description: Тип бонусного счета для возврата example: Мили sumRubEquivalent: type: number description: Сумма возврата бонусными единицами в рублевом эквиваленте example: 600 sum: type: number description: Сумма возврата example: 600 comment: type: string description: Комментарий к возврату nullable: true example: Добровольный возврат example: sumRubEquivalent: 600 accountType: Мили sum: 600 comment: Добровольный возврат RefundAccountType: type: string description: Тип бонусного счета для возврата example: Мили RefundSumRubEquivalent: type: number description: Сумма возврата бонусными единицами в рублевом эквиваленте example: 600 RefundSum: type: number description: Сумма возврата example: 600 RefundComment: type: string description: Комментарий к возврату nullable: true example: Добровольный возврат SuccessResponseBonus: maxItems: 100 type: array description: Массив транзакций по заказу items: $ref: '#/components/schemas/SuccessResponseBonusItems' SuccessResponseBonusItems: required: - balance - typeName - unitName type: object properties: typeName: maxLength: 50 type: string description: Наименование типа бонусного счета nullable: true example: AlfaTravel balance: type: integer description: Баланс счета format: int64 nullable: true example: 189594 unitName: maxLength: 50 type: string description: Наименование единиц измерения поощрений nullable: true example: Мили description: Объект с полями транзакции по заказу example: balance: 189594 unitName: Мили typeName: AlfaTravel TypeName: maxLength: 50 type: string description: Наименование типа бонусного счета nullable: true example: AlfaTravel Balance_1: type: integer description: Баланс счета format: int64 nullable: true example: 189594 UnitName: maxLength: 50 type: string description: Наименование единиц измерения поощрений nullable: true example: Мили PostRegistriesRequest: required: - admPid - clientInf - email - expirationDate - registryId type: object properties: registryId: maxLength: 36 type: string description: Идентификатор реестра example: "039012000001000" expirationDate: type: string description: "Дата и время (местное), до которого можно производить само\ инкассацию по данному реестру (ISO 8601 с часовым поясом)" format: date-time example: 2025-08-05T11:00:00+03:00 admPid: pattern: "^\\d{8}$" type: string description: Номер АДМ (8 цифр) example: "00330456" clientStoreCode: maxLength: 50 type: string description: Код магазина клиента example: ShopCode001 paymentAgentInf: $ref: '#/components/schemas/EncashmentGroup' bankPaymentAgentInf: $ref: '#/components/schemas/EncashmentGroup' clientInf: $ref: '#/components/schemas/EncashmentGroup' email: maxLength: 254 minLength: 1 type: string description: Адрес электронной почты клиента. Нужен для отправки чека об операции example: client@example.com description: Объект для передачи данных о реестре раскассировки example: paymentAgentInf: selfEncashmentAmount: "100.00" accountNumber: "40821810801850000018" clientInf: selfEncashmentAmount: "100.00" accountNumber: "40821810801850000018" registryId: "039012000001000" admPid: "00330456" clientStoreCode: ShopCode001 bankPaymentAgentInf: selfEncashmentAmount: "100.00" accountNumber: "40821810801850000018" email: client@example.com expirationDate: 2025-08-05T11:00:00+03:00 EncashmentGroup: required: - accountNumber - selfEncashmentAmount type: object properties: accountNumber: pattern: "^\\d{20}$" type: string description: Номер счёта example: "40821810801850000018" selfEncashmentAmount: pattern: "^\\d+\\.\\d{1,2}$" type: string description: Сумма по реестру в рублях. Разделительный знак - точка. example: "100.00" example: selfEncashmentAmount: "100.00" accountNumber: "40821810801850000018" PostRegistriesResponse: required: - registryId type: object properties: registryId: maxLength: 36 type: string description: Идентификатор реестра example: "039012000001000" example: registryId: "039012000001000" CancelRegistriesRequest: required: - registryIds type: object properties: registryIds: maxItems: 100 type: array description: Идентификаторы реестров раскассировки example: - "039012000001000" - "039012000001001" items: maxLength: 36 type: string example: registryIds: - "039012000001000" - "039012000001001" CancelRegistriesResponse: required: - requestId type: object properties: requestId: type: string description: Идентификатор запроса example: 550e8400-e29b-41d4-a716-446655440000 example: requestId: 550e8400-e29b-41d4-a716-446655440000 GetAdmResponse: required: - items type: object properties: pagination: $ref: '#/components/schemas/Pagination_1' items: type: array items: $ref: '#/components/schemas/AdmDevice' example: pagination: offset: 0 limit: 10 totalCount: 1 items: - statusDescription: Устройство полностью работоспособно admSoftwareVersion: 2.1.8 billValidatorSoftwareVersion: 1.0.4 admPid: "00330456" status: 1 - statusDescription: Устройство полностью работоспособно admSoftwareVersion: 2.1.8 billValidatorSoftwareVersion: 1.0.4 admPid: "00330456" status: 1 AdmDevice: required: - admPid type: object properties: admPid: type: string description: Уникальный идентификатор устройства example: "00330456" status: type: integer description: | Статус. Принимает возможные значения: * `1` - Устройство полностью работоспособно; * `2` - Работает, но есть проблемы; * `3` - Устройство неработоспособно example: 1 enum: - 1 - 2 - 3 statusDescription: type: string description: Расшифровка статуса example: Устройство полностью работоспособно admSoftwareVersion: type: string description: Версия ПО АДМ example: 2.1.8 billValidatorSoftwareVersion: type: string description: Версия ПО купюроприемника example: 1.0.4 description: Данные АДМ example: statusDescription: Устройство полностью работоспособно admSoftwareVersion: 2.1.8 billValidatorSoftwareVersion: 1.0.4 admPid: "00330456" status: 1 IndividualsPage: required: - items - pagination type: object properties: pagination: $ref: '#/components/schemas/Pagination_4' items: type: array items: $ref: '#/components/schemas/IndividualLead' example: pagination: offset: 0 limit: 10 totalCount: 1 items: - createdAt: 2025-08-07T15:05:29.736Z contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru clientName: ИП Иванов Иван Иванович city: regionId: 77 cityId: 1 presenceCityTitle: Москва inn: inn description: Подготовка документов individualId: 6894c0b98f2def59337246b0 updatedAt: 2025-08-07T15:05:36.376Z status: IN_PROGRESS - createdAt: 2025-08-07T15:05:29.736Z contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru clientName: ИП Иванов Иван Иванович city: regionId: 77 cityId: 1 presenceCityTitle: Москва inn: inn description: Подготовка документов individualId: 6894c0b98f2def59337246b0 updatedAt: 2025-08-07T15:05:36.376Z status: IN_PROGRESS CreateIndividualRequest: required: - agreement - city - contactInfo type: object properties: city: $ref: '#/components/schemas/CreateIndividualRequest_city' agreement: type: boolean description: Согласие на обработку персональных данных. contactInfo: $ref: '#/components/schemas/ContactInfo' description: Тело запроса. example: agreement: true contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru city: regionId: 6 cityId: 0 presenceCityTitle: presenceCityTitle CreatedIndividualId: required: - individualId type: object properties: individualId: type: string example: individualId: individualId Error_2: required: - error - error_description type: object properties: error: type: string example: invalid_token error_description: type: string example: "The access token provided is expired, revoked, malformed, or invalid\ \ for other reasons" IndividualLead: required: - city - clientName - contactInfo - createdAt - description - individualId - status - updatedAt type: object properties: individualId: type: string example: 6894c0b98f2def59337246b0 inn: type: string nullable: true clientName: type: string example: ИП Иванов Иван Иванович createdAt: type: string format: date-time example: 2025-08-07T15:05:29.736Z updatedAt: type: string format: date-time example: 2025-08-07T15:05:36.376Z contactInfo: $ref: '#/components/schemas/ContactInfo' status: type: string example: IN_PROGRESS description: type: string example: Подготовка документов city: $ref: '#/components/schemas/IndividualLead_city' example: createdAt: 2025-08-07T15:05:29.736Z contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru clientName: ИП Иванов Иван Иванович city: regionId: 77 cityId: 1 presenceCityTitle: Москва inn: inn description: Подготовка документов individualId: 6894c0b98f2def59337246b0 updatedAt: 2025-08-07T15:05:36.376Z status: IN_PROGRESS LlcsPage: required: - items - pagination type: object properties: pagination: $ref: '#/components/schemas/Pagination_4' items: type: array items: $ref: '#/components/schemas/LlcLead' example: pagination: offset: 0 limit: 10 totalCount: 1 items: - createdAt: 2023-06-01T08:51:46.555Z contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru clientName: - language: RU full: Общество с ограниченной Ответственностью Альфа short: ООО Альфа - language: EN full: Alfa Limited Liability Company short: Alfa LLC city: regionId: 77 cityId: 1 presenceCityTitle: Москва inn: "7700000000" description: Подготовка документов llcId: 64785c22f344200bcfe1eb1e updatedAt: 2023-06-01T08:51:58.408Z status: IN_PROGRESS - createdAt: 2023-06-01T08:51:46.555Z contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru clientName: - language: RU full: Общество с ограниченной Ответственностью Альфа short: ООО Альфа - language: EN full: Alfa Limited Liability Company short: Alfa LLC city: regionId: 77 cityId: 1 presenceCityTitle: Москва inn: "7700000000" description: Подготовка документов llcId: 64785c22f344200bcfe1eb1e updatedAt: 2023-06-01T08:51:58.408Z status: IN_PROGRESS CreateLlcRequest: required: - agreement - city - clientName - contactInfo type: object properties: city: $ref: '#/components/schemas/CreateIndividualRequest_city' agreement: type: boolean description: Согласие на обработку персональных данных. contactInfo: $ref: '#/components/schemas/ContactInfo' clientName: type: array description: "" example: - language: RU full: Общество с ограниченной Ответственностью Альфа short: ООО Альфа - language: EN full: Alfa Limited Liability Company short: Alfa LLC items: $ref: '#/components/schemas/ClientNameItem' description: Тело запроса. example: agreement: true contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru city: regionId: 6 cityId: 0 presenceCityTitle: presenceCityTitle clientName: - language: RU full: Общество с ограниченной Ответственностью Альфа short: ООО Альфа - language: EN full: Alfa Limited Liability Company short: Alfa LLC CreatedLlcId: required: - llcId type: object properties: llcId: type: string example: llcId: llcId LlcLead: required: - city - clientName - contactInfo - createdAt - description - llcId - status - updatedAt type: object properties: llcId: type: string example: 64785c22f344200bcfe1eb1e inn: type: string nullable: true example: "7700000000" createdAt: type: string format: date-time example: 2023-06-01T08:51:46.555Z updatedAt: type: string format: date-time example: 2023-06-01T08:51:58.408Z contactInfo: $ref: '#/components/schemas/ContactInfo' clientName: type: array description: "" example: - language: RU full: Общество с ограниченной Ответственностью Альфа short: ООО Альфа - language: EN full: Alfa Limited Liability Company short: Alfa LLC items: $ref: '#/components/schemas/ClientNameItem' status: type: string example: IN_PROGRESS description: type: string example: Подготовка документов city: $ref: '#/components/schemas/IndividualLead_city' example: createdAt: 2023-06-01T08:51:46.555Z contactInfo: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru clientName: - language: RU full: Общество с ограниченной Ответственностью Альфа short: ООО Альфа - language: EN full: Alfa Limited Liability Company short: Alfa LLC city: regionId: 77 cityId: 1 presenceCityTitle: Москва inn: "7700000000" description: Подготовка документов llcId: 64785c22f344200bcfe1eb1e updatedAt: 2023-06-01T08:51:58.408Z status: IN_PROGRESS ManagerCitiesPage: required: - items - pagination type: object properties: pagination: $ref: '#/components/schemas/Pagination_4' items: type: array items: $ref: '#/components/schemas/City_2' example: pagination: offset: 0 limit: 10 totalCount: 1 items: - cityName: Москва regionId: 77 cityId: 1 - cityName: Москва regionId: 77 cityId: 1 MonthPeriod: type: string description: "Отчётный месяц в формате ISO 8601 (YYYY-MM-DDThh:mm:ss.SSSZ).\ \ Рекомендуется указывать первое число целевого месяца с нулевым временем\ \ (например, 2025-08-01T00:00:00.000Z). Не старше 6 месяцев от текущей дат\ ы." example: 2025-08-01T00:00:00.000Z ClientsResponse: type: object properties: clients: type: array description: Список ИНН клиентов с продажами по указанным продуктам за месяц; может быть null при отсутствии продаж. nullable: true items: type: string description: Схема ClientsResponse. example: clients: - "782740504" - "782740502" - "782740508" SalesResponse: type: object properties: sales: type: array description: Список наименований успешно проданных клиенту продуктов по ИНН за заданный месяц; может быть null при отсутствии продаж. nullable: true items: type: string description: Схема SalesResponse. example: sales: - РКО - ТА - ИА ComplianceScoreResponse: required: - boundaries - inn - rawScore - riskLevel type: object properties: inn: maxLength: 12 minLength: 10 type: string description: ИНН организаци rawScore: type: number description: Вероятность применения комплаенс-мер (от 0 до 1) format: float example: 0.2094234 riskLevel: type: string description: Оценка в терминах уровня риска example: low enum: - low - medium - high boundaries: $ref: '#/components/schemas/ComplianceScoreResponse_boundaries' example: riskLevel: low inn: inn rawScore: 0.2094234 boundaries: high: 0.65 low: 0.32 SimplePage: type: object properties: limit: type: integer description: Количество записей на одной странице example: 1000 offset: type: integer description: "Количество записей в списке, которые были пропущены" example: 0 totalCount: type: integer description: Общее количество записей example: 10000 description: Данные пагинации example: offset: 0 limit: 1000 totalCount: 10000 Meta_1: type: object properties: totalPages: maximum: 5000 minimum: 1 type: number description: Указывает на количество передаваемых страниц format: int32 example: 1 additionalProperties: false description: "Дополнительные данные о запросе. «totalPages», указывает на ко\ личество передаваемых страниц. Если передается более одной страницы, то эл\ емент «totalPages» обязательно присутствует." example: totalPages: 1 MerchantInfo: type: object properties: merchantId: maxLength: 40 minLength: 1 pattern: "^[A-Z0-9]{1,40}$" type: string description: "Уникальный и неизменный идентификатор, используемый для ид\ ентификации ресурса" example: THIS01IS02MERCHANTID0XXX merchantCategoryCode: pattern: "^\\d{3,4}$" type: string description: "Код категории соответствует ISO 18245 и относится к типу у\ слуг или товаров, которые продавец предоставляет для транзакции" example: "1234" additionalProperties: false description: Информация о продавце CountryCodeAlfa3: pattern: "^[A-Z]{3,3}$" type: string description: Код страны в формате ISO 3166-1 alpha-3 example: RUS PlainCardData: required: - PAN type: object properties: PAN: pattern: "^[0-9]{4}$" type: string description: "Маскированный учетный номер карты (PAN) или номер карты, о\ граниченный последними 4 цифрами." example: "0001" expiryDate: description: Дата окончания срока действия карты example: 12/2025 allOf: - $ref: '#/components/schemas/ISOYearMonth' additionalProperties: false description: "Данные платежной карты, ассоциированной со счетом" Pagination_4: required: - limit - offset - totalCount type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 totalCount: type: integer example: 1 example: offset: 0 limit: 10 totalCount: 1 ContactInfo: required: - email - firstName - lastName - phone type: object properties: phone: pattern: "^7\\d{10}$" type: string description: "Телефон заявителя в формате 7XXXXXXXXXX. Формат: только ци\ фры, начинается с 7, всего 11 цифр." example: "79000000000" lastName: type: string description: Фамилия заявителя. example: Иванов middleName: type: string description: Отчество заявителя (при наличии). example: Иванович firstName: type: string description: Имя заявителя. example: Иван email: type: string description: E-mail заявителя. format: email example: ivan@example.ru description: "Контактная информация заявителя: ФИО и контактные данные." example: lastName: Иванов firstName: Иван phone: "79000000000" middleName: Иванович email: ivan@example.ru ClientNameArray: type: array description: "" example: - language: RU full: Общество с ограниченной Ответственностью Альфа short: ООО Альфа - language: EN full: Alfa Limited Liability Company short: Alfa LLC items: $ref: '#/components/schemas/ClientNameItem' City_2: required: - cityId - cityName - regionId type: object properties: cityId: type: integer description: Идентификатор города example: 1 regionId: type: integer description: Идентификатор региона example: 77 cityName: type: string description: Наименование города example: Москва example: cityName: Москва regionId: 77 cityId: 1 ClientNameItem: required: - full - language - short type: object properties: language: type: string enum: - RU - EN full: type: string short: type: string description: "" _gd_v1_accounts__accountNumber__status_get_200_response: type: object properties: isAlfaBank: type: boolean description: Признак действующего счета в Альфа-Банке example: true example: isAlfaBank: true verifySms_200_response: oneOf: - $ref: '#/components/schemas/VerifySmsFormCreationResponse' - $ref: '#/components/schemas/VerifySmsFormCompletionResponse' resendSms_200_response: oneOf: - $ref: '#/components/schemas/ResendSmsCreationResponse' - $ref: '#/components/schemas/ResendSmsCompletionResponse' CreateTravelOrder_request: required: - order type: object properties: order: $ref: '#/components/schemas/PostOrderTravel' CreateAfishaOrder_request: required: - order type: object properties: order: $ref: '#/components/schemas/PostOrderAfisha' UpdateTravelOrder_request: required: - order type: object properties: order: $ref: '#/components/schemas/PutOrderTravel' ClientInfo_organizationForm: required: - code - fullName - shortName - type type: object properties: fullName: type: string description: Организационно-правовая форма организации клиента example: Общество с ограниченной ответственностью shortName: type: string description: Краткое наименование ОПФ example: ООО type: type: string description: Тип ОПФ example: "2014" code: type: string description: Код ОПФ example: "12300" example: code: "12300" fullName: Общество с ограниченной ответственностью shortName: ООО type: "2014" Account_bank: type: object properties: bic: type: string description: БИК банка example: "044525593" description: "Информация об отделении банке, где открыт счет" example: bic: "044525593" Links_inner: type: object properties: href: type: string description: Cсылка ведущая на следующую/предыдущую страницу example: accountNumber=40702810500006103990&statementDate=2018-03-15&page=3 rel: type: string description: | Признак страницы * `prev` - Предыдущая страница * `next` - Следующая страница enum: - prev - next example: rel: prev href: accountNumber=40702810500006103990&statementDate=2018-03-15&page=3 Transactions_inner: type: object properties: amount: $ref: '#/components/schemas/Amount' amountRub: $ref: '#/components/schemas/AmountRub' correspondingAccount: type: string description: Корреспондирующий счёт example: "30101810400000000225" direction: type: string description: | Направление транзакции * `CREDIT` - Поступление на счет * `DEBIT` - Списание со счета enum: - DEBIT - CREDIT documentDate: type: string description: Дата документа example: 2021-10-07 filial: type: string description: Наименование филиала example: АО "АЛЬФА-БАНК" number: type: string description: Номер операции example: "1843" operationCode: type: string description: | Тип операции * `01` - Платежное поручение/Валютный перевод * `02` - Платежное требование * `03` - Расходный кассовый ордер/Расходный кассовый чек * `04` - Приходный кассовый ордер/Приходный кассовый чек/Объявление на взнос наличными * `06` - Инкассовое поручение * `08` - Аккредитив * `09` - Мемориальный ордер * `16` - Платежный ордер * `17` - Банковский ордер enum: - "01" - "01" - "02" - "03" - "03" - "04" - "04" - "04" - "06" - "08" - "09" - "16" - "17" x-enum-varnames: - PAYMENT - CURRENCY_PAYMENT - PAYMENT_REQUEST - DEBIT_ORDER - DEBIT_CACH_CHECK - CACH_CONTRIBUTION - CREDIT_CACH_CHECK - CREDIT_ORDER - COLLECTION_LETTER - AKKREDITIV - MEMORY_ORDER - PAYMENT_ORDER - BANK_ORDER operationDate: type: string description: Дата и время операции example: 2018-12-31T00:00:00Z paymentPurpose: type: string description: Назначение платежа example: НДС не облагается priority: type: string description: Очередность платежа example: "5" revaln: type: string description: | Признак операции переоценки * `ПК` - Пересчет курса * `ДП` - Дооценка руб. покрытия enum: - ПК - ДП x-enum-varnames: - PK - DP uuid: type: string description: Уникальный идентификатор операции example: 55daccdf-de87-3879-976c-8b8415c8caf9 transactionId: type: string description: Идентификатор операции example: 1211206MOCO#DS0000017 debtorCode: type: string description: Код дебитора example: "0" extendedDebtorCode: type: string description: Расширенный код дебитора example: "50012008" rurTransfer: $ref: '#/components/schemas/RurTransfer' swiftTransfer: $ref: '#/components/schemas/SwiftTransfer' curTransfer: $ref: '#/components/schemas/CurTransfer' example: documentDate: 2021-10-07 operationDate: 2018-12-31T00:00:00Z amount: amount: 1.01 currencyName: USD filial: АО "АЛЬФА-БАНК" correspondingAccount: "30101810400000000225" debtorCode: "0" curTransfer: payerBankCorrAccount: "30101810200000000593" intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга instructionCode: instructionCode messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 instructedAmount: "USD70,00" payeeBankCorrAccount: "30101810200000000593" transactionRelatedReference: transactionRelatedReference senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D intermediaryBankAccount: COBADEFF payerInn: "7728168971" senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK MOSCOW\ \ RUSSIAN FEDERATION" payeeBankBic: "9611925" senderCharges: "USD7,03" payeeKpp: "770801001" payeeAccount: "40802810401300015422" bankOperationCode: CRED transactionTypeCode: S01 payeeName: Наименование получателя messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageIdentifier: S000013082900014 beneficiaryCustomerName: ООО Ромашка payerName: Гаврилов Добрыня Петрович urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D orderingInstitutionAccount: ABOCBNBJ080 messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR transactionReferenceNumber: 69528 payerKpp: "770801001" payerBankName: АО \"АЛЬФА-БАНК\" orderingInstitutionOption: D payerAccount: "40802810401300015422" payeeBankName: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 payerBankBic: "044525593" payeeInn: "7728168971" receiverCharges: receiverCharges operationCode: "01" amountRub: amount: 1.01 currencyName: USD extendedDebtorCode: "50012008" swiftTransfer: bankOperationCode: CRED intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга transactionTypeCode: S01 instructionCode: instructionCode messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageIdentifier: S000013082900014 messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 beneficiaryCustomerName: ООО Ромашка instructedAmount: "USD70,00" transactionRelatedReference: transactionRelatedReference urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" orderingInstitutionAccount: ABOCBNBJ080 senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR intermediaryBankAccount: COBADEFF transactionReferenceNumber: 69528 orderingInstitutionOption: D senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK MOSCOW\ \ RUSSIAN FEDERATION" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 senderCharges: "USD7,03" receiverCharges: receiverCharges priority: "5" uuid: 55daccdf-de87-3879-976c-8b8415c8caf9 revaln: ПК transactionId: 1211206MOCO#DS0000017 rurTransfer: payerBankCorrAccount: "30101810200000000593" departmentalInfo: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" payerKpp: "770801001" receiptDate: 2018-12-31 deliveryKind: электронно payerBankName: АО \"АЛЬФА-БАНК\" payerInn: "7728168971" valueDate: 2018-12-31 cartInfo: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber payerAccount: "40802810401300015422" payeeName: Наименование получателя payeeBankName: АО \"АЛЬФА-БАНК\" payeeBankBic: "9611925" payerBankBic: "044525593" purposeCode: "1" payeeInn: "7728168971" payerName: Гаврилов Добрыня Петрович payeeBankCorrAccount: "30101810200000000593" payeeKpp: "770801001" payeeAccount: "40802810401300015422" payingCondition: payingCondition number: "1843" paymentPurpose: НДС не облагается direction: DEBIT ResponseSignatureRsaXmlSignedInfo_ds_CanonicalizationMethod: type: object properties: Algorithm: type: string example: http://www.w3.org/2001/10/xml-exc-c14n# xml: attribute: true ResponseSignatureRsaXmlSignedInfo_ds_SignatureMethod: type: object properties: Algorithm: type: string example: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 xml: attribute: true ResponseSignatureRsaXmlSignedInfo_ds_Reference_ds_Transforms_ds_Transform_inner: oneOf: - $ref: '#/components/schemas/ResponseSignatureRsaXmlTransform1' - $ref: '#/components/schemas/ResponseSignatureRsaXmlTransform2' ResponseSignatureRsaXmlSignedInfo_ds_Reference_ds_Transforms: type: object properties: ds:Transform: type: array items: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignedInfo_ds_Reference_ds_Transforms_ds_Transform_inner' ResponseSignatureRsaXmlSignedInfo_ds_Reference_ds_DigestMethod: type: object properties: Algorithm: type: string example: http://www.w3.org/2001/04/xmldsig-more#sha384 xml: attribute: true ResponseSignatureRsaXmlSignedInfo_ds_Reference: type: object properties: URI: type: string example: "" xml: attribute: true ds:Transforms: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignedInfo_ds_Reference_ds_Transforms' ds:DigestMethod: $ref: '#/components/schemas/ResponseSignatureRsaXmlSignedInfo_ds_Reference_ds_DigestMethod' ds:DigestValue: type: string example: oDifxB42SMw0vIERQ8nDsPblrSYSmu9jiJoT+BcO9J1hIEsj/h00cK340jXmsz4+ ResponseSignatureRsaXmlTransform1_allOf: type: object properties: Algorithm: type: string example: http://www.w3.org/2000/09/xmldsig#enveloped-signature xml: attribute: true ResponseSignatureRsaXmlTransform2_allOf: type: object properties: Algorithm: type: string example: http://www.w3.org/2001/10/xml-exc-c14n# xml: attribute: true ResponseSignatureRsaXmlKeyInfo_ds_X509Data: type: object properties: ds:X509Certificate: type: string example: |- MIIGMzCCBBugAwIBAgIIQ+Ua6h49X/kwDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAlJVMQ8w DQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazEl MCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0 Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsu cnUwHhcNMjQwNTI3MTMzNTAwWhcNMjkwNTI3MTMzNTAwWjCByTELMAkGA1UEBhMCUlUxDzANBgNV BAgTBk1vc2NvdzEPMA0GA1UEBxMGTW9zY293MRYwFAYDVQQKEw1KU0MgQWxmYS1CYW5rMSUwIwYD VQQLExxEaWdpdGFsIFNlcnZpY2VzIERldmVsb3BtZW50MSswKQYDVQQDEyJURVNUIFRydXN0Q29y ZVJTQSBTaWduZXIyIDIwNDggYml0MSwwKgYJKoZIhvcNAQkBFh10cnVzdGNvcmVfc3VwcG9ydEBh bGZhYmFuay5ydTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALbaUlic4XF47DJtoFQK Nnd46jvaoE9pyxByuEKQkZY8Na5XWNuyr5ZALF6RTYXRS+i2wqig+zsGhEKG5rM2VZFJB4p6Vvwb ULzDeH08tEw01hvnIiUFxrlVlpMIM649rLaMUTZnh8RKq23WkvDxPaEEeLV0f0sgeHpBf2nV7ZeM 4w6LdC2T/hnYAy7VxIS+BN2nDGOIePqh+lGgUZIHY9cO3IbN7yWSQQSC7hQ696RC9L5vWedOXb6C myWlFsuOnAgp+O3z2U1wbovCQ48CU8VprzjLorw/UTz/qJr7uGGICuY7M1Go7qLvICsHclkKqvRc CMLBGxdg6RBkA+6t96cCAwEAAaOCAScwggEjMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFFp1la5Q GzpdMD7SCyadt9CVfElrMAsGA1UdDwQEAwID+DAdBgNVHSUEFjAUBggrBgEFBQcDAwYIKwYBBQUH AwQwgccGA1UdHwSBvzCBvDA8oDqgOIY2aHR0cDovL2FydGFwcC9hcnRpZmFjdG9yeS9UcnVzdENv cmUvQ1JMcy90cnVzdGNvcmUuY3JsMDqgOKA2hjRodHRwOi8vaGF2ZW4ubW9zY293LmFsZmFpbnRy YS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMECgPqA8hjpodHRwOi8vczAxZHBydXByYnMubW9zY293 LmFsZmFpbnRyYS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMA0GCSqGSIb3DQEBCwUAA4ICAQARCvm8 JwBOGonGKMlnwyxnFX2aV1qIkzMgo7ILaCXT/MybvPH/3GQByBOUsASFU7cod57qEOOyQSN/JTQ/ ZdKz3B8goGoO1XC/toybaTib92Dru7XyiJAeOLHksDjMQ7U6Xgk/51xoPa6AvZyOUWNW0KUdQFWl fyJeH+Gt4Xr1OH+LYuUMhiVubUPn+edW/PW8WTzlpjvd55/e69YViSJBuNenV0cmxKe/xWD7ZnfG fBsf+Sy/xhfjP0nFd7qANeQJXmb07gl7zJUyV0oK7fXyHO7Rg2wVcWEr8p9uS/sTS0ZnXJZKN3/O O+zp9UPM23uzZNuySsBbc7QNlJ3c8GLL/R93xvE3BNV+DtZVbu7xaqcWZmFEnfp0iTVCfMC3d9Ci g+KZ5NKBQp+vB0A4+vj8jO/ZCCjtho3nqeJ+exO2AHgLYj6XaeCTed4fW0ENt0XWNrFaVW/wRyHO XvEN8Ocj8LV5Xtwh6xPuwSbas2VL4v7V50O7V5RA4ZucdpdmRj5z/qkqkirGRcWnf+UWwjniI+Bz CGlsPjGJmGgl8OjGUnb/vZ4fN1g2QVBcS1riln0mQDPbaBJNtFOSc3GCh+HttX075tinnux348Yg qsHeKfsVZ6+5gmrumdaS8uN/L/cgFtPJFfwpbz5YGq98owU8BVlodP1eM8C5eEPU1X0BGQ== TransactionsCorrespondent_inner: type: object properties: amount: $ref: '#/components/schemas/Amount' amountRub: $ref: '#/components/schemas/AmountRub' correspondingAccount: type: string description: Корреспондирующий счёт example: "30101810400000000225" direction: type: string description: | Направление транзакции * `CREDIT` - Поступление на счет * `DEBIT` - Списание со счета enum: - DEBIT - CREDIT documentDate: type: string description: Дата документа example: 2021-10-07 filial: type: string description: Наименование филиала example: АО "АЛЬФА-БАНК" number: type: string description: Номер операции example: "1843" operationCode: type: string description: | Тип операции * `01` - Платежное поручение/Валютный перевод * `02` - Платежное требование * `03` - Расходный кассовый ордер/Расходный кассовый чек * `04` - Приходный кассовый ордер/Приходный кассовый чек/Объявление на взнос наличными * `06` - Инкассовое поручение * `08` - Аккредитив * `09` - Мемориальный ордер * `16` - Платежный ордер * `17` - Банковский ордер enum: - "01" - "02" - "03" - "04" - "06" - "08" - "09" - "16" - "17" operationDate: type: string description: Дата и время операции example: 2018-12-31T00:00:00Z paymentPurpose: type: string description: Назначение платежа example: НДС не облагается priority: type: string description: Очередность платежа example: "5" revaln: type: string description: | Признак операции переоценки * `ПК` - Пересчет курса * `ДП` - Дооценка руб. покрытия enum: - ПК - ДП uuid: type: string description: Уникальный идентификатор операции example: 55daccdf-de87-3879-976c-8b8415c8caf9 transactionId: type: string description: Идентификатор операции example: 1211206MOCO#DS0000017 debtorCode: type: string description: Код дебитора example: "0" extendedDebtorCode: type: string description: Расширенный код дебитора example: "50012008" rurTransfer: $ref: '#/components/schemas/RurTransfer' curTransfer: $ref: '#/components/schemas/CurTransfer' example: documentDate: 2021-10-07 operationDate: 2018-12-31T00:00:00Z amount: amount: 1.01 currencyName: USD filial: АО "АЛЬФА-БАНК" correspondingAccount: "30101810400000000225" debtorCode: "0" curTransfer: payerBankCorrAccount: "30101810200000000593" intermediaryBankOption: D intermediaryBankName: АО "АЛЬФА-БАНК" orderingCustomerAccount: /08251801040004813 orderingCustomerName: ООО Радуга instructionCode: instructionCode messageType: "103" exchangeRate: "67,74" beneficiaryBankName: АО \"АЛЬФА-БАНК\" messageOriginator: SABRRU2P receiverCorrespondentAccount: "30101810400000000000" regulatoryReporting: /N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003 beneficiaryBankAccount: LOYDGB21323 instructedAmount: "USD70,00" payeeBankCorrAccount: "30101810200000000593" transactionRelatedReference: transactionRelatedReference senderCorrespondentName: "CITIBANK N.A. NEW YORK,NY" senderCorrespondentAccount: BOTKGB2L valueDateCurrencyInterbankSettledAmount: "130824EUR5447,34" senderCorrespondentOption: D intermediaryBankAccount: COBADEFF payerInn: "7728168971" senderToReceiverInformation: /NZP/OT 15.03.2009. NDS NE OBLAGAETSYA receiverCorrespondentName: "JSC ROSSELKHOZBANK 3, GAGARINSKY PEREULOK MOSCOW\ \ RUSSIAN FEDERATION" payeeBankBic: "9611925" senderCharges: "USD7,03" payeeKpp: "770801001" payeeAccount: "40802810401300015422" bankOperationCode: CRED transactionTypeCode: S01 payeeName: Наименование получателя messageReceiveTime: 15-05-27 13:21 messageDestinator: LAPBLV2X messageIdentifier: S000013082900014 beneficiaryCustomerName: ООО Ромашка payerName: Гаврилов Добрыня Петрович urgent: URGENT orderingInstitutionName: АО "АЛЬФА-БАНК" receiverCorrespondentOption: D orderingInstitutionAccount: ABOCBNBJ080 messageSendTime: 15-05-27 13:21 orderingCustomerOption: K detailsOfCharges: OUR transactionReferenceNumber: 69528 payerKpp: "770801001" payerBankName: АО \"АЛЬФА-БАНК\" orderingInstitutionOption: D payerAccount: "40802810401300015422" payeeBankName: АО \"АЛЬФА-БАНК\" beneficiaryBankOption: D remittanceInformation: PAYMENT ACC AGREEMENT 1 DD 29.11.2018 FOR WATCHES beneficiaryCustomerAccount: /40702810701300000761 payerBankBic: "044525593" payeeInn: "7728168971" receiverCharges: receiverCharges operationCode: "01" amountRub: amount: 1.01 currencyName: USD extendedDebtorCode: "50012008" priority: "5" uuid: 55daccdf-de87-3879-976c-8b8415c8caf9 revaln: ПК transactionId: 1211206MOCO#DS0000017 rurTransfer: payerBankCorrAccount: "30101810200000000593" departmentalInfo: drawerStatus101: "1" oktmo: "11605000" kbk: "39210202010061000160" taxPeriod107: МС.03.2016 docNumber108: "123" reasonCode106: ТП docDate109: 31.12.2018 uip: "32221003200126505006" paymentKind110: "1" payerKpp: "770801001" receiptDate: 2018-12-31 deliveryKind: электронно payerBankName: АО \"АЛЬФА-БАНК\" payerInn: "7728168971" valueDate: 2018-12-31 cartInfo: documentCode: documentCode documentDate: 2019-10-19T06:33:47.923Z restAmount: restAmount documentNumber: documentNumber documentContent: documentContent paymentNumber: paymentNumber payerAccount: "40802810401300015422" payeeName: Наименование получателя payeeBankName: АО \"АЛЬФА-БАНК\" payeeBankBic: "9611925" payerBankBic: "044525593" purposeCode: "1" payeeInn: "7728168971" payerName: Гаврилов Добрыня Петрович payeeBankCorrAccount: "30101810200000000593" payeeKpp: "770801001" payeeAccount: "40802810401300015422" payingCondition: payingCondition number: "1843" paymentPurpose: НДС не облагается direction: DEBIT DownloadFileLinks_inner: type: object properties: url: type: string description: Ссылка на скачивание файла. Ссылка доступна только если status = SUCCEED . example: https://baas.alfabank.ru/filebox/secure-file-transfer.outgoing-files.to-processing/f190bfef-aad6-ce9b-9224-f11ef60564cb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8 method: type: string description: Метод для скачивания файла example: GET example: method: GET url: https://baas.alfabank.ru/filebox/secure-file-transfer.outgoing-files.to-processing/f190bfef-aad6-ce9b-9224-f11ef60564cb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8 AccountResponse_Data: description: Полезная нагрузка ответа allOf: - $ref: '#/components/schemas/DataAccountResponse' AccountResponse_Links: description: Раздел для указания ссылок example: self: https://sb.example.ru/v1.3/example allOf: - $ref: '#/components/schemas/Links_1' AccountResponse_Meta: description: Раздел метаданных allOf: - $ref: '#/components/schemas/Meta' Account_1_Owner: description: Информация о владельце счета allOf: - $ref: '#/components/schemas/PartyIdentification' Account_1_Servicer: oneOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationPilot' - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformation' BranchAndFinancialInstitutionInformationPilot_CorrespondentAccount: required: - identification - schemeName type: object properties: schemeName: description: Наименование схемы идентификации счета allOf: - $ref: '#/components/schemas/AccountIdentificationCode' identification: maxLength: 256 minLength: 1 pattern: "^[\\w\\W]{1,256}$" type: string description: "Идентификатор счета соответствующий схеме идентификации, и\ звестный владельцу счета (номер банковского счета, номер карты, номер\ \ телефона ...)" example: "40817810621234570000" additionalProperties: false description: Корреспондентский счет BranchAndFinancialInstitutionInformationPilot_PostalAddress: required: - addressLine type: object properties: addressLine: maxItems: 2 minItems: 0 type: array description: Строка адреса example: - Адрес в виде строки - вторая часть строки адреса items: maxLength: 70 minLength: 1 pattern: "^[\\w\\W]{1,70}$" type: string description: Строка адреса additionalProperties: false description: "Адрес отделения, обслуживающего счет" StatementResponse_Data: description: Полезная нагрузка ответа allOf: - $ref: '#/components/schemas/Statement_2' StatementResponse_Links: description: Раздел для указания ссылок allOf: - $ref: '#/components/schemas/Links_1' Statement_2_TransactionsSummary: description: Обороты по кредиту и дебету allOf: - $ref: '#/components/schemas/TransactionsSummary' CashBalance_Amount: description: Сумма остатка allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TransactionsSummary_TotalCreditEntries: description: Обороты по кредиту example: numberOfEntries: "2" sum: "100.00" currency: RUB allOf: - $ref: '#/components/schemas/NumberAndSumOfTransactions' TransactionsSummary_TotalDebitEntries: description: Обороты по дебету example: numberOfEntries: "2" sum: "1500.00" currency: RUB allOf: - $ref: '#/components/schemas/NumberAndSumOfTransactions' ReportEntry_Amount: description: "Информация о сумме и валюте операции по счету для данной запис\ и (Примечание - TransactionAmount,ChargeAmount,InstructedAmount - это дета\ ли данного реквизита)" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' ReportEntry_TransactionAmount: description: Сумма в валюте исходной операции по счету allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' ReportEntry_ChargeAmount: description: Комиссия за операции по счету allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' ReportEntry_InstructedAmount: description: "Сумма денег и информации об обменом курсе, подлежащая перевод\ у между плательщиком и получателем денежных средств до вычета расходов, вы\ раженная в валюте обозначенной инициирующей стороной в случае, если указан\ ная сумма и/или валюта отличаются от суммы и/или валюты операции по счету" allOf: - $ref: '#/components/schemas/AmountAndCurrencyExchangeDetails' ReportEntry_BankTransactionCode: description: Подробная информация для полной идентификации собственного банковского кода операции по счету allOf: - $ref: '#/components/schemas/BankTransactionCode' ReportEntry_PaymentTypeInformation: description: Информация о типе платежа allOf: - $ref: '#/components/schemas/PaymentTypeInformation' ReportEntry_UltimateDebtor: description: Фактический плательщик allOf: - $ref: '#/components/schemas/PartyIdentification' ReportEntry_Debtor: description: Плательщик allOf: - $ref: '#/components/schemas/PartyChoice' ReportEntry_DebtorAgent: description: "Финансовое организация, обслуживающая счет плательщика" allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification' ReportEntry_DebtorAgentAccount: description: Однозначная идентификация счета плательщика у обслуживающего его банка в платежной цепочке allOf: - $ref: '#/components/schemas/CashAccount' ReportEntry_DebtorAccount: description: "Уникальная идентификация счета плательщика, на котором будет с\ делана дебетовая запись в результате операции" allOf: - $ref: '#/components/schemas/CashAccount' ReportEntry_IntermediaryAgent: description: "Банк-посредник, находящийся между банком плательщика и банком\ \ получателя денежных средств" allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification' ReportEntry_IntermediaryAgentAccount: description: Счет банка-посредника allOf: - $ref: '#/components/schemas/CashAccount' ReportEntry_CreditorAgent: description: "Финансовое организация, обслуживающая счет получателя денежны\ х средств" allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification' ReportEntry_CreditorAccount: description: "Идентификатор счета получателя средств, на котором будет прове\ дена запись о кредите в результате операции" allOf: - $ref: '#/components/schemas/CashAccount' ReportEntry_CreditorAgentAccount: description: "Однозначная идентификация счета банка получателя денежных сред\ ств у обслуживающего его банка, по которому будет выполнена кредитовая зап\ ись в результате платежной операции" allOf: - $ref: '#/components/schemas/CashAccount' ReportEntry_Creditor: description: Получатель денежных средств allOf: - $ref: '#/components/schemas/PartyChoice' ReportEntry_UltimateCreditor: description: Фактический получатель денежных средств allOf: - $ref: '#/components/schemas/PartyIdentification' ReportEntry_CardTransaction: description: |- Предоставляет данные по карте (номер, платежная система), терминалу (номер, идентификатор) и транзакционные данные, используемые для уникальной идентификации операции по карте allOf: - $ref: '#/components/schemas/CardTransaction18' ReportEntry_RemittanceInformation: description: "Предоставляемая информация, позволяющая сопоставить запись с п\ озициями, для которых предназначен перевод, такими как коммерческие счета\ \ в системе дебиторской задолженности" allOf: - $ref: '#/components/schemas/RemittanceInformation' AmountAndCurrencyExchangeDetails_Amount: description: "Сумма денег, подлежащая переводу между плательщиком и получате\ лем денежных средств до вычета расходов, выраженная в валюте обозначенной\ \ инициирующей стороной" allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' AmountAndCurrencyExchangeDetails_CurrencyExchange: required: - Amount description: "Набор элементов, используемые для указания информации об обмен\ ом курсе. Использование: Это может быть либо встречная сумма, указанная в\ \ сделке с иностранной валютой, либо результат информации о валюте, примен\ енной к указанной сумме, до вычета расходов" allOf: - $ref: '#/components/schemas/CurrencyExchange' PartyChoice_Agent: type: object description: "Информация об участнике, используемая для идентификации финанс\ овой организации" allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformation' PartyChoice_Party: description: "Информация об участнике, используемая для идентификации юридич\ еского или физического лица" allOf: - $ref: '#/components/schemas/PartyIdentification' CardTransaction18_POI: description: "Физический или логический карточный платежный терминал, состоя\ щий из программного обеспечения и аппаратной части" allOf: - $ref: '#/components/schemas/PointOfInteraction1' CardTransaction18_Transaction: description: "Сведения об отдельной операции по карте, записанные на POI-тер\ минале (точке взаимодействия)" allOf: - $ref: '#/components/schemas/CardIndividualTransaction2' PaymentCard4_PlainCardData: description: "Конфиденциальные данные, связанные с выполнением операции по к\ арте" allOf: - $ref: '#/components/schemas/PlainCardData1' PaymentCard4_CardBrand: description: Брендовое наименование карты allOf: - $ref: '#/components/schemas/GenericIdentification32' PlainCardData1_CardSecurityCode: description: "Код безопасности карты (CSC), связанный с выполнением операции\ \ по карте" allOf: - $ref: '#/components/schemas/CardSecurityInformation1' PointOfInteraction1_Identification: description: "Уникальный и однозначный идентификатор (карты/POI-терминала),\ \ присвоенный идентифицирующей организацией" allOf: - $ref: '#/components/schemas/GenericIdentification32' CardIndividualTransaction2_TransactionIdentification: description: "Идентификатор операции, назначенной POI (точка взаимодействия)" allOf: - $ref: '#/components/schemas/TransactionIdentifier1' CardIndividualTransaction2_Product_inner: allOf: - $ref: '#/components/schemas/Product2' RemittanceInformation_CreditorReferenceInformation: description: Информация от получателя денежных средств allOf: - $ref: '#/components/schemas/CreditorReferenceInformation' RemittanceInformation_TaxRemittance: description: "Информация о платеже, которая связана с оплатой налогов" allOf: - $ref: '#/components/schemas/TaxInformation' TaxInformation_creditor: description: Налоговая информация о получателе средств allOf: - $ref: '#/components/schemas/TaxParty' TaxInformation_debtor: description: Налоговая информация о плательщике allOf: - $ref: '#/components/schemas/TaxParty' TaxInformation_Record: description: Дополнительные налоговые реквизиты allOf: - $ref: '#/components/schemas/TaxRecord' TaxRecord_TaxAmount: description: Информация о НДС allOf: - $ref: '#/components/schemas/TaxAmount' StatementInitRequest_Data: allOf: - $ref: '#/components/schemas/DataStatementInitRequest' DataStatementInitRequest_Statement: description: Объект запроса на создание ресурса выписки allOf: - $ref: '#/components/schemas/StatementInitType' StatementInitResponse_Data: description: Полезная нагрузка ответа allOf: - $ref: '#/components/schemas/DataStatementInitResponse' DataStatementInitResponse_Statement: description: Ресурс выписки allOf: - $ref: '#/components/schemas/StatementInitResponseType' ActionsRSACertificate_inner: type: object properties: type: type: string description: Тип действия example: UPLOAD_ON_TOKEN available: type: boolean description: Признак доступности действия example: available: true type: UPLOAD_ON_TOKEN _______________________: title: Причина отказа проверки type: object properties: description: type: string description: Текстовое описание причины отказа example: description: description ReceiptAndPayoutList_company: required: - accountNumber type: object properties: accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета компании example: "40702810606050000022" description: Информация о компании example: accountNumber: "40702810606050000022" ReceiptAndPayoutList_requisite_inner_selfemployed: required: - vatin type: object properties: vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" surname: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Фамилия example: Иванов name: maxLength: 64 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Имя example: Иван patronymic: maxLength: 128 minLength: 1 pattern: "^[а-яА-ЯЁё\\-\\s+]*$" type: string description: Отчество example: Иванoвич description: Персональные данные самозанятого example: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван ReceiptAndPayoutList_requisite_inner: required: - payoutId - payoutRequisite - receiptRequisite - selfemployed type: object properties: payoutId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a selfemployed: $ref: '#/components/schemas/ReceiptAndPayoutList_requisite_inner_selfemployed' payoutRequisite: $ref: '#/components/schemas/PayoutRequisite' receiptRequisite: $ref: '#/components/schemas/ReceiptRequisite' example: selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a PayoutRequisite_byAccount: required: - accountNumber - bic - purpose type: object properties: accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" bic: maxLength: 9 minLength: 9 pattern: "^([0-9]{9})$" type: string description: БИК банка получателя example: "044525593" purpose: maxLength: 210 minLength: 1 type: string description: Назначение платежа example: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: maxLength: 70 type: string description: Комментарий к платежу example: Курьерские услуги за период с 1.12.2020-20.12.2020 description: Реквизиты для проведения выплаты на счет получателя example: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" PayoutRequisite_byPan: required: - pan type: object properties: pan: minLength: 1 type: string description: Номер карты получателя в зашифрованном виде example: wS7fElYo8VWeJ8KelaJ0XA== comment: maxLength: 70 type: string description: Назначение платежа example: Курьерские услуги за период с 1.12.2020-20.12.2020 description: Реквизиты для проведения выплаты на карту получателя example: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== PayoutRequisite_byPhone: required: - bankId - phone type: object properties: phone: pattern: "^79\\d{9}$" type: string description: Телефон example: "79130000011" bankId: maxLength: 12 minLength: 12 pattern: "^[0-9]{12}$" type: string description: Идентификатор банка получателя example: "100000000001" comment: maxLength: 70 type: string description: Комментарий к платежу example: Курьерские услуги за период с 1.12.2020-20.12.2020 description: Реквизиты для проведения выплаты по номеру телефона получателя example: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 ReceiptRequisite_services_inner: required: - amount - name - quantity type: object properties: amount: type: string description: Цена услуги example: "10.00" name: maxLength: 256 minLength: 1 type: string description: Наименование услуги для регистрации дохода example: Курьерские услуги за период с 1.12.2020-20.12.2020 quantity: type: integer description: Количество услуг. Согласно текущей спецификации ФНС всегда должно быть равно 1 default: 1 description: Список услуг example: amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 DigestSignatures_inner: required: - base64Encoded - signatureType type: object properties: base64Encoded: type: string description: "Значение электронной подписи, закодированное в Base64" example: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a signatureType: type: string description: | Тип электронной подписи * `RSA` - РСА * `KEP` - КЭП example: rsa enum: - RSA - KEP poaNumber: type: string description: Номер машиночитаемой доверенности example: DOVER_CBR_7702235133_20211102_1 description: Электронная подпись УЛ Клиента example: poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: rsa base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 8658d934-9527-413b-b23c-d87bb1e9824a ReceiptList_requisite_inner: required: - payoutId - receiptRequisite - selfemployed type: object properties: payoutId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a selfemployed: $ref: '#/components/schemas/ReceiptAndPayoutList_requisite_inner_selfemployed' receiptRequisite: $ref: '#/components/schemas/ReceiptRequisite' example: selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a CheckSelfemployedStatusAndPayoutList_company: required: - accountNumber type: object properties: accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" description: Информация о компании example: accountNumber: "40817810306050000000" CheckSelfemployedStatusAndPayoutList_requisite_inner: required: - payoutId - payoutRequisite - selfemployed type: object properties: payoutId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a selfemployed: $ref: '#/components/schemas/ReceiptAndPayoutList_requisite_inner_selfemployed' payoutRequisite: $ref: '#/components/schemas/PayoutRequisite' example: selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a CheckSelfemployedStatusAndPayoutList_receiptRequisite: type: object properties: receiptId: type: string description: Идентификатор чека example: 200wr5cn4s example: receiptId: 200wr5cn4s PayoutList_requisite_inner: required: - payoutId - payoutRequisite - selfemployed type: object properties: payoutId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a selfemployed: $ref: '#/components/schemas/PersonalInformation' payoutRequisite: $ref: '#/components/schemas/PayoutRequisite' example: selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a StatementList_inner_receiptStatus: required: - status - updatedDate type: object properties: status: $ref: '#/components/schemas/ReceiptStatus' updatedDate: type: string description: Дата и время обновления статуса чека в системе format: date-time example: updatedDate: 2000-01-23T04:56:07.000+00:00 status: IN_PROGRESS StatementList_inner_payoutStatus: required: - status - updatedDate type: object properties: status: $ref: '#/components/schemas/PayoutStatus' updatedDate: type: string description: Дата и время обновления статуса выплаты в системе format: date-time example: updatedDate: 2000-01-23T04:56:07.000+00:00 status: READY StatementList_inner: required: - payoutId - payoutStatus - receiptStatus - selfemployed type: object properties: payoutId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a selfemployed: $ref: '#/components/schemas/PersonalInformation' payoutRequisite: $ref: '#/components/schemas/PayoutRequisite' receiptRequisite: $ref: '#/components/schemas/ReceiptRequisite' receiptLink: $ref: '#/components/schemas/ReceiptLink' receiptStatus: $ref: '#/components/schemas/StatementList_inner_receiptStatus' payoutStatus: $ref: '#/components/schemas/StatementList_inner_payoutStatus' errorRecord: minItems: 0 type: array description: Ошибки обработки записей списка items: $ref: '#/components/schemas/ErrorRecord_inner' description: Информация о выплате example: receiptLink: link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptId: 200wr5cn4s selfemployed: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния errorRecord: - field: field message: error_description - field: field message: error_description payoutStatus: updatedDate: 2000-01-23T04:56:07.000+00:00 status: READY payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a receiptStatus: updatedDate: 2000-01-23T04:56:07.000+00:00 status: IN_PROGRESS ErrorRecord_inner: required: - message type: object properties: field: type: string description: Наменование поля в котором возникла ошибка example: field message: type: string description: Описание ошибки example: error_description example: field: field message: error_description CancelReceiptList_cancelReceipt_inner_receipt_inner: required: - cancelReasonCode - receiptId type: object properties: receiptId: type: string description: Идентификатор чека в ФНС cancelReasonCode: $ref: '#/components/schemas/CancelReasonCode' description: Реквизиты аннулируемых чеков example: cancelReasonCode: REFUND receiptId: receiptId CancelReceiptList_cancelReceipt_inner: required: - receipt - vatin type: object properties: vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" receipt: minItems: 1 type: array items: $ref: '#/components/schemas/CancelReceiptList_cancelReceipt_inner_receipt_inner' example: vatin: "112233445566" receipt: - cancelReasonCode: REFUND receiptId: receiptId - cancelReasonCode: REFUND receiptId: receiptId PayoutResponse_payoutsList_inner: type: object properties: payoutId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a requestId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string example: 8658d934-9527-413b-b23c-d87bb1e9824a vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" payerAccountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" createdDate: type: string description: Дата и время создания запроса в системе format: date-time payoutRequisite: $ref: '#/components/schemas/PayoutRequisite' receiptRequisite: $ref: '#/components/schemas/ReceiptRequisite' receiptLink: $ref: '#/components/schemas/ReceiptLink' receiptStatus: $ref: '#/components/schemas/ReceiptStatus' payoutStatus: $ref: '#/components/schemas/PayoutStatus' example: receiptLink: link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptId: 200wr5cn4s payerAccountNumber: "40817810306050000000" vatin: "112233445566" createdDate: 2000-01-23T04:56:07.000+00:00 payoutRequisite: byPhone: bankId: "100000000001" phone: "79130000011" comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutType: ACCOUNT byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810306050000000" bic: "044525593" byPan: comment: Курьерские услуги за период с 1.12.2020-20.12.2020 pan: wS7fElYo8VWeJ8KelaJ0XA== payoutTotalAmount: "10.00" receiptRequisite: receiptTotalAmount: "10.00" customerVatin: "5566778899" incomeType: FROM_FOREIGN_AGENCY requestDate: 2023-01-18T13:36:42.703Z services: - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: "10.00" quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 operateDate: 2023-01-18T13:36:42.703Z customerName: ООО Петуния requestId: 8658d934-9527-413b-b23c-d87bb1e9824a externalId: 8658d934-9527-413b-b23c-d87bb1e9824a payoutStatus: READY payoutId: 8658d934-9527-413b-b23c-d87bb1e9824a receiptStatus: IN_PROGRESS Selfemployed_passport: description: Паспорт oneOf: - $ref: '#/components/schemas/Passport' - $ref: '#/components/schemas/ForeignPassport' DigestSignatures_1_inner: required: - base64Encoded - signatureType type: object properties: base64Encoded: type: string description: "Значение электронной подписи, закодированное в Base64" example: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: pattern: "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})" type: string signatureType: type: string description: | Тип электронной подписи * `RSA` - РСА * `KEP` - КЭП example: RSA enum: - RSA - KEP poaNumber: type: string description: Номер машиночитаемой доверенности example: DOVER_CBR_7702235133_20211102_1 description: Электронная подпись УЛ Клиента example: poaNumber: DOVER_CBR_7702235133_20211102_1 signatureType: RSA base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: certificateUuid SelfemployedAccount_inner: required: - createdDate - selfemployed - status - updatedDate type: object properties: selfemployed: $ref: '#/components/schemas/Selfemployed' status: $ref: '#/components/schemas/SelfEmployedStatus' updatedDate: type: string description: Дата и время обновления статуса самозанятого в системе format: date-time createdDate: type: string description: Дата и время создания записи о самозанятом в системе format: date-time errorRecord: minItems: 0 type: array description: Ошибки обработки записей списка items: $ref: '#/components/schemas/ErrorRecord_1_inner' example: selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02T00:00:00.000+00:00 number: "1234567" dateOfExpiry: 2024-03-02T00:00:00.000+00:00 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02T00:00:00.000+00:00 email: IvanovIvan@mail.ru createdDate: 2000-01-23T04:56:07.000+00:00 errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23T04:56:07.000+00:00 status: null ErrorRecord_1_inner: required: - error_description type: object properties: field: type: string description: Наменование поля в котором возникла ошибка error_description: type: string description: Описание ошибки example: field: field error_description: error_description TaxpayerListStatus_taxpayerStatusList_inner: required: - status - vatin type: object properties: vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" status: type: string description: | Статус самозанятого в ФНС: * `TAXPAYER_BOUND` - НП НПД состоит на учете в налоговом органе в качестве НП НПД и передал права банку * `TAXPAYER_UNBOUND` - НП НПД не привязан к банку-партнеру * `TAXPAYER_UNREGISTERED` - НП НПД не стоит на учете как самозанятый enum: - TAXPAYER_BOUND - TAXPAYER_UNBOUND - TAXPAYER_UNREGISTERED example: vatin: "112233445566" status: TAXPAYER_BOUND AccrualAndDebtListStatus_accrualList_inner_taxChargeList_inner: required: - amount - dueDate - paidAmount - updatedAt type: object properties: amount: type: string description: Сумма начисления example: "10.00" dueDate: type: string description: Срок оплаты format: date example: 2022-03-02 paidAmount: type: string description: Сумма поступивших оплат в ФНС по данному начислению example: "10.00" updatedAt: type: string description: Дата и время получения данных из ФНС format: date-time example: amount: "10.00" dueDate: 2022-03-02T00:00:00.000+00:00 paidAmount: "10.00" updatedAt: 2000-01-23T04:56:07.000+00:00 AccrualAndDebtListStatus_accrualList_inner_krsbList_inner: required: - debt - overpayment - penalty type: object properties: debt: type: number description: Сумма задолженности example: 990 penalty: type: number description: Сумма пени example: 0.1 overpayment: type: number description: Сумма переплаты example: 0 updatedAt: type: string description: Дата и время получения данных из ФНС format: date-time description: Список задолженностей example: penalty: 0.1 overpayment: 0 debt: 990 updatedAt: 2000-01-23T04:56:07.000+00:00 AccrualAndDebtListStatus_accrualList_inner: required: - status - vatin type: object properties: vatin: maxLength: 12 minLength: 12 pattern: "^([0-9]{12})$" type: string description: ИНН самозанятого example: "112233445566" status: type: string description: | Статус получения данных из ФНС по самозанятому: * NEW - Принят для последующей обработки * SUCCESS - Успешно обработан * ERROR - Ошибка в процессе обработки * IN_PROGRESS - В процессе обработки enum: - NEW - SUCCESS - ERROR - IN_PROGRESS ftsError: type: string description: Ошибка ФНС taxChargeList: minItems: 0 type: array description: Список налоговых начислений items: $ref: '#/components/schemas/AccrualAndDebtListStatus_accrualList_inner_taxChargeList_inner' krsbList: minItems: 0 type: array items: $ref: '#/components/schemas/AccrualAndDebtListStatus_accrualList_inner_krsbList_inner' example: vatin: "112233445566" ftsError: ftsError taxChargeList: - amount: "10.00" dueDate: 2022-03-02T00:00:00.000+00:00 paidAmount: "10.00" updatedAt: 2000-01-23T04:56:07.000+00:00 - amount: "10.00" dueDate: 2022-03-02T00:00:00.000+00:00 paidAmount: "10.00" updatedAt: 2000-01-23T04:56:07.000+00:00 krsbList: - penalty: 0.1 overpayment: 0 debt: 990 updatedAt: 2000-01-23T04:56:07.000+00:00 - penalty: 0.1 overpayment: 0 debt: 990 updatedAt: 2000-01-23T04:56:07.000+00:00 status: NEW ReceiptV2_services_inner: type: object properties: amount: type: number description: Цена услуги example: 10.05 name: type: string description: Наименование услуги для регистрации дохода example: Курьерские услуги за период с 1.12.2020-20.12.2020 quantity: type: integer description: Количество example: amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 Activities_inner: required: - id - name type: object properties: id: maxLength: 5 minLength: 1 type: string description: Идентификатор вида деятельности example: "17" name: maxLength: 128 minLength: 1 type: string description: Наименование вида деятельности example: Доставка example: name: Доставка id: "17" Regions_inner: required: - name - oktmo type: object properties: oktmo: maxLength: 8 minLength: 8 type: string description: ОКТМО региона ведения деятельности example: "40000000" name: maxLength: 128 minLength: 1 type: string description: Наименование региона ведения деятельности example: Санкт-Петербург example: oktmo: "40000000" name: Санкт-Петербург SbpBanks_inner: required: - bankId - bankName type: object properties: bankName: type: string example: Газпромбанк bankId: maxLength: 12 minLength: 12 pattern: "^[0-9]{12}$" type: string example: "100000000001" example: bankId: "100000000001" bankName: Газпромбанк GetAccounts_inner: required: - accountNumber - isActive type: object properties: accountNumber: maxLength: 20 minLength: 20 pattern: "^([0-9]{20})$" type: string description: Номер счета example: "40817810306050000000" isActive: type: boolean description: | Признак активности номинального счета: * `true` - Активен; * `false` - Деактивирован. description: Ответ на запрос получения списка номинальных счетов example: accountNumber: "40817810306050000000" isActive: true DigestSignatures_2_inner: required: - base64Encoded - signatureType type: object properties: base64Encoded: type: string description: "Значение электронной подписи, закодированное в Base64" example: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: description: "Идентификатор сертификата, использованного при создании ЭП" allOf: - $ref: '#/components/schemas/UUID_2' signatureType: type: string description: | Тип электронной подписи * `rsa` - РСА * `kep` - КЭП example: rsa enum: - rsa - kep poaNumber: type: string description: Номер машиночитаемой доверенности example: DOVER_CBR_7702235133_20211102_1 description: Электронная подпись УЛ Клиента Report_type: required: - code - title type: object properties: code: type: string description: Код типа документа title: type: string description: Название документа description: type: string description: Описание назначения документа description: Информация о типе справки/выписки example: code: code description: description title: title Report_status: required: - code - title type: object properties: code: type: string description: Идентификатор статуса enum: - NEW - ENQUEUED - ENQUEUED_POST_PROCESS - PENDING - STARTED - FINISHED - REJECTED - LOADED - LOADED_SIGNED - ERROR - REVISION title: type: string description: Описание статуса description: Статус заказанного документа example: code: NEW title: title UserLimit_allOf: required: - countriesRestrictions - created - id type: object properties: id: type: integer created: type: string format: date countriesRestrictions: $ref: '#/components/schemas/CountriesRestrictions' Offices_cardAttributes: required: - anyOfficeUnnamedEnabled - namedCardEnabled - unnamedCardEnabled type: object properties: unnamedCardEnabled: type: boolean description: Признак доступности неименной карты example: true namedCardEnabled: type: boolean description: Признак доступности именной карты example: false anyOfficeUnnamedEnabled: type: boolean description: Признак доступности получения неименной карты в любом офисе example: false description: Атрибуты карты и ее доступности example: namedCardEnabled: false unnamedCardEnabled: true anyOfficeUnnamedEnabled: false GetAccountsResponse_Data: type: object properties: Account: type: array items: $ref: '#/components/schemas/Account_3' example: Account: - accountId: accountId Owner: cityOfBirth: cityOfBirth identification: identification: identification schemeName: RU.CBR.TXID postalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine mobileNumber: mobileNumber name: name countryOfResidence: countryOfResidence birthDate: birthDate Servicer: PostalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine OrganizationIdentification: - identification: identification schemeName: RU.CBR.TXID - identification: identification schemeName: RU.CBR.TXID name: name BankIdentification: - identification: identification schemeName: RU.CBR.BICFI - identification: identification schemeName: RU.CBR.BICFI CorrespondentAccount: identification: identification schemeName: RU.CBR.BBAN accountDescription: accountDescription accountType: null currency: currency status: null AccountDetails: - identification: identification name: name schemeName: RU.CBR.BBAN - identification: identification name: name schemeName: RU.CBR.BBAN - accountId: accountId Owner: cityOfBirth: cityOfBirth identification: identification: identification schemeName: RU.CBR.TXID postalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine mobileNumber: mobileNumber name: name countryOfResidence: countryOfResidence birthDate: birthDate Servicer: PostalAddress: country: country streetName: streetName townName: townName countrySubDivision: countrySubDivision addressType: null buildingNumber: buildingNumber postCode: postCode addressLine: - addressLine - addressLine OrganizationIdentification: - identification: identification schemeName: RU.CBR.TXID - identification: identification schemeName: RU.CBR.TXID name: name BankIdentification: - identification: identification schemeName: RU.CBR.BICFI - identification: identification schemeName: RU.CBR.BICFI CorrespondentAccount: identification: identification schemeName: RU.CBR.BBAN accountDescription: accountDescription accountType: null currency: currency status: null AccountDetails: - identification: identification name: name schemeName: RU.CBR.BBAN - identification: identification name: name schemeName: RU.CBR.BBAN BalanceResponse_1_Data: description: Полезная нагрузка ответа allOf: - $ref: '#/components/schemas/DataBalanceResponse' BalanceResponse_1_Meta: description: Раздел метаданных allOf: - $ref: '#/components/schemas/Meta_1' Balance_Amount: description: Сумма остатка allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_1' OBRUCreditLine_Amount: description: Значение лимита внутридневного кредитования (ВДК) allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_1' TransactionResponse_Data: description: Полезная нагрузка ответа на запрос об операциях по счету allOf: - $ref: '#/components/schemas/DataTransactionResponse' TransactionHistory_Amount: description: Информация о сумме и валюте операции по счету allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_2' TransactionHistory_BankTransactionCode: description: Подробная информация для полной идентификации собственного банковского кода операции по счету example: code: Payments subCode: MerchantCardTransactions allOf: - $ref: '#/components/schemas/BankTransactionCode' TransactionHistory_ChargeAmount: description: Комиссия за операциию по счету example: amount: "2.00" currency: RUB allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_2' TransactionHistory_InstructedAmount: description: "Сумма денег, подлежащая переводу между плательщиком и получате\ лем денежных средств до вычета расходов, выраженная в валюте обозначенной\ \ инициирующей стороной" example: amount: "202.00" currency: RUB allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_2' TransactionHistory_Debtor_PostalAddress: type: object properties: townName: maxLength: 35 minLength: 1 pattern: "^[\\w\\W]{1,35}$" type: string description: "Наименование населённого пункта или территории, находящейс\ я вне границ поселений" example: Бигсити country: pattern: "^[A-Z]{3,3}$" type: string description: Код страны в формате ISO 3166-1 alpha-3 example: RUS additionalProperties: false description: Почтовый адрес TransactionHistory_Debtor: required: - name type: object properties: name: maxLength: 160 minLength: 1 pattern: "^[\\w\\W]{1,160}$" type: string description: Наименование организации или имя физического лица example: Наименование организации или физического лица Identification: maxItems: 12 minItems: 1 type: array description: Идентификация юридического или физического лица. items: $ref: '#/components/schemas/IdentificationType' MerchantInformation: $ref: '#/components/schemas/MerchantInfo' PostalAddress: $ref: '#/components/schemas/TransactionHistory_Debtor_PostalAddress' additionalProperties: false description: Плательщик TransactionHistory_DebtorAccount: description: "Уникальная идентификация счета плательщика, на котором будет с\ делана дебетовая запись в результате операции" example: name: Моя карта schemeName: RU.CBR.PAN identification: '**1234' allOf: - $ref: '#/components/schemas/CashAccount' TransactionHistory_CreditorAccount: description: | Идентификатор счета получателя средств, на котором будет проведена запись о кредите в результате операции. Применение: должен быть указан, если значение параметра `creditDebitIndicator` равно `debit` allOf: - $ref: '#/components/schemas/CashAccount' TransactionHistory_Creditor: required: - name type: object properties: name: maxLength: 160 minLength: 1 pattern: "^[\\w\\W]{1,160}$" type: string description: Наименование организации или имя физического лица example: Наименование организации или физического лица Identification: maxItems: 12 minItems: 1 type: array description: Идентификация юридического или физического лица. items: $ref: '#/components/schemas/IdentificationType' MerchantInformation: $ref: '#/components/schemas/MerchantInfo' PostalAddress: $ref: '#/components/schemas/TransactionHistory_Debtor_PostalAddress' additionalProperties: false description: Получатель денежных средств example: name: Пятерочка Identification: - schemeName: RU.CBR.BBAN identification: "6574836428347453" PostalAddress: townName: Бигсити country: RUS MerchantInformation: merchantId: 19427360OFALLONMO merchantCategoryCode: "1234" TransactionHistory_CardTransaction: description: "Предоставляет данные по карте (номер, платежная система), терм\ иналу (номер, идентификатор) и транзакционные данные, используемые для уни\ кальной идентификации операции по карте Объект `Transaction.CardTransaction`\ \ не должен возвращаться, если нет отсутствует разрешение `ReadPaymentCards`" allOf: - $ref: '#/components/schemas/CardTransaction' TransactionHistory_RemittanceInformation: required: - unstructured type: object properties: unstructured: maxLength: 140 minLength: 1 pattern: "^[\\w\\W]{1,140}$" type: string description: Текстовое назначение платежа example: Назначение платежа - оплата за товары или услуги additionalProperties: false description: "Предоставляемая информация, позволяющая сопоставить запись с п\ озициями, для которых предназначен перевод, такими как коммерческие счета\ \ в системе дебиторской задолженности" CardTransaction_Transaction: description: "Сведения об отдельной операции по карте, записанные на POI-тер\ минале (точке взаимодействия)" allOf: - $ref: '#/components/schemas/CardIndividualTransaction' AccountPaymentCardsResponse_Data_PaymentCard_inner: type: object allOf: - $ref: '#/components/schemas/AccountPaymentCardsData' AccountPaymentCardsResponse_Data: type: object properties: PaymentCard: maxItems: 50 minItems: 0 type: array items: $ref: '#/components/schemas/AccountPaymentCardsResponse_Data_PaymentCard_inner' description: Раздел данных example: PaymentCard: - null - null - null - null - null PhonePaymentReport_orderInfo: type: object properties: number: type: string description: Номер платежного поручения date: type: string description: Дата платежного поручения format: date-time recipientAccount: type: string description: расчетный счет ФЛ в банке-получателе recipientBic: type: string description: БИК банка-получателя example: date: 2000-01-23T04:56:07.000+00:00 number: number recipientAccount: recipientAccount recipientBic: recipientBic CardInfoRequest_embossedText: required: - firstName - lastName type: object properties: firstName: type: string description: Эмбоссированнное имя lastName: type: string description: Эмбоссированнная фамилия salutation: type: string description: Эмбоссированнное обращение example: firstName: firstName lastName: lastName salutation: salutation CreatePayrollApplicationResponse_originalMessage: required: - createdAt - id - status type: object properties: id: type: string description: Уникальный id исходного сообщения с ведомостью createdAt: type: string description: Дата и время формирования исходного сообщения с ведомостью4 format: date-time status: type: string description: Статус исходного сообщения reason: type: string description: Описание причины присвоения статуса сообщения example: createdAt: 2000-01-23T04:56:07.000+00:00 reason: reason id: id status: status CreatePayrollApplicationResponse_payroll_accrual: required: - id - status - updatedAt type: object properties: id: type: string description: Номер начисления в ведомости updatedAt: type: string description: Дата и время присвоения статуса format: date-time status: type: string description: Статус начисления reason: type: string description: Описание кода причины присвоения статуса начисления example: reason: reason id: id updatedAt: 2000-01-23T04:56:07.000+00:00 status: status CreatePayrollApplicationResponse_payroll: required: - id - status type: object properties: id: type: string description: Идентификатор исходного пакета с ведомостью status: type: string description: Статус исходного пакета с ведомостью reason: type: string description: Описание причины присвоения статуса пакета с ведомостью accrual: $ref: '#/components/schemas/CreatePayrollApplicationResponse_payroll_accrual' example: reason: reason id: id accrual: reason: reason id: id updatedAt: 2000-01-23T04:56:07.000+00:00 status: status status: status GetPayrollApplicationResponse_payroll_accrual: required: - id - status type: object properties: id: type: string description: Номер начисления в ведомости updatedAt: type: string description: Дата и время присвоения статуса format: date-time status: type: string description: Статус начисления reason: type: string description: Описание кода причины присвоения статуса начисления example: reason: reason id: id updatedAt: 2000-01-23T04:56:07.000+00:00 status: status GetPayrollApplicationResponse_payroll: required: - id - status type: object properties: id: type: string description: Идентификатор исходного пакета с ведомостью status: type: string description: Статус исходного пакета с ведомостью reason: type: string description: Описание причины присвоения статуса пакета с ведомостью accrual: $ref: '#/components/schemas/GetPayrollApplicationResponse_payroll_accrual' example: reason: reason id: id accrual: reason: reason id: id updatedAt: 2000-01-23T04:56:07.000+00:00 status: status status: status ResponseCertificates_inner: required: - algorithm - beginDateTime - clientId - expireDateTime - fingerprint - id - ownerName - serialNumber - type type: object properties: id: type: string example: 9610bc6b-f06b-41b6-bae9-6bb5b06a54dd clientId: type: string example: 4aa56f35-abb1-4ebe-9697-389cca4a4475 ownerName: type: string example: Иванов Иван Иванович fingerprint: type: string example: 333773d77ef05aa9f7b7bae8e2779418b2aedb6a organizationName: type: string nullable: true example: ООО 'Ромашка' beginDateTime: type: string format: date-time example: 2023-07-28T15:11:14Z expireDateTime: type: string format: date-time example: 2025-06-19T11:48:06Z status: type: string example: ACTIVE enum: - ACTIVE - REVOKED - DELETED certificateBody: type: string example: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= type: type: string example: ENCRYPTION enum: - ENCRYPTION - SIGNATURE - TLS algorithm: type: string example: RS256 enum: - RS256 - GOST serialNumber: type: string example: "2163173489423972678179275487230070851350268586" example: expireDateTime: 2025-06-19T11:48:06Z clientId: 4aa56f35-abb1-4ebe-9697-389cca4a4475 serialNumber: "2163173489423972678179275487230070851350268586" ownerName: Иванов Иван Иванович organizationName: ООО 'Ромашка' fingerprint: 333773d77ef05aa9f7b7bae8e2779418b2aedb6a id: 9610bc6b-f06b-41b6-bae9-6bb5b06a54dd beginDateTime: 2023-07-28T15:11:14Z type: ENCRYPTION status: ACTIVE certificateBody: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= algorithm: RS256 CreateIndividualRequest_city: required: - cityId - presenceCityTitle - regionId type: object properties: cityId: type: integer description: Идентификатор города. regionId: type: integer description: Идентификатор региона. presenceCityTitle: type: string description: Отображаемое наименование города присутствия. description: Город присутствия банка и регион регистрации. example: regionId: 6 cityId: 0 presenceCityTitle: presenceCityTitle IndividualLead_city: required: - cityId - presenceCityTitle - regionId type: object properties: cityId: type: integer example: 1 regionId: type: integer example: 77 presenceCityTitle: type: string example: Москва example: regionId: 77 cityId: 1 presenceCityTitle: Москва ComplianceScoreResponse_boundaries: type: object properties: low: type: number description: Граница между низким и средним уровнем риска format: float example: 0.32 high: type: number description: Граница между средним и высоким уровнем риска format: float example: 0.65 example: high: 0.65 low: 0.32 responses: "200GetAccounts": description: "Полный список счетов (с идентификаторами accountId), которые б\ ыли авторизованы Пользователем на стороне ППИУ" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/AccountResponse' "400Error-req": description: "Запрос имеет неверное, отсутствующее или несовместимое тело JSON,\ \ параметры URL или поля заголовка" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "400" id: 4aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: "Обязательное поле, необходимое для API, отсутствует в поле\ зной нагрузке" path: Data.Model.Object.filled url: https://example.com/error-description "401Error-req": description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required "403Error-req": description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "403" id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description "405Error-req": description: "Сторонний Поставщик пытается получить доступ к ресурсу с помощ\ ью метода, который не поддерживается" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "406Error-req": description: "Запрос содержал параметр заголовка Accept, отличный от разреше\ нных media types, и набор символов, отличный от UTF-8" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid "429Error-req": description: "Операция была отклонена, так как слишком много запросов было с\ делано в течение определенного периода времени" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid Retry-After: schema: type: string "500Error-req": description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "500" id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг path: Data.Model.Object.filled url: https://example.com/error-description "501Error-req": description: "Сторонний поставщик не поддерживает функции, необходимые для в\ ыполнения запроса" headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "501" id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Данный код ошибки можно использовать при возникновении непредвиденной ошибки path: Data.Model.Object.filled url: https://example.com/error-description "503Error-req": description: Сервис временно не доступен headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: "503" id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен path: Data.Model.Object.filled url: https://example.com/error-description "200GetAccountsaccountIdStatementsStatementId": description: Ответ получения выписки по идентификатору выписки headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid content: application/json: schema: $ref: '#/components/schemas/StatementResponse' "201PostStatementInitResponse": description: Индентификатор выписки headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора коррел\ яции. Если необходимо, то Сторонний поставщик передает обратно значени\ е идентификатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string format: uuid x-jws-signature: description: Отделяемая подпись полезной нагрузки в формате JWS required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementInitResponse' example: Data: Statement: statementId: this-is-a-slug-format-statement-id accountId: this-is-a-slug-format-account-id fromBookingDateTime: 2019-09-15T00:00:00+00:00 toBookingDateTime: 2019-12-15T00:00:00+00:00 Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 "404Error-req": description: Endpoint is not found or not active headers: x-fapi-interaction-id: $ref: '#/components/headers/x-fapi-interaction-id' content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse_1' example: code: "404" message: Not found Errors: - errorCode: RU.CBR.Resource.NotFound message: Endpoint is not found or not active parameters: x-fapi-interaction-id: name: x-fapi-interaction-id in: header description: "RFC4122 UID, используемый в качестве идентификатора корреляции\ . Если необходимо, то Сторонний поставщик передает обратно значение иденти\ фикатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в со\ ответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID) URN Namespace\"\ ." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d page: name: page in: query description: Номер страницы required: false schema: maximum: 5000 minimum: 1 type: integer format: int32 default: 1 x-fapi-auth-date: name: x-fapi-auth-date in: header description: "Время последнего входа Пользователя в систему с TPP. Значение\ \ предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Напри\ мер, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT" required: false schema: maxLength: 29 minLength: 1 pattern: "^[a-zA-Z0-9 :,]{29}$" type: string example: "Mon, 26 Aug 2019 12:23:11 GMT" x-fapi-customer-ip-address: name: x-fapi-customer-ip-address in: header description: "IP-адрес Пользователя, если Пользователь в данный момент подкл\ ючен к Стороннему Поставщику (авторизован в приложении Стороннего Поставщи\ ка)." required: false schema: maxLength: 21 minLength: 0 pattern: "^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\\d{1,3}\\.){3}\\d{1,3}$" type: string example: 172.123.123.123 x-customer-user-agent: name: x-customer-user-agent in: header description: "В заголовке указывается тип устройства (user-agent), который и\ спользует Пользователь. Сторонний Поставщик может заполнить это поле значе\ нием типа устройства (user-agent), указанным Пользователем. Если Пользоват\ ель использует мобильное приложение Стороннего Поставщика, Сторонний Поста\ вщик проверяет, что строка типа устройства (user-agent) отличается от стро\ ки типа устройства (user-agent) на основе браузера." required: false schema: type: string example: mobile accountId: name: accountId in: path description: Идентификатор счета required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: this-is-a-slug-format-account-id fromBookingDateTime: name: fromBookingDateTime in: query description: Дата и время начала фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 toBookingDateTime: name: toBookingDateTime in: query description: Дата и время окончания фильтрации списка операций по счету required: false schema: type: string description: Формат даты и времени format: date-time-string example: 2021-06-05T15:15:13+00:00 x-idempotency-key: name: x-idempotency-key in: header description: Уникальный идентификатор запроса для поддержки идемпотентности. Обязательно для запросов POST к конечным точкам идемпотентного ресурса. Для других запросов не указывается. required: true schema: type: string format: uuid x-jws-signature: name: x-jws-signature in: header description: Отделяемая подпись полезной нагрузки в формате JWS required: true schema: type: string statementId: name: statementId in: path description: Идентификатор выписки required: true schema: maxLength: 40 minLength: 1 pattern: "^[a-zA-Z0-9-]{1,40}$" type: string example: 9b23e27e-f4f8-4cab-9b80-aaa008d4330c accountNumber: name: accountNumber in: path description: Номер счета required: true schema: type: string cardFilter: name: cardFilter in: query description: Фильтр карт required: false cardId: name: cardId in: path description: Идентификатор пластиковой карты required: true schema: type: string DateFrom: name: dateFrom in: query description: Дата начала запроса истории операций (включительно) required: false schema: type: string format: date DateTo: name: dateTo in: query description: Дата окончания запроса истории операций (включительно) required: false schema: type: string format: date Accounts: name: accounts in: query description: Массив номеров счетов для выборки истории операций required: false schema: type: array items: type: string description: Номер счёта Cards: name: cards in: query description: Массив идентификаторов пластиковых карт для выборки истории операций required: false schema: type: array items: type: string description: Идентификатор пластиковой карты OperationDirection: name: operationDirection in: query description: "Направление движения денежных средств: INCOME - приход/пополне\ ние, EXPENSE - расход/списание" required: false schema: type: string enum: - EXPENSE - INCOME Offset: name: offset in: query description: Параметр пагинации - Смещение от начала required: false schema: type: integer Limit: name: limit in: query description: Параметр пагинации - Запрашиваемое кол-во элементов на странице required: false schema: type: integer operationId: name: id in: path description: Идентификатор операции required: true schema: type: string limitId: name: limitId in: path description: Идентификатор пользовательского лимита required: true schema: type: integer formId: name: formId in: path description: Идентификатор заявки required: true schema: type: string example: 55A42D1698400C9EE0543863BB4C2866 phase: name: phase in: query description: Этап процесса оформления заявки required: true schema: $ref: '#/components/schemas/PhaseId' accuracy: name: accuracy in: query description: Точность определения координат required: true schema: type: integer example: 5 address: name: address in: query description: "Адрес, в радиусе которого ведется поиск" required: true schema: type: string example: "г. Москва, ул. Анохина, д. 9" kladrId: name: kladrId in: query description: КЛАДР города доставки required: true schema: type: string example: "7700000000000" latitude: name: latitude in: query description: Широта required: true schema: type: number example: 55.659348 longitude: name: longitude in: query description: Долгота required: true schema: type: number example: 37.472997 radius: name: radius in: query description: "Радиус поиска относительно указанных координат, м." required: false schema: type: number example: 3000 isUnnamed: name: isUnnamed in: query description: Признак неименной/именной карты required: true schema: type: boolean example: true cityId: name: cityId in: query description: Код города доставки required: true schema: type: string example: "21" b2bClientId: name: b2bClientId in: query description: "Идентификатор клиента, от имени которого выполняется запрос" required: true schema: type: string format: uuid example: 021be5ed-6312-4982-a4e9-2a2cc44bc88c qrcId: name: qrcId in: query description: Идентификатор платежной ссылки required: false schema: maxLength: 32 minLength: 1 type: string example: AO1000670LSS7DN18SJQDNP4B05KLJL2 limit: name: limit in: query description: Количество элементов required: false schema: maximum: 100 minimum: 1 type: integer example: 10 offset: name: offset in: query description: Смещение в результатах поиска required: false schema: minimum: 0 type: integer example: 0 merchantId: name: merchantId in: path required: true schema: type: string example: MF0000000001 authToken: name: Authorization-1C in: header description: Basic auth логин и пароль клиента в формате base64(login:password) required: true schema: type: string example: Basic NWUfYlNaUkR6dUpGc3JtGTtULkJVOk3eNmlwTWRLdk8yUg== qrId: name: qrId in: path required: true schema: type: string example: EX2E009997EAL2DG8VFAEN07M1VH92DW b2cClientId: name: b2cClientId in: query description: "Идентификатор клиента, от имени которого интегратором отправля\ ется платеж" schema: type: string partnerId: name: partnerId in: query description: Идентификатор партнера required: true schema: type: integer format: int64 startDate: name: startDate in: query description: Дата начала периода schema: type: string format: date-time finishDate: name: finishDate in: query description: Дата окончания периода schema: type: string format: date-time transactionId: name: transactionId in: query description: Идентификатор транзакции schema: type: string packageId: name: packageId in: path description: Идентификатор пакета платежей required: true schema: type: integer format: int64 checkId: name: checkId in: path description: Идентификатор асинхронного запроса на проверку возможности платежа required: true schema: type: string inn: name: inn in: query description: ИНН ЮЛ required: true schema: type: string active: name: active in: query description: Признак возврата активных подписок required: false schema: type: boolean default: true example: true sort: name: sort in: query description: "Порядок сортировки в формате <имя_поля,asc|desc>. Допустимо ук\ азать несколько значений" required: false schema: type: array items: type: string example: - "dfaName,desc" customerType: name: customerType in: query description: | Тип инвестора. Возможные значения: * `PERSON` - физическое лицо; * `COMPANY` - юридическое лицо required: false schema: type: string example: PERSON dfaName: name: dfaName in: query description: Параметр фильтрации по наименованию ЦФА required: false schema: type: string example: NRD-DT-080324-0100 dfaRedemptionDate: name: dfaRedemptionDate in: query description: Параметр фильтрации по дате погашения ЦФА required: false schema: type: string format: date example: 2024-04-30 dfaParValue: name: dfaParValue in: query description: Параметр фильтрации по стоимости ЦФА required: false schema: type: integer format: int64 example: 100000 dfaType: name: dfaType in: query description: Параметр фильтрации по типу ЦФА required: false schema: type: string example: MONEY_CLAIM dfaRateAmount: name: dfaRateAmount in: query description: Параметр фильтрации по процентной ставке ЦФА required: false schema: type: string example: "1" companyIssuerName: name: companyIssuerName in: query description: Параметр фильтрации по наименованию эмитента required: false schema: type: string example: Акционерное общество "Альфа банк" claimId: name: claimId in: path description: Идентификатор обращения в Банке required: true schema: type: string example: A2504090003 orderId: name: orderId in: path description: Идентификатор заказа в банке required: true schema: type: string example: s-5555 FromDate: name: fromDate in: query description: Начало интервала (ISO 8601 с миллисекундами и Z) required: false schema: pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" type: string format: date-time example: 2025-08-01T00:00:00.001Z ToDate: name: toDate in: query description: Конец интервала (ISO 8601 с миллисекундами и Z) required: false schema: pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" type: string format: date-time example: 2025-08-31T23:59:59.999Z Sort: name: sort in: query description: "Сортировка по полю и направлению. Формат: поле,направление. До\ ступные поля: createdAt, updatedAt. Доступные направления: asc (по возраст\ анию), desc (по убыванию)." required: false schema: pattern: "^(createdAt|updatedAt),(asc|desc)$" type: string example: "createdAt,asc" individualId: name: individualId in: path required: true schema: type: string llcId: name: llcId in: path required: true schema: type: string month: name: month in: query description: Отчётный месяц (ISO 8601). Не старше 6 месяцев от текущей даты. required: true style: form explode: false schema: $ref: '#/components/schemas/MonthPeriod' example: 2025-08-01T00:00:00.000Z productCode: name: productCode in: query description: Код продукта. Допускается передача только одного значения. required: true style: form explode: false schema: type: string example: DEBIT_CARD examples: getCustomerInfo: summary: Пример ответа value: ogrn: "1020203094163" organizationForm: code: "12300" fullName: Общество с ограниченной ответственностью shortName: ООО type: "2014" address: area: Тахтамукайский район settlementType: г. zip: "385600" country: "643" fiasCode: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 city: Майкоп house: "3" building: "1" settlement: Майкоп flat: "123" street: улица Депутатская fullAddress: "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3" region: Республика Адыгея inn: "114693784" fullName: Общество с ограниченной ответственностью "Ромашка" type: LEGAL okpo: "41294456" organizationId: bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732 phone: "79099876543" okved: "71.12" registrationDate: 2000-01-23T04:56:07.000+00:00 kpps: - "2427920" - "2427920" accounts: - specConditions: - code: AI17 description: Счёт заблокирован value: true - code: AI17 description: Счёт заблокирован value: true clientName: Наименование typeName: Расчётный счёт type: PAYMENT amountOverdraftOwnFunds: 0.8008281904610115 amountOverdraftLimit: 100000 amountBalance: 810000 amountHolds: 100 number: "40702810002300001935" blockedSums: - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" bank: bic: "044525593" transitAccountNumber: "40702978904100000001" amountTotal: 100000 openDate: 2021-10-07 currencyCode: "810" - specConditions: - code: AI17 description: Счёт заблокирован value: true - code: AI17 description: Счёт заблокирован value: true clientName: Наименование typeName: Расчётный счёт type: PAYMENT amountOverdraftOwnFunds: 0.8008281904610115 amountOverdraftLimit: 100000 amountBalance: 810000 amountHolds: 100 number: "40702810002300001935" blockedSums: - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" - beginDate: 2020-10-23 num: "112233" initiator: Межрайонная ИФНС России № 51 по г. Москве blockType: PARTIAL_BALANCE_BLOCK cause: "Неисполнение требования об уплате налога, сбора, пени, штрафа\ \ № 53228 от 05.11.2019 г" sum: "988800" bank: bic: "044525593" transitAccountNumber: "40702978904100000001" amountTotal: 100000 openDate: 2021-10-07 currencyCode: "810" shortName: ООО "Ромашка" category: BANK email: client@example.com status: ACTIVE Response: summary: Пример ответа value: | 100 0 10 40702810102300000001 044525593 30101810200000000593 АО "АЛЬФА-БАНК" г Москва 1000.00 2022-06-27T00:00:00.000 2022-06-27T23:59:59.999 1000.00 2022-06-27 1 18810630012040000120 17.02.2022 0 01 45348000 0 17.02.2022 18810192111439342569 2022-06-27 24 03100643000000019500 024501901 40102810045370000002 ОПЕРАЦИОННЫЙ ДЕПАРТАМЕНТ БАНКА РОССИИ//Межрегиональное операционное УФК г Москва 1901108410 191043001 УГИБДД ГУ МВД России по г. Москве 40702810102300000001 044525593 30101810200000000593 АО "АЛЬФА-БАНК" г Москва 0665413230 011206020 Общество с ограниченной ответственностью "Ромашка" почтой 5 Штраф ГИБДД 10.00 01 044525593 30101810200000000593 АО "АЛЬФА-БАНК" г Москва 02 Исполнен 044525593 30101810200000000593 АО "АЛЬФА-БАНК" г Москва 0 80.00 80.00 ResponseSigned: summary: Пример подписанного ответа value: "\n\n\t\n\t\t100\n\ \t\t0\n\t\t10\n\t\n\ \t\n\t\t\n\t\t\t40702810102300000001\n\ \t\t\t\n\t\t\t\t044525593\n\t\t\t\t30101810200000000593\n\ \t\t\t\tАО \"АЛЬФА-БАНК\" г Москва\n\t\t\t\n\t\t\t1000.00\n\ \t\t\t2022-06-27T00:00:00.000\n\t\t\t2022-06-27T23:59:59.999\n\ \t\t\t1000.00\n\t\t\t\n\t\t\ \t\t2022-06-27\n\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\ \t\t\t\t\t\t\t18810630012040000120\n\t\t\t\t\t\t\t17.02.2022\n\ \t\t\t\t\t\t\t0\n\t\t\t\t\t\t\t01\n\ \t\t\t\t\t\t\t45348000\n\t\t\t\t\t\t\t0\n\t\ \t\t\t\t\t\t17.02.2022\n\t\t\t\t\t\t\n\ \t\t\t\t\t\t18810192111439342569\n\t\t\t\t\t\t2022-06-27\n\ \t\t\t\t\t\t24\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t03100643000000019500\n\ \t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t024501901\n\t\t\t\t\t\t\t\ \t40102810045370000002\n\t\t\t\t\t\t\t\tОПЕ\ РАЦИОННЫЙ ДЕПАРТАМЕНТ БАНКА РОССИИ//Межрегиональное операционное УФК г Мос\ ква\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t1901108410\n\t\ \t\t\t\t\t\t191043001\n\t\t\t\t\t\t\tУГИБДД ГУ МВД России\ \ по г. Москве\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\ \t\t\t40702810102300000001\n\t\t\t\t\t\t\t\n\t\t\t\ \t\t\t\t\t044525593\n\t\t\t\t\t\t\t\t30101810200000000593\n\ \t\t\t\t\t\t\t\tАО \"АЛЬФА-БАНК\" г Москва\n\t\t\t\t\t\t\t\n\ \t\t\t\t\t\t\t0665413230\n\t\t\t\t\t\t\t011206020\n\t\ \t\t\t\t\t\tОбщество с ограниченной ответственностью \"Ромашка\"\n\ \t\t\t\t\t\t\n\t\t\t\t\t\tпочтой\n\t\t\t\ \t\t\t5\n\t\t\t\t\t\tШтраф ГИБДД\n\ \t\t\t\t\t\t10.00\n\t\t\t\t\t\t01\n\ \t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t044525593\n\ \t\t\t\t\t30101810200000000593\n\t\t\t\t\tА\ О \"АЛЬФА-БАНК\" г Москва\n\t\t\t\t\t\n\t\t\t\t\t\t02\n\ \t\t\t\t\t\tИсполнен\n\t\t\t\t\t\n\t\t\t\t\n\ \t\t\t\n\t\t\t\n\t\t\t\t044525593\n\t\t\t\ \t30101810200000000593\n\t\t\t\tАО \"АЛЬФА\ -БАНК\" г Москва\n\t\t\t\n\t\t\t0\n\ \t\t\t80.00\n\t\t\t80.00\n\ \t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\ \t\t\n\t\t\t\n\t\t\t\t\n\ \t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\ \tlGkg53OXMheb7EkknHQaiQCZCW8+Z9yhldjGj+3FcLa4HzAuzFzWMw8EYiLa2cGd\n\ \t\t\t\n\t\t\n\t\tZglywuWbdNiPFnRkoj4wMkZbQwDtP/8HRZUWjINtGD+5Yiiab68o/ChvQG8z0v6O6upwmxUIgODa&#13;\n\ \ ptKAzwmJR5g0ScbarcOTrIV3FjEkkOMQeg5H4ntCdQGDq8VxyxfCHtFFEMJ0/3TMzCzq330+voyL&#13;\n\ \ KPKN4w3gyRn6H0rlNwbKXTYn2uJ5bNc1jTfhc+24GgqgDmFToej0POr3YwdnqFwL8RV/h3T83Buc&#13;\n\ \ iBXoCxdhmJ5xGeEu6KTwERP2RQR3trBIOcRJU+wM/KqOWFnrREFHA5iw59xDG16AYp9F5LeE/9On&#13;\n\ \ qpVSRZmksU3XZyoU+f25lZy4TiczYJHfLsLbbQ==\n \n\ \t\t\n\t\t\t\n\t\t\t\tMIIGMzCCBBugAwIBAgIIQ+Ua6h49X/kwDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAlJVMQ8w&#13;\n\ \ DQYDVQQIEwZNb3Njb3cxDzANBgNVBAcTBk1vc2NvdzEWMBQGA1UEChMNSlNDIEFsZmEtQmFuazEl&#13;\n\ \ MCMGA1UECxMcRGlnaXRhbCBTZXJ2aWNlcyBEZXZlbG9wbWVudDEeMBwGA1UEAxMVQWxmYVRydXN0&#13;\n\ \ Q29yZSBDQSBSb290MS0wKwYJKoZIhvcNAQkBFh50cnVzdGNvcmVfc3VwcG9ydEBhbGZhLmJhbmsu&#13;\n\ \ cnUwHhcNMjQwNTI3MTMzNTAwWhcNMjkwNTI3MTMzNTAwWjCByTELMAkGA1UEBhMCUlUxDzANBgNV&#13;\n\ \ BAgTBk1vc2NvdzEPMA0GA1UEBxMGTW9zY293MRYwFAYDVQQKEw1KU0MgQWxmYS1CYW5rMSUwIwYD&#13;\n\ \ VQQLExxEaWdpdGFsIFNlcnZpY2VzIERldmVsb3BtZW50MSswKQYDVQQDEyJURVNUIFRydXN0Q29y&#13;\n\ \ ZVJTQSBTaWduZXIyIDIwNDggYml0MSwwKgYJKoZIhvcNAQkBFh10cnVzdGNvcmVfc3VwcG9ydEBh&#13;\n\ \ bGZhYmFuay5ydTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALbaUlic4XF47DJtoFQK&#13;\n\ \ Nnd46jvaoE9pyxByuEKQkZY8Na5XWNuyr5ZALF6RTYXRS+i2wqig+zsGhEKG5rM2VZFJB4p6Vvwb&#13;\n\ \ ULzDeH08tEw01hvnIiUFxrlVlpMIM649rLaMUTZnh8RKq23WkvDxPaEEeLV0f0sgeHpBf2nV7ZeM&#13;\n\ \ 4w6LdC2T/hnYAy7VxIS+BN2nDGOIePqh+lGgUZIHY9cO3IbN7yWSQQSC7hQ696RC9L5vWedOXb6C&#13;\n\ \ myWlFsuOnAgp+O3z2U1wbovCQ48CU8VprzjLorw/UTz/qJr7uGGICuY7M1Go7qLvICsHclkKqvRc&#13;\n\ \ CMLBGxdg6RBkA+6t96cCAwEAAaOCAScwggEjMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFFp1la5Q&#13;\n\ \ GzpdMD7SCyadt9CVfElrMAsGA1UdDwQEAwID+DAdBgNVHSUEFjAUBggrBgEFBQcDAwYIKwYBBQUH&#13;\n\ \ AwQwgccGA1UdHwSBvzCBvDA8oDqgOIY2aHR0cDovL2FydGFwcC9hcnRpZmFjdG9yeS9UcnVzdENv&#13;\n\ \ cmUvQ1JMcy90cnVzdGNvcmUuY3JsMDqgOKA2hjRodHRwOi8vaGF2ZW4ubW9zY293LmFsZmFpbnRy&#13;\n\ \ YS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMECgPqA8hjpodHRwOi8vczAxZHBydXByYnMubW9zY293&#13;\n\ \ LmFsZmFpbnRyYS5uZXQ6ODA4MC90cnVzdGNvcmUuY3JsMA0GCSqGSIb3DQEBCwUAA4ICAQARCvm8&#13;\n\ \ JwBOGonGKMlnwyxnFX2aV1qIkzMgo7ILaCXT/MybvPH/3GQByBOUsASFU7cod57qEOOyQSN/JTQ/&#13;\n\ \ ZdKz3B8goGoO1XC/toybaTib92Dru7XyiJAeOLHksDjMQ7U6Xgk/51xoPa6AvZyOUWNW0KUdQFWl&#13;\n\ \ fyJeH+Gt4Xr1OH+LYuUMhiVubUPn+edW/PW8WTzlpjvd55/e69YViSJBuNenV0cmxKe/xWD7ZnfG&#13;\n\ \ fBsf+Sy/xhfjP0nFd7qANeQJXmb07gl7zJUyV0oK7fXyHO7Rg2wVcWEr8p9uS/sTS0ZnXJZKN3/O&#13;\n\ \ O+zp9UPM23uzZNuySsBbc7QNlJ3c8GLL/R93xvE3BNV+DtZVbu7xaqcWZmFEnfp0iTVCfMC3d9Ci&#13;\n\ \ g+KZ5NKBQp+vB0A4+vj8jO/ZCCjtho3nqeJ+exO2AHgLYj6XaeCTed4fW0ENt0XWNrFaVW/wRyHO&#13;\n\ \ XvEN8Ocj8LV5Xtwh6xPuwSbas2VL4v7V50O7V5RA4ZucdpdmRj5z/qkqkirGRcWnf+UWwjniI+Bz&#13;\n\ \ CGlsPjGJmGgl8OjGUnb/vZ4fN1g2QVBcS1riln0mQDPbaBJNtFOSc3GCh+HttX075tinnux348Yg&#13;\n\ \ qsHeKfsVZ6+5gmrumdaS8uN/L/cgFtPJFfwpbz5YGq98owU8BVlodP1eM8C5eEPU1X0BGQ==\n\ \ \n\t\t\t\n\t\t\n\t\ \n\n" ResponseSignedEncrypted: summary: Пример подписанного и зашифрованного ответа value: | YsMGdo6pSe1obzC5DCwW51kSok0LsJ0lIM45IcJ0AGPxJg/HdHqBIsf5i0udVnNzALbileuwBoAWwcwiU4iCo2xwDrYaU88Csz3s1wnomqaoQ/h9LLHbTzuZjBm4Uo58nDVbuZ242PZ8T4M4M4I22zmDM6YLW0DgTLpR4QXoq7H+gdSBbc8nQ0Bobca2/z1IBcTPmdobrouyWct4cJ/2H+tbN0873PpOWB0+SQdTZ9/swh/4Pk4OEQmvdxMlccg/ZOrvF+chJxtpdiUFucGdqIgko3YO9FJnCxJY/ycAT90w2ogJqgSaOZTb1yQyfSVQV2oZGDaE8ivc58UwGtfARmnA1rmaFY9SWahbwDE+IhZ77Y/6ymITgkutLpKNlyJfr0phMp6GTUfPwv9HjxmFnvCLuv2Ucc04/gYBx/PvrAwjOxxKUAFOsniWxWw/3eoE5dNBqPI9eya376nUnU09LX7rN5BGpNqKu9UX2Q0br5ee0voKBd/ZFnYbKUJc+1o0DHjW44z+G+HAlvmAQw3c/PqDjX59z1KnBphF/WcyeFGdX8fniEwt3EIEGDYgkKGBSPbpE+Xm42M/t85070xJpReUQtPvfLHA+1DcxLA7RtX0CVfas3GhoHfMLbNCs9q5klxDJD+9v3dk1SbIY+JqAb/JDRAUB9rV9jqTOEMpwNz4jYOeQUm+bxGHZ+AS4ce1U303tKXUnUWlNN8+U8G29mxbIw0JM7mgwDkzvPWGpoEEFGDGcWuYEXEJx/EM5VnPf8xy5SmG5wQISd7CX2KTYic1kda/eBq9Akk4X5Y6GWImqP6pJMG9XIgaqj9Uf7UbZBUMqxwnEIxLXSp3KPOSUlOiHeEOTttbTgbDN4PK/VPGLoHOgLRmHvzy0xQQZhjbu6PZgCp/WK2w0T95w0uh8lU7GxWCAkHZRREftlYtSdaHglQPzsmNybu566+KTklKzdwhWl2tetboM6CY9lKLRfKbqgwZ0ggFPM/2K1xNYJRWdkzkED4UN40UVZ7SwB0RcoJNxmPB/xlOFyOXTLEhmbdB5W63NQT0l3+YIxuISfblcKba4zvsp6YcAP9q0mTtAHU06VFUg9PRGXonTyHTtknh95WBEJdjcqyvc78Mkq3rYPxYdKPuTaVXE6hLKk7+xuOzb4ty3kkSaJiM57X/YBgx1eRo5uwBtK65iCl4BPaqgEmlZQmqWwgZyC4bcOqaeSCIxikc50ymbQlMMek5jaJ9AseGvYNU89NB7OHVaG2xqRd6NOKsGTqJHLXSZwGVlV+elzlu0mava9V1Qy6x/pGDHI0oatAMLxEuNmrOmCYViIuP9eOrM7qf30AYdtMylzJJLvwfN3T94pPBFP1qtwiNq37j/LnZRvpIJc15QpEtby4exAjHxl6pEbCsslfLdXkEvM2Rwc1Ax8w9o2Nf4U1/OSkqyJ2cnmMOlJT6UUL3r8yEMbg/SQDvvJnB1Dpt8I0k4KHZmM16YmpjyClkXZUTQZWHjkhBew+qyONQqJQQGze5+FxDW0y1NJ9zi0MJ4RoLKkyeorpFmAVm1NrzkmMDWm+l+qucg4XHchrC/SoWDEgJDb8tORJfX3vlKiouaeiIw0Y1qmuhUDw0UuQBQFZURR64eTAhiWnbwhrfprOxSV/tbxlo8YtLglnZqvNKpRbL0zzszvfbPHRUF9s1wT7PXCawUA0I1jb4jQNDb/VbF1ymu4ZlrfNPWDmDitkHeHvPWwk8K//WCW6f6yben/9BTvRjwxCAXT+EiktCIAXLAbI3ZD4gkw8e/cLd9WXRTHsW0hVUVOiVFdQicfT6RWpRv+eqYnDrdAPM5beHLuyxgE6/PTnS+mi8KMLEu6z+Ton6aJg2xYnhIbVREqF3wAYS2gxD6Ijg+rqy1JMGtUrZa++a2+HyD5t0bE26DMNjDj4Z1l2FVp2VXN7SWvJs4eG6q7AdZUs8FChDWry544llCOHPUXyYJ65/e6ZEBm18A7iV+/UAH3fJ88kOqWMxrqlr2lKflK0khU8YQTJOa1emcczFZAB7VHuvqjqtbfoKHsKEfuzKAr1Wggq4/hglMRkstcFtaxTWgheJdMkgIn53EedxW9mD+AZf2F4xg5Q9VpnApPfP3Isn2muQ4KpT5xIJE/oLCozqN4/pL46WanyuP5ogrg7AE7n5aRwD0RVQirSe2K3sjAEw/59U5fuE4Gj8xoycst4UNpa856iWC4CksTs8RmCIZoCaVIGZEWENR2HzFIjWTPk4BpqY+zt3wjVS5jKX8FDlh1dOCDgiizr44ZX8JZL+pUuyeNna/UcBDpkw+rffKlLxLjmeKtLv6GDRp5GL+mKOmbShmXJbH2y5AdtbxCDA1sVWbkgmNWsjsw8Bt9Vqrp4ME3TakSUTRh2Oy9ygokDGtQQDNNYWHteNapqgqqWb1Kxk2PUwCSnotcOOh9iiOgBtoKSKEfJ/Bh/W1Ta2Wu77//K5A1bUZlGe4dYj/NTJ65Ry8KG43l2yKZG7hkfu6O6fjpLeHeaLzO/f3JNtRM2qBf9SRXFFG6i3nflpuhT35c1+w6aHxNGtWePpj62drJtJNG5qFVrruHcYWxE1GihRUHdvkCZAUydROWLjmo6vYi5T+XjQraDy9wdi6FYRSPnqJZsgrRQk5aFrY41s5YtfRlovDOPehEZfSAypNsijGiRQOsT0GrCHq5fH7DWPT42KF08rqeHX4emHREVee4pwlRHIk5190MG6UpIE3pleWliNAJGZQ5zpGktf37HrYY/M0cjhzW3u3IV0xpbptKocatR2Bb+0iQrNp+9uCX1Ko9LyC6MD+4d4deGFQjG3b6u9phrXMYFU2vZuULpjX1V0BaEdc6j48IUdKY1nMtQR2hX+We+mEqkYZjtji1qo7AhfvelTX4ELlnRKw/Dj1qskv7ZrvuCLUd8e2x3e4ktR4eHuds9mKpCxnpMHjcnOG1C2jfFyILrabPsn0ea2RK2CCTdPT1B91BEKYWR5W2sSaTQLy1VNN9UM/LvCgL/KMkSLkR12feGmujFKnAyaF1LgaZwXyRWUKj8fRKPQtYmA8i4DNWOIOoUln2ABLsLg4LfY0D45TZGQN6HszaHwdlEbTQwYLp71vIlZq3O1EyEIL1Jom3SpjtLR5P81QOUyHeBHivc5SJnwjcm7a3YcqcXf/YDPJDcCEDQHIJb0/AlkQ4+HLj3HY6XYnb1qE1A1+/H606xNi2NmQDOyYeLCb0XxkljymTCTlIK2uU7h47GaCVgtdEEM5D4pMnisEPBtkitDAFZV67FuBDPm5eJjh8VLoh5omhsR9K9DTWDDW0RT2Cq/hB0Kmc6FdhbszsMKOrd/0VAVbmykJF2sA2kemF5CN6LZG3dq63P2fdB96HxhBw0dmnhxBCidqLVQsjWuEfcgwqOXU4QCDdLcU0ZlRXgu3A6JJIPKMSLmcrUPyXZyOBnmB9WFIZGUUY3+FGWVJltKb1N6h7sO6mYF5s/7p8rLa+WgwjBLbx6GNq8T2fKSmeulK2RECO2IFKzu0DvsTOrqDp/KUUIWhUCFVr4VEgNoS6kbuEZN99EX0WV9RqjXz1qMNCV2YYrqStwP0UumjvzvYm2fbXJJdK/bykrbgK4zdN9n3uagtcY+l0jkIeh3y3JYk/Y/lpSpW+g5UCZNEYLejnyeC8C8Anhq7MlWUKyRvmzPRN09Te7SNShIo6tXEnMkws6K9PMpOJu2iZJhU/R5BRePUKjpf0fQglUJok2LwqC4FNBVk8AJsGdYar6VYReYCjcq6suv/EUPlZNJYu+kMNR2+2bfM1mx/KBe0tpRCeMY7tTVhst7yMVlVIFJ4cBeqC0yZO93mzXB1gRvE0raivsvFrtg9oQ0DVrCosxcR1zXpIojejRu62eSf/uNOzmssi5MX1Q0Okh1+VgEr1YTfJmkvVhCJfTe1uxfJ6x4RTUTIcDNtDGYjN62GCWWZfQEW+7q1MnteavJg8r1HQxtL1lhM/KG76KMSVhQZ/viGxkN1TpmbS2ydeNk7zkDwVP3fIj5h4lyzdL3EmTKuGr99eSJwDUewI9Cn7bQuJVp9l3dSf4jjbqXknU1DugJr/n ResponseGetFileTransaction: summary: Пример ответа value: requestId: 67e50b09-a203-4119-86cb-647d06a803a0 status: SUCCEED downloadFileLinks: - url: https://baas.alfabank.ru/filebox/secure-file-transfer.outgoing-files.to-processing/f190bfef-aad6-ce9b-9224-f11ef60564cb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8 method: GET RequestCreateStatements: summary: "Пример запроса. Важно, убрать форматирование!" value: "{\"Data\":{\"Statement\":{\"accountId\":\"12345678-1234-1234-1234-1234567890AB\"\ ,\"fromBookingDateTime\":\"2019-09-03T00:00:00+00:00\",\"toBookingDateTime\"\ :\"2019-09-03T00:00:00+00:00\"}}}" postIssueResponseExample: summary: Пример ответа value: creator: Ефимов Филипп Архипович createdDate: 2022-04-12T05:32:37.509Z id: 62550ef50163785f2222707e type: issueRsaCertificate status: CREATED getIssueResponseExample: summary: Пример ответа value: requestActivateRsaCertificate: - creator: Ефимов Филипп Архипович createdDate: 2022-04-12T07:46:58.691Z id: 62550ef50163785f2222707e type: activationRsaCertificate results: userSignMethodStatus: ENABLED userSignMethodType: RSA status: FINISHED finishedDate: 2022-04-12T07:49:56.328Z requestIssueRsaCertificate: - creator: Ефимов Филипп Архипович createdDate: 22022-04-12T07:46:58.691Z id: 62550ef50163785f2222707e type: issueRsaCertificate results: owner: Ефимов Филипп Архипович notAfter: 2024-04-12T07:49:27Z serialNumber: 6100035c3cff88cd00f01d734a000100035c3c sendDate: 2022-04-12T07:49:56.110Z executionDate: 2022-04-12T07:49:56.163Z thumbprint: f738ec7266d1e3f6d6d4557bcbbc43ec188db3cf dn: firstName: Филипп lastName: Ефимов country: RU fullName: Ефимов Филипп Архипович email: User176@pochtochka.com issuedCertificateId: 62552f2457595f1652c4b179 notBefore: 2022-04-12T07:39:27Z caRequestId: 220220 status: FINISHED finishedDate: 2022-04-12T07:49:56.328Z requestCurrentSignTypeRsa: - creator: Ефимов Филипп Архипович createdDate: 2022-09-22T10:35:03.304Z id: 62550ef50163785f2222707e type: currentSignTypeRsa status: FINISHED finishedDate: 2022-09-22T10:35:39.967Z requestSwitchRsaCertificate: - creator: Ефимов Филипп Архипович createdDate: 2022-09-22T10:35:03.304Z id: 62550ef50163785f2222707e type: switchRsaCertificate status: FINISHED finishedDate: 2022-09-22T10:35:39.967Z requestRevocationRsaCertificate: - creator: Ефимов Филипп Архипович createdDate: 2022-09-22T10:35:03.304Z id: 62550ef50163785f2222707e type: revocationRsaCertificate status: FINISHED finishedDate: 2022-09-22T10:35:39.967Z requestReissueRsaCertificate: - creator: Ефимов Филипп Архипович createdDate: 22022-04-12T07:46:58.691Z id: 62550ef50163785f2222707e type: reissueRsaCertificate results: owner: Ефимов Филипп Архипович notAfter: 2024-04-12T07:49:27Z serialNumber: 6100035c3cff88cd00f01d734a000100035c3c sendDate: 2022-04-12T07:49:56.110Z executionDate: 2022-04-12T07:49:56.163Z thumbprint: f738ec7266d1e3f6d6d4557bcbbc43ec188db3cf dn: firstName: Филипп lastName: Ефимов country: RU fullName: Ефимов Филипп Архипович email: User176@pochtochka.com issuedCertificateId: 62552f2457595f1652c4b179 notBefore: 2022-04-12T07:39:27Z caRequestId: 220220 status: FINISHED finishedDate: 2022-04-12T07:49:56.328Z getRsaResponseExample: summary: Пример ответа value: certificate: owner: Ефимов Филипп Архипович tokenSerialNumber: 00a81050 notAfter: 2024-04-12T07:49:27Z serialNumber: 6100035c3cff88cd00f01d734a000100035c3c expireSoon: true id: 62552f2457595f1652c4b179 tokenKeyId: "AlboKey_{BBB5EB5D-2B38-488B-B9E2-5E336DDE3DE9}" actions: - available: true type: UPLOAD_ON_TOKEN - available: true type: UPLOAD_ON_TOKEN notBefore: 2022-04-12T07:39:27Z status: CERT_VALID uploadOnToken: true content: MIIFzDCCBICgAwIBAgITYQADXDz/iM0A8B1zSgABAANcPDBBBgkqhkiG9w0BAQow\r\nNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUA\r\nogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UE\r\nCxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENB\r\nIDEwHhcNMjIwNDEyMDczOTI3WhcNMjQwNDEyMDc0OTI3WjCBmTEVMBMGA1UEKgwM\r\n0KTQuNC70LjQv9C/MRUwEwYDVQQEDAzQldGE0LjQvNC+0LIxCzAJBgNVBAYTAlJV\r\nMTUwMwYDVQQDDCzQldGE0LjQvNC+0LIg0KTQuNC70LjQv9C/INCQ0YDRhdC40L/Q\r\nvtCy0LjRhzElMCMGCSqGSIb3DQEJARYWVXNlcjE3NkBwb2NodG9jaGthLmNvbTCC\r\nASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKJu1IfZg/ijEVWCIC8t20Bm\r\nmdUNY1k2ACcIRDA1s8hClq9jc56gj9o1yFeDBOfa73J6M4IS7xD7H75FANdV5K89\r\nyJUjN8MnkTHYw/MnJKujeI+NP4cIhO7+x11W/cufPmSg3M4DlGKFND62gey82Ajb\r\n9oshMFdUzgm2RDR7Oo2xcMWpWvRfCz/fGPfcGGENcOsLbiK+cOyljBuN69utzn8v\r\n+YWGQdhfmkImjFw13lPwmtVQLWqQEiacUDQLl0wALqpaWCUgbsECSpzhn9u7RbES\r\nqyLTfncGWcP0D/eTh65jm+ZVGfab/oSzz0rleuepFhqnn+jrORCzrifscsNDwXcC\r\nAwEAAaOCAeAwggHcMB0GA1UdDgQWBBTbfzj1CFqgIOUtAqiQPszkaMdawzAfBgNV\r\nHSMEGDAWgBTJFzMem6mUoJYYS25xTIHb6XP+ZTCBuwYDVR0fBIGzMIGwMIGtoIGq\r\noIGnhjlodHRwczovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2ludC9BbGZh\r\nLUJhbmtfU0NBMS5jcmyGMGh0dHA6Ly92bGt3czY6OTA4MS9kaXN0cnBvaW50L0Fs\r\nZmEtQmFua19TQ0ExLmNybIY4aHR0cDovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlz\r\ndHJwb2ludC9BbGZhLUJhbmtfU0NBMS5jcmwwgdsGCCsGAQUFBwEBBIHOMIHLMEUG\r\nCCsGAQUFBzAChjlodHRwczovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2lu\r\ndC9BbGZhLUJhbmtfU0NBMS5jcnQwPAYIKwYBBQUHMAKGMGh0dHA6Ly92bGt3czY6\r\nOTA4MS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBEBggrBgEFBQcwAoY4\r\naHR0cDovL3Rlc3RqbWIuYWxmYWJhbmsucnUvZGlzdHJwb2ludC9BbGZhLUJhbmtf\r\nU0NBMS5jcnQwQQYJKoZIhvcNAQEKMDSgDzANBglghkgBZQMEAgMFAKEcMBoGCSqG\r\nSIb3DQEBCDANBglghkgBZQMEAgMFAKIDAgFAA4IBAQA7qvezzVUukOu6PusP9Ulr\r\n801fn7lJlEG4suRmmqWTaOUkkwfoOV+AjyN4K9LtF8JF4BE7ovoz+BAXNl6IIaxB\r\nLup0lnIf2UUXvg8XoAZ9SCNnDdmHI05NrONrRg+7DyCv8FpyudFTkFhmkaMojuUH\r\nZN8V27KlW3Q0ijDrOyn9/rIqAIA5JVbvUfRIMR8DXpZsIkf0HAnZN4Zswn0U5U0K\r\n46Ewva4fWvF7u3638Hkv8u5XNU6E1eaJTWxVM+4J8HdnnTDHSDO27VFh9SxCP8E7\r\ncvQhIhfOXz2qESMSnC2bmlGm863E7fMGxNIpikE2D5LO8Z0KiI0qrhZA7p4tye2c\r\n postActivateResponseExample: summary: Пример ответа value: creator: Ефимов Филипп Архипович createdDate: 2022-04-12T05:32:37.509Z id: 62550ef50163785f2222707e type: activationRsaCertificate status: CREATED putSignSettingResponseExample: summary: Пример ответа value: creator: Ефимов Филипп Архипович createdDate: 2022-09-21T22:15:47.500Z id: 62550ef50163785f2222707e type: currentSignTypeRsa status: CREATED postRevocationResponseExample: summary: Пример ответа value: creator: Ефимов Филипп Архипович createdDate: 2022-04-12T05:32:37.509Z id: 62550ef50163785f2222707e type: revocationRsaCertificate status: CREATED postSwitchResponseExample: summary: Пример ответа value: creator: Ефимов Филипп Архипович createdDate: 2022-04-12T05:32:37.509Z id: 62550ef50163785f2222707e type: switchRsaCertificate status: CREATED postReissueResponseExample: summary: Пример ответа value: creator: Ефимов Филипп Архипович createdDate: 2022-04-12T05:32:37.509Z id: 62550ef50163785f2222707e type: reissueRsaCertificate status: CREATED enableQesResponseExample: summary: Пример ответа value: id: 63160a37e27edd0c316567a6 type: enableQesSignType status: CREATED createdBy: Дмитриев Денис Михайлович createdAt: 2022-09-05T14:39:51.197Z qesRequestsPostRequestExample: summary: Пример запроса value: type: enableQesSignType qesRequestsPostResponseExample: summary: Пример ответа value: id: 63160a37e27edd0c316567a6 type: enableQesSignType content: string qesRequestsPatchRequestExample: summary: Пример запроса value: type: enableQesSignType signature: string qesRequestsPatchResponseExample: summary: Пример ответа value: id: 63160a37e27edd0c316567a6 type: enableQesSignType isSigned: true downloadPoaRequestExample: summary: Пример запроса value: poaNumber: 8e08423a-bcc0-4fba-a791-9825cb1a7cb3 issuerInn: "7727464030" confidantInn: "420548688683" downloadPoaResponseExample: summary: Пример ответа value: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 createPaymentRequest: summary: Пример запроса value: amount: 1.01 date: 2022-10-11 deliveryKind: электронно departmentalInfo: uip: "0" drawerStatus101: "01" kbk: "18210102010011000110" oktmo: "45902000" reasonCode106: ТП taxPeriod107: МС.02.2022 docNumber108: "000000000000001" docDate109: 2022-05-25 paymentKind110: "0" digestSignatures: - base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 externalId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 incomeTypeCode: "2" number: "1047" operationCode: "01" payeeAccount: "40702810564564564531" payeeBankBic: "040173745" payeeBankCorrAccount: "30101810800000000745" payeeInn: "7723870785" payeeKpp: "553453453" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerAccount: "40702810102300000001" payerBankBic: "044525593" payerBankCorrAccount: "30101810200000000593" payerInn: "0453438040" payerKpp: "046773311" payerName: Общество с ограниченной ответственностью "Клиент" priority: "5" purpose: Оплата заказа №1. НДС не облагается urgencyCode: NORMAL vat: rate: "0" type: NO_VAT createPaymentResponse: summary: Пример ответа value: amount: 1.01 bankComment: "" bankStatus: CREATED crucialFieldsHash: 3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316 date: 2022-10-11 deliveryKind: электронно departmentalInfo: uip: "0" drawerStatus101: "01" kbk: "18210102010011000110" oktmo: "45902000" reasonCode106: ТП taxPeriod107: МС.02.2022 docNumber108: "000000000000001" docDate109: 2022-05-25 paymentKind110: "0" externalId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 incomeTypeCode: "2" number: "1047" operationCode: "01" payeeAccount: "40702810564564564531" payeeBankBic: "040173745" payeeBankCorrAccount: "30101810800000000745" payeeInn: "7723870785" payeeKpp: "553453453" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerAccount: "40702810102300000001" payerBankBic: "044525593" payerBankCorrAccount: "30101810200000000593" payerInn: "0453438040" payerKpp: "046773311" payerName: Общество с ограниченной ответственностью "Клиент" priority: "5" purpose: Оплата заказа №1. НДС не облагается urgencyCode: NORMAL vat: rate: "0" type: NO_VAT getPaymentStatusResponse: summary: Пример ответа value: bankStatus: ACCEPTED bankComment: Отправим платёж в течение банковского дня crucialFieldsHash: 3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316 patchPaymentStateResponse: summary: Пример ответа value: bankStatus: PARTSIGNED bankComment: null crucialFieldsHash: 3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316 fromInvoiceRequest: summary: Пример запроса value: amount: 1.01 date: 2018-12-31 deliveryKind: электронно expirationDate: 2022-09-12T19:15:51+03:00 externalId: 5863d914-80ee-4e27-9041-49e8136ab94e operationCode: "01" orderNumber: "1" payeeAccount: "40807810201300000043" paymentNumber: "1" priority: "5" purpose: Оплата заказа №1. НДС не облагается urgencyCode: NORMAL vat: rate: "0" type: NO_VAT fromInvoiceResponse: summary: Пример ответа value: amount: 1.01 bankComment: "" bankStatus: CREATED crucialFieldsHash: 925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50 date: 2018-12-31 deliveryKind: электронно externalId: 5863d914-80ee-4e27-9041-49e8136ab94e incomeTypeCode: null number: "1" operationCode: "01" payeeAccount: "40807810201300000043" payeeBankBic: "044525593" payeeBankCorrAccount: "30101810200000000593" payeeInn: "7723870785" payeeKpp: "553453453" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerAccount: null payerBankBic: null payerBankCorrAccount: null payerInn: null payerKpp: null payerName: null priority: "5" purpose: Оплата заказа №1. НДС не облагается urgencyCode: NORMAL vat: rate: "0" type: NO_VAT fromInvoiceBudgetRequest: summary: Пример запроса value: amount: 100 date: 2022-04-01 deliveryKind: электронно departmentalInfo: uip: "0" drawerStatus101: "01" kbk: "18210102010011000110" oktmo: "45902000" reasonCode106: ТП taxPeriod107: МС.02.2022 docNumber108: "000000000000001" docDate109: 2022-03-25 externalId: 697e31f1-8df2-458e-8646-f77ea5bae8a2 operationCode: "01" payeeAccount: "40702810564564564531" payeeBankBic: "040173745" payeeBankCorrAccount: "30101810800000000745" payeeInn: "7723870785" payeeKpp: "553453453" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerKpp: "772201001" paymentNumber: "1" priority: "5" purpose: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается urgencyCode: NORMAL fromInvoiceBudgetResponse: summary: Пример ответа value: amount: 100 bankComment: null bankStatus: CREATED crucialFieldsHash: 925a81c0d635559af364262b9ed5f0972c0bab64dd03189b511bc0e4cdc80d50 date: 2022-04-01 deliveryKind: электронно departmentalInfo: uip: "0" drawerStatus101: "01" kbk: "18210102010011000110" oktmo: "45902000" reasonCode106: ТП taxPeriod107: МС.02.2022 docNumber108: "000000000000001" docDate109: 2022-03-25 externalId: 697e31f1-8df2-458e-8646-f77ea5bae8a2 number: "1" operationCode: "01" payeeAccount: "40702810564564564531" payeeBankBic: "040173745" payeeBankCorrAccount: "30101810800000000745" payeeInn: "7723870785" payeeKpp: "553453453" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payerKpp: "772201001" priority: "5" purpose: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается urgencyCode: NORMAL CreateRegistryRequest: summary: Пример запроса value: urgencyCode: NORMAL description: Описание реестра payments: - number: "1" date: 2022-04-01 deliveryKind: электронно amount: 100 payerName: Общество с ограниченной ответственностью "Клиент" payerInn: "7736576798" payerKpp: "772201001" payerAccount: "40702810102300000001" payerBankBic: "044525593" payerBankCorrAccount: "30101810200000000593" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeInn: "7723870785" payeeKpp: "553453453" payeeAccount: "40702810564564564531" payeeBankBic: "040173745" payeeBankCorrAccount: "30101810800000000745" departmentalInfo: uip: "0" drawerStatus101: "01" kbk: "18210102010011000110" oktmo: "45902000" reasonCode106: ТП taxPeriod107: МС.02.2022 docNumber108: "000000000000001" docDate109: 2022-03-25 priority: "5" purpose: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается - number: "2" date: 2022-04-01 deliveryKind: электронно amount: 100 payerName: Общество с ограниченной ответственностью "Клиент" payerInn: "7736576798" payerKpp: "772201001" payerAccount: "40702810102300000001" payerBankBic: "044525593" payerBankCorrAccount: "30101810200000000593" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeInn: "7723870785" payeeKpp: "553453453" payeeAccount: "40702810564564564531" payeeBankBic: "040173745" payeeBankCorrAccount: "30101810800000000745" departmentalInfo: uip: "0" drawerStatus101: "01" kbk: "18210102010011000110" oktmo: "45902000" reasonCode106: ТП taxPeriod107: МС.02.2022 docNumber108: "000000000000001" docDate109: 2022-03-25 priority: "5" purpose: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается CreateRegistryResponse: summary: Пример ответа value: registryId: U102702240001208 description: Описание реестра payerAccount: "40702810102300000001" urgencyCode: NORMAL paymentsCount: 1 totalAmount: 100 GetRegistryResponse: summary: Пример ответа value: status: UPLOADED description: Описание реестра payerName: Общество с ограниченной ответственностью "Клиент" payerAccount: "40702810102300000001" urgencyCode: NORMAL registryActualState: paymentsCount: 1 totalAmount: 100.0 states: - count: 1 amount: 100.0 status: DRAFT isValidForSign: true UpdateRegistryStatusResponse: summary: Пример ответа value: status: ON_SIGNING description: Описание реестра payerAccount: "40702810102300000001" urgencyCode: NORMAL content: YW1vdW50PTEwMC4wMApkYXRlPTIwMTgtMDUtMzEKZGVwYXJ0bWVudGFsSW5mby...NOdW1iZXIx= GetRegistryPaymentsResponse: summary: Пример ответа value: pagination: limit: 10 offset: 0 totalCount: 1 payments: - id: U031308240002351 number: "1" status: DRAFT date: 2022-04-01 amount: 100 payerAccount: "40702810102300000001" payeeName: Общество с ограниченной ответственностью "Центр "ИННОВАЦИЯ" payeeInn: "7723870785" payeeKpp: "553453453" payeeAccount: "40702810564564564531" payeeBankBic: "040173745" purpose: Налог на доходы физических лиц за февраль 2022 года. НДС не облагается SignRegistryRequest: summary: Пример запроса value: digestSignatures: - base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 signatureType: RSA GetSignResultRsa: summary: Успешное подписание RSA value: status: SIGNED digestSignatures: - certificateUuid: 61000366d11e143acbc03a56d70001000366d1 signatureType: RSA status: SIGNED GetSignResultPartially: summary: Частичное подписание value: status: PARTIALLY_SIGNED digestSignatures: - certificateUuid: 61000366d11e143acbc03a56d70001000366d1 signatureType: RSA status: SIGNED - certificateUuid: 51999366d11e143acbc03a56d70001000866c1 signatureType: RSA status: FAILED errorCode: signature_error errorMessage: The certificate you are attempting to use to sign the document is not associated with your organization. GetSignResultQes: summary: Ошибка при подписании КЭП value: status: ERROR error: code: signing_failed message: All signing attempts failed. No signatures were applied to the payment register. digestSignatures: - signatureType: QES status: FAILED errorCode: signature_error errorMessage: Insufficient permissions to perform the operation. getBuildProjectsResponseExample: summary: Пример ответа value: - area: ОКТЯБРЬСКИЙ country: RU regionCode: "054" buildingPermitDate: 2021-10-01 city: Новосибирск projectNumber: "162" buildingPermitNumber: 61-310-998601-2022 phases: - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" settlement: Новосибирск commercialName: ЖК ЗАПАДНЫЕ АЛЛЕИ getEscrowOrdersV0ResponseExample: summary: Пример ответа value: pagination: offset: 0 limit: 10 totalCount: 25 items: escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-31 referenceID: EA10509220000013 status: VERIFICATION postEscrowOrdersRequestExample: summary: Пример запроса value: escrowAccount: amount: 112500 currency: RUR estateObject: flat: "1" buildProject: buildingPermitNumber: 61-310-998601-2022 phases: index: 1 type: APARTMENTS depositor: lastName: Федькин firstName: Ратибор birthdate: 1990-08-30 phoneNumber: "75453333435" identityDocumentNumber: "197343" dateIssuedId: 2020-01-01 identityDocumentType: "001" middleName: Васильевич identityDocumentSeries: "5516" equalityAgreement: date: 2020-01-01 number: "5555" getEscrowOrdersV1ResponseExample: summary: Пример ответа value: pagination: offset: 0 limit: 10 totalCount: 25 items: escrowAccount: amount: 6000000.12 currency: RUR accountNumber: "40702810701300000761" fullNameDepositor: Королёв Митрофан Гертрудович buildingPermitNumber: 61-310-998601-2022 creationDate: 2021-12-31 referenceID: EA10509220000013 status: DRAFT getEscrowOrderV0ResponseExample: summary: Пример ответа value: escrowAccount: amount: 8.008281904619307E11 currency: RUR accountNumber: "40824810906580000000" estateObject: flat: "234" buildProject: area: ОКТЯБРЬСКИЙ country: RU regionCode: "054" buildingPermitDate: 2021-10-01 city: Новосибирск projectNumber: "162" buildingPermitNumber: 61-310-998601-2022 phases: - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" settlement: Новосибирск commercialName: ЖК ЗАПАДНЫЕ АЛЛЕИ type: APARTMENTS rejectReason: "К сожалению, во время обработки произошла тех. ошибка." depositor: birthdate: 1998-11-03 phoneNumber: "79055485717" identityDocumentNumber: "615760" dateIssuedId: 2022-04-25 identityDocumentType: "001" fullName: Королёв Митрофан Гертрудович identityDocumentSeries: "8039" creationDate: 2021-12-31 referenceID: EA10808220000061 equalityAgreement: date: 2022-07-14 number: "234" isRegistered: false status: VERIFICATION getEscrowOrderV1ResponseExample: summary: Пример ответа value: escrowAccount: amount: 8.008281904619307E11 currency: RUR accountNumber: "40824810906580000000" estateObject: flat: "234" buildProject: area: ОКТЯБРЬСКИЙ country: RU regionCode: "054" buildingPermitDate: 2021-10-01 city: Новосибирск projectNumber: "162" buildingPermitNumber: 61-310-998601-2022 phases: - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" - street: 11-4 на земельном участке с к.н. 61:44:0073012:390 termEscrowOrder: 2022-03-22 name: поз. 4.1 - 9-этажный 4-х секц дом index: 1 house: "4.1" building: "2" settlement: Новосибирск commercialName: ЖК ЗАПАДНЫЕ АЛЛЕИ type: APARTMENTS rejectReason: "К сожалению, во время обработки произошла тех. ошибка." depositor: birthdate: 1998-11-03 phoneNumber: "79055485717" identityDocumentNumber: "615760" dateIssuedId: 2022-04-25 identityDocumentType: "001" fullName: Королёв Митрофан Гертрудович identityDocumentSeries: "8039" creationDate: 2021-12-31 referenceID: EA10808220000061 equalityAgreement: date: 2022-07-14 number: "234" isRegistered: false status: DRAFT escrowOrderCancelV1ResponseExample: summary: Пример ответа value: referenceID: EA13110220000011 status: CLIENT_CANCELLED postExecuteRequestExample: summary: Пример запроса value: equalityAgreement: isRegistered: true postEscrowOrdersFullRequestExample: summary: Пример запроса value: escrowAccount: amount: 112500 currency: RUR estateObject: flat: "1" buildProject: buildingPermitNumber: 61-310-998601-2022 phases: index: 1 type: APARTMENTS depositor: lastName: Федькин firstName: Ратибор middleName: Васильевич birthdate: 1990-08-30 phoneNumber: "75453333435" identityDocumentNumber: "197343" identityDocumentSeries: "5516" identityDocumentType: "001" dateIssuedId: 2020-01-01 birthPlace: г. Москва regAddress: "Ул. Соцветий, д12, кв. 1" managerContactPhoneNumber: "75453333435" managerContactEmail: manager@gmail.com equalityAgreement: date: 2020-01-01 number: "5555" postEscrowOrdersFullResponseExample: summary: Пример ответа value: referenceID: EA13110220000011 status: VERIFICATION getEscrowReportsV1ResponseExample: summary: Пример ответа value: organizationName: Тестовый пользователь organizationFullName: Тестовый пользователь Номер один Отозвана лицензия buildProjects: - buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 commercialName: Тестовый жилой комплекс actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - index: 1 name: Дом termEscrowOrder: 2024-02-10T00:00:00.000Z - index: 2 name: Паркинг termEscrowOrder: 2024-02-10T00:00:00.000Z - buildPermitNumber: №599-35-92-2024 projectNumber: 503-303 commercialName: Тестовый жилой комплекс 2 actualProjectCompletionDate: 2024-02-11T00:00:00.000Z phases: - index: 1 name: Дом termEscrowOrder: 2024-02-10T00:00:00.000Z - index: 2 name: Паркинг termEscrowOrder: 2024-02-10T00:00:00.000Z postEscrowReportsV1RequestExample: summary: Пример запроса value: buildProjects: - buildPermitNumber: №599-35-92-2024 projectNumber: 503-302 commercialName: Тестовый жилой комплекс actualProjectCompletionDate: 2024-02-10T00:00:00.000Z phases: - index: 1 name: Дом termEscrowOrder: 2024-02-10T00:00:00.000Z - index: 2 name: Паркинг termEscrowOrder: 2024-02-10T00:00:00.000Z - buildPermitNumber: №599-35-92-2024 projectNumber: 503-303 commercialName: Тестовый жилой комплекс 2 actualProjectCompletionDate: 2024-02-11T00:00:00.000Z phases: - index: 1 name: Дом termEscrowOrder: 2024-02-10T00:00:00.000Z - index: 2 name: Паркинг termEscrowOrder: 2024-02-10T00:00:00.000Z showAccountTransactions: true postEscrowReportsV1ResponseExample: summary: Пример ответа value: report: pagination: limit: 10 offset: 0 totalCount: 2 commonInfo: customerNameTo: Тестовая организация ИНН 000000000 periodTo: 2024-11-11T00:00:00.000Z periodFrom: 2022-11-11T00:00:00.000Z reportGenerationDate: 2024-11-11T00:00:00.000Z escrowAccountInfo: - buildPermitNumber: №599-35-92-2024 commercialName: Тестовый жилой комплекс buildProjectPhase: 2 phaseDescription: Паркинг escrowAccountNumber: "40824810906580012508" escrowAccountCurrentStatus: Пополнен escrowAccountOpenDate: 2023-08-15T00:00:00.000Z apartmentCost: "12600000.55" incomingBalance: "0.00" outcomingBalance: "12600000.55" balanceChange: "12600000.55" depositCompletionDate: 2023-01-12T00:00:00.000Z deponentName: Сергеев Сергей Сергеевич deponentINN: "184514811334" shareAgreementNumber: 22-444/111П-1234 shareAgreementDate: 2023-07-10T00:00:00.000Z assignmentAgreementNumber: ДУ 103-4 от 12.02.2023 assignmentAgreementDate: 2023-08-31T00:00:00.000Z escrowAccountCloseDate: 2024-08-31T00:00:00.000Z isRegisteredShareAgreementProvided: "Y" escrowAccountReservePlace: Онлайн escrowAccountOpenPlace: Онлайн developerManger: Иванов Иван Иванович objectType: Комната transactions: - operationDate: 2023-07-20T00:00:00.000Z transactionAmount: "150000.55" primaryDocumentDate: 2023-07-20T00:00:00.000Z primaryDocumentNumber: "350" bicBank: "044525593" - operationDate: 2023-07-16T00:00:00.000Z transactionAmount: "50000.00" primaryDocumentDate: 2023-07-15T00:00:00.000Z primaryDocumentNumber: "75271" bicBank: null - buildPermitNumber: №500-35-92-2024 commercialName: Тестовый жилой комплекс buildProjectPhase: 1 phaseDescription: Дом escrowAccountNumber: "40824810906580012509" escrowAccountCurrentStatus: Пополнен escrowAccountOpenDate: null apartmentCost: "22600000.00" incomingBalance: "0.00" outcomingBalance: "0.00" balanceChange: "0.00" depositCompletionDate: 2023-01-12T00:00:00.000Z deponentName: Иванов Иван Иванович deponentINN: "1845144457441" shareAgreementNumber: 21-444/166П-55 shareAgreementDate: 2023-01-21T00:00:00.000Z assignmentAgreementNumber: ДУ/854-4 от 21.01.2022 assignmentAgreementDate: 2023-08-15T00:00:00.000Z escrowAccountCloseDate: null isRegisteredShareAgreementProvided: "Y" escrowAccountReservePlace: Онлайн escrowAccountOpenPlace: Отделение developerManger: Иванов Иван Иванович objectType: Квартира transactions: null ScoringAnyResponseExample: summary: Пример ScoringAnyResponse value: dealId: c5f72949-0e9a-41bf-a16d-a34b938f41ef application: platformId: B2B borrower: individual: legalInfo: inn: "770778659011" kpp: "770201001" ogrn: "305465110922043" contactPhone: +7(495)545-00-10 partner: numberOfInteractionDays: 149 startDateOfInteraction: 2022-05-01 orderInfo: productCode: Рассрочка для партнёра number: 2023-123-234-3459 ОТ date: 2023-10-25 amount: 328400 returnUrl: success: https://partner.example.ru/success failure: https://partner.example.ru/failure paymentDetails: vat: true vatAmount: 1.239857567345E10 bankDetails: bankName: "АО «Альфа-Банк», г. Москва" bankBIC: "044525593" bankCorrespondentAccount: "30101810200000000000" recipientINN: "5504036333" recipientKPP: "783801001" recipientAccount: "30101810200000000000" recipientName: АКЦИОНЕРНОЕ ОБЩЕСТВО АЛЬФА-БАНК income: "12000234" twoPersonalIncomeTaxesInfo: retentionSumList: - date: 2022-05-01 sum: 58552.25 - date: 2022-05-01 sum: 58552.25 paidSumList: - date: 2022-05-01 sum: 58552.25 - date: 2022-05-01 sum: 58552.25 employeesQuantityList: - date: 2022-05-01 quantity: 134 - date: 2022-05-01 quantity: 134 fullCostSumList: - date: 2022-05-01 sum: 58552.25 - date: 2022-05-01 sum: 58552.25 sellerInventory: inventorySumAndQuantityList: - date: 2022-05-01 quantity: 2 sum: 9000.25 - date: 2022-05-01 quantity: 2 sum: 9000.25 vat: counterparts: - date: 2022-05-01 quantity: 346 purchases: - date: 2022-05-01 sum: 554000.55 - date: 2022-05-01 sum: 554000.55 sales: - date: 2022-05-01 sum: 554000.55 - date: 2022-05-01 sum: 554000.55 - date: 2022-05-01 quantity: 346 purchases: - date: 2022-05-01 sum: 554000.55 - date: 2022-05-01 sum: 554000.55 sales: - date: 2022-05-01 sum: 554000.55 - date: 2022-05-01 sum: 554000.55 totalTaxBaseList: - date: 2022-05-01 sum: 554000.55 - date: 2022-05-01 sum: 554000.55 purchaseAndSaleOperations: - date: 2022-05-01 quantity: 554000 - date: 2022-05-01 quantity: 554000 transportedGoodsInfo: deliveries: - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза - date: 2000-01-23 transportedGoodsVolumeAndCategoryList: - volume: 3456.65 category: Категория груза - volume: 3456.65 category: Категория груза feeList: - date: 2022-05-01 sum: 3000000.76 - date: 2022-05-01 sum: 3000000.76 insurancePremiumsInfo: mandatorySocialInsuranceSumList: - date: 2022-05-01 sum: 7579815.57 - date: 2022-05-01 sum: 7579815.57 mandatoryMedicalInsuranceSumList: - date: 2022-05-01 sum: 7579815.57 - date: 2022-05-01 sum: 7579815.57 mandatoryPensionInsuranceSurchargeSumList: - date: 2022-05-01 sum: 7579815.57 - date: 2022-05-01 sum: 7579815.57 mandatoryPensionInsuranceSumList: - date: 2022-05-01 sum: 7579815.57 - date: 2022-05-01 sum: 7579815.57 supplementarySocialSupportSumList: - date: 2022-05-01 sum: 7579815.57 - date: 2022-05-01 sum: 7579815.57 procuredGoodsInfo: categories: - Категория 1 - Категория 2 profitTax: incomes: - date: 2022-05-01 sum: 8.777003919E7 - date: 2022-05-01 sum: 8.777003919E7 costs: - date: 2022-05-01 sum: 8.777003919E7 - date: 2022-05-01 sum: 8.777003919E7 totalProfits: - date: 2022-05-01 sum: 8.777003919E7 - date: 2022-05-01 sum: 8.777003919E7 delay: loans: - duration: 12 overDueDate: 2022-05-01 sum: 10000 - duration: 12 overDueDate: 2022-05-01 sum: 10000 goods: - duration: 12 overDueDate: 2022-05-01 sum: 10000 - duration: 12 overDueDate: 2022-05-01 sum: 10000 sellerQuality: returnedQuantityList: - date: 2022-05-01 quantity: 12 - date: 2022-05-01 quantity: 12 goodsConcentrationLevels: - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так - concentrationLevelOfSum: 23.5 concentrationLevelOfQuantity: 53.2 nameOfGood: Товар называется так sellerRatings: - date: 2022-05-01 rating: 3.98 - date: 2022-05-01 rating: 3.98 reasonForRefundList: - date: 2022-05-01 reason: Какая-то причина возврата или не выполнения заказа - date: 2022-05-01 reason: Какая-то причина возврата или не выполнения заказа calculationsInformation: currentInterestsSum: 110687 currentInterestsAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentFinesAndCategories: - sum: 20299.1 category: Категория пени/штрафа - sum: 20299.1 category: Категория пени/штрафа currentTaxesSum: 5016161.68 sixPersonalIncomeTaxesInfo: imposedKBKTaxes: - date: 2022-05-01 sum: 33346.47 - date: 2022-05-01 sum: 33346.47 retentionPITDateAndSumList: - date: 2022-05-01 sum: 247912.19 factDate: 2022-05-28 - date: 2022-05-01 sum: 247912.19 factDate: 2022-05-28 paidKBKFines: - date: 2022-05-01 sum: 9110687.53 - date: 2022-05-01 sum: 9110687.53 paidKBKTaxes: - date: 2022-05-01 sum: 9110687.53 - date: 2022-05-01 sum: 9110687.53 paidKBKInterests: - date: 2022-05-01 sum: 9110687.53 - date: 2022-05-01 sum: 9110687.53 factIncomes: - date: 2022-05-01 sum: 247912.19 factDate: 2022-05-28 - date: 2022-05-01 sum: 247912.19 factDate: 2022-05-28 imposedInterests: - date: 2022-05-01 sum: 33346.47 - date: 2022-05-01 sum: 33346.47 imposedFines: - date: 2022-05-01 sum: 33346.47 - date: 2022-05-01 sum: 33346.47 transactionsInfo: minSumTransactionMSB: - date: 2022-05-01 sum: 1000.15 - date: 2022-05-01 sum: 1000.15 transactionsMSBSumList: - date: 2022-05-01 sum: 1000.15 - date: 2022-05-01 sum: 1000.15 transactionsMSBMaxSumList: - date: 2022-05-01 sum: 1000.15 - date: 2022-05-01 sum: 1000.15 transactionsMSBAvgSumList: - date: 2022-05-01 sum: 1000.15 - date: 2022-05-01 sum: 1000.15 transactionsMSBQuantityList: - date: 2022-05-01 quantity: 15 - date: 2022-05-01 quantity: 15 premiumAccount: hasPremiumAccount: true BonusNumbersResponse: {} successGetUserCompliancePositive: value: checkPassed: true persData: givenName: Иван familyName: Иванов middleName: Иванович name: Иванов Иван Иванович birthDate: 1990-01-01 birthPlace: г. Москва citizenship: RU inn: "773342345321" snils: 112-233-445 95 identityDocumentName: Паспорт РФ identityDocumentSeries: "1234" identityDocumentNumber: "567890" identityDocumentAuthorityCode: 770-001 identityDocumentAuthorityName: ОУФМС России по г. Москве identityDocumentIssueDate: 2015-06-10 actualAddressDetails: country: Россия city: Москва zip: "101000" street: Тверская region: "77" area: Центральный localityShortName: "" town: Москва streetShortName: ул. houseNumber: "10" housingNumber: "1" apartmentNumber: "45" successGetUserComplianceNegative: value: checkPassed: false reasons: - description: Отсутствует подтверждение полной идентификации клиента - description: Неактуальные данные паспорта OperationResponseSuccess: value: operationId: 22413cd0-11d7-4a1a-826d-a82470c18a83 ResponeWebhooks: summary: Пример ответа на получение списка вебхуков value: pagination: offset: 0 limit: 1000 totalCount: 2 items: - id: f9f8c674-7a2a-4297-bdb8-ddd3013de3a3 object: ul_transaction_default enabled: true organizationIdHash: ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c callbackUri: https://webhook.partner.ru/api/v1/webhook-events version: 1 data: accounts: - "40802810401300015422" - "40802810401300015422" statusDescriptions: - cause: consent_revoked description: The webhook is disabled due to the agreement being revoked in Alfa ID RequestPostWebhook: summary: Пример запроса на создание value: object: ul_transaction_default callbackUri: https://webhook.partner.ru/api/v1/webhook-events version: 1 data: accounts: - "40802810401300015422" - "40802810401300015422" ResponeWebhook: summary: Пример ответа value: id: f9f8c674-7a2a-4297-bdb8-ddd3013de3a3 object: ul_transaction_default enabled: true organizationIdHash: ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c callbackUri: https://webhook.partner.ru/api/v1/webhook-events version: 1 data: accounts: - "40802810401300015422" - "40802810401300015422" statusDescriptions: - cause: consent_revoked description: The webhook is disabled due to the agreement being revoked in Alfa ID RequestPutWebhook: summary: Пример запроса на редактирование value: object: ul_transaction_default callbackUri: https://webhook.partner.ru/api/v1/webhook-events enabled: true version: 1 data: accounts: - "40802810401300015422" - "40802810401300015422" ReceiptAndPayoutListRequest: summary: Пример запроса value: externalId: f8c1ffe6-696b-4e35-994f-904a9187806d company: accountNumber: "40702810201400022055" requisite: - payoutId: 54077ca4-5c99-4f08-bf01-795918055df6 selfemployed: vatin: "585414307054" surname: Северный name: Элемент patronymic: Оккамович payoutRequisite: payoutType: ACCOUNT byAccount: accountNumber: "40817810604100001305" bic: "044525593" purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutTotalAmount: "24.00" receiptRequisite: customerVatin: "0483685159" customerName: Полное наименование Орг № 89727 incomeType: FROM_LEGAL_ENTITY operateDate: 2023-01-18T13:36:42.703Z requestDate: 2023-01-18T13:36:42.703Z services: - amount: "23.00" name: Курьерские услуги quantity: 1 receiptTotalAmount: "23.00" digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= signatureType: RSA ListResponse: summary: Пример ответа value: requestId: 06ec61b1-efda-a019-b6e5-34ee808da1b6 externalId: a607d9ac-5bfc-dfc1-b8ae-a7aeb9f1d44d ReceiptListRequest: summary: Пример запроса value: externalId: 6561cb23-8f28-411c-928c-e718d3fd9ac3 requisite: - payoutId: 4e85f1d8-3324-45f4-bfe7-72f557c0da9e selfemployed: vatin: "252530829203" surname: Прекрасный name: Элемент patronymic: Насреддинович receiptRequisite: customerVatin: "0483685159" customerName: Полное наименование Орг № 89727 incomeType: FROM_LEGAL_ENTITY operateDate: 2023-11-19T13:36:42.703Z requestDate: 2023-11-20T16:40:42.703Z services: - amount: "17" name: Курьерские услуги за период с 2.12.2020-20.12.2020 quantity: 1 receiptTotalAmount: "17" digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= signatureType: RSA CheckSelfemployedStatusAndPayoutListRequest: summary: Пример запроса value: externalId: eb19f3ef-ca6a-4f84-a28f-c6e7b469b486 company: accountNumber: "40702810201400022055" requisite: - payoutId: b766f52d-f6e6-4a47-bd71-ab332bd0d314 selfemployed: vatin: "252530829203" surname: Прекрасный name: Элемент patronymic: Насреддинович payoutRequisite: payoutType: ACCOUNT byAccount: accountNumber: "40817810110210005303" bic: "044525593" purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutTotalAmount: "24.00" receiptRequisite: receiptId: 200wr5cn4s digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= signatureType: RSA PayoutListRequest: summary: Пример запроса value: externalId: eb19f3ef-ca6a-4f84-a28f-c6e7b469b486 company: accountNumber: "40702810201400022055" requisite: - payoutId: b766f52d-f6e6-4a47-bd71-ab332bd0d314 selfemployed: vatin: "252530829203" surname: Прекрасный name: Элемент patronymic: Насреддинович payoutRequisite: payoutType: ACCOUNT byAccount: accountNumber: "40817810110210005303" bic: "044525593" purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutTotalAmount: "24.00" digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= signatureType: RSA PayoutListStateResponse: summary: Пример ответа value: pagination: limit: 1000 offset: 0 totalCount: 10000 requestId: e82331bd-28ac-481b-b7c3-e03673abc20b externalId: e82331bd-28ac-481b-b7c3-e03673abc20b createdDate: 2023-03-28T08:46:23.462Z listStatus: NEW accountNumber: "40702810501300001805" statementList: - payoutId: e82331bd-28ac-481b-b7c3-e03673abc20b selfemployed: vatin: "112233445566" surname: Иванов name: Иван patronymic: Иванович payoutRequisite: payoutType: ACCOUNT byAccount: accountNumber: "40817810306050000000" bic: "044525593" purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 payoutTotalAmount: "10.00" receiptRequisite: customerVatin: "5566778899" customerName: ООО Петуния incomeType: FROM_LEGAL_ENTITY operateDate: 2023-03-28T08:46:23.463Z requestDate: 2023-03-28T08:46:23.463Z services: - amount: "10.00" name: Курьерские услуги за период с 1.12.2020-20.12.2020 quantity: 1 receiptTotalAmount: "10.00" receiptLink: receiptId: 200wr5cn4s link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print receiptStatus: status: READY updatedDate: 2023-03-28T08:46:23.463Z payoutStatus: status: READY updatedDate: 2023-03-28T08:46:23.463Z errorRecord: - field: Наименование поля в котором возникла ошибка message: Описание ошибки CancelReceiptRequest: summary: Пример запроса value: externalId: f8c1ffe6-696b-4e35-994f-904a9187806d cancelReceipt: - vatin: "585414307054" receipt: - receiptId: 26o3rf60af cancelReasonCode: REGISTRATION_MISTAKE digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= signatureType: RSA CancelReceiptStateResponse: summary: Пример запроса value: pagination: limit: 100 offset: 0 totalCount: 1 requestId: c2f85d3e-2eba-4e61-9e4e-e535e91ef75f externalId: 56e68647-1c31-4ea7-a3bd-8b7f79d80b71 createdDate: 2023-05-04T13:02:46.416183+03:00 listStatus: SUCCESS error: {} statementList: - receiptId: "123" cancelReasonCode: REGISTRATION_MISTAKE status: TECHNICAL_ERROR errorMessage: Payout not found PayoutResponse: summary: Пример ответа value: pagination: limit: 1 offset: 0 totalCount: 12000 payoutsList: - payoutId: 54077ca4-5c99-4f08-bf01-795918055df6 vatin: "0483685159" requestId: fcdf06aa-bc65-4b60-9121-6b4b4e886526 externalId: f8c1ffe6-696b-4e35-994f-904a9187806d payerAccountNumber: "40702810001300000050" createdDate: 2023-06-30T02:41:56.363817+03:00 payoutRequisite: payoutType: ACCOUNT payoutTotalAmount: "24.00" byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810010210029719" bic: "044525593" receiptRequisite: customerVatin: "0483685159" customerName: Полное наименование Орг № 89727 incomeType: FROM_LEGAL_ENTITY operateDate: 2023-06-29T22:46:27.80923+03:00 requestDate: 2023-04-15T23:07:52+03:00 services: - amount: "23.00" name: Курьерс quantity: "1" receiptTotalAmount: "23.00" receiptLink: {} receiptStatus: {} payoutStatus: status: TECHNICAL_ERROR PayoutVatinResponse: summary: Пример ответа value: pagination: limit: 100 offset: 0 totalCount: 1 payoutsList: - payoutId: ec7e7eaa-7d47-41dc-b26c-183fdfd44413 vatin: "037630767401" requestId: 21f8af7a-a474-47ba-8420-ef4fb68bc220 externalId: ec7e7eaa-7d47-41dc-b26c-183fdfd44413 payerAccountNumber: "40702810001300000050" createdDate: 2023-06-29T16:07:33.795049+03:00 payoutRequisite: payoutType: ACCOUNT payoutTotalAmount: "24.00" byAccount: purpose: Курьерские услуги за период с 1.12.2020-20.12.2020 comment: Курьерские услуги за период с 1.12.2020-20.12.2020 accountNumber: "40817810010210029719" bic: "044525593" receiptRequisite: customerVatin: "037630767401" customerName: Полное наименование Орг № 89727 incomeType: FROM_LEGAL_ENTITY operateDate: 2023-04-03T22:26:50+03:00 requestDate: 2023-06-29T16:07:33.597443+03:00 services: - amount: "23.00" name: Курьерс quantity: "1" receiptTotalAmount: "23.00" receiptLink: receiptId: 279iru4gle link: https://lknpd-adp.gnivc.ru/api/v1/receipt/936144570006/279iru4gle/print receiptStatus: status: READY payoutStatus: status: READY updatedDate: 2023-04-03T22:26:50+03:00 SelfemployedListRequest: summary: Пример запроса value: externalId: e82331bd-28ac-481b-b7c3-e03673abc20b selfemployed: - personalInformation: vatin: "112233445566" surname: Иванов name: Иван patronymic: Иванович phone: "79130000011" birthDate: 2000-03-02 birthPlace: Г. Иркутск citizenship: RU passport: series: "6953" number: "987435" dateOfIssue: 2022-03-02 codeOfIssue: 123-321 authority: ОВД Иркутской области по Г. Иркутску по Октябрьскому району address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 email: IvanovIvan@mail.ru digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 5f61c6f7-66c1-4820-bcef-197d4420c34f signatureType: RSA SelfemployedListStateResponse: summary: Пример ответа value: pagination: limit: 1000 offset: 0 totalCount: 10000 requestId: e82331bd-28ac-481b-b7c3-e03673abc20b externalId: e82331bd-28ac-481b-b7c3-e03673abc20b listStatus: NEW createdDate: 2023-03-28T10:22:08.076Z selfemployedAccount: - selfemployed: personalInformation: vatin: "112233445566" surname: Иванов name: Иван patronymic: Иванович phone: "79130000011" birthDate: 2000-03-02 birthPlace: Г. Иркутск citizenship: RU passport: series: "6953" number: "987435" dateOfIssue: 2022-03-02 codeOfIssue: 123-321 authority: ОВД Иркутской области по Г. Иркутску по Октябрьскому району address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 email: IvanovIvan@mail.ru idCard: type: migrationCard number: "1234567" dateOfEffective: 2022-03-02 dateOfExpiry: 2024-03-02 status: READY updatedDate: 2023-03-28T10:22:08.076Z RequestTaxpayerStatusList: summary: Пример запроса value: externalId: e82331bd-28ac-481b-b7c3-e03673abc20b selfemployedVatinList: - "258200435963" TaxpayerListStatusResponse: summary: Пример ответа value: pagination: limit: 1000 offset: 0 totalCount: 10000 requestId: 4e817e78-5876-4608-a873-bcc141454045 externalId: a607d9ac-5bfc-dfc1-b8ae-a7aeb9f1d44d taxpayerStatusList: - vatin: "112233445566" status: TAXPAYER_BOUND AccrualAndDebtListStatusRequest: summary: Пример запроса value: externalId: e82331bd-28ac-481b-b7c3-e03673abc20b selfemployedVatinList: - "258200435963" AccrualAndDebtListStatusResponse: summary: Пример ответа value: pagination: limit: 1000 offset: 0 totalCount: 10000 requestId: e82331bd-28ac-481b-b7c3-e03673abc20b externalId: e82331bd-28ac-481b-b7c3-e03673abc20b accrualList: - vatin: "112233445566" status: NEW taxChargeList: - amount: "10.00" dueDate: 2022-03-02 paidAmount: "10.00" updatedAt: 2023-03-28T10:05:57.281Z krsbList: - debt: 990 penalty: 0.1 overpayment: 0 updatedAt: 2023-03-28T10:05:57.281Z PaymentDocumentListStatusResponse: summary: Пример ответа value: pagination: limit: 1000 offset: 0 totalCount: 10000 requestId: 13a5B82A-9B84-5BDA-FBFa-c1ccD95cB540 externalId: 4feF748b-908F-3f75-20bd-7A96BD7E8aef paymentDocumentListState: - vatin: "836656935521" status: SUCCESS SelfemployedListResponse: summary: Пример ответа value: pagination: offset: 0 limit: 1000 totalCount: 10000 selfemployedAccount: - selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02 number: "1234567" dateOfExpiry: 2024-03-02 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02 email: IvanovIvan@mail.ru errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23 status: null - selfemployed: birthPlace: Г. Иркутск address: Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110 passport: null phone: "79130000011" idCard: dateOfEffective: 2022-03-02 number: "1234567" dateOfExpiry: 2024-03-02 type: migrationCard personalInformation: vatin: "112233445566" patronymic: Иванoвич surname: Иванов name: Иван citizenship: RU birthDate: 2000-03-02 email: IvanovIvan@mail.ru errorRecord: - field: field error_description: error_description - field: field error_description: error_description updatedDate: 2000-01-23T04:56:07.000+00:00 status: null RequestSelfemployedVatin: summary: Пример запроса value: requestUniqueRights: true TaxpayerAccountInfoRequest: summary: Пример ответа value: vatin: "112233445566" externalId: e82331bd-28ac-481b-b7c3-e03673abc20b IncomeForPeriodRequest: summary: Пример запроса value: vatin: "112233445566" taxPeriodId: "202306" externalId": e82331bd-28ac-481b-b7c3-e03673abc20b IncomeV2Request: summary: Пример запроса value: vatin: "112233445566" offset: 0 limit: 10 externalId: e82331bd-28ac-481b-b7c3-e03673abc20b from: 2023-06-30T00:00:00+03:00 to: 2023-06-30T23:59:59+03:00 GetIncomeV2Response: summary: Пример ответа value: receipts: - totalAmount: 25.04 customerVatin: customerVatin partnerCode: partnerCode incomeType: null cancelationTime: 2023-06-30T16:17:57.874Z taxPeriodId: "202306" link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print requestDate: 2023-06-30T16:17:57.874Z services: - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 receiptId: 200wr5cn4s operateDate: 2023-06-30T16:17:57.874Z taxToPay: 1.38 - totalAmount: 25.04 customerVatin: customerVatin partnerCode: partnerCode incomeType: null cancelationTime: 2023-06-30T16:17:57.874Z taxPeriodId: "202306" link: https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print requestDate: 2023-06-30T16:17:57.874Z services: - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 - amount: 10.05 quantity: 0 name: Курьерские услуги за период с 1.12.2020-20.12.2020 receiptId: 200wr5cn4s operateDate: 2023-06-30T16:17:57.874Z taxToPay: 1.38 AgreementPageRequest: summary: Пример запроса value: phone: "79130000011" activities: - "17" regions: - "40000000" returnUrl: https://alfabank.ru/ AgreementPageResponse: summary: Пример ответа value: agreementPageId: 8658d934-9527-413b-b23c-d87bb1e9824a agreementPageLink: https://alfabank.ru/agreement/97ae89a6-2813-4d4d-a2a6-4a10adba9e1f ActivitiesResponse: summary: Пример ответа value: - id: "17" name: Доставка RegionsResponse: summary: Пример ответа value: - oktmo: "40000000" name: Санкт-Петербург SbpBanksResponse: summary: Пример ответа value: - bankName: Газпромбанк bankId: "100000000001" CreatePoaResponse: summary: Пример ответа value: requestUuid: 6ce35d97-f061-4ecf-a333-c1da3d8d4618 GetPoaRequestStatusResponse: summary: Пример ответа value: requestUuid: 6ce35d97-f061-4ecf-a333-c1da3d8d4618 downloadingStatus: COMPLETE detailedPoa: number: e0b215fa-78eb-44ad-9fdb-08924ff64131 inn: "112233445566" GetPoaStatusResponse: summary: Пример ответа value: id: 9cmCi4vnp5Z832k3Z4YXa1aqYMh8hMw7ZtZE6yP9P2Db poaNumber: e0b215fa-78eb-44ad-9fdb-08924ff64131 startDate: 1901-01-01 endDate: 2099-01-01 status: ACTIVE issuerPublicKey: 3066301F06082A85030701010101301306072A85030202240006082A850307010102020343000440D037957D55FB52D5D958E52934C3BEF5C819C3F37CB843D180FCF3C3C777CE92DCB99601F249D2FE3D26BE571FCC67DCDCD740A75D12B5B304C3E5598BFFEFBB GetAccounts: summary: Пример ответа value: - accountNumber: "40817810306050000000" isActive: false - accountNumber: "40817810306053040506" isActive: true StatusPENDINGResponse: summary: PENDING value: requestId: ab9cbb96-360a-4462-a683-955cc29f7f54 status: PENDING StatusFAILEDResponse: summary: FAILED value: requestId: ab9cbb96-360a-4462-a683-955cc29f7f54 status: FAILED error: internal_error error_description: Произошла техническая ошибка. Обратитесь в службу поддержки и сообщите код ошибки afc9b019-77ac-49ef-afb9-688b38b74cc2 StatusCOMPLETEResponse: summary: COMPLETE value: requestId: ab9cbb96-360a-4462-a683-955cc29f7f54 status: COMPLETE StatusResultDataResponse: summary: COMPLETE с результирующими данными value: requestId: ab9cbb96-360a-4462-a683-955cc29f7f54 status: COMPLETE resultData: "Данные субъекта не прошли проверку: N05 PBS0023\\nСубъект не\ \ прошел скоринг и деактивирован в системе.\\n" BeneficiaryListResponse: summary: Пример ответа value: - beneficiaryId: cba2888c-71ad-4211-9420-a85f6e4c10f9 isBeneficiary: true isVpr: false accountNumber: "40817810306053040506" type: FL_RESIDENT personalInformation: vatin: "112233445566" firstName: Иван middleName: Иванович lastName: Иванов citizenship: RU birthDate: 1992-03-02 birthPlace: г. Москва snils: "72865174431" phoneNumber: "79130000011" email: IvanovIvan@email.ru addresses: - type: REGISTRATION_ADDRESS address: ул. Пушкина 55 documents: - type: PASSPORT serial: "8012" number: "555777" issueDate: 2012-03-02 organization: ОВД Иркутской области по Г. Иркутску по Октябрьскому району division: 123-321 isActive: true - beneficiaryId: 87e33a48-ed80-4493-a66e-7268c9ec4931 isBeneficiary: true isVpr: false accountNumber: "40817810306053040506" type: UL_RESIDENT phoneNumber: "78005553535" email: welcome@email.ru addresses: - type: LEGAL_ENTITY_ADDRESS address: ул. Максима Горького 55 name: Акционерное общество «Ромашка» vatin: "1122334455" ogrn: "7665544332211" registrationDate: 2012-12-21 isActive: true AddFLRequest: summary: "ФЛ, резидент" value: isBeneficiary: true type: FL_RESIDENT accountNumber: "40817810306053040506" personalInformation: vatin: "112233445566" firstName: Иван middleName: Иванович lastName: Иванов citizenship: RU birthDate: 1992-03-02 birthPlace: г. Москва snils: "72865174431" phoneNumber: "79130000011" email: IvanovIvan@email.ru addresses: - type: REGISTRATION_ADDRESS address: ул. Пушкина 55 documents: - type: PASSPORT serial: "8012" number: "555777" issueDate: 2012-03-02 organization: ОВД Иркутской области по Г. Иркутску по Октябрьскому району division: 123-321 digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 AddULRequest: summary: "ЮЛ, резидент" value: isBeneficiary: true type: UL_RESIDENT accountNumber: "40817810306053040506" phoneNumber: "78005553535" email: welcome@email.ru addresses: - type: LEGAL_ENTITY_ADDRESS address: ул. Максима Горького 55 name: Акционерное общество «Ромашка» vatin: "1122334455" ogrn: "7665544332211" registrationDate: 2012-12-21 digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 RequestResponse: summary: Пример ответа value: requestId: ab9cbb96-360a-4462-a683-955cc29f7f54 status: PENDING GetFLResponse: summary: "ФЛ, резидент" value: beneficiaryId: cba2888c-71ad-4211-9420-a85f6e4c10f9 isBeneficiary: true isVpr: false accountNumber: "40817810306053040506" type: FL_RESIDENT personalInformation: vatin: "112233445566" firstName: Иван middleName: Иванович lastName: Иванов citizenship: RU birthDate: 1992-03-02 birthPlace: г. Москва snils: "72865174431" phoneNumber: "79130000011" email: IvanovIvan@email.ru addresses: - type: REGISTRATION_ADDRESS address: ул. Пушкина 55 documents: - type: PASSPORT serial: "8012" number: "555777" issueDate: 2012-03-02 organization: ОВД Иркутской области по Г. Иркутску по Октябрьскому району division: 123-321 isActive: true GetULResponse: summary: "ЮЛ, резидент" value: beneficiaryId: 87e33a48-ed80-4493-a66e-7268c9ec4931 isBeneficiary: true isVpr: false accountNumber: "40817810306053040506" type: UL_RESIDENT phoneNumber: "78005553535" email: welcome@email.ru addresses: - type: LEGAL_ENTITY_ADDRESS address: ул. Максима Горького 55 name: Акционерное общество «Ромашка» vatin: "1122334455" ogrn: "7665544332211" registrationDate: 2012-12-21 isActive: true ChangeFLRequest: summary: "ФЛ, резидент" value: type: FL_RESIDENT personalInformation: firstName: Иван middleName: Иванович lastName: Иванов birthDate: 1992-03-02 birthPlace: г. Москва phoneNumber: "79130000011" email: IvanovIvan@email.ru addresses: - type: REGISTRATION_ADDRESS address: ул. Пушкина 55 documents: - type: PASSPORT serial: "8012" number: "555777" issueDate: 2012-03-02 organization: ОВД Иркутской области по Г. Иркутску по Октябрьскому району division: 123-321 isActive: true digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 ChangeULRequest: summary: "ЮЛ, резидент" value: type: UL_RESIDENT phoneNumber: "78005553535" email: welcome@email.ru addresses: - type: LEGAL_ENTITY_ADDRESS address: ул. Максима Горького 55 name: Акционерное общество «Ромашка» registrationDate: 2012-12-21 isActive: false digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 RequisiteAccountRequest: summary: Реквизиты счета value: type: ACCOUNT_NUMBER accountNumber: "40817810570000123456" bik: "123456789" digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 RequisitePhoneRequest: summary: Номер телефона value: type: PHONE_NUMBER phoneNumber: "79130000011" bankId: "012345678910" isMain: false digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 RequisitePanRequest: summary: Номер карты (токен) value: type: CARD_NUMBER pan: wS7fElYo8VWeJ8KelaJ0XA== isMain: false digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 RequisiteAccountResponse: summary: Реквизиты счета value: id: 69e7d84f-9a84-4f60-9bde-6797c9b9736f isMain: true isActive: true RequisitePhoneResponse: summary: Номер телефона value: id: 5d645ebf-8f0b-4125-a4e2-2c6a041ae246 isMain: false isActive: true IsActiveRequest: summary: Признак активности реквизитов value: isActive: false digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 IsMainRequest: summary: Признак основных реквизитов value: isMain: false digestSignatures: - base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: afc38fe0-6674-e319-4897-4c7f8f55babd signatureType: rsa poaNumber: DOVER_CBR_7702235133_20211102_1 BalanceResponse: summary: Пример ответа value: accountNumber: "40817810306053040506" beneficiaryId: cba2888c-71ad-4211-9420-a85f6e4c10f9 date: 2024-01-01 balance: "10.00" successAccountsGet: summary: Получение счетов value: accounts: - mnemonic: moneyway number: "40817810704980004078" type: EH typeDescription: Текущий счёт status: ACTIVE dateCreated: 2021-08-23 balance: currency: RUR minorUnits: 100 holds: 10000 amount: 50000 successAccountByNumber: summary: Получение информации по счёту value: mnemonic: moneyway number: "40817810704980004078" type: EH typeDescription: Текущий счёт status: ACTIVE dateCreated: 2021-08-23 balance: currency: RUR minorUnits: 100 holds: 10000 amount: 50000 accountRequisitesRurGet: summary: Получение реквизитов (RUR счёт) value: clientInfo: firstName: Иван lastName: Иванов patronymicName: Иванович accountNumber: "40817810704980004078" bankName: "АО «Альфа-Банк», г. Москва" bic: "044525593" inn: "7728168971" kpp: "770801001" correspondentAccountNumber: "30101810200000000593" accountRequisitesForeignGet: summary: Получение реквизитов (Валютный счёт) value: clientInfo: firstName: Иван lastName: Иванов patronymicName: Иванович translitFirstName: Ivan translitLastName: Ivanov translitPatronymicName: Ivanovic accountNumber: "40817810704980004078" bankName: "AO «ALFA-BANK», 27 Kalanchevskaya str., Moscow, 107078" correspondentBanks: - correspondentBankAccountNumber: "36310481" correspondentBankName: "CITIBANK NA, 399 Park Avenue, New York, NY 10043,\ \ USA" correspondentSwift: CITIUS33 successCardsGet: summary: Получение списка карт value: cards: - cardId: "123731041" maskedNumber: 458443******3430 type: ER typeDescription: RR title: VISA Rewards PW status: "0" issueDate: 2021-11-15T08:28:22+03:00 account: number: "40817810605610705598" expirationDate: "1126" isPrimary: true isVirtual: false isCredit: false paymentSystem: VISA state: isActive: true isBlocked: false isClosed: false GetCardActionsSuccessResponse: summary: Список доступных действий/задач по заданной карте value: actions: - actionId: CARD_BLOCK title: Блокировка карты available: true CardActionCreateSuccessResponse: summary: Создание операции блокировки карты value: reference: H390506200000003 auth: SMSPWD passwordLength: 4 successTariffsGet: summary: Получение условий обслуживания value: conditions: cardServiceFee: fee: 0 feePeriod: YEARLY isSalaryCard: false isCombo: false successSubscriptionsGet: summary: Получение информации о подключенных уведомлениях по операциям value: subscriptionTariffs: - id: ONLYSMS name: SMS priceAmount: value: 5900 currency: RUR minorUnits: 100 isSelected: true isContactPhoneRequired: true successOperationsHistoryGet: summary: Получение списка истории операций по набору критериев value: operations: - id: 1220117MOCOIBSR 04461 dateTime: 2022-01-17T14:47:49.65Z title: МТС 9166666666 amount: value: 100 currency: RUR minorUnits: 100 comment: Перевод за услуги IPTV mcc: "4899" category: id: "00012" name: "Телефон, интернет, ТВ" direction: EXPENSE loyalty: title: Компенсация за плату услуг Альфа картой percent: 10 amount: value: 100 currency: RUR minorUnits: 100 status: SUCCESS type: A01 terminal: number: "123456789" name: МТС online city: Moscow countryCode: RU sender: name: Сидоров Сидор Сидорович accountNumber: "40817810810210032401" bankBik: "044525593" bankName: Альфа Банк phoneNumber: 79201112222 maskedCardNumber: 1111XXXXXXXX2222 recipient: name: МТС bankBik: "044525500" bankName: ООО МТС Банк phoneNumber: 12223334455 fee: 50.0 isAnotherClient: false cashout: false successOperationDetailsGet: summary: Получение информации об операции по индетификатору операции value: id: 1220117MOCOIBSR 04461 dateTime: 2022-01-17T14:47:49.65Z title: МТС 9166666666 amount: value: 100 currency: RUR minorUnits: 100 comment: Перевод за услуги IPTV mcc: "4899" category: id: "00012" name: "Телефон, интернет, ТВ" direction: EXPENSE loyalty: title: Компенсация за аплату услуг Альфа картой percent: 10 amount: value: 100 currency: RUR minorUnits: 100 status: SUCCESS type: A01 terminal: number: "123456789" name: МТС online city: Moscow countryCode: RU sender: name: Сидоров Сидор Сидорович accountNumber: "40817810810210032401" bankBik: "044525593" bankName: Альфа Банк phoneNumber: 79201112222 maskedCardNumber: 1111XXXXXXXX2222 recipient: name: МТС bankBik: "044525500" bankName: ООО МТС Банк phoneNumber: 12223334455 fee: 50.0 isAnotherClient: false cashout: false successCreateAccountReport: summary: Заказ выписки по счету value: id: 63d11487bbefcc000184cdfd date: 2023-01-25T11:37:43.068Z type: code: ufr_stmt_physical_vypiska title: Выписка по счету status: ENQUEUED createCreditProductReport: summary: Заказ выписки по кредиту value: id: 63d11df5bbefcc000184ce44 date: 2023-01-25T12:17:57.831Z type: code: ufr_stmt_physical_credit_product title: Выписка по кредиту status: ENQUEUED successCreateAccountBalanceEngReport: summary: Заказ справки о доступном остатке на англ value: id: 63d117cfbbefcc000184ce12 date: 2023-01-25T11:51:43.103Z type: code: ufr_stmt_physical_acc_balance_en title: О доступном остатке на английском status: ENQUEUED successCreateAccountBalanceRurReport: summary: Заказ справки о доступном остатке на русском value: id: 63d118bbbbefcc000184ce24 date: 2023-01-25T11:55:39.457Z type: code: ufr_stmt_physical_acc_balance_rur title: О доступном остатке на русском status: ENQUEUED createClosedCreditsReport: summary: Заказ справки о закрытых кредитах value: id: 63d11ba3bbefcc000184ce41 date: 2023-01-25T12:08:03.415Z type: code: ufr_stmt_physical_closed_credit_sfa title: Справка о закрытых кредитах status: ENQUEUED createCreditInfoReport: summary: Заказ справки о наличии или отсутствии кредитов value: id: 63d11cc8bbefcc000184ce43 date: 2023-01-25T12:12:56.565Z type: code: ufr_stmt_physical_credit_info title: О наличии или отсутствии кредитов status: ENQUEUED successCreateDepositReport: summary: Заказ справки по депозиту value: id: 63d119d1bbefcc000184ce2f date: 2023-01-25T12:00:17.935Z type: code: ufr_stmt_physical_deposit title: Справка по депозиту status: ENQUEUED successLimits: summary: Получение базовых лимитов клиента value: oneTime: cashWithdrawals: title: Снятие наличных limits: {} transfers: title: Переводы limits: atmTransferCardToAnotherBank: title: С карты Альфа-Банка в другой банк max: value: 30000000 currency: RUR minorUnits: 100 rest: value: 30000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false atmTransferCardToCardAlfaBank: title: Между картами Альфа-Банка max: value: 60000000 currency: RUR minorUnits: 100 rest: value: 60000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false transferBetweenOwnAccounts: title: Между своими счетами max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false transferToPerson: title: Клиенту банка max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false transferToSbp: title: Перевод через СБП max: value: 30000000 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false transferToAny: title: Перевод в другой банк max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false convertRubToUsd: title: Конвертация валют max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false payments: title: Платежи limits: paymentsInternetAndMobile: title: За интернет и мобильный max: value: 1500000 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false paymentsTelecom: title: "За ТВ, телефонию и ЖКУ" max: value: 1500000 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false paymentsCommunal: title: Коммунальные платежи max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsBudget: title: Платежи в бюджет РФ max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsSBP: title: Оплата товаров/услуг через СБП max: value: 99999999 currency: RUR minorUnits: 100 rest: value: 0 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false day: cashWithdrawals: title: Снятие наличных limits: {} transfers: title: Переводы limits: atmTransferCardToAnotherBank: title: С карты Альфа-Банка в другой банк max: value: 100000000 currency: RUR minorUnits: 100 rest: value: 100000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false atmTransferCardToCardAlfaBank: title: Между картами Альфа-Банка max: value: 200000000 currency: RUR minorUnits: 100 rest: value: 200000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false transferBetweenOwnAccounts: title: Между своими счетами max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false transferToPerson: title: Клиенту банка max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false transferToSbp: title: Перевод через СБП max: value: 30000000 currency: RUR minorUnits: 100 rest: value: 30000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false transferToAny: title: Перевод в другой банк max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false convertRubToUsd: title: Конвертация валют max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false payments: title: Платежи limits: paymentsInternetAndMobile: title: За интернет и мобильный max: value: 5000000 currency: RUR minorUnits: 100 rest: value: 5000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false paymentsTelecom: title: "За ТВ, телефонию и ЖКУ" max: value: 10000000 currency: RUR minorUnits: 100 rest: value: 10000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false paymentsCommunal: title: Коммунальные платежи max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsBudget: title: Платежи в бюджет РФ max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsSBP: title: Оплата товаров/услуг через СБП max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false month: cashWithdrawals: title: Снятие наличных limits: atmWithdrawals: title: Снятие наличных в банкоматах РФ max: value: 300000000 currency: RUR minorUnits: 100 rest: value: 300000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false transfers: title: Переводы limits: atmTransferCardToAnotherBank: title: С карты Альфа-Банка в другой банк max: value: 300000000 currency: RUR minorUnits: 100 rest: value: 300000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false atmTransferCardToCardAlfaBank: title: Между картами Альфа-Банка max: value: 300000000 currency: RUR minorUnits: 100 rest: value: 300000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false transferBetweenOwnAccounts: title: Между своими счетами max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false transferToPerson: title: Клиенту банка max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false transferToSbp: title: Перевод через СБП max: value: 465000000 currency: RUR minorUnits: 100 rest: value: 465000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: GENERAL isPersonal: false transferToAny: title: Перевод в другой банк max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false convertRubToUsd: title: Конвертация валют max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false payments: title: Платежи limits: paymentsInternetAndMobile: title: За интернет и мобильный max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsTelecom: title: "За ТВ, телефонию и ЖКУ" max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsCommunal: title: Коммунальные платежи max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsBudget: title: Платежи в бюджет РФ max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false paymentsSBP: title: Оплата товаров/услуг через СБП max: value: 99999999999999 currency: RUR minorUnits: 100 rest: value: 99999999999999 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 type: UNLIMITED isPersonal: false successGetUserLimits: summary: Получение пользовательских лимитов клиента value: limits: - activity: from: 20-01-2023 to: 16-11-2023 validity: wholePeriod coveredOperations: - onlineShopping - allDebits limits: single: value: 10000 currency: RUR minorUnits: 1 max: value: 20000 currency: RUR minorUnits: 1 rest: value: 2000000 currency: RUR minorUnits: 100 turnover: value: 0 currency: RUR minorUnits: 100 id: 186 created: 2023-01-20 countriesRestrictions: restrictionType: all list: [] successCreateUserLimit: summary: Создание пользовательского лимита value: id: 62c4f39c5f1503000128a5e3 successLoyaltyAccountsGet: summary: Получение бонусных счетов value: loyaltyAccounts: - accountNumber: "1419602531731418" typeDescription: Лояльность X5 Карты typeId: "205" balanceAmount: value: 100 currency: RUR minorUnits: 100 successLoyaltyTransactionsGet: summary: Получение бонусных начислений value: transactions: - title: Покупка мороженого account: "40817810704980004078" reference: EH cashbackPercent: 0.5 cashbackAmount: value: 100 currency: RUR minorUnits: 100 successAccountCashbackGet: summary: Получение бонусных счетов value: cashbackAccount: accountNumber: "1419602531731418" typeDescription: Лояльность X5 Карты typeId: "205" balanceAmount: value: 100 currency: RUR minorUnits: 100 cashbackForecast: totalActivePeriodAmount: amount: value: 100 currency: RUR minorUnits: 100 payOutDate: 2022-02-02 totalIntermediatePeriodAmount: amount: value: 100 currency: RUR minorUnits: 100 payOutDate: 2022-02-02 cashbackStatistic: payments: - period: Июнь status: PAST amount: value: 100 currency: RUR minorUnits: 100 overallCashback: amount: value: 100 currency: RUR minorUnits: 100 description: Кешбэк за всё время CreateFormRequest: summary: Пример запроса value: embossingName: PETROV IVAN firstName: Иван lastName: Петров middleName: Викторович mobilePhone: "9012345678" email: example@yandex.ru passportBirthDate: 1990-09-15 previousFormId: AAAA16686C43888CE05CCCAC163B298F sex: m sopdConfirmed: true CreateFormResponse: summary: Данные для оформления заявки на дебетовую карту отправлены value: formID: 55A42D1698400C9EE0543863BB4C2866 draftId: 5DCD7E06A44C463781A87CC3302F0E1D payload: cause: NOT_REQUESTED productType: DC status: APPROVAL_REJECT InvalidRequest: summary: Некорректный запрос value: error: invalid_request error_description: "The request is missing a required parameter, includes\ \ an unsupported parameter or parameter value, repeats the same parameter,\ \ uses more than one method for including an access token, or is otherwise\ \ malformed" FormNotFound: summary: Заявка с указанным идентификатором не найдена value: error: form_not_found error_description: The requested form is not found VerifySmsFormCreation: summary: Заявка на оформление дебетовой карты создана value: formID: 55A42D1698400C9EE0543863BB4C2866 draftId: 5DCD7E06A44C463781A87CC3302F0E1D payload: cause: NOT_REQUESTED productType: DC status: SUCCESS VerifySmsFormCompletion: summary: Оформление заявки на дебетовую карту завершено value: status: SUCCESS UpgradeRequired: summary: Данные по заявке устарели value: error: conflicting_request error_description: Conflict of the request with the current state of the server - form is not in a draft condition ResendSms: summary: Повторный запрос SMS для подтверждения создания заявки value: formID: 55A42D1698400C9EE0543863BB4C2866 draftId: 5DCD7E06A44C463781A87CC3302F0E1D payload: cause: NOT_REQUESTED productType: DC status: SUCCESS ResendSmsStep2: summary: Повторный запрос SMS для подтверждения завершения оформления заявки value: payload: cause: NOT_REQUESTED status: NEED_SMS CheckDraftSuccess: summary: Получен статус заявки value: formId: 55A42D1698400C9EE0543863BB4C2866 requestCodeWord: true requestBrokerageAccount: false userStatus: - DT - FAMILY ConflictingRequest: summary: Заявка не находится в состоянии "Черновик" value: error: upgrade_required error_description: Server requests a connection that is not supported by the client - form data is out of date DeliveryTypesSuccess: summary: Получены доступные способы доставки value: onlyCourierDelivery: true courier: cardAttributes: unnamedCardEnabled: true namedCardEnabled: false cityId: 21 latitude: 55.659348 longitude: 37.472996 offices: pid: 392 uuid: 83e92bd6-60cd-4924-91a0-571a635c3244 mnemonic: MOES title: ДО «ЮГО-ЗАПАДНАЯ» address: "пр-кт Вернадского, д.119" addressOfficial: "197022, г. Санкт-Петербург, Каменноостровский пр-кт, д\ . 42 Б, лит. А" cardAttributes: unnamedCardEnabled: true namedCardEnabled: false anyOfficeUnnamedEnabled: false metro: id: 1.162 title: Юго-Западная distance: 604 lineId: 1 lineColor: E42313 lineName: Сокольническая clientAvailability: OPENED embossingEnabled: true prodType: - pointone - pointtwo - serviceoffice schedule: - "пн-пт: 10:00-20:00" - "сб: 10:00-18:00" - "вс: выходной" temporarySchedule: date: с 10.02.2023 по 12.02.2023 times: - "пн-ср: 10:00-18:00" constraints: date: 1 сентября times: c 10:00 до 19:00 distance: 3441.0 city: name: Москва fiasId: 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 kladrId: 7700000000000 TimeSlotsSuccess: summary: Получены тайм-слоты для курьерской доставки карты value: uuid: 07a91616-53e1-4ee1-8045-0544e4590a18 availableDates: date: 2023-08-03 slots: isAvailable: true slotFrom: 10:00 slotTo: 11:00 express: false FormConfirmationRequest: summary: Пример запроса value: codeWord: Код1 isUnnamedCard: true deliveryUuid: 304ad059-ae73-459c-9195-acf353589657 currency: RUR officeDelivery: obtainingOffice: "392" courierDelivery: date: 2023-08-12 address: "г. Москва, ул. Анохина, д. 9" comment: Возможно не работает домофон slotTo: 11:00 slotFrom: 10:00 express: true brokerageAccountRequired: true FormConfirmationSuccess: summary: Заявка успешно создана value: status: SUCCESS FormConfirmationNeedSms: summary: Требуется ввести SMS-код для завершения оформления value: status: NEED_SMS GetAccountsResponseExample: summary: Пример ответа value: Data: Account: - accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 status: Enabled currency: RUB accountType: Personal accountDescription: Текущий счет ФЛ (НРБ) AccountDetails: - schemeName: RU.CBR.BBAN identification: "40817810704980004078" name: Имя счета 4078 Owner: name: Владимир Александрович Медведев Identification: schemeName: RU.CBR.TXID identification: "799069378370" mobileNumber: "79114587744" countryOfResidence: RU cityOfBirth: Санкт-Петербург birthDate: 1963-02-25T00:00:00Z PostalAddress: addressType: Postal addressLine: - "109156, РОССИЯ, Краснодарский край, Краснодарский район, Красно\ дар, ул. Казачья, д. 46-41, 25" streetName: Казачья buildingNumber: 46/41-27 postCode: "350002" townName: Краснодар countrySubDivision: Краснодарский край country: AF Servicer: name: "АО «Альфа-Банк», г. Москва" BankIdentification: - schemeName: RU.CBR.BIC identification: "044525593" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728168971" - schemeName: RU.CBR.TAXT identification: "770801001" CorrespondentAccount: schemeName: RU.CBR.BBAN identification: "30101810200000000593" PostalAddress: addressType: Residential addressLine: - "107078, г. Москва, ул. Каланчевская, д. 27" streetName: Каланчевская buildingNumber: "27" postCode: "107078" townName: Москва country: RU - accountId: 1123675f-e35a-f529-10f8-e4e4af233d9c status: Enabled currency: RUB accountType: Personal accountDescription: Текущ.сч.ФЛ.Кредитн.карта (НРБ) AccountDetails: - schemeName: RU.CBR.BBAN identification: "40817810304100012280" name: Текущ.сч.ФЛ.Кредитн.карта (НРБ) Owner: name: Владимир Александрович Медведев Identification: schemeName: RU.CBR.TXID identification: "799069378370" mobileNumber: "79114587744" countryOfResidence: RU cityOfBirth: Санкт-Петербург birthDate: 1963-02-25T00:00:00Z PostalAddress: addressType: Postal addressLine: - "109156, РОССИЯ, Краснодарский край, Краснодарский район, Красно\ дар, ул. Казачья, д. 46-41, 25" streetName: Казачья buildingNumber: 46/41-27 postCode: "350002" townName: Краснодар countrySubDivision: Краснодарский край country: AF Servicer: name: "АО «Альфа-Банк», г. Москва" BankIdentification: - schemeName: RU.CBR.BIC identification: "044525593" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728168971" - schemeName: RU.CBR.TAXT identification: "770801001" CorrespondentAccount: schemeName: RU.CBR.BBAN identification: "30101810200000000593" PostalAddress: addressType: Residential addressLine: - "107078, г. Москва, ул. Каланчевская, д. 27" streetName: Каланчевская buildingNumber: "27" postCode: "107078" townName: Москва country: RU - accountId: 1123675f-df00-f037-f4b9-73df2f8108dd status: Enabled currency: JPY accountType: Personal accountDescription: Альфа счет AccountDetails: - schemeName: RU.CBR.BBAN identification: "40817810004980004025" name: Имя 4025 Owner: name: Владимир Александрович Медведев Identification: schemeName: RU.CBR.TXID identification: "799069378370" mobileNumber: "79114587744" countryOfResidence: RU cityOfBirth: Санкт-Петербург birthDate: 1963-02-25T00:00:00Z PostalAddress: addressType: Postal addressLine: - "109156, РОССИЯ, Краснодарский край, Краснодарский район, Красно\ дар, ул. Казачья, д. 46-41, 25" streetName: Казачья buildingNumber: 46/41-27 postCode: "350002" townName: Краснодар countrySubDivision: Краснодарский край country: AF Servicer: name: "AO «ALFA-BANK», 27 Kalanchevskaya str., Moscow, 107078" BankIdentification: - schemeName: RU.CBR.BIC identification: "044525593" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728168971" - schemeName: RU.CBR.TAXT identification: "770801001" PostalAddress: addressType: Residential addressLine: - "107078, г. Москва, ул. Каланчевская, д. 27" streetName: Каланчевская buildingNumber: "27" postCode: "107078" townName: Москва country: RU - accountId: 1123675f-e92f-fb78-4cfd-f5370e8d8996 status: Enabled currency: RUB accountType: Personal accountDescription: Ср-ва кл. по опер. с ц.б. и ин.вал. AccountDetails: - schemeName: RU.CBR.BBAN identification: "40817810704980004093" name: Ср-ва кл. по опер. с ц.б. и ин.вал. Owner: name: Владимир Александрович Медведев Identification: schemeName: RU.CBR.TXID identification: "799069378370" mobileNumber: "79114587744" countryOfResidence: RU cityOfBirth: Санкт-Петербург birthDate: 1963-02-25T00:00:00Z PostalAddress: addressType: Postal addressLine: - "109156, РОССИЯ, Краснодарский край, Краснодарский район, Красно\ дар, ул. Казачья, д. 46-41, 25" streetName: Казачья buildingNumber: 46/41-27 postCode: "350002" townName: Краснодар countrySubDivision: Краснодарский край country: AF Servicer: name: "АО «Альфа-Банк», г. Москва" BankIdentification: - schemeName: RU.CBR.BIC identification: "044525593" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728168971" - schemeName: RU.CBR.TAXT identification: "770801001" CorrespondentAccount: schemeName: RU.CBR.BBAN identification: "30101810200000000593" PostalAddress: addressType: Residential addressLine: - "107078, г. Москва, ул. Каланчевская, д. 27" streetName: Каланчевская buildingNumber: "27" postCode: "107078" townName: Москва country: RU - accountId: 1123675f-e35a-f529-10f9-2e1920dfd15f status: Disabled currency: RUB accountType: Personal accountDescription: тест AccountDetails: - schemeName: RU.CBR.BBAN identification: "40817810304100012281" name: тест Owner: name: Владимир Александрович Медведев Identification: schemeName: RU.CBR.TXID identification: "799069378370" mobileNumber: "79114587744" countryOfResidence: RU cityOfBirth: Санкт-Петербург birthDate: 1963-02-25T00:00:00Z PostalAddress: addressType: Postal addressLine: - "109156, РОССИЯ, Краснодарский край, Краснодарский район, Красно\ дар, ул. Казачья, д. 46-41, 25" streetName: Казачья buildingNumber: 46/41-27 postCode: "350002" townName: Краснодар countrySubDivision: Краснодарский край country: AF Servicer: name: "АО «Альфа-Банк», г. Москва" BankIdentification: - schemeName: RU.CBR.BIC identification: "044525593" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728168971" - schemeName: RU.CBR.TAXT identification: "770801001" CorrespondentAccount: schemeName: RU.CBR.BBAN identification: "30101810200000000593" PostalAddress: addressType: Residential addressLine: - "107078, г. Москва, ул. Каланчевская, д. 27" streetName: Каланчевская buildingNumber: "27" postCode: "107078" townName: Москва country: RU Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 GetAccountResponseExample: summary: Пример ответа value: Data: Account: - accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 status: Enabled currency: RUB accountType: Personal accountDescription: Текущий счет ФЛ (НРБ) AccountDetails: - schemeName: RU.CBR.BBAN identification: "40817810704980004078" name: Имя счета 4078 Owner: name: Владимир Александрович Медведев Identification: schemeName: RU.CBR.TXID identification: "799069378370" mobileNumber: "79114587744" countryOfResidence: RU cityOfBirth: Санкт-Петербург birthDate: 1963-02-25T00:00:00Z PostalAddress: addressType: Postal addressLine: - "109156, РОССИЯ, Краснодарский край, Краснодарский район, Красно\ дар, ул. Казачья, д. 46-41, 25" streetName: Казачья buildingNumber: 46/41-27 postCode: "350002" townName: Краснодар countrySubDivision: Краснодарский край country: AF Servicer: name: "АО «Альфа-Банк», г. Москва" BankIdentification: - schemeName: RU.CBR.BIC identification: "044525593" OrganizationIdentification: - schemeName: RU.CBR.TXID identification: "7728168971" - schemeName: RU.CBR.TAXT identification: "770801001" CorrespondentAccount: schemeName: RU.CBR.BBAN identification: "30101810200000000593" PostalAddress: addressType: Residential addressLine: - "107078, г. Москва, ул. Каланчевская, д. 27" streetName: Каланчевская buildingNumber: "27" postCode: "107078" townName: Москва country: RU Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 BalancesResponseExample: summary: Пример ответа value: Data: Balance: - accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 type: ClosingAvailable Amount: amount: "240.00" currency: RUB creditDebitIndicator: Credit dateTime: 2024-08-21T08:03:49.620928445Z CreditLine: [] - accountId: 1123675f-e35a-f529-10f8-e4e4af233d9c type: ClosingAvailable Amount: amount: "16000.00" currency: RUB creditDebitIndicator: Debit dateTime: 2024-08-21T08:03:49.621057689Z CreditLine: [] - accountId: 1123675f-df00-f037-f4b9-73df2f8108dd type: ClosingAvailable Amount: amount: "0.00" currency: JPY creditDebitIndicator: Debit dateTime: 2024-08-21T08:03:49.621132752Z CreditLine: [] - accountId: 1123675f-e92f-fb78-4cfd-f5370e8d8996 type: ClosingAvailable Amount: amount: "2400.00" currency: RUB creditDebitIndicator: Debit dateTime: 2024-08-21T08:03:49.621222492Z CreditLine: [] - accountId: 1123675f-e35a-f529-10f9-2e1920dfd15f type: ClosingAvailable Amount: amount: "50.00" currency: RUB creditDebitIndicator: Debit dateTime: 2024-08-21T08:03:49.621307386Z CreditLine: [] Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 BalanceResponseExample: summary: Пример ответа value: Data: Balance: - accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 type: ClosingAvailable Amount: amount: "240.00" currency: RUB creditDebitIndicator: Credit dateTime: 2024-08-21T08:03:49.620928445Z CreditLine: [] Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 GetTransactionsResponseExample: summary: Пример ответа value: Data: Transaction: - transactionId: 1220618MOCOIBSR 00789 accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 creditDebitIndicator: Debit status: AcceptedSettlementCompleted BankTransactionCode: code: "00012" bookingDateTime: 2022-03-18T18:03:02.681Z groupId: "00012" Amount: amount: "1.00" currency: RUR - transactionId: 1220311MOCOIBSR 06371 accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 creditDebitIndicator: Debit status: AcceptedSettlementCompleted BankTransactionCode: code: "00012" bookingDateTime: 2022-03-22T14:23:35.483Z groupId: "00012" Amount: amount: "100.00" currency: RUR - transactionId: 1220310MOCOIBSR 05639 accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 creditDebitIndicator: Debit status: AcceptedSettlementCompleted BankTransactionCode: code: "00025" bookingDateTime: 2022-03-30T12:53:37.892Z groupId: "00025" Amount: amount: "1.00" currency: RUR Links: self: https://sb.example.ru/v1.3/example GetCardsResponseExample: summary: Пример ответа value: Data: PaymentCard: - accountId: 1123675f-e7ce-faca-faa4-793d09face73 paymentCardId: "129600634" paymentCardType: credit paymentCardName: Visa Gold PayWave PaymentCardData: PAN: "0596" expiryDate: 12/2028 cardStatus: blocked effectiveDate: 06/2022 cardScheme: VISA designUrl: "https://online.alfabank.ru/cards-images/cards/CZ/images?layers=BACKGROUND,LOGO,PAYMENT_SYSTEM&width=%d" - accountId: 1123675f-ec2c-f42f-b2a5-a19202b80883 paymentCardId: "129600637" paymentCardType: debit paymentCardName: MIR PaymentCardData: PAN: "0597" expiryDate: 12/2028 cardStatus: pending effectiveDate: 06/2022 cardScheme: MIR designUrl: "https://online.alfabank.ru/cards-images/cards/CZ/images?layers=BACKGROUND,LOGO,PAYMENT_SYSTEM&width=%d" - accountId: 1123675f-ec2c-f42f-b2a5-a19202b80884 paymentCardId: "129600638" paymentCardType: debit paymentCardName: MIR PaymentCardData: PAN: "0599" expiryDate: 12/2028 cardStatus: active effectiveDate: 06/2022 cardScheme: MIR designUrl: "https://online.alfabank.ru/cards-images/cards/CZ/images?layers=BACKGROUND,LOGO,PAYMENT_SYSTEM&width=%d" Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 GetCardResponseExample: summary: Пример ответа value: Data: PaymentCard: - accountId: 1123675f-e92f-fb78-4cee-5f6e93450bb5 paymentCardId: "129600634" paymentCardType: credit paymentCardName: Visa Gold PayWave PaymentCardData: PAN: "0596" expiryDate: 12/2028 cardStatus: blocked effectiveDate: 06/2022 cardScheme: VISA designUrl: "https://online.alfabank.ru/cards-images/cards/CZ/images?layers=BACKGROUND,LOGO,PAYMENT_SYSTEM&width=%d" Links: self: https://sb.example.ru/v1.3/example Meta: totalPages: 1 paymentUrlsOneTimeUseRequest: summary: Пример запроса value: client: b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c partnerId: 214 name: Ссылка для оплаты ИП Иванов И.П. payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 ttl: 4320 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 redirectUrl: null takeTax: true taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 paymentUrlsOneTimeUseResponse: summary: Пример ответа value: qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM name: Ссылка для оплаты ИП Иванов И.П. payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 qrcType: ONETIME paymentPurpose: Оплата по договору №123456789 от 01.09.2001 takeTax: true taxAmount: 200000 image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= lastPayment: null uip: 281000670LSS7DN18SJQDNP4B05KLJL2 registrationDate: 2022-01-10T12:33:25Z expirationDate: 2022-05-26T09:09:32Z paymentUrlsReusableRequest: summary: Пример запроса value: client: b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c partnerId: 214 name: Ссылка для ИП Иванов И.П. payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 redirectUrl: null takeTax: true taxAmount: 200000 paymentUrlsReusableResponse: summary: Пример ответа value: qrcId: AO1000670LSS7DN18SJQDNP4B05KLJL2 payload: https://b2b.cbrpay.ru/AO1000670LSS7DN18SJQDNP4B05KLJL2 name: Ссылка для оплаты ИП Иванов И.П. payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 qrcType: REUSABLE paymentPurpose: Оплата по договору №123456789 от 01.09.2001 takeTax: true taxAmount: 200000 image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= lastPayment: null uip: null registrationDate: 2022-05-26T09:09:32Z expirationDate: null registerPaymentUrlsRequest: summary: Пример запроса value: client: b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c partnerId: 214 paymentUrls: - name: Ссылка для оплаты ИП Иванов И.П. payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 qrcType: ONETIME ttl: 4320 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 redirectUrl: https://exampletsp.io/qwertyui takeTax: true taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 payerInn: "3664069397" getPaymentUrls: summary: Пример ответа value: pagination: limit: 10 offset: 0 totalCount: 1 paymentUrls: - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM name: Ссылка для оплаты ИП Иванов И.П. payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 qrcType: ONETIME paymentPurpose: Оплата по договору №123456789 от 01.09.2001 takeTax: true taxAmount: 200000 image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= lastPayment: amount: 1000000 taxAmount: 200000 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payerAccount: "40702810901400001130" currency: RUR timestamp: 2022-05-26T09:09:32Z payerInfo: name: OOO Ромашка inn: "3664069397" bik: "044525593" accountType: BBAN bankName: АО "АЛЬФА-БАНК" bankCorrAccount: "30101810200000000593" uip: 281000670LSS7DN18SJQDNP4B05KLJL2 registrationDate: 2022-01-10T12:33:25Z expirationDate: 2022-05-26T09:09:32Z updateStatusPaymentUrlsRequest: summary: Пример запроса value: client: b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c partnerId: 214 paymentUrls: - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM isActive: true getPaymentUrlsResponse: summary: Пример ответа value: pagination: limit: 10 offset: 0 totalCount: 1 status: COMPLETE paymentUrls: - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payload: https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM name: Ссылка для оплаты ИП Иванов И.П. payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 ttl: 4320 qrcType: ONETIME paymentPurpose: Оплата по договору №123456789 от 01.09.2001 redirectUrl: https://exampletsp.io/qwertyui takeTax: true taxAmount: 200000 image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII= uip: 281000670LSS7DN18SJQDNP4B05KLJL2 payerInn: "3664069397" registrationDate: 2022-01-10T12:33:25Z expirationDate: 2022-01-13T12:33:25Z registrationStatus: REGISTERED errorDescription: "Возникла ошибка при регистрации QR со стороны НСПК: {Т\ екст ошибки от НСПК}." getPaymentDataByQRc: summary: Пример ответа value: qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM qrcType: ONETIME legalId: LF0000000001 legalName: ООО "Кофейня у Артёма" memberId: "100000000001" brandName: Кофейня у Артёма payeeAccount: "40702810100010000001" merchantId: MF0000000001 amount: 1000000 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 address: "г. Воронеж, ул. Лисюкова, д.5, стр.1" mcc: "4122" fraudScore: "0000000000000000" inn: "4285733785" redirectUrl: https://exampletsp.io/qwertyui agentId: A00000000001 takeTax: true taxAmount: 200000 uip: 281000670LSS7DN18SJQDNP4B05KLJL2 getIncomingPayments: summary: Пример ответа value: pagination: limit: 10 offset: 0 totalCount: 1 payments: - qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 amount: 1000000 taxAmount: 200000 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 payeeAccount: "40702810901400001130" payerAccount: "40702810901400001289" currency: RUR timestamp: 2022-05-26T09:09:32Z payerInfo: name: OOO Ромашка inn: "911006876365" bik: "044525593" accountType: BBAN bankName: АО "АЛЬФА-БАНК" bankCorrAccount: "30101810200000000593" recipientInfo: name: OOO Ромашка inn: "911006876365" bik: "044525593" bankName: АО "АЛЬФА-БАНК" bankCorrAccount: "30101810200000000593" getOutgoingPaymentsResponse: summary: Пример ответа value: pagination: limit: 10 offset: 0 totalCount: 1 payments: - outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM nspkTransactionId: B467FC50C59A469A9898AB7B05EE3F07 status: COMPLETE amount: 1000000 taxAmount: 200000 currency: RUR payerAccount: "40702810901400001130" paymentPurpose: Оплата по договору №123456789 от 01.09.2001 timestamp: 2022-05-26T09:09:32Z commission: 100 payerInfo: name: OOO Ромашка inn: "911006876365" bik: "044525593" accountType: BBAN bankName: АО "АЛЬФА-БАНК" bankCorrAccount: "30101810200000000593" recipientInfo: name: OOO Ромашка inn: "911006876365" bik: "044525593" bankName: АО "АЛЬФА-БАНК" bankCorrAccount: "30101810200000000593" executeOneStepOutgoingPaymentRequest: summary: Пример запроса value: client: b2bClientId: 021be5ed-6312-4982-a4e9-2a2cc44bc88c partnerId: 214 qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM payerAccount: "40702810100010000001" amount: 1000000 paymentPurpose: Оплата по договору №123456789 от 01.09.2001 takeTax: true taxAmount: 200000 digestSignatures: - base64Encoded: HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== certificateUuid: 61000366d11e143acbc03a56d70001000366d1 signatureType: RSA poaNumber: null executeOneStepOutgoingPaymentResponse: summary: Пример ответа value: outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM status: COMPLETE commission: 100 outgoingPaymentStatusResponse: summary: Пример ответа value: outgoingPaymentId: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 qrcId: AD1000038AQ1FG409KGACUQU5QRSH3FM status: COMPLETE merchantResponse: summary: Пример ответа value: merchantId: MF0000000001 errorBadRequest: summary: Ошибка value: detail: Некоторые обязательные поля отсутствуют или имеют неверный формат instance: /path status: 400 title: Неверные параметры запроса type: BAD_REQUEST errorBadCredentials: summary: Ошибка value: detail: "Неверные логин или пароль, либо устаревший токен" instance: /path status: 401 title: Ошибка аутентификации type: BAD_CREDENTIALS authorizationException: summary: Ошибка value: detail: У пользователя недостаточно прав для выполнения операции instance: /path status: 403 title: Доступ запрещён type: AUTHORIZATION_EXCEPTION notFoundException: summary: Ошибка value: detail: Указанный объект не существует instance: /path status: 404 title: Ресурс не найден type: NOT_FOUND tooManyRequestsException: summary: Ошибка value: detail: Превышено количество запросов за заданный интервал времени instance: /path status: 429 title: Слишком много запросов type: TOO_MANY_REQUESTS internalServerErrorException: summary: Ошибка value: detail: При обработке запроса произошла непредвиденная ошибка instance: /path status: 500 title: Внутренняя ошибка сервера type: INTERNAL_SERVER_ERROR timeoutException: summary: Ошибка value: detail: Попробуйте выполнить запрос позже instance: /path status: 503 title: Сервис временно недоступен type: "-" PaymentsSearchBody: summary: Пример запроса на поиск платежей по qr кодам value: qrIds: - EX1B006EL9Q5HUTK9VR9PHM322T2ALQN paymentInfo: summary: Пример ответа value: - account: 40702810601990021865 amount: 1000 currency: RUB operationDate: 2019-08-24T14:15:22Z paymentId: a40e0714-c5c2-476b-a444-3578edfcbc2a paymentStatus: IN_PROGRESS qrId: EX1B006EL9Q5HUTK9VR9PHM322T2ALQN ReusableLinkBody: summary: Пример запроса многоразовой ссылки value: account: 40702810601990021865 amount: 1000 currency: RUB merchantId: MF0000000001 paymentPurpose: 1C test payment link redirectUrl: http://example.ru takeTax: true totalTaxAmount: 100 oneTimeLinkBody: summary: Пример запроса одноразовой ссылки value: account: 40702810601990021865 amount: 1000 currency: RUB merchantId: MF0000000001 orderId: a00e000-c0c0-006b-a000-3008etrsbc2a paymentPurpose: 1C test payment link qrTtl: 1000 redirectUrl: http://example.ru takeTax: true totalTaxAmount: 100 uip: uniqueId getPhonePaymentReportResponse: summary: Пример ответа value: client: b2cClientId: 6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4 partnerId: 214 payments: - account: "40702810401300003178" inn: "0352417325" transactionId: "3389" sequence: azapov100-frod-1 payPackage: "5592" nspkTransactionId: A3137112354541010000050011000101 nspkBankName: ПИР Банк nspkName: last: Иванов first: Иван middle: Иванович nameCheck: true name: last: Иванов first: Иван middle: Иванович eqTrnId: C31170523000000X orderInfo: number: "51" date: 2023-08-09T15:18:36.556Z recipientAccount: "40817495834383110206" recipientBic: "044525491" phone: "0079086010338" amount: 10007.03 feeAccount: "40702810701300003179" feeAmount: 1.05 createDate: 2023-05-17T14:22:40.974Z modifyDate: 2023-05-17T14:24:58.078Z nspkStatus: ACWP addPhonePaymentRequest: summary: Пример запроса value: signedBody: CORRECT_SIGNED_BODY client: b2cClientId: 6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4 partnerId: 214 inn: "0352417325" account: "40702810401300003178" total: 10007.03 nameCheck: true payments: - name: last: Иванов first: Иван middle: Иванович amount: 100.53 nspkBankId: 1crt88888881 phone: "0079086010338" sequence: azapov100-frod-1 paymentDescription: "{AZAPOV44110} azapov22 (AZ114455)" ric: 1 addPhonePaymentResponse: summary: Пример ответа value: client: b2cClientId: 6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4 partnerId: 214 payPackage: "5593" payments: - nameCheck: true name: last: Иванов first: Иван middle: Иванович amount: 10007.03 feeAmount: 1.05 transactionId: "3390" phone: "0079086010338" sequence: azapov100-frod-1 createDate: 2023-05-18T08:21:00.520824Z paymentDescription: "Перевод СБП.{AZAPOV44110} azapov22 (AZ114455)" ric: 1 addPhonePaymentCheckRequest: summary: Пример запроса value: client: b2cClientId: 6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4 partnerId: 214 nameCheck: true payments: - amount: 10007.03 nspkBankId: 1crt88888881 phone: "0079056010339" name: last: Иванов first: Иван middle: Иванович addPhonePaymentCheckResponse: summary: Пример ответа value: client: b2cClientId: 6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4 partnerId: 214 checkId: "305" getPhonePaymentCheckStatusResponse: summary: Пример ответа value: client: b2cClientId: 6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4 partnerId: 214 payments: - amount: 10007.03 nspkBankId: 1crt88888881 nspkName: last: Иванов first: Иван middle: Иванович nameCheck: true name: last: Иванов first: Иван middle: Иванович phone: "0079056010339" status: ALLOWED getBanksResponse: summary: Пример ответа value: - bankId: "100000000001" bankName: Газпромбанк getClientInnResponse: summary: Пример ответа value: client: b2cClientId: 6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4 partnerId: 214 inn: "0283988847" successCreditOffersGet: summary: Список кредитных предложений value: offers: - id: "70001101781" title: Кредит на любые цели webViewUrl: https://alfabank.ru/mobile-offers/web/.../?isWebView=true&fromCurrent=true creditProduct: creditInfo: rate: 9.99 period: 12 cardInfo: gracePeriod: 13 limit: 2.576E8 currency: RUR GetStatisOrDynamicQRc: summary: Пример запроса value: termNo: "30000600" amount: 10000 currency: RUR qrcType: "02" ttl: 10 queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status subscriptionPurpose: Подписка на оплату интернета 500р./мес. redirectUrl: https://exampletsp.io/qwertyui GetQRcResponse: summary: Пример запроса value: termNo: "30000600" payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAAQA/w…...YII payrrn: "000000020512" qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 status: CREATED GetQRcStatusResponse: summary: Пример запроса value: creditDatePos: 2022-12-19 termNo: "30000600" amount: 10000 currency: RUR payrrn: "000000020512" qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 status: ACWP trxId: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 trxDT: 2022-12-19T07:40:28Z GetQRcSubscriptionRequest: summary: Пример запроса value: termNo: "30000600" subscriptionPurpose: Подписка на оплату интернета 500р./мес. ttl: 4320 queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status redirectUrl: https://exampletsp.io/qwertyui GetQRcSubscriptionResponse: summary: Пример запроса value: qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B payrrn: "000000020512" PaymentFromBindedAccountRequest: summary: Пример запроса value: termNo: "30000600" amount: 10000 currency: RUR paymentPurpose: Назначение платежа ttl: 4320 queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status redirectUrl: https://exampletsp.io/qwertyui subscriptionToken: 70LSS7DN18SJQRS10006DNPKLJL24B05 senderMemberId: "100000000001" messageId: 123Rersal_Num567 PaymentFromBindedAccountResponse: summary: Пример запроса value: termNo: "30000600" payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B image: iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAAQA/w…...YII payrrn: "000000020512" qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 QRcRefundRequest: summary: Пример запроса value: termNo: "30000600" payrrn: "000000020512" qrcId: AD100074066RHM939FE9OQKR0TQ63HB6 originalTrxId: A003610425360300b4ubOp6511E4F998 originalTrxDT: 2022-12-19T07:40:28Z amount: 10000 currency: RUR queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status messageId: 123Rersal_Num567 QRcRefundResponse: summary: Пример запроса value: termNo: "30000600" amount: 10000 currency: RUR payrrn: "000000020512" trxId: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 trxDT: 2022-12-19T07:40:28Z messageId: 123Rersal_Num567 GetQRcRefundStatusResponse: summary: Пример запроса value: termNo: "30000600" batchId: "1738" amount: "10000" url: http://10.8.18.33:9017/sbp-payment/agent/status originalQRcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 originalTrxId: X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2 payerId: '*******5526' status: ACWP trxId: 1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2 trxDT: 2020-07-28T11:45:31Z CashQRcsRegistrationRequest: summary: Пример запроса value: mediaType: image/png width: "200" height: "200" redirectUrl: https://exampletsp.io/qwertyui qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 CashQRcsRegistrationResponse: summary: Пример запроса value: termNo: "30000600" qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 payload: https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=100739&cur=RUB&crc=C08B status: CREATED image: mediaType: image/png content: iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAArvElEQVR4Xu2d/bOvVXne/ /B2Pwbvw1OqlrAAAAAElFTkSuQmCC CashQRcsActivationRequest: summary: Пример запроса value: amount: 10000 currency: RUR paymentPurpose: "Капучино 300 мл 1 шт., булочка 1 шт." ttl: 5 queryData: notificationUrl: http://10.8.18.33:9017/sbp-payment/agent/status CashQRcsActivationResponse: summary: Пример запроса value: termNo: "30000600" paramsId: AP5GK3L276DN8PDR8ON1LF4RVOL44444 qrcId: AS1000670LSS7DN18SJQDNP4B05KLJL2 amount: 10000 currency: RUR paymentPurpose: "Капучино 300 мл 1 шт., булочка 1 шт." payrrn: "000000020512" Request: summary: Пример запроса value: applicationId: 7421w6f13a01983593e8dffb71fa6d15 applicationCreatedAt: 2000-01-23T04:56:07.000+00:00 registryNumber: "1" registryCreatedAt: 2000-01-23T04:56:07.000+00:00 currency: RUR contractNumber: 005V4Z bic: "044525593" rowsCount: "1" organization: fullname: Общество с ограниченной ответственностью Тест Альфа-Линк ЗУП country: RU address: Москва inn: "0178827953" accountNumber: "40702810200000000083" employees: - npp: "1" lastName: Григорьев firstName: Вениамин middleName: Федосьевич bankBranchCode: "0000" bankBranchOfficeCode: "0000" birthDate: 1993-02-21 sex: M position: Бухгалтер salaryCurrencyCode: "643" resident: "true" citizenship: РОССИЯ populationCategory: "207" mobilePhone: "9054823041" mobileBank: "2" bkiSharingAllowed: "false" personnelNumber: 0000-00114 employmentDate: 2022-04-05 salaryAmount: "30000" paymentDate: 2022-01-05 contactPhone: "79054823041" cardInfo: type: VISA currencyCode: "643" embossedText: firstName: V lastName: GRIGOREV salutation: MR salaryType: "0" identityDocument: typeName: Паспорт гражданина РФ typeCode: "21" series: 79 96 number: "380515" issueDate: 2013-04-19 issuerName: ТП УФМС РОССИИ ПО Г МОСКВА В ОДЕССКОМ РАЙОНЕ issuerCode: 550-025 birthPlace: regionFull: Москва regionShort: МСК districtFull: Москва districtShort: МСК cityFull: Москва cityShort: МСК locationFull: Москва locationShort: МСК GetClientSubscriptions: summary: Список подписок клиента value: - serviceCode: RISK_EVENT state: DISABLED activatedAt: 2024-09-17T13:54:37.789+03:00 nextFeeAt: null disabledAt: 2024-10-01 clientDisabledAt: 2024-09-17 extendedState: REPLACED - serviceCode: RISK_EVENT state: ACTIVE activatedAt: 2024-09-17T13:55:20.506+03:00 nextFeeAt: 2024-11-01 disabledAt: null clientDisabledAt: null extendedState: ACTIVE ErrorScope: summary: "У пользователя нет прав на использование запрашиваемого сервиса, д\ оступ к которому не предусмотрен настройками scope" value: error: insufficient_scope error_description: The request requires higher privileges than provided by the access token NotEnoughRightsForOperation: summary: У пользователя нет прав на операцию value: error: permission_error error_description: User doesn't have enough rights DeliveryPageResponseExample: summary: Пример DeliveryPageResponse value: pagination: offset: 10 limit: 5 totalCount: 4901 items: - externalId: bf1d1b2f-9ebe-4bf1-8b8f-6f6f6f6f6f6f productCode: CC smartRepeated: false productionTypeCode: Неименная creationDate: 2025-01-01T00:00:00Z deliveryDate: 2025-01-15T00:00:00Z slotFrom: 10:00 slotTo: 12:00 statusCode: В работе clientFio: Иванов И. И. regionName: Москва cityName: Москва deliveryAddress: Ленина 45 courierFio: Иванов И. И. viewCard: MIR Classic PW Ins clientSES: false comment: Комментарий brokerageAccountRequired: false processType: Детский банк. ИА Родитель + Ребёнок documents: - Паспорт ComplianceResponse: summary: Результат прохождения проверки клиентом value: result: true StatusResponse: summary: Статус проверяемого документа value: status: RECEIVED CreatePaymentRequest: summary: Запрос для сохранения платежного поручения value: externalId: 0521cc44-ae0f-4e73-9b16-a1630d50e444 principalInfo: name: ООО Виктория inn: "7707083893" kpp: "773601001" creditorInfo: name: ООО Кредитор inn: "7707083893" kpp: "773601001" ogrn: "1027700132195" bankName: Банк Пример bankBIC: "044525225" bankCorrAccountNumber: "30101810400000000225" accountNumber: "40702810500000000001" orderType: BUDGET compensationPeriod: "365" paymentPurpose: Оплата за услуги currencyCode: RUB monetaryClaimAmount: 150077.88 monetaryClaimId: claim-123 contractNumber: "12345" contractDate: 2023-05-10 fixedRatePercentage: 5.5 floatRatePercentage: 1.25 paymentPriority: "5" payerStatus: "101" accrualUniqueId: 22-1234567890 taxPaymentCode: "106" taxPeriod: "2021" baseDocumentType: Счет baseDocumentDate: 2023-04-01 kbk: "18210102010011000110" oktmo: "45384000" SavePaymentResponse: summary: Ответ на сохранение платежного поручения value: externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479 paymentId: h7d6c70b-5d5c-4542-n207-4g83bj45u579 CreateRegisterRequest: summary: Запрос для создания реестра платежных поручений value: totalSum: 100000.01 plannedExecutionDate: 2024-02-15 paymentIds: - 24970b11-0bc0-43ab-8087-a8f3d0fe91cf - h7d6c70b-5d5c-4542-n207-4g83bj45u579 SaveRegisterResponse: summary: Ответ на сохранение реестра платежных поручений value: id: 76ec6909-dacd-47af-a71d-9db02a3679a7 file: SGVsbG8sIFdvcmxkIQ== registerNumber: 13791 SignRegisterRequest: summary: Запрос для подписания реестра платежных поручений value: registerId: 76ec6909-dacd-47af-a71d-9db02a3679a7 digestSignatures: base64Encoded: SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA= certificateUuid: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 SignRegisterResponse: summary: Ответ на подписание реестра платежных поручений value: message: The registry has been successfully signed and sent for funding UpdateOrderResponse: summary: Пример ответа при изменение информации о статусе заказа value: quantity: 0 orderId: ST1057RQKDD partnerName: ST status: L CreateOrderResponse: summary: Пример ответа при создании заказа на списание лимитов value: quantity: 5 orderId: ST1057RQUDD partnerName: ST createdAt: 2024-01-11T23:19:09.224 GetBalanceResponse: summary: Пример ответа при получении доступных лимитов клиента value: customerSP: A1 quantity: 10 CreateLoungeReportRequest: summary: "Пример входящего CreateLoungeReportRequest при передачи факта посе\ щения БЗ, vip-lounge, пользование услугой fasttrack" value: id: 35105768-d48e-48cd-8894-71be35692ff8 alfaData: userId: 35105768-d48e-48cd-8894-71be35692ff8 orderId: ST00000001 count: request: 4 adult: 2 child: 1 baby: 1 category: BUSINESS_LOUNGE usingArea: ALFA requestDateTime: 2025-01-01T18:00:00.000Z eventDateTime: 2025-01-01T18:00:00.000Z service: id: 35105768-d48e-48cd-8894-71be35692ff9 name: VIP Lounge Service transportHub: Sheremetyevo International Airport country: Russia type: GENERAL travelType: INTERNATIONAL price: total: 50000 adult: 30000 child: 15000 baby: 5000 transactionType: FREE eventStatus: CREATED LoungeReportResponse: value: createdId: 678f435884171b4548c8b59c getInitialPlacementListResponse: summary: Пример ответа value: pagination: limit: 10 offset: 0 totalCount: 1 items: - title: АЛЬФА-БАНК subtitle: Структурная облигация description: Участие от 10 000Р icon: https://testdfa.alfabank.ru:9010/dfa/icons/750ad7ea-3158-4966-afab-643ae3f8cd7f background: '#36363A' placementLink: https://testdfa.alfabank.ru/retail-investor/webview/dfa/BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP buyPlacementLink: https://testdfa.alfabank.ru/retail-investor/webview/dfa/buy?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP buyPlacementOneLink: https://test-alfa-mobile.alfabank.ru/mobile/goto/dfa_id_buy_dc?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP placementOneLink: https://testdfa.alfabank.ru/mobile/goto/dfa_webview_with_two_parameters?dfaId=BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaId: BpYrHah7gVmAMHH36Sg3znwCzwYfW4vrXmEtwhJhsqLP dfaName: ALFB-1-SB-082023-00001 dfaType: MONEY_CLAIM dfaQualificationPersonRequirements: ALL dfaQualificationCompanyRequirements: ALL dfaBankAccount: "47422810800000000000" companyIssuerId: 8rJg73mcacMn5p6Fmpsre1Jk3rwU4yz7UzDpFfGyShH4 companyIssuerName: АО Вольт companyIssuerOgrn: "1130731080666" companyIssuerAddress: Октябрьская улица 123 д. 18 companyIssuerEmail: volt@mail.ru companyIssuerSite: volt.ru companyIssuerInn: "514564365" dfaParValue: 100000 dfaCurrency: RUB dfaRestriction: true dfaRestrictionValue: 44650800 dfaRateType: FIXED dfaRateAmount: "13.2" dfaNpdPaymentPeriod: EOP dfaNpdPaymentPeriodComment: комментарий dfaNpdAccrualPeriod: EOP dfaNpdAccrualPeriodComment: комментарий dfaDebtAccrualPeriod: EOP dfaDebtAccrualPeriodComment: комментарий dfaDebtPaymentPeriod: EOP dfaDebtPaymentPeriodComment: комментарий dfaRedemptionDate: 2027-08-18 status: PRESALE statusDate: 2023-08-03T14:17:51.525Z dfaMinValue: 1000000 dfaMaxValue: 1000000 dfaMinNumber: 1 dfaMaxNumber: 7 dfaRateRangeEnable: true dfaMinRate: 5.7 dfaMaxRate: 15.3 dfaStartDate: 2023-02-01T00:00:00Z dfaEndDate: 2023-02-01T00:00:00Z dfaSaleEndDate: 2023-08-03T14:17:51.525Z dfaDocIconName: sample.jpg dfaDocIconKey: /dfa/icons/d82ffa63-bda0-4e56-92e7-522829a721ba dfaDocConditionsName: Презентация.pdf dfaDocConditionsKey: docs/15cc2bfd-48bc-484b-97f1-c8913cc5372d dfaDocPresentationKey: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 dfaDocPresentationName: Презентация.pdf dfaReleaseDecisionKey: docs/5f5537b4-d633-4c1b-8e9f-4d3406162246 dfaReleaseDecisionName: Презентация.pdf dfaInvestorFee: 1.1 dfaSecondaryBuyerFee: 1.2 dfaSecondarySellerFee: 1.3 tokensaleHardcap: true availableOnSecondaryMarket: true dfaPriceStep: 100 dfaBorrowerName: Иванов Иван Иванович dfaBorrowerInn: "369930244602" dfaBorrowerOgrn: "6131238182674" dfaLoanNumber: "654321" dfaLoanAmount: Отсутствует dfaLoanRateType: FIXED dfaLoanRate: 10.6 dfaLoanStartDate: 2023-08-03T14:17:51.525Z dfaLoanEndDate: 2023-08-03T14:17:51.525Z dfaMinBuyPrice: 100000 dfaMaxBuyPrice: 1000000 dfaMinSellPrice: 50000 dfaMaxSellPrice: 500000 profitOnDfa: 0 contractVersion: 53 exchangeContractVersion: 54 creationDate: 2023-08-03T14:17:51.525Z dfaTotalAmount: 10000 dfaIssuerFee: 3.0 dfaHybridSelectedTypes: - CASH dfaHybridPaymentDeadline: В рублях в течение 3-х рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА dfaHybridAssetDeadline: В течение 10 рабочих дней с момента направления Эмитенту Заявки на погашение ЦФА dfaHybridAssetAddress: г. Москва dfaSecondaryQualificationPersonRequirements: QUALIFIED_ONLY dfaSecondaryQualificationCompanyRequirements: QUALIFIED_ONLY dfaHardcapEnd: 15 dfaSecondaryStartDate: 2023-08-03T14:17:51.525Z dfaAvailableForIssuer: true redemptionRule: BY_AMORTIZATION dfaProductVariety: Наименование типа продукта для покупателя dfaSubType: Структурная облигация dfaPrettyName: Лабиринт dfaExtraInfoList: 1 ЦФА = 1 кв.м dfaLifeTime: "10000" refAsset: name: Структурная облигация blocks: - name: external isRequired: true visibility: - COMPANY - PERSON parameters: - name: title value: Альфа Банк isRequired: true visibility: - COMPANY - PERSON - name: subtitle value: Структурная облигация isRequired: true visibility: - COMPANY - PERSON - name: salesPoints isRequired: false visibility: - COMPANY - PERSON parameters: - name: title_1 value: Высокая доходность isRequired: false visibility: - COMPANY - PERSON - name: description_1 value: Высокая доходность при отсутствии резко-негативных колебаний цен на базовые активы isRequired: false visibility: - COMPANY - PERSON - name: icon_1 value: profit1Icon isRequired: false visibility: - COMPANY - PERSON dfaDocs: - order: 1 preferences: id: 0ec417b6-6e4a-4a20-9abf-0fa861914cfe name: Презентация isRequired: false visibility: - COMPANY - PERSON formats: - PDF - PNG description: Презентация выпуска singleFile: false noDuplicates: false files: - id: 3f39cde3-76c2-4bdb-b2da-ef3f8491fcc1 name: Презентация.pdf url: https://testdfa.alfabank.ru:9010/dfa/docs/62979838-de96-41dd-a47a-91c74c97ecf2 key: docs/55ac2445-19fc-44d5-94c8-764a827764ba responseGetCertificates: summary: Пример ответа на получение всех сертификатов value: - id: 9610bc6b-f06b-41b6-bae9-6bb5b06a54dd clientId: 4aa56f35-abb1-4ebe-9697-389cca4a4475 ownerName: Кудрявцев Ермолай Игоревич fingerprint: 333773d77ef05aa9f7b7bae8e2779418b2aedb6a organizationName: ООО 'Ромашка' beginDateTime: 2023-07-28T15:11:14Z expireDateTime: 2025-06-19T11:48:06Z status: ACTIVE certificateBody: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= type: ENCRYPTION algorithm: RS256 serialNumber: "2163173489423972678179275487230070851350268586" requestAddCertificate: summary: Пример запроса на добавление сертификата value: certificateBody: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= type: ENCRYPTION responseAddCertificate: summary: Пример ответа на добваление сертификата value: id: 9610bc6b-f06b-41b6-bae9-6bb5b06a54dd clientId: 4aa56f35-abb1-4ebe-9697-389cca4a4475 ownerName: Кудрявцев Ермолай Игоревич fingerprint: 333773d77ef05aa9f7b7bae8e2779418b2aedb6a organizationName: ООО 'Ромашка' beginDateTime: 2023-07-28T15:11:14Z expireDateTime: 2025-06-19T11:48:06Z status: ACTIVE certificateBody: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= type: ENCRYPTION algorithm: RS256 serialNumber: "2163173489423972678179275487230070851350268586" requestChangeCertificate: summary: Пример запроса на обновление сертификата value: op: replace path: /status value: ACTIVE responseChangeCertificate: summary: Пример ответа на обновление сертификата value: id: 9610bc6b-f06b-41b6-bae9-6bb5b06a54dd clientId: 4aa56f35-abb1-4ebe-9697-389cca4a4475 ownerName: Кудрявцев Ермолай Игоревич fingerprint: 333773d77ef05aa9f7b7bae8e2779418b2aedb6a organizationName: ООО 'Ромашка' beginDateTime: 2023-07-28T15:11:14Z expireDateTime: 2025-06-19T11:48:06Z status: ACTIVE certificateBody: MIIGATCCBLWgAwIBAgITYQADiqqgHk1/OTmNhAABAAOKqjBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUAwWzELMAkGA1UEBhMCUlUxEjAQBgNVBAoTCUFsZmEtQmFuazELMAkGA1UECxMCSVQxKzApBgNVBAMTIkFsZmEtQmFuayBJc3N1aW5nIFN1Ym9yZGluYXRlIENBIDEwHhcNMjMwNzI4MTUxMTE0WhcNMjUwNjE5MTE0ODA2WjCBpzEXMBUGA1UEKgwO0JXRgNC80L7Qu9Cw0LkxGzAZBgNVBAQMEtCa0YPQtNGA0Y/QstGG0LXQsjELMAkGA1UEBhMCUlUxOzA5BgNVBAMMMtCa0YPQtNGA0Y/QstGG0LXQsiDQldGA0LzQvtC70LDQuSDQmNCz0L7RgNC10LLQuNGHMSUwIwYJKoZIhvcNAQkBFhZVc2VyNTA0QHBvY2h0b2Noa2EuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ZM3Ztf+Ro4e64R8yI4qDV/zLdJjUCx5WNBx6gcp1pJ4uhQixw+ASy4Oxu0Xp7OxmpXtvDJFi4kr6QymtzMNYqJA3GZk85p+Iobkwo5zHKyBf0tX5HwmFWjJx9CqZKp8iZAFw9nqz1uqronxyzTgULPL6eE9igVSzaVf5msV8sXXfl87guVHF+Ph18hsdng1WiCJ7Mi14ETdI9O0R5eJiPZztLIHRnXuBtB1Oa1YiiWtvkZNnpLKONwxljdTZlH7h7KfaXUwW3kX8r0p7jvO7gNhMXvOSK1JPXWevmBHrjONVlG2atWoxT2IHs2ZDz+BLxgSwLc9NIQK+qKhIMfA1wIDAQABo4ICBzCCAgMwJQYDVR0RBB4wHIILZXhhbXBsZS5jb22CDSouZXhhbXBsZS5jb20wHQYDVR0OBBYEFGbczU3B6IZhHwKsC8ODg8r4xi3nMB8GA1UdIwQYMBaAFMkXMx6bqZSglhhLbnFMgdvpc/5lMIG7BgNVHR8EgbMwgbAwga2ggaqggaeGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybIYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3JshjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNybDCB2wYIKwYBBQUHAQEEgc4wgcswRQYIKwYBBQUHMAKGOWh0dHBzOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDA8BggrBgEFBQcwAoYwaHR0cDovL3Zsa3dzNjo5MDgxL2Rpc3RycG9pbnQvQWxmYS1CYW5rX1NDQTEuY3J0MEQGCCsGAQUFBzAChjhodHRwOi8vdGVzdGptYi5hbGZhYmFuay5ydS9kaXN0cnBvaW50L0FsZmEtQmFua19TQ0ExLmNydDBBBgkqhkiG9w0BAQowNKAPMA0GCWCGSAFlAwQCAwUAoRwwGgYJKoZIhvcNAQEIMA0GCWCGSAFlAwQCAwUAogMCAUADggEBAHTjDmxldqWkRgpT5gXKuIzyqIHjlDZMMfahcWBxqWV9XC46bcPx8gvlpzb8N+oK+X6AqDt3+vneAiGQn8iNs9ajDKtes9ulZzMUJBwzwv26DsiI3s4/0phypAcqQVHJQxvU+rdrh5FgqJcNZsuOtOaJhiO/i/3J7hoL/oxVwSk+lX4m+X5u76/Vdqk9ydKXNNnzMi12F4FvD+igTrezzLjPHQRx5vLY0cWwLEdBxLJmBwd1u7EBT3j+v9Pyh0pTzXsJC0BY1BIt6VOh6QGKGTKT3cBB6zbIOrY7UTOkYdCqtyB9vhayAyti3aO37PANUQ7dUwUEZyf64/D4/HRlhqI= type: ENCRYPTION algorithm: RS256 serialNumber: "2163173489423972678179275487230070851350268586" claims-resolved: summary: Пример запроса для передачи обработанных обращений value: resolutionDate: 2025-06-26T09:09:32+03 resolution: POSITIVE orderId: Ad-2b47 clientReply: "Заказ был частично возвращен, поэтому начисление кэшбэка отм\ енено" employeeReply: По частично возвращаенным заказам кэшбэк не начисляется CreateOrderTravelRequest: summary: Пример запроса на создание заказа Travel value: order: externalId: AVIA-78901 accountType: Мили ruleId: 12 type: AVIA dateTime: 2023-10-05T14:30:00.000Z totalSum: 25410.5 bonusPayment: - type: 0 sumRubEquivalent: 5000 sum: 10000 comment: Оплата милями cashPayment: - type: Оплата картой sum: 20410.5 currency: RUB content: reservationSource: WEBVIEW tripType: OW segments: - class: A type: REGULAR number: SU-123 supplier: Aeroflot departure: city: MOW country: RUS point: SVO dateTime: 2023-11-20T08:00:00.000Z arrival: city: IST country: TUR point: IST dateTime: 2023-11-20T11:30:00.000Z travelers: adults: 2 children: 1 infants: 0 reportData: bookingType: GDS startPrice: 20000.0 markup: 5410.5 SuccessResponseCreateOrder: summary: Пример ответа на создание заказа value: orderId: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: Created SuccessResponseAlreadyOrder: summary: Пример ответа заказ уже создан value: orderId: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: Order already exists CreateOrderAfishaRequest: summary: Пример запроса на создание заказа Afisha value: order: externalId: AFISHA-789 accountType: Бонусные рубли type: EVENT dateTime: 2023-12-15T19:00:00.000Z totalSum: 2500.5 content: eventName: Концерт группы 'Кино' eventId: KINO-2023 venue: Крокус Сити Холл country: RUS city: MOW date: 2023-12-20T20:00:00.000Z address: "г. Москва, 66-й км МКАД" tickets: - sector: A row: "5" seat: "12" - sector: A row: "5" seat: "13" UpdateOrderTravelRequest: summary: Пример запроса на обновление заказа Travel value: order: externalId: TRAVEL-456 type: AVIA dateTime: 2023-11-10T15:30:00.000Z totalSum: 35000.75 changeReason: CHANGE_TIMETABLE content: reservationSource: SITE segments: - departure: city: MOW country: RUS point: SVO dateTime: 2023-12-01T10:00:00.000Z arrival: city: IST country: TUR point: IST dateTime: 2023-12-01T14:30:00.000Z ConfirmationRequest: summary: Пример запроса на подтверждение заказа value: comment: Подтверждаю оплату милями paymentTransaction: - sum: 15000 currency: RUB maskedCardNumber: 123456******7890 rrn: "1498745362575217925125545565" dateTime: 2023-10-05T14:30:00.000Z SuccessResponseConfirmationOrder: summary: Пример ответа на подтверждение заказа value: orderId: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: Confirmed SuccessConfirmAlreadyOrder: summary: Пример ответа подтвержденного заказа value: orderId: 40b3c2d2-e491-4b19-94cd-461e6fa35a60 status: Order already confirmed PatchDeactivateRequest: summary: Пример запроса на деактивацию заказа value: accountType: Мили sumRubEquivalent: 10000 sum: 5000 comment: Добровольный возврат SuccessResponseBonus: summary: Пример ответа на создание заказа value: - typeName: AlfaTravel balance: 189594 unitName: Мили createRegistryRequest: summary: Пример запроса value: registryId: "039012000001000" expirationDate: 2025-08-05T11:00:00+03:00 admPid: "00330456" clientStoreCode: ShopCode001 paymentAgentInf: accountNumber: "40821810801850000018" selfEncashmentAmount: "100.00" bankPaymentAgentInf: accountNumber: "40821810501850000004" selfEncashmentAmount: "100.00" clientInf: accountNumber: "40702810701850008187" selfEncashmentAmount: "100.00" email: client@example.com cancelRegistriesRequest: summary: Пример запроса value: registryIds: - "039012000001000" - "039012000001001" getAdmResponse: summary: Пример ответа value: pagination: limit: 10 offset: 0 totalCount: 2 items: - admPid: "00330456" status: 1 statusDescription: Устройство полностью работоспособно admSoftwareVersion: 2.1.8 billValidatorSoftwareVersion: 1.0.4 - admPid: "00349012" status: 1 statusDescription: Устройство полностью работоспособно admSoftwareVersion: 2.1.8 billValidatorSoftwareVersion: 1.0.4 create_individual_example: value: city: cityId: 1 regionId: 77 presenceCityTitle: Москва agreement: true contactInfo: lastName: Петров firstName: Иван middleName: Сергеевич phone: "79005553322" email: ivan.petrov@example.ru create_llc_example: value: city: cityId: 2 regionId: 78 presenceCityTitle: Санкт-Петербург agreement: true contactInfo: lastName: Петров firstName: Пётр middleName: Петрович phone: "79001234567" email: p.petrov@example.ru clientName: - language: RU full: Общество с ограниченной ответственностью «Альфа Технологии» short: ООО «Альфа Технологии» - language: EN full: Alpha Technologies LLC short: AlphaTech getComplianceScoreResponse: summary: Пример ответа value: inn: "1234567890" rawScore: 0 riskLevel: medium boundaries: low: 0.6 high: 0.9 headers: x-fapi-interaction-id: description: "RFC4122 UID, используемый в качестве идентификатора корреляции\ . Если необходимо, то Сторонний поставщик передает обратно значение иденти\ фикатора корреляции в заголовке ответа x-fapi-interaction-id." required: true schema: type: string description: "Универсальный уникальный идентификатор (UUID) версии 4, в со\ ответствии с IETC RFC 4122 \"Universally Unique IDentifier (UUID) URN Namespace\"\ ." format: uuid example: 97ed4827-7b6f-4491-a06f-b548d5a7512d securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT