---
swagger: "2.0"
info:
  title: Financial API
  version: 1.1.5
  description: '**FinancialAPI АО «Банк ЦентрКредит»** предназначен для автоматизации
    взаимодействия информационной системы клиента с информационной системой АО "Банк
    ЦентрКредит" на основе открытой технической спецификации программных интерфейсов.'
  x-ibm-name: financial-api
  contact:
    email: api@bcc.kz
    url: ""
    name: АО «Банк ЦентрКредит»
parameters:
  referenceId:
    name: referenceId
    required: true
    in: path
    description: Референс номер платежа в системе банка
    type: string
  iban:
    name: iban
    type: string
    required: true
    in: path
    description: 20 разрядный номер счета
  appid:
    name: appid
    type: string
    required: true
    in: path
    description: Уникальный идентификатор приложения (ClientId)
  x-jws-signature:
    name: x-jws-signature
    type: string
    required: true
    in: header
    description: JWS Message закодированное в Base64
tags:
- name: Счета
  description: Операции над счетами
- name: Выписки
  description: Операции над выписками
- name: Платежи
  description: Операции над платежами
- name: Информация
  description: Операции связанные с получением дополнительной информации
paths:
  /{appid}/accounts:
    get:
      operationId: getAccounts
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/AccountsResponse'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      description: Получение списка счетов
      security:
      - Authorization:
        - access_profile_view
      produces:
      - application/json
      tags:
      - Счета
    parameters:
    - $ref: '#/parameters/appid'
  /{appid}/accounts/{iban}:
    get:
      operationId: getStatusAccount
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/AccountInformation'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      produces:
      - application/json
      description: Получение информации о счете (остаток, состояние и т.п.)
      security:
      - Authorization:
        - access_accounts_view
      tags:
      - Счета
    parameters:
    - $ref: '#/parameters/appid'
    - $ref: '#/parameters/iban'
  /{appid}/accounts/{iban}/statement:
    get:
      operationId: getAccountStatement
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/StatementResponse'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      produces:
      - application/json
      description: Получение выписки по операциям проведенным по балансу счета
      tags:
      - Выписка
      parameters:
      - name: startDate
        in: query
        type: string
        format: dd-MM-yyyy
        description: Дата начала периода
        required: true
      - name: endDate
        in: query
        type: string
        format: dd-MM-yyyy
        description: Дата окончания периода
        required: true
      - name: currency
        type: string
        in: query
        description: Валюта счета
        required: false
      security:
      - Authorization:
        - access_statement_view
    parameters:
    - $ref: '#/parameters/appid'
    - $ref: '#/parameters/iban'
  /{appid}/accounts/{iban}/statement/v2:
    get:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/StatementV2Response'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      tags:
      - Выписка
      description: Получение выписки по операциям проведенным по балансу счета
      operationId: getAccountStatementV2
      parameters:
      - name: startDate
        in: query
        type: string
        format: dd-MM-yyyy
        description: Дата начала периода
        required: true
      - name: endDate
        in: query
        type: string
        format: dd-MM-yyyy
        description: Дата окончания периода
        required: true
      - name: currency
        type: string
        in: query
        description: Валюта счета
        required: true
    parameters:
    - $ref: '#/parameters/iban'
    - $ref: '#/parameters/appid'
  /{appid}/payments:
    get:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/PaymentsResponse'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      description: Получение информации о платежах
      parameters:
      - name: startDate
        in: query
        type: string
        format: dd-MM-yyyy
        description: Дата начала периода
        required: true
      - name: endDate
        in: query
        type: string
        format: dd-MM-yyyy
        description: Дата окончания периода
        required: true
      operationId: getPayments
      tags:
      - Платежи
      security:
      - Authorization:
        - access_statement_view
        - access_payments_view
    post:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/PaymentInformationResponse'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      description: Создание платежа
      operationId: createPayment
      tags:
      - Платежи
      parameters:
      - $ref: '#/parameters/x-jws-signature'
      - name: payment
        in: body
        schema:
          $ref: '#/definitions/PaymentBody'
        required: true
        description: Тело платежа согласно описаноой модели данных
      - name: type
        in: query
        type: string
        required: true
        description: Тип платежного поручения
      produces:
      - application/json
      consumes:
      - application/json
      security:
      - Authorization:
        - access_payments_view
        - access_payments_send
        - access_payments_create
    parameters:
    - $ref: '#/parameters/appid'
  /{appid}/payments/{referenceId}:
    get:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/PaymentInformationResponse'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      description: Просмотр информации по платежу
      tags:
      - Платежи
      parameters:
      - $ref: '#/parameters/referenceId'
      security:
      - Authorization:
        - access_payments_view
      operationId: getPayment
      produces:
      - application/json
    parameters:
    - $ref: '#/parameters/appid'
    - $ref: '#/parameters/referenceId'
  /{appid}/payments/mt:
    post:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/PaymentInformationResponse'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      description: Оправка платежа в формате МТ100
      operationId: sendMT
      tags:
      - Платежи
      parameters:
      - $ref: '#/parameters/x-jws-signature'
      - name: data
        required: true
        in: body
        schema:
          $ref: '#/definitions/MTPayment'
        description: Описание платежа
      security:
      - Authorization:
        - access_payments_create
        - access_payments_sendMT
    parameters:
    - $ref: '#/parameters/appid'
  /{appid}/payments/base:
    post:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/PaymentInformationResponse'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      operationId: createPaymentBase
      tags:
      - Платежи
      description: Операция создания платежа упакованного в формат Base64. Добавлен
        для совместимости.
      parameters:
      - $ref: '#/parameters/x-jws-signature'
      - name: payload
        required: true
        in: body
        schema:
          $ref: '#/definitions/PaymentBase64'
        description: Сообщение для банка в формате Base64. Введено для совместимости
          с библиотекой Kalkan
      - name: type
        type: string
        required: true
        in: query
        description: Тип платежного поручения
      security:
      - Authorization:
        - access_payments_view
        - access_payments_create
        - access_payments_aprove
        - access_payments_send
    parameters:
    - $ref: '#/parameters/appid'
  /{appid}/messages:
    get:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/Messages'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      operationId: getMessages
      tags:
      - Информация
      description: Получение списка сообщений от банка
      security:
      - Authorization:
        - access_profile_view
    parameters:
    - $ref: '#/parameters/appid'
  /{appid}/information/taxpayer/{iin}:
    get:
      responses:
        200:
          description: Успешное выполнение операции
          schema:
            $ref: '#/definitions/TaxPayerInfo'
        400:
          description: Ошибка в запросе
          schema:
            $ref: '#/definitions/Response'
        401:
          description: Ошибка авторизации
          schema:
            $ref: '#/definitions/Response'
        403:
          description: Ошибка доступов
          schema:
            $ref: '#/definitions/Response'
        500:
          description: Ошибка работы сервера
          schema:
            $ref: '#/definitions/Response'
      tags:
      - Информация
      description: Получение данных о налогоплательщике по ИИН из справочника налогоплательщиков
        РК
      operationId: getInfoTaxPayerStatus
      security:
      - Authorization:
        - access_profile_view
    parameters:
    - $ref: '#/parameters/appid'
    - name: iin
      type: string
      required: true
      in: path
      description: Идентификационный номер налогоплательщика
  /healthcheck:
    get:
      responses:
        200:
          description: 200 OK
        500:
          description: ""
      operationId: health
      description: Проверка доступности сервиса
      security:
      - Authorization: []
basePath: /v1/financial
definitions:
  AccountsList:
    type: array
    description: Список счетов
    items:
      $ref: '#/definitions/Account'
  Account:
    type: object
    properties:
      iban:
        type: string
        example: KZ100100100100100100
        description: 20 разрядный счет
      description:
        type: string
        example: Счет
        description: Описание счета
    description: Информация о счете
    required:
    - iban
    additionalProperties: true
  AccountInformation:
    type: object
    properties:
      iban:
        type: string
        example: KZ100100100100100100
        description: 20 разрядный счет
      description:
        type: string
        example: Счет
        description: Описание счета
      type:
        type: string
        example: CURR
        description: Тип счета
      status:
        type: string
        example: A
        description: Статус счета
      dateOpened:
        type: string
        example: 31-03-2020
        format: date
        description: Дата открытия счета
      dateLastStatement:
        type: string
        example: 31-03-2020
        format: date
        description: Дата последней транзакции
      currency:
        type: string
        example: KZT
        description: Валюта счета
      balanceAccount:
        description: Баланс по счету в валюте счета
        $ref: '#/definitions/AccountBalanceInformation'
      balanceNational:
        description: Баланс по счету в национальной валюте
        $ref: '#/definitions/AccountBalanceInformation'
    description: Информация о счете
    required:
    - iban
    - type
    - status
    - balanceAccount
    additionalProperties: true
  AccountBalanceInformation:
    properties:
      currency:
        type: string
        example: KZT
        description: Валюта баланса
      balance:
        type: string
        example: 27508779.810000
        description: Текущий баланс счета
        format: float
      availableFunds:
        type: number
        example: 27508779.810000
        description: Доступные средства
        format: float
      blockedBalance:
        type: number
        example: 0
        description: Блокированные средства
        format: float
    additionalProperties: false
    description: Информация о балансе счета
    required:
    - currency
    - balance
  AccountsResponse:
    type: object
    properties:
      accounts:
        $ref: '#/definitions/AccountsList'
    required:
    - accounts
    description: Результат выполения запроса о счетах доступных для обслуживания в
      канале API
  PaymentsResponse:
    type: object
    description: Список платежей за период указанный в запросе
    properties:
      payments:
        $ref: '#/definitions/PaymentsArray'
        description: Массив платежей согласно заданного фильтра
    required:
    - payments
  PaymentsArray:
    type: array
    description: Список платежей согласно фильтра указанного в запросе
    items:
      $ref: '#/definitions/PaymentInformationResponse'
  PaymentInformationResponse:
    properties:
      referenceId:
        type: string
        example: 123
        description: Уникальный номер операции в системе Банка
      documentId:
        type: string
        example: 213
        description: Уникальный номер документа в системе Банка
      documentNumber:
        type: string
        example: 123123
        description: Уникальный номер документа в системе использующего API
      dateCreated:
        type: string
        example: "2019-12-10 00:00:00"
        description: Дата создания документа в системе Банка
        format: date-time
      datePayment:
        type: string
        example: "2019-12-10 00:00:00"
        description: Дата проведения платежа в системе Банка
        format: date-time
      valueDate:
        type: string
        example: "2019-12-10 00:00:00"
        description: Дата валютюрования платежа в системе Банка
        format: date-time
      dateLastChange:
        type: string
        example: "2019-12-10 21:33:44"
        description: Дата последнего изменения в платеже в системе Банка
        format: date-time
      type:
        $ref: '#/definitions/PaymentType'
      status:
        $ref: '#/definitions/PaymentStatus'
      amount:
        type: number
        example: 14078.230000
        description: Сумма платежа
        format: float
      currency:
        type: string
        example: KZT
        description: Валюта платежа
      paymentPayer:
        $ref: '#/definitions/PaymentMember'
      paymentBeneficiary:
        $ref: '#/definitions/PaymentMember'
      beneficiaryBank:
        $ref: '#/definitions/PaymentBank'
      paymentDetails:
        type: string
        example: Возврат средств
        description: Назначение платежа
      signatoryA:
        $ref: '#/definitions/PaymentSignatory'
        description: Данные руководителя
      signatoryB:
        $ref: '#/definitions/PaymentSignatory'
        example: Данные главного бухгалтера
    additionalProperties: false
    description: Описание платежа
    required:
    - referenceId
    - documentId
    - documentNumber
    - dateCreated
    - datePayment
    - valueDate
    - dateLastChange
    - type
    - status
    - amount
    - currency
    - paymentPayer
    - paymentBeneficiary
    - paymentDetails
    - signatoryA
    - signatoryB
  PaymentBody:
    type: object
    properties:
      documentNumber:
        type: string
        example: 123123
        description: Уникальный номер документа в системе использующего API
      datePayment:
        type: string
        example: "2019-12-10 00:00:00"
        description: Дата проведения платежа в системе Банка
        format: date-time
      valueDate:
        type: string
        example: "2019-12-10 00:00:00"
        description: Дата валютюрования платежа в системе Банка
        format: date-time
      amount:
        type: number
        example: 14078.230000
        description: Сумма платежа
        format: float
      currency:
        type: string
        example: KZT
        description: Валюта платежа
      paymentSender:
        $ref: '#/definitions/PaymentSender'
      paymentBeneficiary:
        $ref: '#/definitions/PaymentBeneficiary'
      beneficiaryBank:
        $ref: '#/definitions/PaymentBank'
      details:
        $ref: '#/definitions/Details'
      signatoryA:
        $ref: '#/definitions/PaymentSignatory'
        description: Данные руководителя
      signatoryB:
        $ref: '#/definitions/PaymentSignatory'
        example: Данные главного бухгалтера
  PaymentMember:
    properties:
      bin:
        type: string
        example: 123456789
        description: БИН участника платежа
      name:
        type: string
        example: АО "Новые технологии"
        description: Наименование участника платежа
      iban:
        type: string
        example: KZ123456789987654321
        description: Уникальный идентификатор банковского счета
    additionalProperties: false
    description: Описание участника платежа
    required:
    - bin
    - name
    - iban
  PaymentBank:
    properties:
      code:
        type: string
        description: БИК банка бенифициара
        example: KZBGNRLE
      name:
        type: string
        description: Наименование банка бенифициара
        example: АО "Банк ЦентрКредит"
    additionalProperties: false
    description: Описание банка бенифициара платежа
  PaymentSignatory:
    properties:
      name:
        type: string
        description: ФИО подписывающего лица
        example: Искаков Б.А.
    description: Описание должностного лица от имени которого проводится платеж
    required:
    - name
  PaymentStatus:
    type: object
    description: Описание статуса платежа
    properties:
      code:
        type: string
        example: COMPLETED
        description: Код статуса платежа в системе Банка
      description:
        type: string
        example: Платеж совершен
        description: Описание статуса платежа в системе Банка
      reason:
        type: string
        example: Успешно
        description: Описание статуса
  PaymentType:
    properties:
      code:
        type: string
        example: INTERNAL.SIMPLE
        description: Тип платежа
      description:
        type: string
        example: Платеж внутри сети БЦК
        description: Описание типа платежа
    additionalProperties: false
    required:
    - description
  Details:
    type: object
    properties:
      knp:
        type: string
        example: 590
        description: Код назначения платежей
      narrative:
        type: string
        example: ""
      detailsOfCharge:
        type: string
        example: ""
        description: Для валютного платежа
      passport:
        type: string
        example: ""
        description: Для валютного платежа
      contractName:
        type: string
        example: ""
        description: Для валютного платежа
      contractDate:
        type: string
        example: ""
        description: Для валютного платежа
      codeVO:
        type: string
        example: ""
        description: Для валютного платежа
      narrativeCNY:
        type: string
        example: ""
        description: Для валютного платежа
      infoBeneficiary:
        type: string
        example: ""
        description: Для валютного платежа
      operType:
        type: string
        example: ""
        description: Для валютного платежа
      budgetCode:
        type: string
        example: ""
        description: Для валютного платежа
      paymentPeriod:
        type: string
        example: ""
        description: Для валютного платежа
      mainpaymentReason:
        type: string
        example: ""
        description: Для валютного платежа
      paymenttype:
        type: string
        example: ""
        description: Для валютного платежа
      octocode:
        type: string
        example: ""
        description: Для валютного платежа
      budgetdate:
        type: string
        example: ""
        description: Для валютного платежа
      budgettype:
        type: string
        example: ""
        description: Для валютного платежа
      appSign:
        type: string
        example: ""
        description: Для валютного платежа
      sender:
        type: object
        description: Для валютного платежа
        properties:
          address:
            type: string
            description: Адрес отправителя
            example: PR.MANGILYK EL 55
          city:
            type: string
            example: ALMATY
            description: Город отправителя
          comAccount:
            type: string
            example: KZ100100100100100100
            description: Счет отправителя
      beneficiary:
        description: Для валютного платежа
        type: object
        properties:
          address:
            type: string
            example: Nur-Sultan, 24 Syganak Str.
            description: Адрес получателя
          city:
            type: string
            example: Nur-Sultan
            description: Город получателя
          idn:
            type: string
            example: 134480385
            description: БИН получателя
          inn:
            type: string
            example: ""
          kpp:
            type: string
            example: ""
          countryCode:
            type: string
            example: KZ
            description: Код страны
      beneficiarybank:
        description: Для валютного платежа
        type: object
        properties:
          city:
            type: string
            example: Almaty
            description: Город получателя
          account:
            type: string
            example: First Heartland Jysan Inv JSC
            description: Данные получателя
          countryCode:
            type: string
            example: KZ
            description: Код страны
  PaymentSender:
    type: object
    properties:
      bin:
        type: string
        example: 100100100100
        description: ИИН/БИН отправителя
      name:
        type: string
        example: Товарищество с ограниченной ответственностью ...
        description: Наименование отправителя
      partycode:
        type: string
        example: 2
        description: ""
      kbe:
        type: string
        example: 17
        description: КБЕ отправителя
      iban:
        type: string
        example: KZ100100100100100100
        description: Счет отправителя
  PaymentBeneficiary:
    type: object
    properties:
      bin:
        type: string
        example: 100100100100
        description: ИИН/БИН получателя
      name:
        type: string
        example: Товарищество с ограниченной ответственностью ...
        description: Наименование получателя
      partycode:
        type: string
        example: 2
        description: ""
      kbe:
        type: string
        example: 17
        description: КБЕ получателя
      iban:
        type: string
        example: KZ100100100100100100
        description: Счет получателя
  MTPayment:
    properties:
      bodyMT:
        type: string
        example: base64string
        format: base64
        description: Платежное поручение в формате МТ100
    additionalProperties: false
    description: Описание структуры сообщения для отправки платежных поручений в формате
      МТ
  PaymentBase64:
    properties:
      payload:
        type: string
        example: base64string
        format: base64
        description: Содержимое PaymentBody
    additionalProperties: false
    description: Проведение платежа в виде строки base64
    required:
    - payload
  StatementResponse:
    properties:
      statement:
        type: array
        items:
          $ref: '#/definitions/Statement'
      balanceIn:
        type: string
        example: 1543405.450000
        description: Остаток на начала периода
      balanceInEq:
        type: string
        example: ""
        description: ""
      balanceInRate:
        type: string
        example: 0
        description: ""
      balanceInCurr:
        type: string
        example: KZT
        description: Валюта
      balanceOut:
        type: string
        example: 1976268.120000
        description: Остаток на конец периода
      balanceOutEq:
        type: string
        example: ""
        description: ""
      balanceOutRate:
        type: string
        example: 0
        description: ""
      balanceOutCurr:
        type: string
        example: KZT
        description: Валюта
    additionalProperties: false
    description: Структура ответа при вызове операции получения выписки по счету
  Statement:
    type: object
    description: Описание данных одной транзации в выписке
    properties:
      documentId:
        type: string
        example: 13183286117129
        description: Уникальный идентификатор документа
      documentNumber:
        type: string
        example: 100
        description: Уникальный номер документа
      date:
        type: string
        example: 04-02-2020
        description: Дата проведения платежа
        format: date
      senderBank:
        type: string
        example: АО "Народный Банк Казахстана"
        description: Банк отправителя
      senderBankCode:
        type: string
        example: KCJBKZKX
        description: Код банка отправителя
      senderBIN:
        type: string
        example: 180640010876
        description: БИН банка отправителя
      senderAccount:
        type: string
        example: KZ100100100100100100
        description: Счет отправителя
      senderName:
        type: string
        example: Жунусова Алия Бахытжановна
        description: Полное имя отправителя
      beneficiarBank:
        type: string
        example: АО "Банк ЦентрКредит"
        description: Банк получателя
      beneficiarBankCode:
        type: string
        example: KCJBKZKX
        description: Код банка получателя
      beneficiarBIN:
        type: string
        example: 981141000668
        description: БИН банка получателя
      beneficiarAccount:
        type: string
        example: KZ100100100100100100
        description: Счет получателя
      beneficiarName:
        type: string
        example: Жунусова Алия Бахытжановна
        description: Полное имя получателя
      debet:
        type: number
        example: 350
        format: float
        description: Сумма платежа debet счета
      credit:
        type: number
        example: 350
        format: float
        description: Сумма платежа credit счета
      equivalentAmount:
        type: number
        example: 350
        format: float
        description: ""
      purposeCode:
        type: string
        example: 841
        description: Код назначения платежа
      description:
        type: string
        example: Описание платежа
        description: Описание платежа
      type:
        type: string
        example: D
        description: Тип платежа (credit или debet)
    required:
    - date
    - senderAccount
    - senderBank
    - beneficiarAccount
    - beneficiarBank
    additionalProperties: true
  StatementV2Response:
    type: object
    description: Структура выписки по счету.
    properties:
      info:
        $ref: '#/definitions/StatementV2Info'
      inBalance:
        $ref: '#/definitions/BalanceV2Info'
      outBalance:
        $ref: '#/definitions/BalanceV2Info'
      transactions:
        type: array
        items:
          $ref: '#/definitions/Transaction'
  StatementV2Info:
    type: object
    properties:
      reference:
        type: string
        example: 09301
        description: Референс
      currency:
        type: string
        example: KZT
        description: Валюта выписки
      accountBankCode:
        type: string
        example: KCJBKZKX
        description: БИК банка
      accountNumber:
        type: string
        example: KZ100100100100100100
        description: Номер счёта
      accountType:
        type: string
        example: CURR
        description: Тип счёта
      accountName:
        type: string
        example: Счет
        description: Наименование счёта
      accOwnerAddress:
        type: string
        example: 050000, КАЗАХСТАН, АЛМАТЫ г
        description: Адрес клиента
      bankBranchAddress:
        type: string
        example: 050000, КАЗАХСТАН, АЛМАТЫ г
        description: Адрес отделения банка
      bankBranchIdn:
        type: string
        example: 100100100100
        description: БИН отделения банка
      bankBranchBIC:
        type: string
        example: KCJBKZKX
        description: БИК отделения банка
      lastStatementDate:
        type: string
        example: 31-03-2020
        format: date
        description: Дата последней выписки
      accOwnerCode:
        type: string
        example: 17
        description: Код резиденства и сектора эконимики клиента
      accOwnerIdn:
        type: string
        example: 100100100100
        description: ИИН/БИН клиента
      accOwnerName:
        type: string
        example: Клиент
        description: Наименование клиента
      bankBranchName:
        type: string
        example: Отделение
        description: Наименование отделения банка
      bankBranchCode:
        type: string
        example: QQ1
        description: Код отделения банка
      dateFrom:
        type: string
        format: date
        example: 03-11-2020
        description: Дата начала периода
      dateTo:
        type: string
        format: date
        example: 03-11-2020
        description: Дата окончания периода
      statementDateTime:
        type: string
        format: date-time
        example: 23-02-2021 15:08:23
        description: Дата формирования выписки
      payCountDebit:
        type: number
        example: 55
        description: Количество транзакций по дебету
      payCountCredit:
        type: number
        example: 22
        description: Количество транзакции по кредиту
      turnoverDebit:
        type: number
        example: 694210.330000
        description: Обороты по дебету
      turnoverCredit:
        type: number
        example: 694210.440000
        description: Обороты по кредиту
      turnover:
        type: number
        example: 6941110.330000
        description: Обороты
      eqTurnover:
        type: number
        example: 69422.330000
        description: Обороты в эквиваленте
  BalanceV2Info:
    type: object
    properties:
      date:
        type: string
        example: 03-11-2020
        format: date
        description: Дата баланса
      currency:
        type: string
        example: USD
        description: Валюта
      rate:
        type: number
        example: 1
        description: Курс
      amount:
        type: number
        example: 1543405.450000
        description: Баланс в валюте
      eqAmount:
        type: number
        example: 1543405.450000
        description: Баланс в эквиваленте
  Transaction:
    type: object
    properties:
      paymentId:
        type: string
        example: 10002282217111
        description: Идентификатор транзакции
      docNumber:
        type: string
        example: 175
        description: Номер документа
      valueDate:
        type: string
        example: 04-02-2020
        format: date
        description: Дата валютирования
      entryDate:
        type: string
        example: 04-02-2020
        format: date
        description: Операционный день
      execdate:
        type: string
        example: 23-02-2021 15:08:23
        format: date-time
        description: Дата/Время исполнения
      createDate:
        type: string
        example: 23-02-2021 15:08:23
        format: date-time
        description: Дата/Время ввода в систему
      dbcrfl:
        type: string
        example: 1
        description: Направление транзакции (1-дебет, 0-кредит)
      amount:
        type: number
        example: 154655.730000
        format: float
        description: Сумма транзакции
      clientReference:
        type: string
        example: 175
        description: Клиентский референс
      bankReference:
        type: string
        example: ALM2020471551594
        description: Банковский референс
      knp:
        type: string
        example: 332
        description: Код назначения платежа
      budgetCode:
        type: string
        example: 142
        description: Код бюджетной классификации
      partyCode:
        type: string
        example: 14
        description: Резиденство и сектор экономики корреспондента
      partyIdn:
        type: string
        example: 100100100100
        description: ИИН/Бин корреспондента
      partyName:
        type: string
        example: Банк ЦентрКредит АО
        description: Наименование корреспондента
      partyAccount:
        type: string
        example: KZ100100100100100100
        description: Счет корреспондента
      partyBankCode:
        type: string
        example: KCJBKZKX
        description: БИК банка корреспондента
      partyBankName:
        type: string
        example: АО "Банк ЦентрКредит"
        description: Наименование банка корреспондента
      corrIdn:
        type: string
        example: 180640010876
        description: ИИН/БИН отправителя
      corrName:
        type: string
        example: Наименование
        description: Наименование отправителя
      purpose:
        type: string
        example: Для зачисления на картсчета сотрудникам
        description: Назначение платежа
      eqAmount:
        type: string
        example: 154655.730000
        description: Сумма транзакции в эквиваленте
      eqCurrency:
        type: string
        example: KZT
        description: Валюта эквивалента
      chief:
        type: string
        example: Иванов И. И.
        description: Руководитель (1-я подпись)
      mainbk:
        type: string
        example: Не предусмотрено
        description: Главный бухгалтер (2-я подпись)
      stage:
        type: string
        example: FIN
        description: Состояние
      period:
        type: string
        example: 4
        description: Период оплаты (для платежей в бюджет)
      clerk:
        type: string
        example: Иванов И. И.
        description: Исполнитель
      poTypeDesc:
        type: string
        example: Платежное поручение
        description: Тип платежа
      cardTrnAmount:
        type: string
        description: Сумма транзакции по карте
      cardTrnCurr:
        type: string
        description: Валюта транзакции по карте
      cardRRn:
        type: string
      officialRate:
        type: string
        description: Учетный курс валюты транзакции
      marketRate:
        type: string
        description: Рыночный курс валюты транзакции
      registry:
        $ref: '#/definitions/RegistryRecord'
  RegistryRecord:
    type: object
    description: Реестр платежа
    properties:
      assign:
        type: string
        description: Назначение
      code:
        type: string
        description: Номер документа
      dop:
        type: string
        description: Дата документа
      dt:
        type: string
        description: Дата рождения
      errCode:
        type: string
        description: Код ошибки
      fm:
        type: string
        description: Фамилия
      ft:
        type: string
        description: Отечество
      knp:
        type: string
        description: Код назначения платежа
      la:
        type: string
        description: Лицевой счет
      nm:
        type: string
        description: Имя
      nord:
        type: number
      opv:
        type: string
        description: Идентификатор пенсионной проплаты
      pendFl:
        type: number
      period:
        type: string
        description: Период оплаты
      rnn:
        type: string
        description: ИИН/БИН
      subRef:
        type: string
        description: Субреференс
      sum:
        type: string
        description: Сумма
  jose-header:
    properties:
      x5c:
        type: array
        items:
          type: string
        description: Содержит публичный ключ сертификата X.509 или цепочку сертификатов.
          Дополнителные сведения RFC 7515 раздел 4.1.2.
        example: qwe
      alg:
        type: string
        description: Используемый криптографический алгоритм. Дополнителные сведения
          RFC 7515 раздел 4.1.2.
        example: '"RS256"'
    additionalProperties: false
    description: Описывает цифровую подпись примененную при подписании сообщения.
      Дополнительные сведения приведены в раздел 4 RFC 7515 ( https://tools.ietf.org/html/rfc7515#page-9
      )
  jws-message:
    properties:
      payload:
        type: string
        example: eyJzcnZJZCI6MSwiYW1vdW50IjoxMDAsImN......1cnJl
        description: Исходное сообщение JSON закодированное в Base64 которое требуется
          подписать ЭЦП
      signatures:
        $ref: '#/definitions/jws-signatures'
        description: Массив электронных подписей подписавших сообщений.
    additionalProperties: false
    description: Сообщение для шлюза подписанное в соответствии с стандартом  JSON
      Web Signature  (https://tools.ietf.org/html/rfc7515)
    required:
    - payload
    - signatures
  jws-signatures:
    description: Маccив электронных подписей подписавших сообщение.
    type: array
    items:
      $ref: '#/definitions/jws-signature'
  jws-signature:
    properties:
      header:
        $ref: '#/definitions/jose-header'
        description: Заголовки описывающие электронную подпись.
      signature:
        type: string
        description: Электронная подпись сообщения.
    additionalProperties: false
    description: Определяет параметры подписи и саму подпись для подписанного сообщения
      (JWS Payload) и защищенных заголовков сообщения. Дополнительная информация RFC
      7515 раздел 7.2.1.
    required:
    - header
    - signature
  Response:
    properties:
      success:
        type: boolean
        example: false
        description: Результат выполнения операции
      code:
        type: integer
        example: 0
        description: Код ответа
        format: int32
      description:
        type: string
        example: Ошибка
        description: Описание кода ответа
    additionalProperties: true
    description: Информация о результате выполнения операции, может содержать дополнительные
      не описанные в документации атрибуты специфичные для разных API
    required:
    - success
    - code
    - description
  Messages:
    type: object
    properties:
      messages:
        type: array
        items:
          $ref: '#/definitions/Message'
    description: Список сообщений от банка
  Message:
    properties:
      id:
        type: string
        example: 3122244910
        description: Уникальный идентификатор сообщения
      tm:
        type: string
        example: "2019-01-29 17:59:32"
        format: date-time
        description: Дата публикации сообщения
      msg:
        type: string
        example: Сообщение №1
        description: Содержимое сообщения
      clerk:
        type: string
        example: Иванов И.И.
        description: Сотрудник Банка опубликовавший сообщение
    additionalProperties: false
    required:
    - id
    - tm
    - msg
    - clerk
    description: Описание структуры сообщения от Банка
  TaxPayerInfo:
    properties:
      title:
        type: string
        example: Иванов Иван Иванович
        description: ФИО или наименование налогоплательщика
      selfEmployedTitle:
        type: string
        example: ИП "Новые технологии"
        description: Наименование индивидуального предпринимателя
      taxPayerType:
        type: integer
        example: 0
        description: Тип налогоплательщика. 1 — Юридическое лицо, 0 — физическое число
        format: int32
      notResident:
        type: integer
        example: 0
        description: Признак не резидента. 1 — не резидент, 0 — резидент
        format: int32
      personType:
        type: integer
        example: 32
        description: Тип физического лица. 1 — ничего из нижеследующих, 32 — индивидуальный
          предприниматель, 64 — адвокат, 128 — частный нотариус, 256 — частный судебный
          исполнитель. Для ЮЛ данное поле отсутствует
        format: int32
      inactive:
        type: integer
        example: 0
        description: Признак бездействующего налогоплательщика. 0 — действующий, 1
          — бездействующий
        format: int32
      taxAuthorityCode:
        type: integer
        example: 181401
        description: Код налогового органа по месту жительства или местоположению.
          Код налогового органа передается без лидирующего нуля. Т.е. если код 0380,
          то в поле вернется 380. Кроме того в случае если в системе хранится нечисловое
          значение кода, то будет возвращено значение 1. В случае если код не определен,
          то данное поле в ответе будет отсутствовать
        format: int32
    additionalProperties: false
    description: Информация о налогоплательщике по ИИН из справочника налогоплательщиков
      РК
    required:
    - taxPayerType
    - title
    - notResident
    - inactive
schemes:
- https
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
  categories:
  - ""
security:
- Authorization: []
securityDefinitions:
  Authorization:
    type: oauth2
    description: Access code полученый при прохждении авторизации в oAuth сервисе
    flow: application
    scopes:
      access_profile_view: Доступ на просмотр профиля
      access_profile_edit: Доступ на редактирование профиля
      access_accounts_view: Доступ на просмотр счетов
      access_statement_view: Доступ на просмотр выписки по счету
      access_payments_view: Доступ на просмотр платежей
      access_payments_create: Доступ на создание платежей
      access_payments_aprove: Доступ на одобрение платежей
      access_payments_send: Доступ на отправку платежей
      access_payments_sendMT: Доступ на отправку МТ платежей
    tokenUrl: https://$(api.endpoint.hostname)/v1/oauth2/token
    x-tokenIntrospect:
      url: ""
    x-scopeValidate:
      url: http://10.15.18.21:7088
produces:
- application/json
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-sandbox.bcc.kz/bcc/production
  description: Точка подключения для вызова сервисов в песочнице. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
  type:
  - development
- endpointUrl: https://api-test.bcc.kz/bcc/production
  description: Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
  type:
  - development
...