---
swagger: "2.0"
info:
  x-ibm-name: smart-online-broker-api
  title: Smart Online Broker API
  version: 1.0.0
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
  description: Smart Online Broker API АО “Банк ЦентрКредит" предназначен для интеграции
    Партнеров  с системами Банка, предоставляющие Клиенту возможность покупки Товаров,
    в том числе с использованием Кредита/Рассрочки с пред одобрением решения, полученного
    в Банке
schemes:
- https
basePath: /v1/broker
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  Authorization:
    type: oauth2
    description: Токен аутентификации полученный при вызове сервиса авторизации
    flow: application
    scopes:
      bcc.application.broker: Scope for Smart Online Broker API
    tokenUrl: https://api.bcc.kz/bcc/production/v2/oauth/token
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /pre-approved:
    post:
      summary: PreApproved
      tags:
      - Smart online broker
      parameters:
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/RequestBody'
        description: Тело запроса
      responses:
        200:
          description: PreApproved handler success
          schema:
            $ref: '#/definitions/ResponseBody'
        400:
          description: PreApproved handler errors
          schema:
            $ref: '#/definitions/httperror.Details'
        500:
          description: PreApproved handler errors
          schema:
            $ref: '#/definitions/httperror.Details'
  /merchant-post-link:
    post:
      summary: Merchant postLink
      tags:
      - Smart online broker
      parameters:
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/MerchantRequestBody'
        description: Тело запроса
      responses:
        200:
          description: Merchant postLink handler success
          schema:
            $ref: '#/definitions/MerchantResponseBody'
        400:
          description: Merchant postLink handler errors
          schema:
            $ref: '#/definitions/httperror.Details'
        500:
          description: Merchant postLink handler errors
          schema:
            $ref: '#/definitions/httperror.Details'
  /orders:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/OrderResponseBody'
      operationId: orders
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/OrdersRequestBody'
  /products:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ProductListResponse'
      parameters:
      - name: partner
        type: string
        required: true
        in: query
        description: Идентификатор мерчанта
      - name: amount
        type: string
        required: true
        in: query
        description: Сумма
      operationId: getProducts
definitions:
  httperror.Details:
    type: object
    properties:
      code:
        type: integer
        description: Код ответа
      message:
        type: string
        description: Сообщение об ответе
      status:
        type: string
        description: Статус ответа
    additionalProperties: false
  RequestBody:
    type: object
    properties:
      address:
        $ref: '#/definitions/Address'
      channel:
        type: string
        example: web
      customer:
        $ref: '#/definitions/Customer'
      goods:
        type: array
        items:
          $ref: '#/definitions/Good'
      isDelivery:
        type: boolean
        example: true
      loanLength:
        type: string
        example: "12"
      orderState:
        type: string
        example: INIT
      paymentMethod:
        type: string
        example: annuity
      productType:
        type: string
        example: loan
      redirectUrl:
        type: string
        example: https://example.kz/webhook
      referenceId:
        type: string
        example: BGR1231
      salesPlace:
        type: string
        example: "050000"
      totalCost:
        type: string
        example: "50000"
      verificationSmsCode:
        type: string
        example: "1243"
      verificationSmsDateTime:
        type: string
        example: 06.10.2023 10:07:23
    required:
    - address
    - channel
    - customer
    - goods
    - isDelivery
    - loanLength
    - orderState
    - paymentMethod
    - productType
    - redirectUrl
    - referenceId
    - salesPlace
    - totalCost
    - verificationSmsCode
    - verificationSmsDateTime
  Address:
    type: object
    properties:
      delivery:
        type: string
        description: Адрес доставки товара
        example: Улица Розыбакиева, 388/Б2
      pickupPoint:
        type: string
        description: Адрес пункта самовывоза
        example: Mega Center Alma-Ata, Улица Розыбакиева, 263
    required:
    - delivery
    - pickupPoint
  Customer:
    type: object
    properties:
      contact:
        $ref: '#/definitions/Contact'
      firstName:
        type: string
        example: Аскар
      lastName:
        type: string
        example: Аскаров
      middleName:
        type: string
        example: Аскарович
      state:
        type: string
        example: orange
      taxCode:
        type: string
        example: "960629450735"
    required:
    - contact
    - lastName
    - firstName
    - middleName
    - state
    - taxCode
  Contact:
    type: object
    properties:
      email:
        type: string
        example: askar.askarov@gmail.com
      mobileNumber:
        type: string
        example: "7475774285"
    required:
    - email
    - mobileNumber
  Good:
    type: object
    properties:
      brand:
        type: string
        example: apple
      category:
        type: string
        example: accessories
      image:
        type: string
        example: https://example.kz/goods/images/airpods_pro_2
      model:
        type: string
        example: AirPods Pro 2
      price:
        type: string
        example: "169990"
      sku:
        type: string
        example: ACS1
    required:
    - brand
    - image
    - category
    - model
    - price
    - sku
  ResponseBody:
    properties:
      code:
        type: string
        description: Код ответа
        example: "200"
      message:
        type: string
        description: Сообщение об ответе
        example: Заявка успешно создана
      requestUuid:
        type: string
        description: Уникальный идентификатор запроса
        example: c5171b44-0bd3-6a2f-21aa-60ee039ddff3
      redirectLink:
        type: string
        description: Ссылка для перенаправления
        example: https://oprb-dev.bcc.kz/epos/?preapp=03e60d13-bd8a-29c8-a03c-ca9d74c63b83&lang=kk&v=2
      status:
        type: string
        description: Статус ответа
        example: Success
    additionalProperties: false
    description: Создание заявки и отправка продуктов
  MerchantResponseBody:
    properties:
      code:
        type: string
        description: Код ответа
        example: "200"
      message:
        type: string
        description: Сообщение об ответе
        example: Статус заявки успешно обновлен
      status:
        type: string
        description: Статус ответа
        example: Success
    additionalProperties: false
  MerchantRequestBody:
    properties:
      loanLength:
        type: string
        description: Срок кредита в месяцах
        example: "12"
      productCode:
        type: string
        description: Код продукта
        example: INS12
      referenceId:
        type: string
        description: Уникальный идентификатор заказа
        example: BGR1231
      state:
        type: string
        description: Состояние заявки
        example: CUSTOMER_REJECTED
      stateTitle:
        type: string
        description: Название состояния
        example: Клиент отказался
    additionalProperties: false
    required:
    - stateTitle
    - state
    - referenceId
    - productCode
    - loanLength
  OrdersRequestBody:
    properties:
      name:
        type: string
        description: Название магазина
        example: Shop
      amount:
        type: number
        format: float
        example: 3000000
        description: Сумма заказа
      posName:
        type: string
        description: Поинт код
        example: 02-2018-L3
      language:
        type: string
        description: Язык интерфейса
        example: ru
      postLink:
        type: string
        description: Вебхук
        example: https://example.kz
      expiresAt:
        type: string
        description: Дата и время истечения срока действия
        example: "2023-02-11T04:44:31+06:00"
      pointCode:
        type: string
        description: Поинт код
        example: 02-2018-L3
      requestId:
        type: string
        description: Идентификатор запроса
        example: ""
      partnerCode:
        type: string
        description: Код партнера
      phoneNumber:
        type: string
        description: "77011413341"
        example: "77011413341"
      iin:
        type: string
        description: ИИН клиента
        example: "870318302342"
      productCode:
        type: string
        description: Код продукта
        example: STD12
      failRedirect:
        type: string
        description: Ссылка для перенаправления при неудаче
        example: https://example.kz
      partnerOrderId:
        type: string
        description: Идентификатор заказа партнера
        example: "1018000"
      successRedirect:
        type: string
        description: Ссылка для перенаправления при успехе
        example: https://example.kz
    additionalProperties: false
    required:
    - name
    - amount
    - posName
    - language
    - pointCode
    - partnerCode
    - productCode
    - partnerOrderId
  OrderResponseBody:
    properties:
      requestId:
        type: string
        description: Идентификатор запроса
        example: "123"
      partnerOrderId:
        type: string
        description: Идентификатор заказа партнера
        example: "1018000"
      preappId:
        type: string
        description: Идентификатор предварительной заявки
        example: c5171b44-0bd3-6a2f-21aa-60ee039ddff3
      redirectLink:
        type: string
        description: Ссылка для перенаправления
        example: https://blt.testjam.kz/epos/?preapp=c5171b44-0bd3-6a2f-21aa-60ee039ddff3&lang=ru&v=2
      expiresAt:
        type: string
        description: Дата и время истечения срока действия
        example: "2023-02-11T04:44:31+06:00"
    additionalProperties: false
    required:
    - expiresAt
    - redirectLink
    - preappId
    - partnerOrderId
    - requestId
  Product:
    type: object
    required:
    - name
    - monthlyPayment
    - period
    - productCode
    properties:
      name:
        type: string
        description: Название продукта
        example: Рассрочка 0-0-12
      monthlyPayment:
        type: number
        description: Ежемесячный платеж
        example: 25000
      period:
        type: number
        description: Срок кредита в месяцах
        example: 12
      productCode:
        type: string
        description: Код продукта
        example: CC12INS
  ProductList:
    type: object
    properties:
      products:
        type: array
        description: Список продуктов
        items:
          $ref: '#/definitions/Product'
    required:
    - products
  ProductListResponse:
    type: object
    properties:
      products:
        type: array
        description: Список продуктов
        items:
          $ref: '#/definitions/Product'
      message:
        type: string
        description: Сообщение ответа
        example: Success
      status:
        type: number
        description: HTTP статус ответа
        example: 200
    required:
    - products
    - message
    - status
tags: []
security:
- Authorization:
  - bcc.application.broker
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
...