Info Card API

Info Card API 1.0.0

0
No votes yet

Предоставление клиенту ФЛ услуги API "Информационный по платежным картам"

expand_moreexpand_lessContact information
АО «Банк ЦентрКредит»
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"

Paths

/block

post /block

Блокировка карты

Метод для блокировки карты

Authorization
Authorization
(oauth2 application)

Токен аутентификации полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.individual.card.api
Allow access to Info Card API
requestBody
Optional in body
object
BlockCardRequest
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

BlockCardResponse
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/info-card/block
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/info-card/block
content-type
accept

/statement

post /statement

Выписка по карте

Метод для получения выписки по номеру счета. Выписка отображает движения по счету

Authorization
Authorization
(oauth2 application)

Токен аутентификации полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.individual.card.api
Allow access to Info Card API
requestBody
Optional in body
object
StatementRequest
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

StatementResponse
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/info-card/statement
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/info-card/statement
content-type
accept

/balance

post /balance

Получения баланса

Метод для получения баланса по номеру счета

Authorization
Authorization
(oauth2 application)

Токен аутентификации полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.individual.card.api
Allow access to Info Card API
Accept
Optional in header
string
application/json
200

200 OK

BalanceResponse
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/info-card/balance
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/info-card/balance
accept

Definitions 

{
    "properties": {
        "cardIdn": {
            "type": "string",
            "description": "Идентификатор карты",
            "example": "SMP\/20\/P\/1441478-C\/23\/580011"
        }
    },
    "additionalProperties": false
}
              
{
    "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"
    ]
}

Детали выписок

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

Информация о выписке

{
    "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"
            }
        }
    }
}
              
{
    "properties": {
        "currentBalance": {
            "type": "string",
            "description": "Доступный баланс с учетом суммы холда"
        },
        "currency": {
            "type": "string",
            "description": "Валюта"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "cardIdn": {
            "type": "string",
            "description": "Идентификатор карты"
        }
    },
    "additionalProperties": false,
    "required": [
        "cardIdn"
    ]
}