openapi: 3.0.4 info: title: 2218.ccop-akulBff-s-rest-v1 description: Спецификация API для взаимодействия с СУБО Администрирования карточных операций ЮЛ version: 1.2.0 contact: name: Чижков Виталий Алексеевич (4033050) email: vchizhkov@vtb.ru servers: - url: https://ms-ccop-m131-lan-hms-bff.ccop-akul-ift.test.vtb.ru/api/front/v1 description: IFT tags: - name: ccop-m131-lan-hms-bff paths: /forms/init: get: tags: - ccop-m131-lan-hms-bff summary: Получение метаинформации для конфигурации канального приложения operationId: getFormsConfiguration responses: '200': description: Метаинформация для конфигурации канального приложения content: application/json: schema: $ref: '#/components/schemas/FormsConfigurationDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /cards/search: post: tags: - ccop-m131-lan-hms-bff summary: Поиск в форме Карты operationId: findCards requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CardSearchQueryDto' responses: '200': description: Результаты поиска content: application/json: schema: $ref: '#/components/schemas/CardSearchResultDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Карта не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /cards/{cardId}: get: tags: - ccop-m131-lan-hms-bff summary: Получить детальную информацию по карте operationId: getCardDetailedInfo parameters: - $ref: '#/components/parameters/cardId' responses: '200': description: Результаты поиска content: application/json: schema: $ref: '#/components/schemas/CardDetailDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Карта не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' # Смена статуса карты (блокировка карты) /cards/{cardId}/status: post: tags: - ccop-m131-lan-hms-bff summary: Изменение статуса карты operationId: setCardStatus parameters: - $ref: '#/components/parameters/cardId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetCardStatusQueryDto' responses: '200': description: Результат публикации нового статуса карты '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Карта не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /limits/search: post: tags: - ccop-m131-lan-hms-bff summary: Поиск по форме лимитов operationId: findLimits requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LimitSearchQueryDto' responses: '200': description: Результаты поиска content: application/json: schema: $ref: '#/components/schemas/LimitSearchResultDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Карта не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /limits/{limitId}: get: tags: - ccop-m131-lan-hms-bff summary: Получить детальную информацию по лимиту operationId: getLimitDetailedInfo parameters: - $ref: '#/components/parameters/limitId' responses: '200': description: Детальная информация по лимиту content: application/json: schema: $ref: '#/components/schemas/LimitDetailDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Лимит не найден content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' delete: tags: - ccop-m131-lan-hms-bff summary: Удалить лимит operationId: deleteLimit parameters: - $ref: '#/components/parameters/limitId' responses: '200': description: Лимит удален '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Лимит не найден content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /limits: post: tags: - ccop-m131-lan-hms-bff summary: Добавить новый лимит operationId: addLimit requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddLimitDto' responses: '200': description: Информация об успешно добавленном лимите content: application/json: schema: $ref: '#/components/schemas/LimitDetailDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' put: tags: - ccop-m131-lan-hms-bff summary: Обновить существующий лимит operationId: updateLimit requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ModifyLimitDto' responses: '200': description: Информация об успешно обновленном лимите content: application/json: schema: $ref: '#/components/schemas/LimitDetailDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /operations/search: post: tags: - ccop-m131-lan-hms-bff summary: Поиск по форме операции operationId: findOperations requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OperationSearchQueryDto' responses: '200': description: Результаты поиска content: application/json: schema: $ref: '#/components/schemas/OperationSearchResultDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /operations/{operationId}: get: tags: - ccop-m131-lan-hms-bff summary: Получить детальную информацию по операции operationId: getOperationDetailedInfo parameters: - $ref: '#/components/parameters/operationId' responses: '200': description: Детальная информация по операции content: application/json: schema: $ref: '#/components/schemas/OperationDetailDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Операция не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /operations/{operationId}/reversal/execute: post: tags: - ccop-m131-lan-hms-bff summary: Отмена операции operationId: operationReversalExecute parameters: - $ref: '#/components/parameters/operationId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReversalExecuteDto' responses: '200': description: Результаты создания reversal content: application/json: schema: $ref: '#/components/schemas/ReversalExecuteResultDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Операция не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' # Справочники /dictionaries/mcc: get: summary: Получить список всех записей справочника 084 - MCC (Коды видов деятельности торговых точек на территории РФ) description: Возвращает массив объектов MCC с детальной информацией по каждому коду. operationId: getMccDictionary tags: - ccop-m131-lan-hms-bff responses: '200': description: Успешный ответ content: application/json: schema: type: array maxItems: 100000 items: $ref: '#/components/schemas/DictionaryMccDto' '400': description: Операция не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /dictionaries/okv: get: summary: Получить список записей справочника 012 - OKV (Общероссийский классификатор валют) description: Возвращает массив объектов валют с детальной информацией. operationId: getOkvDictionary tags: - ccop-m131-lan-hms-bff responses: '200': description: Успешный ответ content: application/json: schema: type: array maxItems: 100000 items: $ref: '#/components/schemas/DictionaryOkvDto' '400': description: Операция не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /dictionaries/oksm: get: summary: Получить список записей справочника 014 (Общероссийский классификатор стран мира (ОКСМ)) description: Возвращает массив объектов стран с детальной информацией. operationId: getOksmDictionary tags: - ccop-m131-lan-hms-bff responses: '200': description: Успешный ответ content: application/json: schema: type: array maxItems: 100000 items: $ref: '#/components/schemas/DictionaryOksmDto' '400': description: Операция не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /dictionaries/osc: get: summary: Получить список записей технического справочника кодов операций лимита description: Возвращает массив объектов с информацией о кодах операций лимитов operationId: getOscDictionary tags: - ccop-m131-lan-hms-bff responses: '200': description: Успешный ответ content: application/json: schema: type: array maxItems: 100000 items: $ref: '#/components/schemas/DictionaryOscDto' '400': description: Операция не найдена content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' /tasks: post: tags: - ccop-m131-lan-hms-bff summary: Завершение задания (ОС ОЗ) operationId: changeTaskStatus requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TaskDto' responses: '200': description: Результаты поиска content: application/json: schema: $ref: '#/components/schemas/TaskDto' '400': description: Ошибка форматно-логического контроля content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Серверная ошибка content: application/json: schema: $ref: '#/components/schemas/ErrorList' components: schemas: CardSearchQueryDto: type: object additionalProperties: false required: - filter - pagination properties: filter: $ref: '#/components/schemas/CardFilterDto' sort: type: array maxItems: 1000 description: Правила сортировки items: $ref: '#/components/schemas/SortingDto' pagination: $ref: '#/components/schemas/PaginationDto' CardFilterDto: type: object additionalProperties: false properties: pan: type: string pattern: ^\d{16}$ description: Полный номер карты dpan: type: string maxLength: 16 description: Токенизированный номер карты maskedPan: type: string pattern: ^\d{16}$ description: Маскированный полный номер карты CardSearchResultDto: type: object additionalProperties: false required: - itemsList - pagination properties: itemsList: type: array maxItems: 100000 description: Правила сортировки items: $ref: '#/components/schemas/CardItemDto' sort: type: array maxItems: 1000 description: Правила сортировки items: $ref: '#/components/schemas/SortingDto' pagination: $ref: '#/components/schemas/PaginationDto' CardItemDto: type: object additionalProperties: false required: - client - status - productCode - gbl - cardId properties: maskedPan: type: string pattern: ^\d{16}$ description: Маскированный полный номер карты dpan: type: string maxLength: 16 description: Токенизированный номер карты status: $ref: '#/components/schemas/CardStatusEnum' gbl: type: string maxLength: 255 description: Глобальная бизнес-линия - SMB, CIB accountNumber: type: string maxLength: 20 description: Номер счета productCode: type: string description: Код продукта maxLength: 255 example: SMB_UBC_MR_22002461_001 client: $ref: '#/components/schemas/CardClientDto' productInstanceId: type: string maxLength: 255 description: Идентификатор продукта example: "c712f9f9-9842-4f4e-8cb0-e885f2d61935" cardId: type: string maxLength: 255 description: Идентификатор карты CardDetailDto: type: object additionalProperties: false required: - expiryDate - status - activationType - productCode - gbl - paymentSystem - phone3DS - officeService properties: maskedPan: type: string pattern: ^\d{16}$ description: Маскированный полный номер карты dpan: type: string maxLength: 16 description: Токенизированный номер карты example: 123456DPAN345678 cardId: type: string maxLength: 255 description: Идентификатор карты paymentSystem: $ref: '#/components/schemas/PaymentSystemEnum' expiryDate: type: string maxLength: 5 description: Дата окончания срока действия карты example: "01/39" status: $ref: '#/components/schemas/CardStatusEnum' comment: type: string maxLength: 255 description: Основание изменения параметров (заполняется сотрудником вручную) openingDate: type: string format: date description: Дата открытия карты closingDate: type: string format: date description: Дата закрытия карты plastics: type: array maxItems: 1000 description: Набор данных о физическом пластике items: $ref: '#/components/schemas/CardPlasticDto' phone3DS: type: string maxLength: 20 description: Телефон для подключения 3DS example: "+79854351234" officeService: $ref: '#/components/schemas/OfficeDto' holder: $ref: '#/components/schemas/CardHolderDto' client: $ref: '#/components/schemas/CardClientDto' groupCode: type: string maxLength: 255 description: Идентификатор группового карточного контракта в соответствии с данными продуктового СУБО gbl: type: string maxLength: 255 description: Глобальная бизнес-линия - SMB, CIB productCode: type: string maxLength: 255 description: Код продукта example: SMB_UBC_MR_22002461_001 activationType: $ref: '#/components/schemas/ActivationTypeEnum' productInstance: $ref: '#/components/schemas/CardProductInstanceDto' representativeId: type: string maxLength: 255 description: Идентификатор представителя CardPlasticDto: type: object additionalProperties: false required: - plasticType description: Данные о физическом пластике properties: plasticType: $ref: '#/components/schemas/PlasticTypeEnum' officeDelivery: $ref: '#/components/schemas/OfficeDto' statusLogistic: type: string maxLength: 255 description: Логистический статус карты embossingLane1: type: string maxLength: 255 description: Эмбоссированая строка (1) example: "CARD HOLDER" embossingLane2: type: string maxLength: 255 description: Эмбоссированая строка (2) example: "COMPANY NAME" embossingLane3: type: string maxLength: 255 description: Эмбоссированая строка (3) example: "DEPARTMENT" OfficeDto: type: object additionalProperties: false description: Данные о точке обслуживания/доставки (из ОПС Отделения и точки продаж) properties: name: type: string maxLength: 255 description: Наименование офиса Банка example: "ДО № 1 в г. Твери" fullName: type: string maxLength: 255 description: Полное наименование офиса Банка example: "Дополнительный офис № 1 в г. Твери Филиала №6911 Банка ВТБ 24 (закрытое акционерное общество)" CardHolderDto: type: object additionalProperties: false required: - holderId - firstName - lastName description: Данные о держателе карты (физическом лице, владельце пластика) properties: holderId: type: string maxLength: 255 description: Идентификатор держателя карты (mdmId) example: "4986438" firstName: type: string maxLength: 255 description: Имя держателя example: Иван middleName: type: string maxLength: 255 description: Отчество держателя example: Иванович lastName: type: string maxLength: 255 description: Фамилия держателя example: Иванов birthDateTime: type: string maxLength: 255 description: Дата рождения documents: type: array maxItems: 1000 description: Набор документов держателя items: $ref: '#/components/schemas/CardHolderDocumentDto' CardHolderDocumentDto: type: object additionalProperties: false required: - number - series - issueName - issueDate description: Данные о документе держателя карты properties: expirationDate: type: string maxLength: 255 description: Срок действия документа issueCode: type: string maxLength: 255 description: Код подразделения, выдавшего документ issueDate: type: string maxLength: 255 description: Дата выдачи issueName: type: string maxLength: 255 description: Кем выдан number: type: string maxLength: 255 description: Номер series: type: string maxLength: 255 description: Серия typeCode: type: string maxLength: 255 description: Тип документа trustFlag: type: boolean description: Признак актуальности example: true CardClientDto: type: object additionalProperties: false required: - tin - name - fullName description: Данные о клиенте (юридическом лице, владельце счета) properties: clientId: type: string maxLength: 255 description: Идентификатор клиента (mdmId) example: "1238193" name: type: string maxLength: 255 description: Наименование клиента fullName: type: string maxLength: 255 description: Полное наименование клиента tin: type: string maxLength: 255 description: ИНН клиента CardProductInstanceDto: type: object additionalProperties: false description: Данные об экземпляре продукта properties: productInstanceId: type: string maxLength: 255 description: Идентификатор продукта example: "c712f9f9-9842-4f4e-8cb0-e885f2d61935" accounts: type: array description: Информация о счетах, связанных с экземпляром продукта minItems: 0 maxItems: 1000 items: $ref: '#/components/schemas/AccountDto' AccountDto: type: object additionalProperties: false required: - accountNumber - isoCurrencyCode description: Данные о счете properties: accountNumber: type: string maxLength: 20 description: Номер счета accountStatus: type: string maxLength: 255 description: Статус счета isoCurrencyCode: type: string maxLength: 255 description: Цифровой код валюты contractNumber: type: string maxLength: 255 description: Номер договора, в рамках которого открыт счет example: 0191-C-567238 PlasticTypeEnum: type: string description: Форма выпуска карты enum: - CARD - STICKER - VIRTUAL example: CARD PaymentSystemEnum: type: string description: Платежная система enum: - MIR - VISA - MASTER_CARD example: MIR CardStatusEnum: type: string description: Статус карты enum: - NEW - LOCKED - ACTIVE - DEACTIVATED - BLOCKED - LOST - STOLEN - DAMAGED - COMPROMISED - CLOSED example: NEW ActivationTypeEnum: type: string description: Способ активации карты enum: - IMMEDIATELY # активация в момент выпуска карты - BY_ACTION # активация при совершении операции с пин-кодом в банкомате - BY_REQUEST # активация по запросу - BY_ACTION_OR_REQUEST # активация при совершении операции с пин-кодом в банкомате или по запросу example: IMMEDIATELY # Управление параметрами карты SetCardStatusQueryDto: type: object required: - status properties: oldStatus: $ref: '#/components/schemas/CardStatusEnum' status: $ref: '#/components/schemas/CardStatusEnum' comment: type: string maxLength: 255 description: Основание изменения параметров (заполняется сотрудником вручную) # Лимиты по карте LimitSearchQueryDto: type: object additionalProperties: false required: - filter - pagination properties: filter: $ref: '#/components/schemas/LimitFilterDto' sort: type: array maxItems: 1000 description: Правила сортировки items: $ref: '#/components/schemas/SortingDto' pagination: $ref: '#/components/schemas/PaginationDto' LimitFilterDto: type: object additionalProperties: false required: - cardId properties: clientId: type: string maxLength: 255 description: Идентификатор клиента productInstanceId: type: string maxLength: 255 description: Идентификатор счета groupCode: type: string maxLength: 255 description: Идентификатор группы карт holderId: type: string maxLength: 255 description: Идентификатор держателя representativeId: type: string maxLength: 255 description: Идентификатор представителя cardId: type: string maxLength: 255 description: Идентификатор карты statuses: type: array minItems: 0 maxItems: 20 description: Диапазон статусов для фильтра items: $ref: '#/components/schemas/LimitStatusEnum' periodTypes: type: array minItems: 0 maxItems: 20 description: Диапазон периодов расчета для фильтра items: $ref: '#/components/schemas/LimitPeriodTypeEnum' levels: type: array minItems: 0 maxItems: 20 description: Диапазон уровней применения лимита для фильтра items: $ref: '#/components/schemas/LimitLevelEnum' sourcesInfo: type: array minItems: 0 maxItems: 20 description: Диапазон источников данных для фильтра items: $ref: '#/components/schemas/SourceInfoEnum' operationSelectionCodes: type: array minItems: 0 maxItems: 20 description: Диапазон кодов предопределенного селектора типа операции для фильтра items: type: string maxLength: 255 LimitSearchResultDto: type: object additionalProperties: false required: - itemsList - pagination properties: itemsList: type: array maxItems: 100000 description: Правила сортировки items: $ref: '#/components/schemas/LimitItemDto' sort: type: array maxItems: 1000 description: Правила сортировки items: $ref: '#/components/schemas/SortingDto' pagination: $ref: '#/components/schemas/PaginationDto' LimitItemDto: type: object additionalProperties: false required: - limitId - periodType - status properties: limitId: type: string maxLength: 255 description: Идентификатор лимита operationSelectionCode: type: string maxLength: 255 description: Код предопределенного селектора типа операции operationSelection: $ref: '#/components/schemas/LimitOperationSelectionDto' periodType: $ref: '#/components/schemas/LimitPeriodTypeEnum' periodLen: type: integer minimum: 0 maximum: 2147483000 description: Продолжительность периода status: $ref: '#/components/schemas/LimitStatusEnum' sum: type: number minimum: -999999999999999 maximum: 999999999999999 description: Ограничение суммы операций за период count: type: integer minimum: 0 maximum: 2147483000 description: Ограничение количества операций за период sourceInfo: type: string maxLength: 255 description: Источник данных о лимите limitUtilization: $ref: '#/components/schemas/LimitUtilizationDto' currency: type: string maxLength: 5 description: Валюта лимита LimitDetailDto: type: object additionalProperties: false required: # - limitId - сделал условно необязательным, потому что переиспользую модель в эндпоинте добавления лимита, где заранее этого идентификатора нет - periodType - status - dateModify properties: limitId: type: string format: uuid maxLength: 255 description: Идентификатор лимита clientId: type: string maxLength: 255 description: Идентификатор клиента productInstanceId: type: string maxLength: 255 description: Идентификатор счета groupCode: type: string maxLength: 255 description: Идентификатор группы карт holderId: type: string maxLength: 255 description: Идентификатор держателя representativeId: type: string maxLength: 255 description: Идентификатор представителя cardId: type: string maxLength: 255 description: Идентификатор карты operationSelectionCode: type: string maxLength: 255 description: Код предопределенного селектора типа операции operationSelection: $ref: '#/components/schemas/LimitOperationSelectionDto' periodType: $ref: '#/components/schemas/LimitPeriodTypeEnum' periodLen: type: integer minimum: 0 maximum: 2147483000 description: Продолжительность периода status: $ref: '#/components/schemas/LimitStatusEnum' sum: type: number minimum: -999999999999999 maximum: 999999999999999 description: Ограничение суммы операций за период count: type: integer minimum: 0 maximum: 2147483000 description: Ограничение количества операций за период sourceInfo: type: string maxLength: 255 description: Источник данных о лимите productCode: type: string description: Код продукта limitUtilization: $ref: '#/components/schemas/LimitUtilizationDto' currency: type: string maxLength: 5 description: Валюта лимита dateModify: type: string format: date-time description: Дата изменений reverseType: $ref: '#/components/schemas/LimitReverseTypeEnum' limitTypeCode: type: string maxLength: 255 description: Код типа лимита, служит для приоритезации лимитов, принадлежащих к разным уровням иерархии limitPriorityInType: type: integer minimum: -2147483000 maximum: 2147483000 description: Приоритетность лимита в рамках заданного limitTypeCode comment: type: string maxLength: 255 description: Основание изменения параметров (заполняется сотрудником УСКО вручную в случае, если были изменения параметров лимита) # Абстракция, дтошка с общими полями и для создания и для редактирования CommonLimitPropertiesDto: type: object properties: limitId: type: string format: uuid description: Идентификатор лимита productCode: type: string description: Код продукта resetUtilization: type: boolean description: Необходимость сброса счетчиков при изменении параметров лимита (Не заполняется по SINGLE, SLIDING_*, по другим типам лимитов обязательно) resetCounterResetTime: type: boolean description: Признак необходимости сброса текущего периода лимита при обновлении при изменении параметров лимита (Не заполняется по SINGLE, SLIDING_*, по другим типам лимитов обязательно) cardId: type: string description: Идентификатор карты groupCode: type: string description: Идентификатор группы карт clientId: type: string description: Идентификатор клиента productInstanceId: type: string description: Идентификатор счета holderId: type: string description: Идентификатор держателя representativeId: type: string description: Идентификатор представителя operationSelectionCode: type: string description: Код предопределенного селектора типа операции operationSelection: $ref: '#/components/schemas/LimitOperationSelectionDto' # Поле из нашей спецификации periodType: $ref: '#/components/schemas/LimitPeriodTypeEnum' # Поле из нашей спецификации periodLen: type: integer description: Продолжительность периода status: $ref: '#/components/schemas/LimitStatusEnum' # Поле из нашей спецификации sum: type: number description: Ограничение суммы операций за период currency: type: string description: Валюта лимита maxLength: 5 count: type: integer description: Ограничение количества операций за период sourceInfo: type: string description: Источник данных о лимите # Поле из нашей спецификации limitUtilization: $ref: '#/components/schemas/LimitUtilizationDto' # Поле из нашей спецификации reverseType: $ref: '#/components/schemas/LimitReverseTypeEnum' # Поле из нашей спецификации limitTypeCode: type: string description: Код типа лимита, служит для приоритезации лимитов, принадлежащих к разным уровням иерархии maxLength: 50 limitPriorityInType: type: integer description: Приоритетность лимита в рамках заданного limitTypeCode dateModify: type: string format: date-time description: Дата изменений # Поле из нашей спецификации comment: type: string description: Основание изменения параметров (заполняется сотрудником УСКО вручную в случае, если были изменения параметров лимита) # Поле из нашей спецификации ModifyLimitDto: required: - limitId - periodType - status allOf: - properties: oldLimitDiff: type: string description: "Различия от предыдущего лимита, нужно для аудита" example: "sum: 200.00 -> 512.00, status: ACTIVE -> NOT_ACTIVE, limitUtilization.utilizationSum: 100.00 -> 64.00" - $ref: '#/components/schemas/CommonLimitPropertiesDto' AddLimitDto: required: - periodType allOf: - $ref: '#/components/schemas/CommonLimitPropertiesDto' SourceInfoEnum: type: string description: Тип источника данных enum: - BANK # общебанковский - INDIVIDUAL # индивидуальный example: BANK LimitStatusEnum: type: string description: Статус карты enum: - ACTIVE - NOT_ACTIVE - DELETED example: ACTIVE LimitReverseTypeEnum: type: string description: Действия со счетчиками лимитов при возвратной операции enum: - NO_RESTORE # Восстановление счетчиков не производится - SUM_RESTORE # Выполняется восстановление только счетчика суммы израсходованного лимита - SUM_RESTORE_COUNT_RESTORE # Выполняется восстановление как счетчика суммы лимита, так и счетчика количества операций - SUM_RESTORE_COUNT_INCREASE # Восстанавливается счетчик суммы лимита, а счетчик количества операций увеличивается. example: NO_RESTORE LimitPeriodTypeEnum: type: string description: Тип периода расчета лимита enum: - DAY - WEEK - MONTH - YEAR - SINGLE # на одну операцию - SLIDING_DAYS # в течение последних суток - SLIDING_HOURS # в течение последнего часа - SLIDING_MINUTES # в течение последней минуты - FOREVER example: FOREVER LimitLevelEnum: type: string description: Тип уровня применения лимита enum: - CARD # на карту - GROUP # на групповой контракт - PRODUCT_INSTANCE # на карт-счет - HOLDER # на держателя карты - CLIENT # на клиента ЮЛ - REPRESENTATIVE # на представителя ЮЛ example: GROUP LimitUtilizationDto: type: object additionalProperties: false description: Данные по расходованию лимита required: - dateModify properties: utilizationSum: type: number minimum: -999999999999999 maximum: 999999999999999 description: Израсходованная сумма лимита utilizationCount: type: integer minimum: 0 maximum: 2147483000 description: Израсходованное количество операций dateModify: type: string format: date-time description: Дата последнего изменения счетчика лимитов LimitOperationSelectionDto: type: object additionalProperties: false description: Селектор типа операции properties: operationKind: type: array maxItems: 1000 items: type: string maxLength: 255 description: Тип операции terminalType: type: array maxItems: 1000 items: type: string maxLength: 255 description: Тип терминала, используемого при авторизации cardEntryMode: type: array maxItems: 1000 items: type: string maxLength: 255 description: Способ предъявления карты authenticationMode: type: array maxItems: 1000 items: type: string maxLength: 255 description: Способ аутентификации acquirer: type: array maxItems: 1000 items: type: string maxLength: 255 description: Эквайер mcc: type: array maxItems: 1000 items: type: string maxLength: 255 description: Разрешенный код MCC area: type: array maxItems: 1000 items: type: string maxLength: 255 description: Регион, в котором выполняется авторизация операции currency: type: array maxItems: 1000 items: type: string maxLength: 5 description: Валюта транзакции # Операции OperationSearchQueryDto: type: object additionalProperties: false required: - filter - pagination properties: filter: $ref: '#/components/schemas/OperationFilterDto' sort: type: array maxItems: 1000 description: Правила сортировки items: $ref: '#/components/schemas/SortingDto' pagination: $ref: '#/components/schemas/PaginationDto' OperationFilterDto: type: object additionalProperties: false properties: cardId: type: string maxLength: 255 description: Идентификатор карты pan: type: string pattern: ^\d{16}$ description: Полный номер карты dpan: type: string description: Токенизированный номер карты accountNumber: type: string maxLength: 20 description: Номер счета rrn: type: string maxLength: 255 description: Номер документа для платежных систем (RRN) example: "513413504695" arn: type: string maxLength: 255 description: Референсное значение Эквайрера (ARN) 23 знака, может начинаться с 0 example: "79999995217716170000069" authorizationCode: type: string maxLength: 255 description: Код авторизации example: "D4HJ91" from: type: string format: date-time description: с to: type: string format: date-time description: по OperationSearchResultDto: type: object additionalProperties: false required: - itemsList - pagination properties: itemsList: type: array maxItems: 100000 description: Правила сортировки items: $ref: '#/components/schemas/OperationItemDto' sort: type: array maxItems: 1000 description: Правила сортировки items: $ref: '#/components/schemas/SortingDto' pagination: $ref: '#/components/schemas/PaginationDto' OperationItemDto: type: object additionalProperties: false required: - operationId properties: operationId: type: string maxLength: 255 description: Внутренний идентификатор операции example: "22ad7fa9-9a60-4f45-8df3-aa8b885f7880" dpan: type: string maxLength: 16 description: Токенизированный номер карты maskedPan: type: string pattern: ^\d{16}$ description: Маскированный полный номер карты transactionLifePhase: $ref: '#/components/schemas/TransactionLifePhaseEnum' transactionLocalDateTime: type: string format: date-time description: Дата и время операции example: "2025-04-25T11:38:19.000+03:00" rrn: type: string maxLength: 255 description: Номер документа для платежных систем (RRN) example: "513413504695" authorizationCode: type: string maxLength: 255 description: Код авторизации example: "D4HJ91" arn: type: string maxLength: 255 description: Референсное значение Эквайрера (ARN) 23 знака, может начинаться с 0 example: "79999995217716170000069" paymentSystem: type: string maxLength: 255 description: Платежная система транзакции example: "MIR" operationStatus: $ref: '#/components/schemas/IncomingMessageStatusEnum' example: "APPROVED" transactionKind: $ref: '#/components/schemas/TransactionKind' maxLength: 255 description: Тип транзакции example: "Cash" isReversalTransaction: type: boolean description: Транзакция является реверсом (реверсирует другую транзакцию) example: true transactionAmount: $ref: '#/components/schemas/MoneyDto' transactionClearingAmount: $ref: '#/components/schemas/MoneyDto' OperationDetailDto: type: object additionalProperties: false required: - operationId - tokenKind - transactionKind properties: operationId: type: string maxLength: 255 description: Внутренний идентификатор операции example: "22ad7fa9-9a60-4f45-8df3-aa8b885f7880" dpan: type: string maxLength: 16 description: Токенизированный номер карты maskedPan: type: string pattern: ^\d{16}$ description: Маскированный полный номер карты transactionLifePhase: $ref: '#/components/schemas/TransactionLifePhaseEnum' transactionUndoState: $ref: '#/components/schemas/TransactionUndoStateEnum' transactionLocalDateTime: type: string format: date-time description: Дата и время операции example: "2025-04-25T11:38:19.000+03:00" operationStatus: $ref: '#/components/schemas/IncomingMessageStatusEnum' financialInstructionStatus: $ref: '#/components/schemas/FinancialInstructionStatusEnum' rrn: type: string maxLength: 255 description: Номер документа для платежных систем (RRN) example: "513413504695" terminal: $ref: '#/components/schemas/IncomingMessageTerminalDto' customerChecks: $ref: '#/components/schemas/IncomingMessageCustomerChecksDto' cardEntryMode: type: string maxLength: 255 description: Режим использования карты example: "Icc" tokenKind: $ref: '#/components/schemas/TokenKindEnum' arn: type: string maxLength: 255 description: Референсное значение Эквайрера (ARN) 23 знака, может начинаться с 0 example: "79999995217716170000069" paymentSystem: type: string maxLength: 255 description: Платежная система транзакции example: "MIR" transactionAmount: $ref: '#/components/schemas/MoneyDto' transactionClearingAmount: $ref: '#/components/schemas/MoneyDto' transactionKind: $ref: '#/components/schemas/TransactionKind' maxLength: 255 description: Тип транзакции example: "Cash" isAdviceTransaction: type: boolean description: Признак того, что транзакция является извещением (Advice) example: true isReversalTransaction: type: boolean description: Транзакция является реверсом (реверсирует другую транзакцию) example: true reversalReason: type: string maxLength: 255 description: Причина реверса example: "Timeout" result: $ref: '#/components/schemas/IncomingMessageResultDto' reversalReasonDescription: type: string maxLength: 255 description: Основание отмены (reversal) - заполняется вручную на UI cardId: type: string maxLength: 255 description: Идентификатор карты purpose: $ref: '#/components/schemas/PurposeDto' source: $ref: '#/components/schemas/BankingDetailDto' target: $ref: '#/components/schemas/BankingDetailDto' BankingDetailDto: type: object additionalProperties: false required: - accountNumber properties: accountNumber: type: string maxLength: 20 description: Номер счета в ЦФТ PurposeDto: type: object additionalProperties: false description: Назначение платежа required: - description properties: description: type: string maxLength: 255 description: Элемент объекта example: Оплата ЖКХ IncomingMessageResultDto: type: object additionalProperties: false required: - resultMessage description: Результат транзакции properties: resultMessage: type: string maxLength: 255 description: Результат транзакции example: "Approved" authorizationCode: type: string maxLength: 255 description: Код авторизации example: "D4HJ91" declineReason: type: string maxLength: 255 description: Причина отказа example: "Клиринг невозможен: Операция не может быть обработана" MoneyDto: type: object additionalProperties: false required: - value - currency description: Сумма в валюте properties: value: type: string maxLength: 255 description: Сумма example: "500000.00" currency: type: string maxLength: 5 description: Валюта example: "RUB" IncomingMessageTerminalDto: type: object additionalProperties: false description: Терминальное устройство (POS, ATM) на котором произошла транзакция properties: merchantName: type: string maxLength: 255 description: Наименование владельца терминала acquirerCountry: type: string maxLength: 255 description: Страна эквайера example: "643" name: type: string maxLength: 255 description: Ссылочный идентификатор (имя) терминала example: "00005606" type: type: string maxLength: 255 description: Тип терминала example: "Pos" mcc: type: integer minimum: -2147483000 maximum: 2147483000 description: Код деятельности торговой точки присвоенный терминалу example: 5691 IncomingMessageCustomerChecksDto: type: object additionalProperties: false description: Проверки владельца карты properties: isCustomerPresent: type: boolean description: Присутствует ли владелец карты при совершении транзакции example: true isSignChecked: type: boolean description: Подпись владельца карты проверена example: true isTdsChecked: type: boolean description: Карта проверена по технологии 3-D Secure example: true TransactionLifePhaseEnum: type: string description: Фаза жизненного цикла транзакции enum: - AUTH - CHARGEBACK - CHARGEBACK2 - CHARGEBACK2NOTIFY - CHARGEBACK_NOTIFY - PRESENTMENT - PRESENTMENT_NOTIFY - PRESENTMENT_RS - REPRESENTMENT - REPRESENTMENT_NOTIFY - RETRIEVAL - RETRIEVAL_NOTIFY - RETRIEVAL_RS - RETRIEVAL_RS_NOTIFY - SINGLE - SINGLE_NOTIFY - SINGLE_RS - TERMINAL_COMPLETION - WRITEOFF_DEFERRED - WRITEOFF_DEFERRED_NOTIFY example: WRITEOFF_DEFERRED_NOTIFY TransactionUndoStateEnum: type: string description: Статус отката транзакции enum: - NORMAL - UNDO - UNDONE example: UNDONE TokenKindEnum: type: string description: Вид токена enum: - CARD # карта - CERT # сертификат - EXT_AUTH_APP # внешнее приложение аутентификации - LOGIN # логин и пароль - MOBILE_APP # мобильное приложение - PHONE # телефон - WEB_APP # веб-приложение example: CARD IncomingMessageStatusEnum: type: string description: Статус входящего финансового сообщения карточной операции клиента ЮЛ enum: - APPROVED - PROCESSING - RECEIVED - REJECTED - SYSTEM_ERROR example: APPROVED FinancialInstructionStatusEnum: type: string description: Статус финансовой инструкции enum: - COMPLETED - ERROR - NEW - PROCESSING - REJECTED example: COMPLETED TransactionKind: type: string description: Тип транзакции enum: - GOODS - CASH - GET_CONTRACT_INFO - DEPOSIT - RETURN - QUASI_CASH - GET_TOKEN_INFO - GOODS_WITH_CASHBACK - PAYMENT_DEBIT - PAYMENT_CREDIT - PIN_CHANGE - CHECK_TOKEN - UNKNOWN_VALUE # ReversalExecute ReversalExecuteDto: type: object properties: transactionAmount: $ref: '#/components/schemas/TransactionAmountDto' transactionAmountReversal: $ref: '#/components/schemas/TransactionAmountDto' reversalReasonDescription: type: string maxLength: 255 description: Обоснование реверсала example: В рамках задачи TransactionAmountDto: type: object properties: value: type: string maxLength: 255 description: Сумма оригинальной транзакции/Сумма реверсала example: 500000.00 currency: type: string maxLength: 5 description: Валюта оригинальной транзакции/Валюта реверсала example: RUB ReversalExecuteResultDto: type: object description: Успешный ответ properties: operationId: type: string maxLength: 255 description: Идентификатор операции, к которой добавили Комментарий example: 22ad7fa9-9a60-4f45-8df3-aa8b885f7880 # Справочники DictionaryMccDto: type: object description: Элемент справочника MCC required: - isActive - version - upDate - value properties: isActive: type: boolean description: Статус актуальности данной записи example: true version: type: integer description: Версия данной записи example: 1 upDate: type: string format: date-time description: Дата и время изменения записи (в UTC, формат ISO 8601) example: "2025-03-25T14:30:00Z" value: type: string maxLength: 255 description: Код MCC (основной) example: "9390" codeVisa: type: string maxLength: 255 description: Код Visa example: "N" codeMC: type: string maxLength: 255 description: Код MasterCard example: "N" codeAE: type: string maxLength: 255 description: Код American Express example: "N" codeUp: type: string maxLength: 255 description: Код UnionPay example: "N" codeSbp: type: string maxLength: 255 description: Код СБП example: "N" name: type: string maxLength: 255 description: Наименование на русском языке example: "Платежи на ЕКС в ГИС ЕПГУ" nameEng: type: string maxLength: 255 description: Наименование на английском языке example: "N" description: type: string maxLength: 5000 description: Описание категории example: "Eating places and restaurants" isMoto: type: string maxLength: 255 description: Признак MOTO (Mail Order/Telephone Order) example: "Y" isProductPos: type: string maxLength: 255 description: Признак Product POS example: "N" isIrfPos: type: string maxLength: 255 description: Признак IRF POS example: "N" isHrPos: type: string maxLength: 255 description: Признак HR POS example: "N" isDobPos: type: string maxLength: 255 description: Признак DOB POS example: "N" isLicencePos: type: string maxLength: 255 description: Признак Licence POS example: "N" isProductEcom: type: string maxLength: 255 description: Признак Product Ecom example: "N" isIrfEcom: type: string maxLength: 255 description: Признак IRF Ecom example: "N" isHrEcom: type: string maxLength: 255 description: Признак HR Ecom example: "N" isDobEcom: type: string maxLength: 255 description: Признак DOB Ecom example: "N" isLicenceEcom: type: string maxLength: 255 description: Признак Licence Ecom example: "N" isProductSbp: type: string maxLength: 255 description: Признак Product SBP example: "N" extIsActive: type: string maxLength: 255 description: Признак активности (из внешней системы) example: "Y" DictionaryOkvDto: type: object description: Элемент справочника валют (OKV) required: - isActive - version - upDate - value properties: isActive: type: boolean description: Статус актуальности данной записи example: true version: type: integer description: Версия данной записи example: 72 upDate: type: string format: date-time description: Дата и время изменения записи (в UTC, формат ISO 8601) example: "2025-03-25T14:30:00Z" value: type: string maxLength: 255 description: Код валюты (основной) example: "932" id: type: string maxLength: 255 description: Внутренний уникальный код записи (строковый идентификатор) example: "455" code: type: string maxLength: 255 description: Внутренний код - уникальный номер позиции классификатора example: "310" isoLat3: type: string maxLength: 255 description: Буквенный код валюты (трехбуквенный) example: "ZWL" nameRus: type: string maxLength: 255 description: Наименование валюты на русском языке example: "ДОЛЛАР ЗИМБАБВЕ" nameCou: type: string maxLength: 255 description: Краткое наименование стран и территорий example: "ЗИМБАБВЕ" nameCou1: type: string maxLength: 255 description: Краткое наименование стран и территорий (продолжение) example: "" nameCou2: type: string maxLength: 255 description: Краткое наименование стран и территорий (продолжение) example: "" nameCou3: type: string maxLength: 255 description: Краткое наименование стран и территорий (продолжение) example: "" cbDate: type: string maxLength: 255 description: Дата начала действия валюты example: "25.06.2024" ceDate: type: string maxLength: 255 description: Дата окончания действия валюты example: "31.12.2099" DictionaryOksmDto: type: object description: Элемент справочника стран мира (OKSM) required: - isActive - version - upDate - value properties: isActive: type: boolean description: Статус актуальности данной записи example: true version: type: integer description: Версия данной записи example: 72 upDate: type: string format: date-time description: Дата и время изменения записи (в UTC, формат ISO 8601) example: "2025-03-25T14:30:00Z" value: type: string maxLength: 255 description: Код страны example: "643" name: type: string maxLength: 255 description: Наименование страны example: "Российская Федерация" alphaTwo: type: string maxLength: 255 description: Двухбуквенный код страны (alpha-2) example: "RU" alphaThree: type: string maxLength: 255 description: Трехбуквенный код страны (alpha-3) example: "RUS" DictionaryOscDto: type: object description: Элемент справочника кодов операций properties: id: type: integer description: Идентификатор operationName: description: Наименование операции type: string operationSelectionCode: description: Код условий отбора операции type: string # Задание TaskDto: type: object additionalProperties: false required: - status properties: id: type: string maxLength: 255 description: Идентификатор задания status: type: string maxLength: 255 description: Публикуемый статус задания # Постраничная разбивка PaginationDto: type: object additionalProperties: false required: - pageNumber - pageSize properties: pageNumber: type: integer description: Текущий номер страницы minimum: 1 maximum: 1000 pageSize: type: integer description: Количество элементов, выводимых на странице minimum: 1 maximum: 1000 totalItems: type: integer description: Общее количество элементов (передается только в ответе от сервиса) minimum: 0 maximum: 2147483000 totalPages: type: integer description: Общее количество страниц (передается только в ответе от сервиса) minimum: 0 maximum: 1000 # Сортировка SortingDto: type: object additionalProperties: false required: - sortBy - sortDirection properties: sortBy: type: string maxLength: 255 description: Название атрибута, по которому производится сортировка sortDirection: $ref: '#/components/schemas/SortDirectionEnum' SortDirectionEnum: type: string description: Направление сортировки enum: - ASC # по возрастанию - DESC # по убыванию example: ASC # Формат ошибок ErrorList: type: array maxItems: 1000 description: Набор ошибок items: $ref: '#/components/schemas/ErrorDto' ErrorDto: type: object additionalProperties: false required: - code description: Описание ошибки при выполнении запроса properties: code: type: string maxLength: 255 description: Код ошибки message: type: string description: Описание ошибки example: Something goes wrong maxLength: 255 payload: type: string maxLength: 255 description: Сериализованные исходные данные об ошибке # Конфигурация отображения форм для канального приложения FormsConfigurationDto: type: object additionalProperties: false required: - user description: Конфигурация отображения форм для канального приложения properties: user: $ref: '#/components/schemas/FormsUserDto' FormsUserDto: type: object additionalProperties: false required: - roles description: Метаданные о пользователе канального приложения properties: roles: type: array description: Набор пользовательских ролей maxItems: 100 items: type: string maxLength: 255 parameters: cardId: name: cardId in: path description: Уникальный идентификатор карты example: b74c2d3d-989b-43be-9fcf-6feae1d53222 required: true schema: type: string 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}$' limitId: name: limitId in: path description: Уникальный идентификатор лимита example: b74c2d3d-989b-43be-9fcf-6feae1d53222 required: true schema: type: string 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}$' operationId: name: operationId in: path description: Уникальный идентификатор операции example: b74c2d3d-989b-43be-9fcf-6feae1d53222 required: true schema: type: string 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}$'