---
swagger: "2.0"
info:
  x-ibm-name: escrow-api
  title: Escrow API
  version: 1.0.0
  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'
      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
      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
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/CreateDealResponse'
        400:
          description: Bad Request
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: Информация о продавце
tags: []
security:
- Authorization:
  - bcc.application.escrow.api
x-ibm-endpoints:
- endpointUrl: https://api.bcc.kz:10443/bcc/production
  description: Альтернативная точка подключения для вызова сервиса в продуктивной
    среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в
    режиме "PRODUCTION"
  type:
  - production
  - development
- endpointUrl: https://api-test.bcc.kz/bcc/production
  description: Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
  type:
  - development
- endpointUrl: https://api.bcc.kz/bcc/production
  description: Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
  type:
  - production
- endpointUrl: https://api-sandbox.bcc.kz/bcc/production
  description: Точка подключения для вызова сервисов в песочнице. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
  type:
  - development
...