---
swagger: "2.0"
info:
  x-ibm-name: escrow-api
  title: Escrow API
  version: 1.0.1
  description: Сервис по работе со счетами эскроу
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/escrow
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  Authorization:
    type: oauth2
    description: Токен аутентификации полученный при вызове сервиса авторизации
    flow: application
    scopes:
      bcc.application.escrow.api: Allow to 'Escrow API'
    tokenUrl: https://api.bcc.kz/bcc/production/v2/oauth/token
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /ext/deals:
    post:
      description: Создает запись о сделке и отправляет Push покупателю
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Партнеры
      summary: Создать
      operationId: create-new-deal
      parameters:
      - description: Create request
        name: request
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateRequest'
      - $ref: '#/parameters/x-client-token'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/CreateDealResponse'
        400:
          description: Bad Request
  /ext/deals/{id}:
    get:
      description: Возвращает информацию по сделке
      produces:
      - application/json
      tags:
      - Партнеры
      summary: Получить по ID
      operationId: get-by-id
      parameters:
      - type: string
        description: ID сделки
        name: id
        in: path
        required: true
      - $ref: '#/parameters/x-client-token'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/GetDealResponse'
        400:
          description: Bad Request
    put:
      description: Запускает процесс по проверке регистрации сделки
      produces:
      - application/json
      tags:
      - Партнеры
      summary: Обновить статус сделки
      operationId: update-deal-status
      parameters:
      - type: string
        description: ID сделки
        name: id
        in: path
        required: true
      - $ref: '#/parameters/x-client-token'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/CreateDealResponse'
        400:
          description: Bad Request
  /buyer/accept/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            type: string
        400:
          description: Bad Request
      summary: Accept Escrow application
      description: Подтвердить заявление на открытие Escrow счета
    parameters:
    - $ref: '#/parameters/x-client-token'
  /buyer/code/iin/{iin}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/GetGovDocument'
        400:
          description: Bad Request
      summary: Получить SMS code для выгрузки документа из ГДБФЛ
      description: Получить SMS code по ИИН для выгрузки документа из ГДБФЛ
    parameters:
    - name: iin
      type: string
      required: true
      in: path
      description: ИИН
    - $ref: '#/parameters/x-client-token'
  /buyer/list:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/FilterBuyerEscrow'
        400:
          description: Bad Request
      summary: Получить список заявление Escrow
      description: Получить список заявление Escrow
    parameters:
    - $ref: '#/parameters/x-client-token'
  /buyer/{bin}/id/{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/FilterBuyerEscrow'
        400:
          description: Bad Request
      summary: Просмотр заявление Escrow
      description: Просмотр заявление Escrow
    parameters:
    - name: bin
      type: string
      required: true
      in: path
      description: БИН
    - name: id
      type: string
      required: true
      in: path
      description: Идентификатор
    - $ref: '#/parameters/x-client-token'
  /buyer/cancel/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            type: string
        400:
          description: Bad Request
      summary: Подтвердить отмену заявление на открытие Escrow счета
      description: Подтвердить отмену заявление на открытие Escrow счета
    parameters:
    - $ref: '#/parameters/x-client-token'
    - name: id
      type: string
      required: true
      in: path
      description: Идентификатор
  /save:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/EscrowApplication'
        400:
          description: Bad Request
      summary: Создать заявление для выпуска Escrow
      description: Создать заявление для выпуска Escrow юр. лиц
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/CreateEscrowApplicationRequest'
        description: The input CreateEscrowApplicationRequest struct
      operationId: saveEscrow
    parameters:
    - $ref: '#/parameters/x-client-token'
  /approve/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/EscrowApplication'
        400:
          description: Bad Request
      summary: Одобрить заявку для выпуска Escrow
      description: Одобрить заявку для выпуска Escrow юр. лиц
      parameters:
      - name: id
        type: string
        required: true
        in: path
        description: ID заявки
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/EscrowApplication'
        description: The input EscrowApplication struct
    parameters:
    - $ref: '#/parameters/x-client-token'
  /sent/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/EscrowSign'
        400:
          description: Bad Request
      summary: Отправить заявку для выпуска Escrow
      description: Отправить заявку для выпуска Escrow
      parameters:
      - name: id
        type: string
        required: true
        in: path
        description: ID заявки
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/EscrowSign'
        description: The input EscrowSign struct
    parameters:
    - $ref: '#/parameters/x-client-token'
  /list:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/EscrowApplication'
        400:
          description: Bad Request
      summary: Получить список заявление Escrow
      description: Получить список заявление Escrow
      parameters:
      - name: from_date
        type: string
        required: true
        in: query
        format: date
      - name: to_date
        type: string
        required: false
        in: query
        format: date
    parameters:
    - $ref: '#/parameters/x-client-token'
  /{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/EscrowApplication'
        400:
          description: Bad Request
      summary: Получить заявление Escrow по id
      description: Получить заявление Escrow по id
      parameters:
      - name: id
        type: string
        required: true
        in: path
        description: ID заявки
    parameters:
    - $ref: '#/parameters/x-client-token'
  /{escrow_id}/trustee-persons:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            type: integer
        400:
          description: Bad Request
      summary: Список доверенных лиц
      description: Получить список доверенных лиц Escrow заявки
      parameters:
      - name: escrow_id
        type: string
        required: true
        in: path
        description: ID заявки
    parameters:
    - $ref: '#/parameters/x-client-token'
  /update/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/EscrowApplication'
        400:
          description: Bad Request
      summary: Обновить заявление
      description: Обновить заявление
      parameters:
      - name: id
        type: string
        required: true
        in: path
        description: ID заявки
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/CreateEscrowApplicationRequest'
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/buyer/cancel:
    post:
      responses:
        200:
          description: 200 OK
        400:
          description: Bad Request
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/buyer/list:
    post:
      responses:
        200:
          description: 200 OK
        400:
          description: Bad Request
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/buyer/accept:
    post:
      responses:
        200:
          description: 200 OK
        400:
          description: Bad Request
      summary: Список заявлений для снятие средств
      description: Список заявлений для снятие средств
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/save:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/UnlockAgreeResult'
        400:
          description: Bad Request
      summary: Создает заявку на снятие блокировки суммы для Эскроу счета
      description: Создает заявку на снятие блокировки суммы для Эскроу счета
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/EscrowSign'
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/approve:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/UnlockAgreeResult'
        400:
          description: Bad Request
      summary: Метод позволяет одобрить заявку
      description: Метод позволяет одобрить заявку
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/EscrowSign'
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/{bin}/{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/UnlockAgreeRp'
        400:
          description: Bad Request
      summary: Просмотр заявки по BIN и AgreeID
      description: Просмотр заявки по BIN и AgreeID
      parameters:
      - name: bin
        type: string
        required: true
        in: path
        description: БИН
      - name: id
        type: string
        required: true
        in: path
        description: ID заявки
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/update/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/UnlockAgreeResult'
        400:
          description: Bad Request
      summary: Обновление заявки
      description: Обновление заявки
      parameters:
      - name: id
        type: string
        required: true
        in: path
        description: ID заявки
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/EscrowSign'
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/remove/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/UnlockAgreeResult'
        400:
          description: Bad Request
      summary: Создает заявку на снятие блокировки суммы для Эскроу счета
      description: Создает заявку на снятие блокировки суммы для Эскроу счета
      parameters:
      - name: id
        type: string
        required: true
        in: path
        description: ID заявки
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/EscrowSign'
    parameters:
    - $ref: '#/parameters/x-client-token'
  /agree/unlock/list:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/DBUnlockAgree'
        400:
          description: Bad Request
      summary: Возвращает список заявок на снятие
      description: Возвращает список заявок на снятие
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/EscrowSign'
    parameters:
    - $ref: '#/parameters/x-client-token'
  /report/close/view/{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ReportFileResponse'
        400:
          description: Bad Request
      summary: Предварительный просмотр заявление закрытия эскроу счета
      description: Предварительный просмотр заявление закрытия эскроу счета
      parameters:
      - type: string
        description: id
        name: id
        in: path
        required: true
    parameters:
    - $ref: '#/parameters/x-client-token'
  /report/unlock/view/{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ReportFileResponse'
        400:
          description: Bad Request
      summary: Предварительный просмотр заявление разблокировки суммы
      description: Предварительный просмотр заявление разблокировки суммы
      parameters:
      - type: string
        description: id
        name: id
        in: path
        required: true
    parameters:
    - $ref: '#/parameters/x-client-token'
  /report/{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ReportFileResponse'
        400:
          description: Bad Request
      summary: Получить файл
      description: Получить файл из ЦЭА или minio
      parameters:
      - type: string
        description: id
        name: id
        in: path
        required: true
    parameters:
    - $ref: '#/parameters/x-client-token'
  /report/list/{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/CeaFileMap'
        400:
          description: Bad Request
      summary: Получить список файлов
      description: Получить список файлов из ЦЭА или minio
      parameters:
      - type: string
        description: id
        name: id
        in: path
        required: true
    parameters:
    - $ref: '#/parameters/x-client-token'
  /report/consent/view/{id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ReportFileResponse'
        400:
          description: Bad Request
      summary: Предварительный просмотр согласие на сбор данных
      description: Предварительный просмотр согласие на сбор данных
      parameters:
      - type: string
        description: id
        name: id
        in: path
        required: true
    parameters:
    - $ref: '#/parameters/x-client-token'
  /close/approve/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/EscrowApplication'
        400:
          description: Bad Request
      summary: Одобрить заявку для закрытия Escrow юр. лиц
      description: Одобрить заявку для закрытия Escrow
      parameters:
      - type: string
        description: id
        name: id
        in: path
        required: true
      - description: The input EscrowSign struct
        name: data
        in: body
        required: true
        schema:
          $ref: '#/definitions/EscrowSign'
    parameters:
    - $ref: '#/parameters/x-client-token'
  /close/{id}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            type: string
        400:
          description: Bad Request
      summary: Закрытие Escrow application
      description: Закрытие Escrow application
      parameters:
      - type: string
        description: id
        name: id
        in: path
        required: true
    parameters:
    - $ref: '#/parameters/x-client-token'
definitions:
  CreateDealResponse:
    type: object
    properties:
      result:
        type: string
        description: Результат операции
        example: success - успешный
      resultMessage:
        type: string
        description: Текстовое сообщение
      resultObject:
        $ref: '#/definitions/CreateResponse'
        description: Дополнительные данные
  CreateRequest:
    type: object
    properties:
      address:
        $ref: '#/definitions/Address'
        description: Адрес
      amount:
        type: number
        description: Сумма сделки
      buyer:
        $ref: '#/definitions/Participant'
        description: Покупатель
      cadastralNumber:
        type: string
        description: Кадастровый номер недвижимости
      city:
        type: string
        description: Город обслуживания
      dueDate:
        type: string
        description: Срок выполнения сделки
      externalId:
        type: string
        description: Номер заявки
      seller:
        $ref: '#/definitions/Participant'
        description: Продавец
    required:
    - address
    - amount
    - buyer
    - cadastralNumber
    - city
    - dueDate
    - seller
    - externalId
  CreateResponse:
    type: object
    properties:
      dealId:
        type: string
        example: fed3352a-13f8-4c72-802e-ecb69c317be3
        description: Уникальный идентификатор сделки
  GetDealResponse:
    type: object
    properties:
      result:
        type: string
        description: Результат операции
        example: success - успешный
      resultMessage:
        type: string
        description: Текстовое сообщение
      resultObject:
        $ref: '#/definitions/ActualDeal'
        description: Дополнительные данные
  Address:
    type: object
    properties:
      buildingNumber:
        type: string
        description: Номер дома
      district:
        type: string
        description: Район
      flatNumber:
        type: string
        description: Номер квартиры
      region:
        type: string
        description: Регион
      street:
        type: string
        description: Улица
      town:
        type: string
        description: Город
      fullAddress:
        type: string
        description: Полный адрес
    required:
    - buildingNumber
    - district
    - region
    - street
    - town
  Participant:
    type: object
    properties:
      accountNumber:
        type: string
      fullName:
        type: string
        description: ФИО продавца/покупателя
      iin:
        type: string
        description: ИИН продавца/покупателя
      phoneNumber:
        type: string
        description: Номер телефона
      signDate:
        type: string
        description: Дата подписания
    required:
    - iin
    - fullName
    - phoneNumber
  ActualDeal:
    type: object
    properties:
      accountNumber:
        type: string
        description: ""
      accountStatus:
        type: string
        description: Статус счета (смотри Список статусов)
      address:
        $ref: '#/definitions/Address'
        description: Адрес
      amount:
        type: number
        description: Сумма сделки
      buyer:
        $ref: '#/definitions/Participant'
        description: Информация о покупателе
      cadastralNumber:
        type: string
        description: Кадастровый номер недвижимости
      city:
        type: string
        description: Город обслуживания
      contractStatus:
        type: string
        description: Статус договора
      dueDate:
        type: string
        description: Срок выполнения сделки
      externalId:
        type: string
        description: Номер заявки
      id:
        type: string
        example: fed3352a-13f8-4c72-802e-ecb69c317be3
        description: Уникальный идентификатор сделки
      openedAt:
        type: string
        description: Дата открытия эскроу счета
      seller:
        $ref: '#/definitions/Participant'
        description: Информация о продавце
  GetGovDocument:
    properties:
      data:
        type: string
      sucess:
        type: boolean
    additionalProperties: false
  FilterBuyerEscrow:
    properties:
      bin:
        type: string
      id:
        type: integer
      iin:
        type: string
      sign_request:
        type: string
    additionalProperties: false
  CreateEscrowApplicationRequest:
    type: object
    properties:
      auth_key:
        $ref: '#/definitions/AuthKey'
      contract_date:
        type: string
      contract_expired:
        type: string
      documents_file_base64:
        type: string
      escrow:
        $ref: '#/definitions/EscrowApplication'
      persons:
        type: array
        items:
          $ref: '#/definitions/TrusteePerson'
      user_info:
        $ref: '#/definitions/UserClaim'
  AuthKey:
    type: object
    properties:
      Channel:
        type: string
      username:
        type: string
  EscrowApplication:
    type: object
    properties:
      approve_bank:
        type: integer
      approve_bank_message:
        type: string
      buyer_address:
        type: string
      buyer_bik:
        type: string
      buyer_bin:
        type: string
      buyer_doc_id_begdate:
        type: string
      buyer_doc_id_num:
        type: string
      buyer_first_name:
        type: string
      buyer_iban:
        type: string
      buyer_iin:
        type: string
      buyer_kbe:
        type: string
      buyer_last_name:
        type: string
      buyer_long_name:
        type: string
      buyer_mail:
        type: string
      buyer_middle_name:
        type: string
      buyer_phone:
        type: string
      cli_bin:
        type: string
      cli_code:
        type: string
      cli_first_name:
        type: string
      cli_iban:
        type: string
      cli_iin:
        type: string
      cli_kbe:
        type: string
      cli_last_name:
        type: string
      cli_long_name:
        type: string
      cli_phone:
        type: string
      cli_type:
        type: integer
      contract_amount:
        type: number
      contract_date:
        type: string
      contract_expired:
        type: string
      contract_num:
        type: string
      contract_target:
        type: string
      contract_val:
        type: string
      count_code:
        type: integer
      created_at:
        type: string
      dep_code:
        type: string
      doc_num:
        type: string
      escrow_iban:
        type: string
      escrow_tranche:
        type: boolean
      expired_at:
        type: string
      id:
        type: integer
      reason:
        type: string
      signature_a:
        type: string
      signature_a_id:
        type: integer
      signature_b:
        type: string
      signature_b_id:
        type: integer
      status:
        type: string
      updated_at:
        type: string
  TrusteePerson:
    type: object
    properties:
      created_at:
        type: string
      email:
        type: string
      escrow_id:
        type: integer
      expired_date:
        type: string
      first_name:
        type: string
      id:
        type: integer
      iin:
        type: string
      is_main:
        type: boolean
      last_name:
        type: string
      middle_name:
        type: string
      num_doc:
        type: string
      phone:
        type: string
      sign_date_create_app:
        type: string
      start_date:
        type: string
      updated_at:
        type: string
  UserClaim:
    type: object
    properties:
      firstname:
        type: string
      firstsignature:
        type: boolean
      id:
        type: integer
      iin:
        type: string
      lastname:
        type: string
      middlename:
        type: string
      organization:
        type: object
        properties:
          approvalType:
            type: string
          cliCode:
            type: string
          clientType:
            type: string
          customerId:
            type: integer
          customerName:
            type: string
          idn:
            type: string
      secondsignature:
        type: boolean
      username:
        type: string
  EscrowSign:
    type: object
    properties:
      cli_login:
        type: string
      created_at:
        type: string
      escrow_id:
        type: integer
      id:
        type: integer
      idn:
        type: string
      sign_request:
        type: string
      status:
        type: string
      updated_at:
        type: string
  UnlockAgreeResult:
    type: object
    properties:
      amount:
        type: number
      message:
        type: string
      status:
        type: string
      unlockId:
        type: integer
      сounterparty:
        $ref: '#/definitions/CounterpartyPayment'
  UnlockAgreeRp:
    type: object
    properties:
      counterparty:
        $ref: '#/definitions/CounterpartyPayment'
      isCounterparty:
        type: boolean
      unlock:
        $ref: '#/definitions/DBUnlockAgree'
  CounterpartyPayment:
    type: object
    properties:
      amount:
        type: number
      bic:
        type: string
      created_at:
        type: string
      description:
        type: string
      iban:
        type: string
      id:
        type: integer
      idn:
        type: string
      knp:
        type: string
      knp_name:
        type: string
      longname:
        type: string
      nds:
        type: boolean
      unlock_id:
        type: integer
  DBUnlockAgree:
    type: object
    properties:
      amount:
        type: number
      counterparty_pay:
        type: boolean
      created_dt:
        type: string
      error_message:
        type: string
      escrowId:
        type: integer
      id:
        type: integer
      reason:
        type: string
      status:
        type: string
      updated_dt:
        type: string
  ReportFileResponse:
    type: object
    properties:
      base64:
        type: string
      entity_id:
        type: integer
  CeaFileMap:
    type: object
    properties:
      cea_file_id:
        type: integer
      created_at:
        type: string
      document_type:
        description: STATEMENT, CONTRACT и т.д
        type: string
      entity_id:
        description: id записи escrow или unlock и т.д
        type: integer
      entity_type:
        description: тип сущности ESCROW_APPLICATION, UNLOCK_AGREES и т.д
        type: string
      err_message:
        type: string
      file_name:
        type: string
      iban:
        type: string
      id:
        type: integer
      status:
        type: string
      updated_at:
        type: string
tags: []
security:
- Authorization:
  - bcc.application.escrow.api
parameters:
  x-client-token:
    name: x-client-token
    type: string
    required: true
    in: header
    description: Токен клиента
x-ibm-endpoints:
- endpointUrl: https://api.bcc.kz:10443/bcc/production
  description: Альтернативная точка подключения для вызова сервиса в продуктивной
    среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в
    режиме "PRODUCTION"
  type:
  - production
  - development
- endpointUrl: https://api.bcc.kz/bcc/production
  description: Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
  type:
  - production
- endpointUrl: https://api-test.bcc.kz/bcc/production
  description: Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
  type:
  - development
...