Escrow API

Escrow 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"

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

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

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

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

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

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

Paths

/ext/deals

post /ext/deals
Партнеры

Создать

Создает запись о сделке и отправляет Push покупателю

Authorization
Authorization
(oauth2 application)

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

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.escrow.api
Allow to 'Escrow API'
request
Required in body
object

Create request

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

OK

CreateDealResponse
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/ext/deals
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/ext/deals
content-type
accept

/ext/deals/{id}

get /ext/deals/{id}
Партнеры

Получить по ID

Возвращает информацию по сделке

Authorization
Authorization
(oauth2 application)

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

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.escrow.api
Allow to 'Escrow API'
id
Required in path
string

ID сделки

Accept
Optional in header
string
application/json
200

OK

GetDealResponse
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/ext/deals/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/ext/deals/{id}
accept
id
put /ext/deals/{id}
Партнеры

Обновить статус сделки

Запускает процесс по проверке регистрации сделки

Authorization
Authorization
(oauth2 application)

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

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.escrow.api
Allow to 'Escrow API'
id
Required in path
string

ID сделки

Accept
Optional in header
string
application/json
200

OK

CreateDealResponse
400

Bad Request

Example Request
Example Response
PUT https://api.bcc.kz:10443/bcc/production/v1/escrow/ext/deals/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/ext/deals/{id}
accept
id

Definitions 

{
    "type": "object",
    "properties": {
        "result": {
            "type": "string",
            "description": "Результат операции",
            "example": "success - успешный"
        },
        "resultMessage": {
            "type": "string",
            "description": "Текстовое сообщение"
        },
        "resultObject": {
            "$ref": "#\/definitions\/CreateResponse",
            "description": "Дополнительные данные"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "address": {
            "$ref": "#\/definitions\/Address",
            "description": "Адрес"
        },
        "amount": {
            "type": "number",
            "description": "Сумма сделки"
        },
        "buyer": {
            "$ref": "#\/definitions\/Participant",
            "description": "Покупатель"
        },
        "cadastralNumber": {
            "type": "string",
            "description": "Кадастровый номер недвижимости"
        },
        "city": {
            "type": "string",
            "description": "Город обслуживания"
        },
        "dueDate": {
            "type": "string",
            "description": "Срок выполнения сделки"
        },
        "externalId": {
            "type": "string",
            "description": "Номер заявки"
        },
        "seller": {
            "$ref": "#\/definitions\/Participant",
            "description": "Продавец"
        }
    },
    "required": [
        "address",
        "amount",
        "buyer",
        "cadastralNumber",
        "city",
        "dueDate",
        "seller",
        "externalId"
    ]
}
              
{
    "type": "object",
    "properties": {
        "dealId": {
            "type": "string",
            "example": "fed3352a-13f8-4c72-802e-ecb69c317be3",
            "description": "Уникальный идентификатор сделки"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "result": {
            "type": "string",
            "description": "Результат операции",
            "example": "success - успешный"
        },
        "resultMessage": {
            "type": "string",
            "description": "Текстовое сообщение"
        },
        "resultObject": {
            "$ref": "#\/definitions\/ActualDeal",
            "description": "Дополнительные данные"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "buildingNumber": {
            "type": "string",
            "description": "Номер дома"
        },
        "district": {
            "type": "string",
            "description": "Район"
        },
        "flatNumber": {
            "type": "string",
            "description": "Номер квартиры"
        },
        "region": {
            "type": "string",
            "description": "Регион"
        },
        "street": {
            "type": "string",
            "description": "Улица"
        },
        "town": {
            "type": "string",
            "description": "Город"
        },
        "fullAddress": {
            "type": "string",
            "description": "Полный адрес"
        }
    },
    "required": [
        "buildingNumber",
        "district",
        "region",
        "street",
        "town"
    ]
}
              
{
    "type": "object",
    "properties": {
        "accountNumber": {
            "type": "string"
        },
        "fullName": {
            "type": "string",
            "description": "ФИО продавца\/покупателя"
        },
        "iin": {
            "type": "string",
            "description": "ИИН продавца\/покупателя"
        },
        "phoneNumber": {
            "type": "string",
            "description": "Номер телефона"
        },
        "signDate": {
            "type": "string",
            "description": "Дата подписания"
        }
    },
    "required": [
        "iin",
        "fullName",
        "phoneNumber"
    ]
}
              
{
    "type": "object",
    "properties": {
        "accountNumber": {
            "type": "string",
            "description": ""
        },
        "accountStatus": {
            "type": "string",
            "description": "Статус счета (смотри Список статусов)"
        },
        "address": {
            "$ref": "#\/definitions\/Address",
            "description": "Адрес"
        },
        "amount": {
            "type": "number",
            "description": "Сумма сделки"
        },
        "buyer": {
            "$ref": "#\/definitions\/Participant",
            "description": "Информация о покупателе"
        },
        "cadastralNumber": {
            "type": "string",
            "description": "Кадастровый номер недвижимости"
        },
        "city": {
            "type": "string",
            "description": "Город обслуживания"
        },
        "contractStatus": {
            "type": "string",
            "description": "Статус договора"
        },
        "dueDate": {
            "type": "string",
            "description": "Срок выполнения сделки"
        },
        "externalId": {
            "type": "string",
            "description": "Номер заявки"
        },
        "id": {
            "type": "string",
            "example": "fed3352a-13f8-4c72-802e-ecb69c317be3",
            "description": "Уникальный идентификатор сделки"
        },
        "openedAt": {
            "type": "string",
            "description": "Дата открытия эскроу счета"
        },
        "seller": {
            "$ref": "#\/definitions\/Participant",
            "description": "Информация о продавце"
        }
    }
}