---
swagger: "2.0"
info:
  x-ibm-name: info-card-api
  title: Info Card API
  version: 1.0.0
  description: Предоставление клиенту ФЛ услуги API "Информационный по платежным картам"
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/info-card
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  Authorization:
    type: oauth2
    description: Токен аутентификации полученный при вызове сервиса авторизации
    flow: application
    scopes:
      bcc.application.individual.card.api: Allow access to Info Card API
    tokenUrl: https://api.bcc.kz/bcc/production/v2/oauth/token
security:
- Authorization:
  - bcc.application.individual.card.api
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /block:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/BlockCardResponse'
      operationId: blockCard
      summary: Блокировка карты
      description: Метод для блокировки карты
      parameters:
      - name: requestBody
        required: false
        in: body
        schema:
          $ref: '#/definitions/BlockCardRequest'
  /statement:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/StatementResponse'
      summary: Выписка по карте
      description: Метод для получения выписки по номеру счета. Выписка отображает
        движения по счету
      operationId: getStatement
      parameters:
      - name: requestBody
        required: false
        in: body
        schema:
          $ref: '#/definitions/StatementRequest'
  /balance:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/BalanceResponse'
      description: Метод для получения баланса по номеру счета
      summary: Получения баланса
      operationId: getBalance
definitions:
  BlockCardResponse:
    properties:
      cardIdn:
        type: string
        description: Идентификатор карты
        example: SMP/20/P/1441478-C/23/580011
    additionalProperties: false
  StatementRequest:
    properties:
      idn:
        type: string
        description: IDN карты
        example: SMP/20/P/1441478-C/23/580011
      dateFrom:
        type: string
        description: Дата начала периода
        example: 01.01.2024
      dateTo:
        type: string
        description: Дата окончания периода
        example: 01.01.2024
    additionalProperties: false
    required:
    - idn
    - dateFrom
    - dateTo
  StatementDetails:
    type: object
    required:
    - amountKzt
    - amountVal
    - cashback
    - comission
    - description
    - operationTime
    - postingDate
    properties:
      operationTime:
        type: string
        description: Дата операции
      postingDate:
        type: string
        description: Дата отражения на счете
      description:
        type: string
        description: Описание операции
      amountVal:
        type: number
        description: Сумма в валюте операции
      amountKzt:
        type: number
        description: Сумма в тенге
      comission:
        type: number
        description: Комиссия
      cashback:
        type: number
        description: Cashback
    description: Детали выписок
  StatementResponse:
    type: object
    required:
    - accName
    - accValCode
    - balAvl
    - balIn
    - balOut
    - cardCode
    - iban
    - iin
    - incomes
    - outcomes
    - statements
    properties:
      iban:
        type: string
        description: Полный номер карты
      accValCode:
        type: string
        description: Валюта
      cardCode:
        type: string
        description: Маска карты
      accName:
        type: string
        description: ФИО
      iin:
        type: string
        description: ИИН
      balIn:
        type: number
        description: Остаток на начало даты (Входящий остаток)
      balOut:
        type: number
        description: Остаток на конец даты (Исходящий остаток)
      incomes:
        type: number
        description: Поступления за период
      outcomes:
        type: number
        description: Расходы за период
      balAvl:
        type: number
        description: Текущий остаток
      statements:
        type: array
        description: Детали выписок
        items:
          $ref: '#/definitions/StatementDetails'
    description: Информация о выписке
  BalanceResponse:
    properties:
      currentBalance:
        type: string
        description: Доступный баланс с учетом суммы холда
      currency:
        type: string
        description: Валюта
    additionalProperties: false
  BlockCardRequest:
    properties:
      cardIdn:
        type: string
        description: Идентификатор карты
    additionalProperties: false
    required:
    - cardIdn
tags: []
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
...