Сервис для управления счетами ОСИ
Альтернативная точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
Paths
/accounts
Получение списка счетов
Токен аутентификации, полученный при вызове сервиса авторизации
Токен клиента
/accounts/{iban}/statement
Выписка по счету
Токен аутентификации, полученный при вызове сервиса авторизации
Токен клиента
Номер 20 разрядного счета по которому требуется получение информации
{
"pattern": "^KZ[A-Z0-9]{18}$"
}
Дата начала периода (YYYY-MM-DD)
Дата окончания периода (YYYY-MM-DD)
Валюта выписки
200 OK
BadRequest
Unauthorized
Forbidden
Internal Server Error
Definitions
Структура выписки по счету.
{
"type": "object",
"properties": {
"info": {
"$ref": "#\/definitions\/StatementInfo"
},
"inBalance": {
"$ref": "#\/definitions\/BalanceInfo"
},
"outBalance": {
"$ref": "#\/definitions\/BalanceInfo"
},
"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": "Сумма"
}
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Account"
}
}
{
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Идентификатор счета"
},
"iban": {
"type": "string",
"description": "Номер счета",
"example": "KZ128560000000517854"
},
"client_code": {
"type": "string",
"description": "Идентификатор клиента",
"example": "01253687"
},
"description": {
"type": "string",
"description": "Описание"
},
"name": {
"type": "string",
"description": "Название счета",
"example": "Текущий счет"
},
"currency": {
"type": "string",
"description": "Валюта",
"example": "KZT"
},
"status": {
"type": "string",
"description": "Статус",
"example": "OPENED"
},
"division": {
"type": "string",
"description": "Код отдела"
},
"type": {
"$ref": "#\/definitions\/AccountType",
"description": "Тип счета"
},
"is_main": {
"type": "boolean",
"description": "Признак основного счета"
}
},
"additionalProperties": false,
"required": [
"id",
"client_code",
"description",
"iban",
"name",
"currency",
"status",
"division",
"type",
"is_main"
]
}
{
"enum": [
"CURR",
"CARD"
],
"type": "string"
}