GbdulCheckOsi API

GbdulCheckOsi API 1.0.0

0
No votes yet

Сервис проверки сведений о наличии/отсутствии зарегистрированного ОСИ по указанному в запросе РКА

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

/check-osi

post /check-osi

Предоставлению информации об уплаченных суммах на лицевом счете налогоплательщика

Authorization
Authorization
(oauth2 application)

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

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.govtech.api
Allow access to Goventment Services API
requestBody
Required in body
object
RequestDto
xib-trace-id
Required in header
string

Уникальный идентификатор запроса

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

ResponseDto
400

Validation errors

FailureResponse
404

Not Found

FailureResponse
500

Different errors

FailureResponse
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/gov/gbdul/check-osi
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/gov/gbdul/check-osi
content-type
accept
xib-trace-id

Definitions 

{
    "title": "Параметры запроса",
    "required": [
        "businessData",
        "idn"
    ],
    "type": "object",
    "properties": {
        "businessData": {
            "$ref": "#\/definitions\/BusinessDataTypeDto"
        },
        "idn": {
            "type": "string",
            "description": "ИИН\/БИН"
        }
    }
}

Тип, описывающий бизнесс данные

{
    "title": "Тип, описывающий бизнесс данные",
    "required": [
        "rka"
    ],
    "type": "object",
    "properties": {
        "rka": {
            "type": "string",
            "description": "РКА объекта"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "timestamp": {
            "type": "string",
            "format": "date-time"
        },
        "error": {
            "type": "string"
        },
        "violations": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Violation"
            }
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Обслуживаемые объекты

{
    "title": "Обслуживаемые объекты",
    "type": "object",
    "properties": {
        "rka": {
            "type": "string",
            "description": "РКА объектов"
        }
    }
}
              
{
    "title": "Результат запроса",
    "type": "object",
    "properties": {
        "result": {
            "$ref": "#\/definitions\/ResultTypeDto"
        }
    }
}

Результат услуги

{
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#\/definitions\/StatusTypeDto"
        },
        "bin": {
            "type": "string",
            "description": "БИН ОСИ"
        },
        "nameOsiRu": {
            "type": "string",
            "description": "Наименование ОСИ на русском языке"
        },
        "nameOsiKz": {
            "type": "string",
            "description": "Наименование ОСИ на казахском языке"
        },
        "servicedObject": {
            "type": "array",
            "description": "Обслуживаемые объекты",
            "items": {
                "$ref": "#\/definitions\/RKATypeDto"
            }
        }
    }
}

Статус ответа

{
    "title": "Статус ответа",
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "description": "Код статуса ответа"
        },
        "infoRu": {
            "type": "string",
            "description": "Пояснение ответа на русском языке"
        },
        "infoKz": {
            "type": "string",
            "description": "Пояснение ответа на казахском языке"
        }
    }
}