Financial API

Financial API 1.2.1

5
Средняя: 5 (2 оценки)
Счета Выписки Платежи Информация

FinancialAPI АО «Банк ЦентрКредит» предназначен для автоматизации взаимодействия информационной системы клиента с информационной системой АО "Банк ЦентрКредит" на основе открытой технической спецификации программных интерфейсов.

expand_moreexpand_lessКонтактная информация
АО «Банк ЦентрКредит»
production
development
https://api.bcc.kz:10443/bcc/production

Альтернативная точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"

production
https://api.bcc.kz/bcc/production

Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"

development
https://api-test.bcc.kz/bcc/production

Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"

Пути

/{appid}/accounts

get /{appid}/accounts
Счета

Получение списка счетов

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_profile_view
Доступ на просмотр профиля
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

Accept
Опционально в header
string
application/json
200

Успешное выполнение операции

AccountsResponse
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts
accept
appid

/{appid}/accounts/{iban}

get /{appid}/accounts/{iban}
Счета

Получение информации о счете (остаток, состояние и т.п.)

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_accounts_view
Доступ на просмотр счетов
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

iban
Required in path
string

20 разрядный номер счета

Accept
Опционально в header
string
application/json
200

Успешное выполнение операции

AccountInformation
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts/{iban}
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts/{iban}
accept
appid
iban

/{appid}/accounts/{iban}/statement

get /{appid}/accounts/{iban}/statement
Выписка

Получение выписки по операциям проведенным по балансу счета

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_statement_view
Доступ на просмотр выписки по счету
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

iban
Required in path
string

20 разрядный номер счета

startDate
Required in query
string / dd-MM-yyyy

Дата начала периода

endDate
Required in query
string / dd-MM-yyyy

Дата окончания периода

currency
Опционально в query
string

Валюта счета

Accept
Опционально в header
string
application/json
200

Успешное выполнение операции

StatementResponse
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts/{iban}/statement
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts/{iban}/statement
accept
appid
iban
startDate
endDate
currency

/{appid}/accounts/{iban}/statement/v2

get /{appid}/accounts/{iban}/statement/v2
Выписка

Получение выписки по операциям проведенным по балансу счета

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
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
Доступ на отправку МТ платежей
iban
Required in path
string

20 разрядный номер счета

appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

startDate
Required in query
string / dd-MM-yyyy

Дата начала периода

endDate
Required in query
string / dd-MM-yyyy

Дата окончания периода

currency
Required in query
string

Валюта счета

200

Успешное выполнение операции

StatementV2Response
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts/{iban}/statement/v2
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/accounts/{iban}/statement/v2
accept
iban
appid
startDate
endDate
currency

/{appid}/payments

get /{appid}/payments
Платежи

Получение информации о платежах

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_statement_view
Доступ на просмотр выписки по счету
access_payments_view
Доступ на просмотр платежей
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

startDate
Required in query
string / dd-MM-yyyy

Дата начала периода

endDate
Required in query
string / dd-MM-yyyy

Дата окончания периода

200

Успешное выполнение операции

PaymentsResponse
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments
accept
appid
startDate
endDate
post /{appid}/payments
Платежи

Создание платежа

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_payments_view
Доступ на просмотр платежей
access_payments_send
Доступ на отправку платежей
access_payments_create
Доступ на создание платежей
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

x-jws-signature
Required in header
string

JWS Message закодированное в Base64

payment
Required in body
object

Тело платежа согласно описаноой модели данных

PaymentBody
type
Required in query
string

Тип платежного поручения

Content-Type
Опционально в header
string
application/json
Accept
Опционально в header
string
application/json
200

Успешное выполнение операции

PaymentInformationResponse
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
POST https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments
content-type
accept
x-jws-signature
appid
type

/{appid}/payments/{referenceId}

get /{appid}/payments/{referenceId}
Платежи

Просмотр информации по платежу

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_payments_view
Доступ на просмотр платежей
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

referenceId
Required in path
string

Референс номер платежа в системе банка

Accept
Опционально в header
string
application/json
200

Успешное выполнение операции

PaymentInformationResponse
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments/{referenceId}
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments/{referenceId}
accept
appid
referenceId

/{appid}/payments/mt

post /{appid}/payments/mt
Платежи

Оправка платежа в формате МТ100

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_payments_create
Доступ на создание платежей
access_payments_sendMT
Доступ на отправку МТ платежей
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

x-jws-signature
Required in header
string

JWS Message закодированное в Base64

data
Required in body
object

Описание платежа

MTPayment
200

Успешное выполнение операции

PaymentInformationResponse
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
POST https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments/mt
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments/mt
content-type
accept
x-jws-signature
appid

/{appid}/payments/base

post /{appid}/payments/base
Платежи

Операция создания платежа упакованного в формат Base64. Добавлен для совместимости.

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_payments_view
Доступ на просмотр платежей
access_payments_create
Доступ на создание платежей
access_payments_aprove
Доступ на одобрение платежей
access_payments_send
Доступ на отправку платежей
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

x-jws-signature
Required in header
string

JWS Message закодированное в Base64

payload
Required in body
object

Сообщение для банка в формате Base64. Введено для совместимости с библиотекой Kalkan

PaymentBase64
type
Required in query
string

Тип платежного поручения

200

Успешное выполнение операции

PaymentInformationResponse
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
POST https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments/base
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/payments/base
content-type
accept
x-jws-signature
appid
type

/{appid}/messages

get /{appid}/messages
Информация

Получение списка сообщений от банка

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_profile_view
Доступ на просмотр профиля
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

200

Успешное выполнение операции

Messages
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/messages
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/messages
accept
appid

/{appid}/information/taxpayer/{iin}

get /{appid}/information/taxpayer/{iin}
Информация

Получение данных о налогоплательщике по ИИН из справочника налогоплательщиков РК

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
Scopes
access_profile_view
Доступ на просмотр профиля
appid
Required in path
string

Уникальный идентификатор приложения (ClientId)

iin
Required in path
string

Идентификационный номер налогоплательщика

200

Успешное выполнение операции

TaxPayerInfo
400

Ошибка в запросе

Response
401

Ошибка авторизации

Response
403

Ошибка доступов

Response
500

Ошибка работы сервера

Response
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/information/taxpayer/{iin}
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/{appid}/information/taxpayer/{iin}
accept
appid
iin

/healthcheck

get /healthcheck

Проверка доступности сервиса

Authorization v2
Authorization v2
(oauth2 application)

Access code полученный при прохождении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v2/oauth/token
Scopes
bcc.application.financial.api
shymbolat.aitbek@bcc.kz
Authorization V1
Authorization V1
(oauth2 application)

Access code полученый при прохждении авторизации в oAuth сервисе

Token URL
https://$(api.endpoint.hostname)/v1/oauth2/token
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
Доступ на отправку МТ платежей
200

200 OK

500
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/financial/healthcheck
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/financial/healthcheck
accept

Определения

Список счетов

{
    "type": "array",
    "items": {
        "$ref": "#\/definitions\/Account"
    }
}

Информация о счете

{
    "type": "object",
    "properties": {
        "iban": {
            "type": "string",
            "example": "KZ100100100100100100",
            "description": "20 разрядный счет"
        },
        "description": {
            "type": "string",
            "example": "Счет",
            "description": "Описание счета"
        }
    },
    "required": [
        "iban"
    ],
    "additionalProperties": true
}

Информация о счете

{
    "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"
        }
    },
    "required": [
        "iban",
        "type",
        "status",
        "balanceAccount"
    ],
    "additionalProperties": true
}

Информация о балансе счета

{
    "properties": {
        "currency": {
            "type": "string",
            "example": "KZT",
            "description": "Валюта баланса"
        },
        "balance": {
            "type": "string",
            "example": 27508779.81,
            "description": "Текущий баланс счета",
            "format": "float"
        },
        "availableFunds": {
            "type": "number",
            "example": 27508779.81,
            "description": "Доступные средства",
            "format": "float"
        },
        "blockedBalance": {
            "type": "number",
            "example": 0,
            "description": "Блокированные средства",
            "format": "float"
        }
    },
    "additionalProperties": false,
    "required": [
        "currency",
        "balance"
    ]
}

Результат выполения запроса о счетах доступных для обслуживания в канале API

{
    "type": "object",
    "properties": {
        "accounts": {
            "$ref": "#\/definitions\/AccountsList"
        }
    },
    "required": [
        "accounts"
    ]
}

Список платежей за период указанный в запросе

{
    "type": "object",
    "properties": {
        "payments": {
            "$ref": "#\/definitions\/PaymentsArray",
            "description": "Массив платежей согласно заданного фильтра"
        }
    },
    "required": [
        "payments"
    ]
}

Список платежей согласно фильтра указанного в запросе

{
    "type": "array",
    "items": {
        "$ref": "#\/definitions\/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.23,
            "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": "Данные главного бухгалтера"
        },
        "benCountry": {
            "type": "string",
            "description": "Страна резиденства (Если КБЕ начинается с «2» страна резиденства обязательна к заполнению)",
            "example": "KZ"
        },
        "jurfl": {
            "type": "string",
            "description": "Признак юридического лица (1- Юридическое лицо, 0 - Физическое лицо)",
            "example": "1"
        },
        "factPaymentBeneficiary": {
            "$ref": "#\/definitions\/FactPayment",
            "description": "Фактический бенефициар"
        },
        "factPaymentSender": {
            "$ref": "#\/definitions\/FactPayment",
            "description": "Фактический плательщик"
        }
    },
    "additionalProperties": false,
    "required": [
        "referenceId",
        "documentId",
        "documentNumber",
        "dateCreated",
        "datePayment",
        "valueDate",
        "dateLastChange",
        "type",
        "status",
        "amount",
        "currency",
        "paymentPayer",
        "paymentBeneficiary",
        "paymentDetails",
        "signatoryA",
        "signatoryB"
    ]
}
              
{
    "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.23,
            "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": "Данные главного бухгалтера"
        },
        "benCountry": {
            "type": "string",
            "description": "Страна резиденства (Если КБЕ начинается с «2» страна резиденства обязательна к заполнению)",
            "example": "KZ"
        },
        "jurfl": {
            "type": "string",
            "description": "Признак юридического лица (1- Юридическое лицо, 0 - Физическое лицо)",
            "example": "1"
        },
        "factPaymentBeneficiary": {
            "$ref": "#\/definitions\/FactPayment",
            "description": "Фактический бенефициар"
        },
        "factPaymentSender": {
            "$ref": "#\/definitions\/FactPayment",
            "description": "Фактический плательщик"
        }
    }
}

Описание участника платежа

{
    "properties": {
        "bin": {
            "type": "string",
            "example": 123456789,
            "description": "БИН участника платежа"
        },
        "name": {
            "type": "string",
            "example": "АО \"Новые технологии\"",
            "description": "Наименование участника платежа"
        },
        "iban": {
            "type": "string",
            "example": "KZ123456789987654321",
            "description": "Уникальный идентификатор банковского счета"
        }
    },
    "additionalProperties": false,
    "required": [
        "bin",
        "name",
        "iban"
    ]
}

Описание банка бенифициара платежа

{
    "properties": {
        "code": {
            "type": "string",
            "description": "БИК банка бенифициара",
            "example": "KZBGNRLE"
        },
        "name": {
            "type": "string",
            "description": "Наименование банка бенифициара",
            "example": "АО \"Банк ЦентрКредит\""
        }
    },
    "additionalProperties": false
}

Описание должностного лица от имени которого проводится платеж

{
    "properties": {
        "name": {
            "type": "string",
            "description": "ФИО подписывающего лица",
            "example": "Искаков Б.А."
        }
    },
    "required": [
        "name"
    ]
}

Описание статуса платежа

{
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "example": "COMPLETED",
            "description": "Код статуса платежа в системе Банка"
        },
        "description": {
            "type": "string",
            "example": "Платеж совершен",
            "description": "Описание статуса платежа в системе Банка"
        },
        "reason": {
            "type": "string",
            "example": "Успешно",
            "description": "Описание статуса"
        }
    }
}
              
{
    "properties": {
        "code": {
            "type": "string",
            "example": "INTERNAL.SIMPLE",
            "description": "Тип платежа"
        },
        "description": {
            "type": "string",
            "example": "Платеж внутри сети БЦК",
            "description": "Описание типа платежа"
        }
    },
    "additionalProperties": false,
    "required": [
        "description"
    ]
}
              
{
    "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": "Код страны"
                }
            }
        }
    }
}
              
{
    "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": "Счет отправителя"
        }
    }
}
              
{
    "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": "Счет получателя"
        }
    }
}

Описание структуры сообщения для отправки платежных поручений в формате МТ

{
    "properties": {
        "bodyMT": {
            "type": "string",
            "example": "base64string",
            "format": "base64",
            "description": "Платежное поручение в формате МТ100"
        }
    },
    "additionalProperties": false
}

Проведение платежа в виде строки base64

{
    "properties": {
        "payload": {
            "type": "string",
            "example": "base64string",
            "format": "base64",
            "description": "Содержимое PaymentBody"
        }
    },
    "additionalProperties": false,
    "required": [
        "payload"
    ]
}

Структура ответа при вызове операции получения выписки по счету

{
    "properties": {
        "statement": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Statement"
            }
        },
        "balanceIn": {
            "type": "string",
            "example": 1543405.45,
            "description": "Остаток на начала периода"
        },
        "balanceInEq": {
            "type": "string",
            "example": "",
            "description": ""
        },
        "balanceInRate": {
            "type": "string",
            "example": 0,
            "description": ""
        },
        "balanceInCurr": {
            "type": "string",
            "example": "KZT",
            "description": "Валюта"
        },
        "balanceOut": {
            "type": "string",
            "example": 1976268.12,
            "description": "Остаток на конец периода"
        },
        "balanceOutEq": {
            "type": "string",
            "example": "",
            "description": ""
        },
        "balanceOutRate": {
            "type": "string",
            "example": 0,
            "description": ""
        },
        "balanceOutCurr": {
            "type": "string",
            "example": "KZT",
            "description": "Валюта"
        }
    },
    "additionalProperties": false
}

Описание данных одной транзации в выписке

{
    "type": "object",
    "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
}

Структура выписки по счету.

{
    "type": "object",
    "properties": {
        "info": {
            "$ref": "#\/definitions\/StatementV2Info"
        },
        "inBalance": {
            "$ref": "#\/definitions\/BalanceV2Info"
        },
        "outBalance": {
            "$ref": "#\/definitions\/BalanceV2Info"
        },
        "transactions": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Transaction"
            }
        }
    }
}
              
{
    "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.33,
            "description": "Обороты по дебету"
        },
        "turnoverCredit": {
            "type": "number",
            "example": 694210.44,
            "description": "Обороты по кредиту"
        },
        "turnover": {
            "type": "number",
            "example": 6941110.33,
            "description": "Обороты"
        },
        "eqTurnover": {
            "type": "number",
            "example": 69422.33,
            "description": "Обороты в эквиваленте"
        }
    }
}
              
{
    "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.45,
            "description": "Баланс в валюте"
        },
        "eqAmount": {
            "type": "number",
            "example": 1543405.45,
            "description": "Баланс в эквиваленте"
        }
    }
}
              
{
    "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.73,
            "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.73,
            "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"
        }
    }
}

Реестр платежа

{
    "type": "object",
    "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": "Сумма"
        }
    }
}

Описывает цифровую подпись примененную при подписании сообщения. Дополнительные сведения приведены в раздел 4 RFC 7515 ( https://tools.ietf.org/html/rfc7515#page-9 )

{
    "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
}

Сообщение для шлюза подписанное в соответствии с стандартом JSON Web Signature (https://tools.ietf.org/html/rfc7515)

{
    "properties": {
        "payload": {
            "type": "string",
            "example": "eyJzcnZJZCI6MSwiYW1vdW50IjoxMDAsImN......1cnJl",
            "description": "Исходное сообщение JSON закодированное в Base64 которое требуется подписать ЭЦП"
        },
        "signatures": {
            "$ref": "#\/definitions\/jws-signatures",
            "description": "Массив электронных подписей подписавших сообщений."
        }
    },
    "additionalProperties": false,
    "required": [
        "payload",
        "signatures"
    ]
}

Маccив электронных подписей подписавших сообщение.

{
    "type": "array",
    "items": {
        "$ref": "#\/definitions\/jws-signature"
    }
}

Определяет параметры подписи и саму подпись для подписанного сообщения (JWS Payload) и защищенных заголовков сообщения. Дополнительная информация RFC 7515 раздел 7.2.1.

{
    "properties": {
        "header": {
            "$ref": "#\/definitions\/jose-header",
            "description": "Заголовки описывающие электронную подпись."
        },
        "signature": {
            "type": "string",
            "description": "Электронная подпись сообщения."
        }
    },
    "additionalProperties": false,
    "required": [
        "header",
        "signature"
    ]
}

Информация о результате выполнения операции, может содержать дополнительные не описанные в документации атрибуты специфичные для разных API

{
    "properties": {
        "success": {
            "type": "boolean",
            "example": false,
            "description": "Результат выполнения операции"
        },
        "code": {
            "type": "integer",
            "example": 0,
            "description": "Код ответа",
            "format": "int32"
        },
        "description": {
            "type": "string",
            "example": "Ошибка",
            "description": "Описание кода ответа"
        }
    },
    "additionalProperties": true,
    "required": [
        "success",
        "code",
        "description"
    ]
}

Список сообщений от банка

{
    "type": "object",
    "properties": {
        "messages": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/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"
    ]
}

Информация о налогоплательщике по ИИН из справочника налогоплательщиков РК

{
    "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,
    "required": [
        "taxPayerType",
        "title",
        "notResident",
        "inactive"
    ]
}
              
{
    "properties": {
        "bin": {
            "type": "string",
            "description": "Налоговый идентификатор",
            "example": "000000000000"
        },
        "name": {
            "type": "string",
            "description": "Наименование (В случае передачи в поле «Налоговый идентификатор» значения «000000000000»  поле «Наименование» обязательно к заполнению)"
        },
        "jurfl": {
            "type": "string",
            "description": "Признак юридического лица (В случае передачи в поле «Налоговый идентификатор» значения «000000000000»  поле «Признак юридического лица» обязательно к заполнению, 1- Юридическое лицо, 0 - Физическое лицо)",
            "example": "1"
        }
    },
    "additionalProperties": false,
    "required": [
        "bin"
    ]
}