openapi: 3.0.1
info:
  title: СБП API для Участников Системы Казначейских Платежей(СКП)
  description: |
    Описание API произведено в формате **OpenAPI 3.0.1**.
    Документ описывает взаимодействие Федерального Казначейства с Участниками Системы Казначейских Платежей(СКП) в части генерации Функциональных ссылок и других операций для приема казначейских платежей через систему СБП.
    
  version: '1.0.14'
  x-logo:
    url: sbplogo.png
    backgroundColor: '#1B1537'
    altText: SBP logo
servers:
  - url: /
tags:
  - name: PaymentAPI
    description: |
      Методы API для работы с Функциональными Ссылками
    x-displayName: Управление Функциональными Ссылками
  - name: MerchantNotification
    description: |
      Вызовы, отправляемые в адрес Участника СКП. В случае реализации данных методов API на стороне Участника СКП, ФК будет направлять уведомления такому Участнику СКП.
    x-displayName: Уведомления для Участника СКП

paths:
  /sbp/budget/v1/qrc-data-template:
    post:
      tags:
        - PaymentAPI
      summary: Регистрация Функциональной ссылки СБП по шаблону платежа
      operationId: createQrcViaTemplate
      security:
        - oAuth2ClientCredentials: []
      parameters:      
        - name: mediaType
          in: query
          description: Опциональный тип QR-картинки
          required: false
          schema:
            type: string
            enum:
              - image/png
              - image/svg+xml
        - name: width
          in: query
          description: Ширина изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
        - name: height
          in: query
          description: Высота изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BudgetPaymentLinkDataViaTemplate'
        required: true
      responses:
        '201':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RM05001"
                message: "Нарушена структура запроса"
                data: {}
        '401':
          description: Ошибка доступа
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RQT0000"
                message: "Ошибка валидации токена доступа"
                data: {}
  /sbp/budget/v1/qrc-data:
    post:
      tags:
        - PaymentAPI
      summary: Регистрация Функциональной ссылки СБП
      operationId: createQrc
      security:
        - oAuth2ClientCredentials: []
      parameters:      
        - name: mediaType
          in: query
          description: Опциональный тип QR-картинки
          required: false
          schema:
            type: string
            enum:
              - image/png
              - image/svg+xml
        - name: width
          in: query
          description: Ширина изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
        - name: height
          in: query
          description: Высота изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BudgetPaymentLinkDataDto'
        required: true
      responses:
        '201':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RM05001"
                message: "Нарушена структура запроса"
                data: {}
        '401':
          description: Ошибка доступа
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RQT0000"
                message: "Ошибка валидации токена доступа"
                data: {}
  /sbp/budget/v1/qrc-data/{qrcId}/image:
    get:
      tags:
        - PaymentAPI
      summary: Запрос изображения для ранее зарегистрированной Функциональной ссылки
      operationId: getQrcImage
      security:
        - oAuth2ClientCredentials: []
      parameters:
        - name: qrcId
          in: path
          description: Идентификатор Функциональной ссылки
          required: true
          schema:
            maxLength: 32
            minLength: 32
            type: string
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - image/png
              - image/svg+xml
            default: image/png
        - name: width
          in: query
          description: Ширина изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
        - name: height
          in: query
          description: Высота изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
      responses:
        '200':
          description: Операция успешно выполнена
          content:
            image/png:
              schema:
                type: string
            image/svg+xml:
              schema:
                type: string
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RM05001"
                message: "Нарушена структура запроса"
                data: {}
        '401':
          description: Ошибка доступа
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RQT0000"
                message: "Ошибка валидации токена доступа"
                data: {}
  /sbp/budget/v1/qrc-data/{qrcId}/payload:
    get:
      tags:
        - PaymentAPI
      summary: Запрос payload для ранее зарегистрированной Функциональной ссылки СБП
      operationId: getQrcPayload
      security:
        - oAuth2ClientCredentials: []
      parameters:
        - name: qrcId
          in: path
          description: Идентификатор зарегистрированной Функциональной ссылки СБП
          required: true
          schema:
            maxLength: 32
            minLength: 32
            type: string
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
        - name: mediaType
          in: query
          description: Опциональный тип изображения Функциональной ссылки
          required: false
          schema:
            type: string
            enum:
              - image/png
              - image/svg+xml
        - name: width
          in: query
          description: Ширина изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
        - name: height
          in: query
          description: Высота изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
      responses:
        '200':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RM05001"
                message: "Нарушена структура запроса"
                data: {}
        '401':
          description: Ошибка доступа
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RQT0000"
                message: "Ошибка валидации токена доступа"
                data: {}
  /sbp/budget/v1/qrc-status:
    put:
      tags:
        - PaymentAPI
      summary: Запрос статуса Операций СБП по идентификатору Функциональной ссылки
      operationId: getStatusQRCOperationsV1
      security:
        - oAuth2ClientCredentials: []
      requestBody:
        description: Массив qrcId, по которым необходимо получить статусы операций
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BudgetOperationStatusByQrcIdV1Request'
        required: true
      responses:
        '200':
          description: Успешный ответ
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetOperationStatusByQrcIdV1Response'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RQ05014"
                message: "Значение qrcId не найдено"
                data: {}
        '401':
          description: Ошибка доступа
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: "RQT0000"
                message: "Ошибка валидации токена доступа"
                data: {}
  /sbp/budget/v1/cash-register-qrc:
    post:
      tags:
        - PaymentAPI
      summary: Регистрация Кассовой ссылки СБП C2G
      operationId: createCashQrc
      parameters:      
        - name: mediaType
          in: query
          description: Опциональный тип QR-картинки
          required: false
          schema:
            type: string
            enum:
              - image/png
              - image/svg+xml
        - name: width
          in: query
          description: Ширина изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
        - name: height
          in: query
          description: Высота изображения
          required: false
          schema:
            type: integer
            format: int32
            default: 300
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BudgetCashLinkDataDto'
        required: true
      responses:
        '201':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: RM05001
                message: Нарушена структура запроса
                data: {}
  /sbp/budget/v1/cash-register-qrc/{qrcId}/params:
    post:
      tags:
        - PaymentAPI
      summary: Активация Кассовой ссылки
      description: |
        Метод вызывается перед оплатой текущим плательщиком. Оплата по неактивированным Кассовым ссылкам невозможна. В результате выполнения данного метода для Кассовой ссылки будет определен набор активных значений параметров для оплаты.
      operationId: cashRegisterQrcParams
      parameters:
        - name: qrcId
          in: path
          description: Идентификатор Функциональной ссылки
          required: true
          schema:
            maxLength: 32
            minLength: 32
            type: string
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/BudgetCashRegisterQrcDataDto'
                - type: object
                  required:
                    - amount
        required: true
      responses:
        '200':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetCashLinkActivationResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: RM05001
                message: Нарушена структура запроса
                data: {}
    delete:
      tags:
        - PaymentAPI
      summary: Деактивация Кассовой ссылки 
      description: |
        Учатник СКП должен деактивировать Кассовую ссылку в случае, если Плательщик отказался от выполнения оплаты. Деактивация влечет удаление активных значений параметров Кассовой ссылки
      operationId: cashRegisterQrcParamsDelete
      parameters:
        - name: qrcId
          in: path
          description: Идентификатор Функциональной ссылки
          required: true
          schema:
            maxLength: 32
            minLength: 32
            type: string
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
      responses:
        '200':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetCashLinkDeActivationResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: RM05001
                message: Нарушена структура запроса
                data: {}
  /sbp/budget/v1/cash-register-qrc/{qrcId}/{paramsId}:
    get:
      tags:
        - PaymentAPI
      summary: Запрос Статуса Операции СБП C2G по Кассовой ссылке СБП C2G
      operationId: getStatusOperationCashLink
      description: |
        Метод следует использовать, если по проведенной Операции СБП C2G не получено «Уведомление о финальном статусе Операции СБП C2G». 
        Информация по проведенной Операции СБП C2G с конкретными значениями параметров qrcId и paramsId доступна в течение 24 часов с момента проведения Операции СБП C2G
      parameters:
        - name: qrcId
          in: path
          description: Идентификатор Функциональной ссылки
          required: true
          schema:
            maxLength: 32
            minLength: 32
            type: string
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
        - name: paramsId
          in: path
          description: Идентификатор активного набора параметров
          required: true
          schema:
            type: string
            maxLength: 32
            minLength: 32
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
      responses:
        '200':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusCashLinkOperationResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: RM05001
                message: Нарушена структура запроса
                data: {}
  /sbp/budget/v1/cash-register-qrc/{qrcId}:
    get:
      tags:
        - PaymentAPI 
      summary: Запрос статуса Кассовой ссылки
      operationId: getRegisterQrc
      parameters:
        - name: qrcId
          in: path
          description: Идентификатор Функциональной ссылки
          required: true
          schema:
            maxLength: 32
            minLength: 32
            type: string
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
      responses:
        '200':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusCashLinkResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: RM05001
                message: Нарушена структура запроса
                data: {}
    put:
      tags:
        - PaymentAPI
      summary: Изменение параметров Кассовой ссылки 
      operationId: putRegQrc
      parameters:
        - name: qrcId
          in: path
          description: Идентификатор Функциональной ссылки
          required: true
          schema:
            maxLength: 32
            minLength: 32
            type: string
          example: "AD100074066RHM939FE9OQKR0TQ63HB6"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BudgetCashRegQrcPutDataDto'
      responses:
        '200':
          description: Операция успешно выполнена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetCashRegQrcPutDataResponseDto'
        '400':
          description: Некорректный запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
              example:
                code: RM05001
                message: Нарушена структура запроса
                data: {}
  /sbp/budget/v1/qrc/notification:
    post:
      tags:
        - MerchantNotification
      summary: Уведомление для Участника СКП о финальном статусе Операции СБП
      operationId: sendFinalStatusAck
      security:
        - ApiKeyAuth: []
      requestBody:
        description: Данные Уведомления для Участника СКП о финальном статусе Операции СБП от ОПКЦ СБП
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/C2GNotificationV1Dto'
        required: true
      responses:
        '200':
          description: Успешный ответ (Уведомление получено)
          content: {}
        '401':
          description: Ошибка проверки API ключа
          content: {}
        '500':
          description: Внутренняя ошибка
          content: {}
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows: 
        clientCredentials: 
          tokenUrl: https://api.sbp.gisgmp.ru/oauth2/token/
          refreshUrl: https://api.sbp.gisgmp.ru/oauth2/token/
          scopes: {} # SBP GISGMP does not use scopes
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key  # секретный ключ обратного вызова из ЛК интеграционного сервиса СБП ФК
  schemas:
    BudgetPaymentLinkDataDto:
      title: Полные данные регистрируемой Функциональной ссылки
      required:
        - portalId
        - payeeInn
        - payeeKpp
        - qrTtl
        - needFiscalization
        - qrcType
        - paymentPurpose
        - payerStatus
      type: object
      properties:
        portalId:
          maxLength: 12
          minLength: 12
          type: string
          description: |
            Идентификатор Портала, зарегистрированного в ЛК интеграционного сервиса СБП ФК сотрудником ФК.
            Обязателен для заполнения при направлении запроса от портала.
            Заполняется значением зарегистрированного портала в ЛК интеграционного сервиса СБП ФК.
          example: "PR0000000001"
        payeeInn:
          maxLength: 10
          minLength: 10
          type: string
          description: |
            ИНН прямого/косвенного получателя средств.
            Обязателен для заполнения при направлении запроса от портала.
          example: "7712345678"
        payeeKpp:
          maxLength: 9
          minLength: 9
          type: string
          description: |
            КПП прямого/косвенного получателя средств.
            Необходимо заполнять при направлении запроса от портала.
          example: "501234567"
        qrTtl:
          type: integer
          maximum: 129600
          minimum: 1
          description: |
            Срок использования Функциональной ссылки СБП в минутах, допустимый диапазон значений – от 1 до 129600 включительно. 
            Если при регистрации Функциональной ссылки СБП параметр qrTtl не был указан, то такая Функциональная ссылка СБП будет действительна в течение 4320 минут.
            Не используется при значении параметра «qrcType» = «01»
          example: 65
        needFiscalization:
          type: boolean
          description: Признак необходимости фискализации данных на уровне интеграционного сервиса СБП ФК.
          example: false
        account:
          maxLength: 20
          minLength: 20
          type: string
          description: |
            Казначейский счет получателя, на который осуществляется зачисление. 
            Обязателен при значении параметра «qrcType» = «01» или «02». 
            Не используется при значении параметра «qrcType» = «03»
          example: "40702810100010000001"
        qrcType:
          type: string
          description: |
            Тип ссылки СБП:
              * "01" - QR-Static (Многоразовая Платежная ссылка СБП). Может использоваться для выполнения множества Операций СБП C2G
              * "02" - QR-Dynamic (Одноразовая Платежная ссылка СБП). Предназначена для выполнения единичной Операции СБП C2G. Используется в Сценариях "Оплата с привязкой счета" и "Оплата с привязанного счета"
              * "03" - QR-Subscription (Информационная ссылка СБП для привязки счета Плательщика)
          example: "02"
          enum:
            - '01'
            - '02'
            - '03'
        amount:
          type: string
          maxLength: 12
          minLength: 1
          description: |
            Сумма Операции в копейках. Целое, положительное число.
            Обязателен для заполнения, если qrcType = "02". Всегда отсутствует для qrcType = "03". Может отсутствовать при регистрации qrcType = 01.
          example: "100000"
        paymentPurpose:
          type: string
          maxLength: 210
          minLength: 1
          description: Расширенное назначение платежа. Не используется при значении параметра "qrcType" = "03"
          example: "Оплата по договору №123 от 01.02.2023"
        subscriptionPurpose:
          maxLength: 140
          minLength: 1
          type: string
          description: |
            Назначение привязки счета. Обязателен при значении параметра «qrcType» = «03», может присутствовать при значении параметра «qrcType» = «02», не используется при значении параметра «qrcType» = «01»
          example: "Пример назначения подписки"
        redirectUrl:
          maxLength: 1024
          minLength: 1
          type: string
          description: |
            Ссылка для автоматического возврата Плательщика из Приложения Плательщика в приложение Участника СКП. 
            Допускаются только символы в кодировке ASCII[1]. 
            Формат должен соответствовать правилам кодировки URL
          nullable: true
          example: "https://nspk.ru"
        uin:
          oneOf:
            - type: string
              maxLength: 1
              minLength: 1
            - type: string
              maxLength: 4
              minLength: 4
            - type: string
              maxLength: 25
              minLength: 20
          description: |
            Уникальный идентификатор начисления
            При оплате начисления, заполняется значением ревизита "УИН" начисления ГИС ГМП.
          example: "18810350130210000016"
        payerStatus:
          maxLength: 2
          minLength: 2
          type: string
          description: |
            Статус плательщика (101)
            При оплате начисления, заполняется значением ревизита "Статус плательщика" начисления ГИС ГМП.
          example: "01"
        kbk:
          maxLength: 20
          minLength: 1
          type: string
          description: |
            Код бюджетной классификации (104)
            При оплате начисления, заполняется значением ревизита "КБК" начисления ГИС ГМП.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "10000000000000000140"
          default: "0"
        oktmo:
          maxLength: 8
          minLength: 1
          type: string
          description: |
            Код по общероссийскому классификатору территорий миниципальных образований (105)
            При оплате начисления, заполняется значением ревизита "Код ОКТМО" начисления ГИС ГМП.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "46783000"
          default: "0"
        paymentBasis:
          maxLength: 2
          minLength: 1
          type: string
          description: |
            Основание платежа (106)
            При оплате начисления, заполняется значением ревизита "Показатель основания платежа" начисления ГИС ГМП.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "ЗД"
          default: "0"
        customsCode:
          maxLength: 10
          minLength: 1
          type: string
          description: |
            Код таможенного органа (107)
            При оплате начисления, заполняется значением ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП, если он имеет длину =8 символов.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "10000010"
          default: "0"
        accrualDate:
          type: string
          format: date
          description: |
            Дата начисления (107)
            При оплате начисления, заполняется значением ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП, если он имеет длину =10 символов и первые 2 символа НЕ равны МС, КВ, ПЛ, ГД.
          example: "2023-01-01"
        docNum:
          maxLength: 15
          minLength: 1
          type: string
          description: |
            Номер документа основания платежа (108)
            При оплате начисления, заполняется значением ревизита "Показатель номера документа" начисления ГИС ГМП.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "123"
          default: "0"
        docDate:
          type: string
          format: date
          description: |
            Дата документа основания платежа (109)
            При оплате начисления, заполняется значением ревизита "Показатель даты документа" начисления ГИС ГМП. Если в начислении указано значение "0" или "00", то необходимо заполнять значением "1111-11-11"
            При отсутствии реквизита в запросе подставляется значение из default
          example: "2023-01-01"
          default: "1111-11-11"
        accrualYear:
          type: integer
          maximum: 2099
          minimum: 1950
          description: |
            Год начисления (107)
            При оплате начисления, заполняется значением с 7-го по 10-й символ ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП, если он имеет длину =10 символов и первые 2 символа равны МС или КВ или ПЛ или ГД.
          example: 2023
        accrualPeriod:
          maxLength: 4
          minLength: 4
          type: string
          enum:
            - 'MM01'
            - 'MM02'
            - 'MM03'
            - 'MM04'
            - 'MM05'
            - 'MM06'
            - 'MM07'
            - 'MM08'
            - 'MM09'
            - 'MM10'
            - 'MM11'
            - 'MM12'
            - 'QTR1'
            - 'QTR2'
            - 'QTR3'
            - 'QTR4'
            - 'HLF1'
            - 'HLF2'
          description: |
            Периодичность начисления (107)
            При оплате начисления, заполняется значением ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП, если он имеет длину =10 символов и первые 2 символа равны МС или КВ или ПЛ
                Заполняется значением MMXX, где XX - номер месяца(4 и 5 символы реквизита начисления); либо QTRX, где X - номер квартала(5 символ реквизита начисления); либо HLFX, где X - номер полугодия(5 символ реквизита начисления)
          example: "QTR2"
        accrualPayeeName:
          type: string
          maxLength: 160
          minLength: 1
          description: |
            Наименование получателя начисления
            Обязателен для заполнения при направлении запроса от портала.
            При оплате начисления, заполняется значением ревизита "Наименование организации являющейся получателем средств" начисления ГИС ГМП.
          example: "УФК по Белгородской области (УМВД России по Белгородской области л/с 04261221580)"
        paymentPriority:
          maxLength: 1
          minLength: 1
          type: string
          description: Очередность платежа (21)
          example: "5"
          default: "5"
        personalAccount:
          maxLength: 11
          minLength: 11
          type: string
          description: Лицевой счет, открытый в ФК
          example: "20516X70890"
        actualPayeeAccount:
          maxLength: 30
          minLength: 1
          type: string
          description: Лицевой счет, открытый в ФО косвенному получателю
          example: "40123456789123456789123456789600"
        # Блок полей Фактического плательщика заполняется только если требуется отражать лицо, которому выставлено обязательство по оплате.
        actualPayerKpp:
          maxLength: 9
          minLength: 9
          type: string
          description: |
            Код причины постановки Фактического Плательщика.
            При оплате начисления, заполняется значением КПП плательщика если оно содержится в реквизите "Идентификатор плательщика" начисления ГИС ГМП.
                Не заполняется если Фактическим Плательщиком является физическое лицо или индивидуальный предприниматель.
          example: "501234567"
        actualPayer:
          maxLength: 140
          minLength: 1
          type: string
          description: |
            Наименование Фактического Плательщика
            При оплате начисления, заполняется значением реквизита "Плательщик" начисления ГИС ГМП, в случае если плательщиком является юридическое лицо; 
                в случае если Фактическим Плательщиком является физическое лицо или индивидуальный предприниматель заполняется значением "-".
          example: "ООО Севильский цирюльникъ"
        actualPayerDocId:
          maxLength: 15
          minLength: 1
          type: string
          description: |
            Идентификатор документа Фактического Плательщика.
            При оплате начисления, заполняется по шаблону "тип_документа;номер_документа" в случае если Фактическим Плательщиком является физическое лицо. 
                Данные для заполнения содержатся в ревизите "Идентификатор плательщика" начисления ГИС ГМП.
          example: "01;0201251245"
        actualPayerInn:
          maxLength: 12
          minLength: 10
          type: string
          description: |
            Идентификационный номер налогоплательщика Фактического Плательщика.
            При оплате начисления, заполняется значением ИНН плательщика, если оно содержится в реквизите "Идентификатор плательщика" начисления ГИС ГМП.
          example: "7701234567"
    BudgetPaymentLinkDataViaTemplate:
      title: Данные регистрируемой Функциональной ссылки по зарегистрированному шаблону платежа
      required:  
        - qrTtl
        - needFiscalization
        - paymentTemplateId
        - qrcType
        - paymentPurpose
      type: object
      properties:
        terminalId:
          maxLength: 12
          minLength: 12
          type: string
          description: |
            Идентификатор Терминала, зарегистрированного в личном кабинете интеграционного сервиса СБП ФК участником СКП. 
            Обязателен для заполнения при направлении запроса от терминала. 
            Заполняется значением зарегистрированного терминала в ЛК интеграционного сервиса СБП ФК.
          example: "TR0000000001"
        portalId:
          maxLength: 12
          minLength: 12
          type: string
          description: |
            Идентификатор Портала, зарегистрированного в ЛК интеграционного сервиса СБП ФК сотрудником ФК.
            Обязателен для заполнения при направлении запроса от портала.
            Заполняется значением зарегистрированного портала в ЛК интеграционного сервиса СБП ФК.
          example: "PR0000000001"
        payeeInn:
          maxLength: 10
          minLength: 10
          type: string
          description: |
            ИНН прямого/косвенного получателя средств.
            Обязателен для заполнения при направлении запроса от портала.
          example: "7712345678"
        payeeKpp:
          maxLength: 9
          minLength: 9
          type: string
          description: |
            КПП прямого/косвенного получателя средств.
            Необходимо заполнять при направлении запроса от портала.
          example: "501234567"
        qrTtl:
          type: integer
          maximum: 129600
          minimum: 1
          description: |
            Срок использования Функциональной ссылки СБП в минутах, допустимый диапазон значений – от 1 до 129600 включительно. 
            Если при регистрации Функциональной ссылки СБП параметр qrTtl не был указан, то такая Функциональная ссылка СБП будет действительна в течение 4320 минут.
            Не используется при значении параметра «qrcType» = «01»
          example: 65
        needFiscalization:
          type: boolean
          description: Признак необходимости фискализации данных на уровне интеграционного сервиса СБП ФК.
          example: false
        paymentTemplateId:
          maxLength: 20
          minLength: 1
          type: string
          description: Идентификатор шаблона платежа, зарегистрированного в личном кабинете интеграционного сервиса СБП ФК участником СКП
          example: "TM001331010001000001"
        qrcType:
          type: string
          description: |
            Тип ссылки СБП:
              * "01" - QR-Static (Многоразовая Платежная ссылка СБП). Может использоваться для выполнения множества Операций СБП C2G
              * "02" - QR-Dynamic (Одноразовая Платежная ссылка СБП). Предназначена для выполнения единичной Операции СБП C2G. Используется в Сценариях "Оплата с привязкой счета" и "Оплата с привязанного счета"
              * "03" - QR-Subscription (Информационная ссылка СБП для привязки счета Плательщика) (Зарезервированное значение для будущего использования)
          example: "02"
          enum:
            - '01'
            - '02'
            - '03'
        amount:
          type: string
          maxLength: 12
          minLength: 1
          description: |
            Сумма Операции в копейках. Целое, положительное число.
            Обязателен для заполнения, если qrcType = "02". Всегда отсутствует для qrcType = "03". Может отсутствовать при регистрации qrcType = 01.
          example: "100000"
        paymentPurpose:
          type: string
          maxLength: 210
          minLength: 1
          description: Расширенное назначение платежа. Не используется при значении параметра "qrcType" = "03"
          example: "Оплата по договору №123 от 01.02.2023"
        subscriptionPurpose:
          maxLength: 140
          minLength: 1
          type: string
          description: |
            Зарезервированное поле для будущего использования.
            Назначение привязки счета. Обязателен при значении параметра «qrcType» = «03», может присутствовать при значении параметра «qrcType» = «02», не используется при значении параметра «qrcType» = «01»
          example: "Пример назначения подписки"
        redirectUrl:
          maxLength: 1024
          minLength: 1
          type: string
          description: |
            Ссылка для автоматического возврата Плательщика из Приложения Плательщика в приложение Участника СКП. 
            Допускаются только символы в кодировке ASCII[1]. 
            Формат должен соответствовать правилам кодировки URL
          nullable: true
          example: "https://nspk.ru"
        uin:
          oneOf:
            - type: string
              maxLength: 1
              minLength: 1
            - type: string
              maxLength: 4
              minLength: 4
            - type: string
              maxLength: 25
              minLength: 20                    
          description: |
            Уникальный идентификатор начисления
            При оплате начисления, заполняется значением ревизита "УИН" начисления ГИС ГМП.
          example: "18810350130210000016"
        paymentBasis:
          maxLength: 2
          minLength: 1
          type: string
          description: |
            Основание платежа (106)
            При оплате начисления, заполняется значением ревизита "Показатель основания платежа" начисления ГИС ГМП.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "ЗД"
          default: "0"
        customsCode:
          maxLength: 10
          minLength: 1
          type: string
          description: |
            Код таможенного органа (107)
            При оплате начисления, заполняется значением ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП, если он имеет длину =8 символов.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "10000010"
          default: "0"
        accrualDate:
          type: string
          format: date
          description: |
            Дата начисления (107)
            При оплате начисления, заполняется значением ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП.
                Данный реквизит заполняется если значение реквизита начисления имеет длину 10 символов и первые 2 символа НЕ равны МС, КВ, ПЛ, ГД.
          example: "2023-01-01"
        docNum:
          maxLength: 15
          minLength: 1
          type: string
          description: |
            Номер документа основания платежа (108)
            При оплате начисления, заполняется значением ревизита "Показатель номера документа" начисления ГИС ГМП.
            При отсутствии реквизита в запросе подставляется значение из default
          example: "123"
          default: "0"
        docDate:
          type: string
          format: date
          description: |
            Дата документа основания платежа (109)
            При оплате начисления, заполняется значением ревизита "Показатель даты документа" начисления ГИС ГМП. Если в начислении указано значение "0" или "00", то необходимо заполнять значением "1111-11-11"
            При отсутствии реквизита в запросе подставляется значение из default
          example: "2023-01-01"
          default: "1111-11-11"
        accrualYear:
          type: integer
          maximum: 2099
          minimum: 1950
          description: |
            Год начисления (107)
            При оплате начисления, заполняется значением с 7-го по 10-й символ ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП, если он имеет длину =10 символов и первые 2 символа равны МС или КВ или ПЛ или ГД.
          example: 2023
        accrualPeriod:
          maxLength: 4
          minLength: 4
          type: string
          enum:
            - 'MM01'
            - 'MM02'
            - 'MM03'
            - 'MM04'
            - 'MM05'
            - 'MM06'
            - 'MM07'
            - 'MM08'
            - 'MM09'
            - 'MM10'
            - 'MM11'
            - 'MM12'
            - 'QTR1'
            - 'QTR2'
            - 'QTR3'
            - 'QTR4'
            - 'HLF1'
            - 'HLF2'
          description: |
            Периодичность начисления (107)
            При оплате начисления, заполняется значением ревизита "Показатель налогового периода или код таможенного органа" начисления ГИС ГМП, если он имеет длину =10 символов и первые 2 символа равны МС или КВ или ПЛ
                Заполняется значением MMXX, где XX - номер месяца(4 и 5 символы реквизита начисления); либо QTRX, где X - номер квартала(5 символ реквизита начисления); либо HLFX, где X - номер полугодия(5 символ реквизита начисления)
          example: "QTR2"
        # Блок полей Фактического плательщика заполняется только если требуется отражать лицо, которому выставлено обязательство по оплате. 
        actualPayerKpp:
          maxLength: 9
          minLength: 9
          type: string
          description: |
            Код причины постановки Фактического Плательщика.
            При оплате начисления, заполняется значением КПП плательщика если оно содержится в реквизите "Идентификатор плательщика" начисления ГИС ГМП.
                Не заполняется если Фактическим Плательщиком является физическое лицо или индивидуальный предприниматель.
          example: "501234567"
        actualPayer:
          maxLength: 140
          minLength: 1
          type: string
          description: |
            Наименование Фактического Плательщика
            При оплате начисления, заполняется значением реквизита "Плательщик" начисления ГИС ГМП, в случае если плательщиком является юридическое лицо;
                в случае если Фактическим Плательщиком является физическое лицо или индивидуальный предприниматель заполняется значением "-".
          example: "ООО Севильский цирюльникъ"
        actualPayerDocId:
          maxLength: 15
          minLength: 1
          type: string
          description: |
            Идентификатор документа Фактического Плательщика.
            При оплате начисления, заполняется по шаблону "тип_документа;номер_документа" в случае если Фактическим Плательщиком является физическое лицо. 
                Данные для заполнения содержатся в ревизите "Идентификатор плательщика" начисления ГИС ГМП.
          example: "01;0201251245"
        actualPayerInn:
          maxLength: 12
          minLength: 10
          type: string
          description: |
            Идентификационный номер налогоплательщика Фактического Плательщика.
            При оплате начисления, заполняется значением ИНН плательщика, если оно содержится в реквизите "Идентификатор плательщика" начисления ГИС ГМП.
          example: "7701234567"
    PaymentLinkResponseDto:
      title: Успешный ответ на запрос регистрации Функциональной ссылки и запрос получениея payload
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа
        message:
          maxLength: 255
          type: string
          description: Описание кода ответа
        data:
          properties:
            qrcId:
              maxLength: 32
              minLength: 32
              type: string
              description: Идентификатор функциональной ссылки СБП
              example: "AS1000670LSS7DN18SJQDNP4B05KLJL2"
            payload:
              type: string
              description: Функциональноая ссылка СБП
              example: "https://c2g.cbrpay.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2"
            status:
              type: string
              description: Статус регистрации функциональной ссылки СБП
              example: "CREATED"
              enum:
                - CREATED
            image:
              $ref: '#/components/schemas/Image'
    Image:
      title: Объект QR-кода
      type: object
      properties:
        mediaType:
          type: string
          description: Формат получаемого файла
          example: "image/png"
          enum:
            - image/png
            - image/svg+xml
        content:
          type: string
          description: base64encoded image. Формат для декодирования зависит от mediaType
          example: "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII="
    ResponseDto:
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа
          example: "RQ00000"
        message:
          maxLength: 255
          type: string
          description: Описание кода ответа
          example: "Текст, разъясняющий ответ"
        data:
          type: object
    C2GNotificationV1Dto:
      title: Данные "Уведомления для Участника СКП о финальном статусе Операции СБП C2G"
      required:
        - amount
        - payerId
        - qrcId
        - status
        - timestamp
        - trxId
      type: object
      properties:
        qrcId:
          maxLength: 32
          minLength: 32
          type: string
          description: Идентификатор зарегистрированной Платежной ссылки СБП
          example: "AD1000038AQ1FG409KGACUQU5QRSH3FM"
        trxId:
          maxLength: 32
          minLength: 32
          type: string
          description: Идентификатор Операции СБП C2G
          example: "A105600390167601000004681598593B"
        terminalId:
          maxLength: 12
          minLength: 12
          type: string
          description: Идентификатор Терминала которому должна быть передана информация об оплате
          example: "TR0000000001"
        paramsId:
          type: string
          maxLength: 32
          minLength: 32
          description: Идентификатор активных значений параметров Кассовой ссылки СБП.
          example: "83746290376583029856473829018735"
        status:
          maxLength: 4
          minLength: 4
          type: string
          description: |
            Финальный статус Операции СБП C2G:
            * "ACWP" - ACCEPTED операция завершена успешно;
            * "RJCT" - REJECTED операция отклонена;
          enum:
            - ACWP
            - RJCT
          example: "ACWP"
        amount:
          type: string
          maxLength: 12
          minLength: 1
          description: Сумма Операции СБП C2G в копейках. Целое, положительное число.
          example: "5000"
        errorCode:
          nullable: true
          maxLength: 6
          minLength: 6
          type: string
          description: Зарезервированное поле для будущего использования
        message:
          nullable: true
          maxLength: 105
          minLength: 1
          type: string
          description: Зарезервированное поле для будущего использования
        timestamp:
          type: string
          description: Дата и время выполнения Операции СБП C2G
          example: "2021-03-02T17:15:01.148"
        payerId:
          maxLength: 15
          minLength: 13
          type: string
          description: Маскированный номер телефона Клиента-Плательщика
          example: "*********6731"
    BudgetCashLinkDataDto:
      title: Данные регистрируемой кассовой ссылки
      required:
        - terminalId
        - account
        - payerStatus
        - needFiscalization
      type: object
      properties:
        terminalId:
          maxLength: 12
          minLength: 12
          type: string
          description: |
            Идентификатор Терминала, зарегистрированного в личном кабинете интеграционного сервиса СБП ФК участником СКП.
          example: "TR0000000001"
        qrcId:
          maxLength: 32
          minLength: 32
          type: string
          description: |
            Заранее полученный в ФК Идентификатор Кассовой ссылки
            Указывается только в случае получения зарегистрированного Идентификатора в ФК.
            В случае отсутствия qrcId в запросе, будет присвоено новое значение Идентификатора.
          example: "AS1000670LSS7DN18SJQDNP4B05KLJL2"
        redirectUrl: 
          maxLength: 1024
          minLength: 1
          type: string
          description: |
            Ссылка для автоматического возврата Плательщика из Приложения Плательщика в приложение Участника СКП. 
            Допускаются только символы в кодировке ASCII . 
            Формат должен соответствовать правилам кодировки URL
          nullable: true
          example: "https://exampletsp.io/qwertyui"
        needFiscalization:
          type: boolean
          description: Признак необходимости фискализации данных на уровне интеграционного сервиса СБП ФК.
          example: false
        account:
          maxLength: 20
          minLength: 20
          type: string
          description: Казначейский счет получателя, на который осуществляется зачисление.
          example: "40702810100010000001"
        payerStatus:
          maxLength: 2
          minLength: 2
          type: string
          description: Показатель статуса плательщика (101)
          example: "01"
        kbk: 
          maxLength: 20
          minLength: 1
          type: string
          description: |
            Код бюджетной классификации (104)
            При отсутствии реквизита в запросе подставляется значение из default
          example: "10000000000000000140"
          default: "0"
        oktmo: 
          maxLength: 8
          minLength: 1
          type: string
          description: |
            Код по общероссийскому классификатору территорий миниципальных образований (105)
            При отсутствии реквизита в запросе подставляется значение из default
          example: "46783000"
          default: "0"
        paymentPriority: 
          maxLength: 1
          minLength: 1
          type: string
          description: Очередность платежа (21)
          example: "5"
          default: "5"
        personalAccount:
          maxLength: 11
          minLength: 11
          type: string
          description: Лицевой счет, открытый в ФК
          example: "01234567890"
        actualPayeeAccount:
          maxLength: 30
          minLength: 1
          type: string
          description: Лицевой счет, открытый в ФО косвенному получателю
          example: "40123456789123456789123456789600"
    BudgetCashRegisterQrcDataDto:
      title: Данные для активация кассовой ссылки
      required: 
        - terminalId
        - amount
        - paymentPurpose
      type: object
      properties:
        terminalId:
          maxLength: 12
          minLength: 12
          type: string
          description: |
            Идентификатор Терминала, зарегистрированного в личном кабинете интеграционного сервиса СБП ФК участником СКП.
          example: "TR0000000001"
        amount:
          maxLength: 12
          minLength: 1
          type: string
          description: Сумма в копейках
          example: "100"
        paymentPurpose:
          maxLength: 140
          minLength: 1
          type: string
          description: Назначение платежа
          example: "Оплата покупок"
        qrTtl:
          type: integer
          maximum: 20
          minimum: 1
          description: |
            Срок использования набора активных значений параметров Кассовой ссылки СБП C2G в минутах, 
            допустимый диапазон значений – от 1 до 20 включительно. Если значение параметра qrTtl не 
            задано, используется значение по умолчанию, равное 5 минутам.
            Если по Кассовой ссылке СБП C2G не будет выполнена Операция СБП C2G, она автоматически 
            деактивируется после истечения qrTtl
          example: 2
    BudgetCashRegQrcPutDataDto:
      title: Данные метода "Изменение параметров Кассовой ссылки"
      required:
        - terminalId
        - account
        - payerStatus
      properties:
        terminalId:
          maxLength: 12
          minLength: 12
          type: string
          description: |
            Идентификатор Терминала, зарегистрированного в личном кабинете интеграционного сервиса СБП ФК участником СКП.
          example: "TR0000000001"
        redirectUrl:
          maxLength: 1024
          minLength: 1
          type: string
          description: |
            Ссылка для автоматического возврата Плательщика из Приложения Плательщика в приложение Участника СКП. 
            Допускаются только символы в кодировке ASCII . 
            Формат должен соответствовать правилам кодировки URL
          nullable: true
          example: "https://exampletsp.io/qwertyui"
        account:
          maxLength: 20
          minLength: 20
          type: string
          description: Казначейский счет получателя, на который осуществляется зачисление.
          example: "40702810100010000001"
        payerStatus:
          maxLength: 2
          minLength: 2
          type: string
          description: Показатель статуса плательщика (101)
          example: "01"
        kbk: 
          maxLength: 20
          minLength: 1
          type: string
          description: |
            Код бюджетной классификации (104)
            При отсутствии реквизита в запросе подставляется значение из default
          example: "10000000000000000140"
          default: "0"
        oktmo:
          maxLength: 8
          minLength: 1
          type: string
          description: |
            Код по общероссийскому классификатору территорий миниципальных образований (105)
            При отсутствии реквизита в запросе подставляется значение из default
          example: "46783000"
          default: "0"
        paymentPriority:
          maxLength: 1
          minLength: 1
          type: string
          description: Очередность платежа (21)
          example: "5"
          default: "5"
        personalAccount:
          maxLength: 11
          minLength: 11
          type: string
          description: Лицевой счет, открытый в ФК
          example: "01234567890"
        actualPayeeAccount:
          maxLength: 30
          minLength: 1
          type: string
          description: Лицевой счет, открытый в ФО косвенному получателю
          example: "40123456789123456789123456789600"
    BudgetCashRegQrcPutDataResponseDto:
      title: Успешный ответ на "Изменение параметров Кассовой ссылки"
      required:
        - code
        - message
        - data
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа на запрос
          example: "RQ00000"
        message:
          maxLength: 255
          minLength: 1
          type: string
          description: Описание кода ответа на запрос
          example: "Запрос обработан успешно"
        data:
          type: object
          nullable: true
          properties:
            qrcId:
              description: Идентификатор Кассовой ссылки СБП C2G
              type: string
              maxLength: 32
              minLength: 32
              example: "AS1000670LSS7DN18SJQDNP4B05KLJL2"
            status:
              description: Статус изменения счета. Единственное допустимое значение – «UPDATED»
              type: string
              enum:
                - 'UPDATED'
              example: "UPDATED"
    BudgetCashLinkActivationResponseDto:
      title: Успешный ответ на "Активацию кассовой ссылки СБП C2G"
      required:
        - code
        - message
        - data
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа на запрос
          example: "RQ00000"
        message:
          maxLength: 255
          minLength: 1
          type: string
          description: Описание кода ответа на запрос
          example: "Запрос обработан успешно"
        data:
          type: object
          nullable: true
          required:
            - paramsId
            - qrcId
            - amount
            - paymentPurpose
          properties:
            paramsId:
              type: string
              description: Идентификатор активных значений параметров Кассовой ссылки СБП C2G
              maxLength: 32
              minLength: 32
              example: "AP5GK3L276DN8PDR8ON1LF4RVOL44444"
            qrcId:
              type: string
              description: Идентификатор Кассовой ссылки СБП C2G
              maxLength: 32
              minLength: 32
              example: "AS1000038AQ1FG409KGACUQU5QRSH3FM"
            amount:
              maxLength: 12
              minLength: 1
              type: string
              description: Сумма в копейках
              example: 100
            currency:
              maxLength: 3
              minLength: 3
              type: string
              description: |
                Валюта – используется константа «RUB». 
                Если в запросе не будет указано значение параметра currency, 
                ОПКЦ СБП самостоятельно установит значение currency = «RUB»
              example: "RUB"
            paymentPurpose:
              maxLength: 140
              minLength: 1
              type: string
              description: Назначение платежа
              example: "Оплата покупок"
    BudgetCashLinkDeActivationResponseDto:
      title: Успешный ответ на "Деактивацию кассовой ссылки СБП C2G"
      required:
        - code
        - message
        - data
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа на запрос
          example: "RQ05022"
        message:
          maxLength: 255
          minLength: 1
          type: string
          description: Описание кода ответа на запрос
          example: "Невозможно деактивировать Кассовую ссылку СБП"
        data:
          type: object
          nullable: true
          example: null
    StatusCashLinkOperationResponseDto:
      title: Успешный ответ на "Запрос Статуса Операции СБП C2G по Кассовой ссылке СБП C2G"
      required:
        - code
        - message
        - data
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа на запрос
          example: "RQ00000"
        message:
          maxLength: 255
          minLength: 1
          type: string
          description: Описание кода ответа на запрос
          example: "Запрос обработан успешно"
        data:
          type: object
          nullable: true
          required:
            - qrcId
            - status
            - cashRegisterQrcStatus
            - trxStatus
            - trxId
            - amount
            - timestamp
            - payerId
          properties:
            qrcId:
              type: string
              description: Идентификатор Кассовой ссылки СБП C2G
              maxLength: 32
              minLength: 32
              example: "AS1000670LSS7DN18SJQDNP4B05KLJL2"
            status:
              type: string
              description: Статус изменения счета. Единственное допустимое значение – «UPDATED»
              enum:
                - 'UPDATED'
              example: "UPDATED"
            cashRegisterQrcStatus:
              type: string
              description: |
                Текущий статус Кассовой ссылки СБП C2G для указанного paramsId:
                * "WAITING_PAYMENT" – Кассовая ссылка СБП C2G для указанного paramsId активирована и готова к оплате;
                * "IN_PROGRESS"– Операция по Кассовой ссылке СБП C2G для указанного paramsId в процессе выполнения;
                * "DEACTIVATED" – Кассовая ссылка СБП C2G с указанным paramsId более не существует (все действия по ней завершены)
              enum:
                - 'WAITING_PAYMENT'
                - 'IN_PROGRESS'
                - 'DEACTIVATED'
              example: "DEACTIVATED"
            trxStatus:
              type: string
              description: |
                Текущий статус Кассовой ссылки СБП C2G для указанного paramsId:
                * "NTST" – Операция не начата;
                * "RCVD" – Операция в обработке;
                * "ACWP" – Операция завершена успешно;
                * "RJCT" – Операция отклонена
              enum:
                - 'NTST'
                - 'RCVD'
                - 'ACWP'
                - 'RJCT'
              example: "ACWP"
            trxId:
              type: string
              description: Идентификатор Операции СБП C2G
              maxLength: 32
              minLength: 32
              nullable: true
              example: "A3018040434305010000057B3DС2D4A7"
            amount:
              type: string
              description: Сумма в копейках
              maxLength: 12
              minLength: 1
              example: 100
            timestamp:
              type: string
              description: Дата и время выполнения Операции СБП C2G
              maxLength: 24
              minLength: 24
              nullable: true
              example: "2021-03-02T17:15:01.148"
            payerId:
              type: string
              description: Маскированный номер телефона Клиента-Плательщика
              maxLength: 15
              minLength: 13
              nullable: true
              example: "*********6731"
    StatusCashLinkResponseDto:
      title: Успешный ответ на "Запрос Статуса Операции СБП C2G по Кассовой ссылке СБП C2G"
      required:
        - code
        - message
        - data
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа на запрос
          example: "RQ00000"
        message:
          maxLength: 255
          minLength: 1
          type: string
          description: Описание кода ответа на запрос
          example: "Запрос обработан успешно"
        data:
          type: object
          nullable: true
          required:
            - status
            - paramsId
          properties:
            status:
              type: string
              description: |
                Текущий статус Кассовой ссылки СБП C2G для указанного paramsId:
                * "INACTIVATED" – Кассовая ссылка СБП C2G не активирована;
                * "WAITING_PAYMENT" – Кассовая ссылка СБП C2G активирована и готова к оплате;
                * "IN_PROGRESS" – Операция по Кассовой ссылки СБП C2G в процессе выполнения
              enum:
                - 'INACTIVATED'
                - 'WAITING_PAYMENT'
                - 'IN_PROGRESS'
              example: "WAITING_PAYMENT"
            paramsId:
              type: string
              description: |
                Идентификатор активного набора параметров. Параметр будет отсутствовать, если статус Кассовой ссылки имеет значение «INACTIVATED»
              maxLength: 32
              minLength: 32
              nullable: true
              example: "AP10007NHUS4H34G9HTA5184AAGN2FDH"
    BudgetOperationIdReservationResponse:
      title: Успешный ответ на "Получение идентификаторов для Многоразовых Платежных ссылок СБП C2G"
      required:
        - code
        - message
        - data
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа на запрос
          example: "RQ00000"
        message:
          maxLength: 255
          minLength: 1
          type: string
          description: Описание кода ответа на запрос
          example: "Запрос обработан успешно"
        data:
          type: object
          nullable: true
          required:
          - qrcIds
          properties:
            qrcIds:
              type: array
              description: Массив qrcId, по которым нужно получить статус Операций СБП C2G
              items:
                maxLength: 32
                minLength: 32
                type: string
                description: Идентификатор зарегистрированной Платежной ссылки СБП
                example: "AD1000670LSS7DN18SJQDNP4B05KLJL2"
    BudgetOperationStatusByQrcIdV1Request:
      title: Данные метода "Запрос статуса Операций СБП по идентификатору QR Dynamic"
      required:
        - qrcIds
      type: object
      properties:
        qrcIds:
          type: array
          description: Массив qrcId, по которым нужно получить статус Операций СБП C2G
          items:
            maxLength: 32
            minLength: 32
            type: string
            description: Идентификатор зарегистрированной Платежной ссылки СБП
            example: "AD1000670LSS7DN18SJQDNP4B05KLJL2"
    BudgetOperationStatusByQrcIdV1Response:
      title: Успешный ответ на "Запрос статуса Операций СБП по идентификатору QR Dynamic"
      required:
        - code
        - message
        - data
      type: object
      properties:
        code:
          maxLength: 7
          minLength: 7
          type: string
          description: Код ответа на запрос
          example: "RQ00000"
        message:
          maxLength: 255
          minLength: 1
          type: string
          description: Описание кода ответа на запрос
          example: "Запрос обработан успешно"
        data:
          type: array
          description: Массив статусов Операций СБП C2G
          items:
            required:
              - code
              - message
              - qrcId
            type: object
            properties:
              qrcId:
                maxLength: 32
                minLength: 32
                type: string
                description: Идентификатор Платежной ссылки СБП, запрос по которой направлялся
                example: AD1000670LSS7DN18SJQDNP4B05KLJL2
              code:
                maxLength: 7
                minLength: 7
                type: string
                description: Код ответа на запрос статусов Операций СБП C2G
                example: "RQ00000"
              message:
                maxLength: 255
                minLength: 1
                type: string
                description: Описание кода ответа на запрос
                example: "Запрос обработан успешно"
              status:
                type: string
                nullable: true
                example: "ACWP"
                description: |
                  Статус Операции СБП:
                    * ACWP - ACCEPTED, Операция завершена успешно;
                    * RCVD - RECEIVED, Операция в обработке;
                    * RJCT - REJECTED, Операция отклонена;
                    * NTST - NOT_STARTED, Операция по Платежной ссылке СБП не найдена;
                enum:
                  - ACWP
                  - RCVD
                  - RJCT
                  - NTST
                  - null
              trxId:
                maxLength: 32
                minLength: 32
                type: string
                nullable: true
                description: Идентификатор Операции СБП
                example: "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2"
  parameters:
    width:
      name: width
      in: query
      description: Ширина изображения
      schema:
        maximum: 1000
        minimum: 200
        type: integer
        default: 300
    height:
      name: height
      in: query
      description: Высота изображения
      schema:
        maximum: 1000
        minimum: 200
        type: integer
        default: 300
