Escrow API

Escrow API 1.0.1

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

/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
x-client-token
Required in header
string

Токен клиента

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
x-client-token

/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 сделки

x-client-token
Required in header
string

Токен клиента

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
x-client-token
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 сделки

x-client-token
Required in header
string

Токен клиента

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
x-client-token
id

/buyer/accept/{id}

post /buyer/accept/{id}

Accept Escrow application

Подтвердить заявление на открытие Escrow счета

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

Accept
Optional in header
string
application/json
200

200 OK

{
    "schema": {
        "type": "string"
    }
}
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/accept/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/accept/{id}
accept
x-client-token

/buyer/code/iin/{iin}

get /buyer/code/iin/{iin}

Получить SMS code для выгрузки документа из ГДБФЛ

Получить SMS code по ИИН для выгрузки документа из ГДБФЛ

Authorization
Authorization
(oauth2 application)

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

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

ИИН

x-client-token
Required in header
string

Токен клиента

Accept
Optional in header
string
application/json
200

200 OK

GetGovDocument
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/code/iin/{iin}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/code/iin/{iin}
accept
x-client-token
iin

/buyer/list

post /buyer/list

Получить список заявление Escrow

Получить список заявление Escrow

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

Accept
Optional in header
string
application/json
200

200 OK

FilterBuyerEscrow
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/list
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/list
accept
x-client-token

/buyer/{bin}/id/{id}

get /buyer/{bin}/id/{id}

Просмотр заявление Escrow

Просмотр заявление Escrow

Authorization
Authorization
(oauth2 application)

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

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

БИН

id
Required in path
string

Идентификатор

x-client-token
Required in header
string

Токен клиента

Accept
Optional in header
string
application/json
200

200 OK

FilterBuyerEscrow
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/{bin}/id/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/{bin}/id/{id}
accept
x-client-token
bin
id

/buyer/cancel/{id}

post /buyer/cancel/{id}

Подтвердить отмену заявление на открытие Escrow счета

Подтвердить отмену заявление на открытие Escrow счета

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

id
Required in path
string

Идентификатор

Accept
Optional in header
string
application/json
200

200 OK

{
    "schema": {
        "type": "string"
    }
}
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/cancel/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/buyer/cancel/{id}
accept
x-client-token
id

/save

post /save

Создать заявление для выпуска Escrow

Создать заявление для выпуска Escrow юр. лиц

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

requestBody
Required in body
object

The input CreateEscrowApplicationRequest struct

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

200 OK

EscrowApplication
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/save
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/save
content-type
accept
x-client-token

/approve/{id}

post /approve/{id}

Одобрить заявку для выпуска Escrow

Одобрить заявку для выпуска Escrow юр. лиц

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

id
Required in path
string

ID заявки

requestBody
Required in body
object

The input EscrowApplication struct

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

200 OK

EscrowApplication
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/approve/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/approve/{id}
content-type
accept
x-client-token
id

/sent/{id}

post /sent/{id}

Отправить заявку для выпуска Escrow

Отправить заявку для выпуска Escrow

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

id
Required in path
string

ID заявки

requestBody
Required in body
object

The input EscrowSign struct

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

200 OK

EscrowSign
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/sent/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/sent/{id}
content-type
accept
x-client-token
id

/list

get /list

Получить список заявление Escrow

Получить список заявление Escrow

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

from_date
Required in query
string / date
to_date
Optional in query
string / date
Accept
Optional in header
string
application/json
200

200 OK

EscrowApplication
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/list
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/list
accept
x-client-token
from_date
to_date

/{id}

get /{id}

Получить заявление Escrow по id

Получить заявление Escrow по 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'
x-client-token
Required in header
string

Токен клиента

id
Required in path
string

ID заявки

Accept
Optional in header
string
application/json
200

200 OK

EscrowApplication
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/{id}
accept
x-client-token
id

/{escrow_id}/trustee-persons

get /{escrow_id}/trustee-persons

Список доверенных лиц

Получить список доверенных лиц Escrow заявки

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

escrow_id
Required in path
string

ID заявки

Accept
Optional in header
string
application/json
200

200 OK

{
    "schema": {
        "type": "integer"
    }
}
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/{escrow_id}/trustee-persons
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/{escrow_id}/trustee-persons
accept
x-client-token
escrow_id

/update/{id}

post /update/{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'
x-client-token
Required in header
string

Токен клиента

id
Required in path
string

ID заявки

requestBody
Required in body
object
CreateEscrowApplicationRequest
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

EscrowApplication
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/update/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/update/{id}
content-type
accept
x-client-token
id

/agree/unlock/buyer/cancel

post /agree/unlock/buyer/cancel
Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

Accept
Optional in header
string
application/json
200

200 OK

400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/buyer/cancel
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/buyer/cancel
accept
x-client-token

/agree/unlock/buyer/list

post /agree/unlock/buyer/list
Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

Accept
Optional in header
string
application/json
200

200 OK

400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/buyer/list
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/buyer/list
accept
x-client-token

/agree/unlock/buyer/accept

post /agree/unlock/buyer/accept

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

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

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

Accept
Optional in header
string
application/json
200

200 OK

400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/buyer/accept
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/buyer/accept
accept
x-client-token

/agree/unlock/save

post /agree/unlock/save

Создает заявку на снятие блокировки суммы для Эскроу счета

Создает заявку на снятие блокировки суммы для Эскроу счета

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

requestBody
Required in body
object
EscrowSign
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

UnlockAgreeResult
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/save
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/save
content-type
accept
x-client-token

/agree/unlock/approve

post /agree/unlock/approve

Метод позволяет одобрить заявку

Метод позволяет одобрить заявку

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

requestBody
Required in body
object
EscrowSign
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

UnlockAgreeResult
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/approve
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/approve
content-type
accept
x-client-token

/agree/unlock/{bin}/{id}

get /agree/unlock/{bin}/{id}

Просмотр заявки по BIN и AgreeID

Просмотр заявки по BIN и AgreeID

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

bin
Required in path
string

БИН

id
Required in path
string

ID заявки

Accept
Optional in header
string
application/json
200

200 OK

UnlockAgreeRp
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/{bin}/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/{bin}/{id}
accept
x-client-token
bin
id

/agree/unlock/update/{id}

post /agree/unlock/update/{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'
x-client-token
Required in header
string

Токен клиента

id
Required in path
string

ID заявки

requestBody
Required in body
object
EscrowSign
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

UnlockAgreeResult
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/update/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/update/{id}
content-type
accept
x-client-token
id

/agree/unlock/remove/{id}

post /agree/unlock/remove/{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'
x-client-token
Required in header
string

Токен клиента

id
Required in path
string

ID заявки

requestBody
Required in body
object
EscrowSign
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

UnlockAgreeResult
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/remove/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/remove/{id}
content-type
accept
x-client-token
id

/agree/unlock/list

post /agree/unlock/list

Возвращает список заявок на снятие

Возвращает список заявок на снятие

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

requestBody
Required in body
object
EscrowSign
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

DBUnlockAgree
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/list
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/agree/unlock/list
content-type
accept
x-client-token

/report/close/view/{id}

get /report/close/view/{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'
x-client-token
Required in header
string

Токен клиента

id
Required in path
string

id

Accept
Optional in header
string
application/json
200

200 OK

ReportFileResponse
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/report/close/view/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/report/close/view/{id}
accept
x-client-token
id

/report/unlock/view/{id}

get /report/unlock/view/{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'
x-client-token
Required in header
string

Токен клиента

id
Required in path
string

id

Accept
Optional in header
string
application/json
200

200 OK

ReportFileResponse
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/report/unlock/view/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/report/unlock/view/{id}
accept
x-client-token
id

/report/{id}

get /report/{id}

Получить файл

Получить файл из ЦЭА или minio

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

id
Required in path
string

id

Accept
Optional in header
string
application/json
200

200 OK

ReportFileResponse
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/report/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/report/{id}
accept
x-client-token
id

/report/list/{id}

get /report/list/{id}

Получить список файлов

Получить список файлов из ЦЭА или minio

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

id
Required in path
string

id

Accept
Optional in header
string
application/json
200

200 OK

CeaFileMap
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/report/list/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/report/list/{id}
accept
x-client-token
id

/report/consent/view/{id}

get /report/consent/view/{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'
x-client-token
Required in header
string

Токен клиента

id
Required in path
string

id

Accept
Optional in header
string
application/json
200

200 OK

ReportFileResponse
400

Bad Request

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/escrow/report/consent/view/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/report/consent/view/{id}
accept
x-client-token
id

/close/approve/{id}

post /close/approve/{id}

Одобрить заявку для закрытия Escrow юр. лиц

Одобрить заявку для закрытия Escrow

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

id
Required in path
string

id

data
Required in body
object

The input EscrowSign struct

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

200 OK

EscrowApplication
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/close/approve/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/close/approve/{id}
content-type
accept
x-client-token
id

/close/{id}

post /close/{id}

Закрытие Escrow application

Закрытие Escrow application

Authorization
Authorization
(oauth2 application)

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

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

Токен клиента

id
Required in path
string

id

Accept
Optional in header
string
application/json
200

200 OK

{
    "schema": {
        "type": "string"
    }
}
400

Bad Request

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/escrow/close/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/escrow/close/{id}
accept
x-client-token
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": "Информация о продавце"
        }
    }
}
              
{
    "properties": {
        "data": {
            "type": "string"
        },
        "sucess": {
            "type": "boolean"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "bin": {
            "type": "string"
        },
        "id": {
            "type": "integer"
        },
        "iin": {
            "type": "string"
        },
        "sign_request": {
            "type": "string"
        }
    },
    "additionalProperties": false
}
              
{
    "type": "object",
    "properties": {
        "auth_key": {
            "$ref": "#\/definitions\/AuthKey"
        },
        "contract_date": {
            "type": "string"
        },
        "contract_expired": {
            "type": "string"
        },
        "documents_file_base64": {
            "type": "string"
        },
        "escrow": {
            "$ref": "#\/definitions\/EscrowApplication"
        },
        "persons": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/TrusteePerson"
            }
        },
        "user_info": {
            "$ref": "#\/definitions\/UserClaim"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "Channel": {
            "type": "string"
        },
        "username": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "approve_bank": {
            "type": "integer"
        },
        "approve_bank_message": {
            "type": "string"
        },
        "buyer_address": {
            "type": "string"
        },
        "buyer_bik": {
            "type": "string"
        },
        "buyer_bin": {
            "type": "string"
        },
        "buyer_doc_id_begdate": {
            "type": "string"
        },
        "buyer_doc_id_num": {
            "type": "string"
        },
        "buyer_first_name": {
            "type": "string"
        },
        "buyer_iban": {
            "type": "string"
        },
        "buyer_iin": {
            "type": "string"
        },
        "buyer_kbe": {
            "type": "string"
        },
        "buyer_last_name": {
            "type": "string"
        },
        "buyer_long_name": {
            "type": "string"
        },
        "buyer_mail": {
            "type": "string"
        },
        "buyer_middle_name": {
            "type": "string"
        },
        "buyer_phone": {
            "type": "string"
        },
        "cli_bin": {
            "type": "string"
        },
        "cli_code": {
            "type": "string"
        },
        "cli_first_name": {
            "type": "string"
        },
        "cli_iban": {
            "type": "string"
        },
        "cli_iin": {
            "type": "string"
        },
        "cli_kbe": {
            "type": "string"
        },
        "cli_last_name": {
            "type": "string"
        },
        "cli_long_name": {
            "type": "string"
        },
        "cli_phone": {
            "type": "string"
        },
        "cli_type": {
            "type": "integer"
        },
        "contract_amount": {
            "type": "number"
        },
        "contract_date": {
            "type": "string"
        },
        "contract_expired": {
            "type": "string"
        },
        "contract_num": {
            "type": "string"
        },
        "contract_target": {
            "type": "string"
        },
        "contract_val": {
            "type": "string"
        },
        "count_code": {
            "type": "integer"
        },
        "created_at": {
            "type": "string"
        },
        "dep_code": {
            "type": "string"
        },
        "doc_num": {
            "type": "string"
        },
        "escrow_iban": {
            "type": "string"
        },
        "escrow_tranche": {
            "type": "boolean"
        },
        "expired_at": {
            "type": "string"
        },
        "id": {
            "type": "integer"
        },
        "reason": {
            "type": "string"
        },
        "signature_a": {
            "type": "string"
        },
        "signature_a_id": {
            "type": "integer"
        },
        "signature_b": {
            "type": "string"
        },
        "signature_b_id": {
            "type": "integer"
        },
        "status": {
            "type": "string"
        },
        "updated_at": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "created_at": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "escrow_id": {
            "type": "integer"
        },
        "expired_date": {
            "type": "string"
        },
        "first_name": {
            "type": "string"
        },
        "id": {
            "type": "integer"
        },
        "iin": {
            "type": "string"
        },
        "is_main": {
            "type": "boolean"
        },
        "last_name": {
            "type": "string"
        },
        "middle_name": {
            "type": "string"
        },
        "num_doc": {
            "type": "string"
        },
        "phone": {
            "type": "string"
        },
        "sign_date_create_app": {
            "type": "string"
        },
        "start_date": {
            "type": "string"
        },
        "updated_at": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "firstname": {
            "type": "string"
        },
        "firstsignature": {
            "type": "boolean"
        },
        "id": {
            "type": "integer"
        },
        "iin": {
            "type": "string"
        },
        "lastname": {
            "type": "string"
        },
        "middlename": {
            "type": "string"
        },
        "organization": {
            "type": "object",
            "properties": {
                "approvalType": {
                    "type": "string"
                },
                "cliCode": {
                    "type": "string"
                },
                "clientType": {
                    "type": "string"
                },
                "customerId": {
                    "type": "integer"
                },
                "customerName": {
                    "type": "string"
                },
                "idn": {
                    "type": "string"
                }
            }
        },
        "secondsignature": {
            "type": "boolean"
        },
        "username": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "cli_login": {
            "type": "string"
        },
        "created_at": {
            "type": "string"
        },
        "escrow_id": {
            "type": "integer"
        },
        "id": {
            "type": "integer"
        },
        "idn": {
            "type": "string"
        },
        "sign_request": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "updated_at": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "amount": {
            "type": "number"
        },
        "message": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "unlockId": {
            "type": "integer"
        },
        "сounterparty": {
            "$ref": "#\/definitions\/CounterpartyPayment"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "counterparty": {
            "$ref": "#\/definitions\/CounterpartyPayment"
        },
        "isCounterparty": {
            "type": "boolean"
        },
        "unlock": {
            "$ref": "#\/definitions\/DBUnlockAgree"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "amount": {
            "type": "number"
        },
        "bic": {
            "type": "string"
        },
        "created_at": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "iban": {
            "type": "string"
        },
        "id": {
            "type": "integer"
        },
        "idn": {
            "type": "string"
        },
        "knp": {
            "type": "string"
        },
        "knp_name": {
            "type": "string"
        },
        "longname": {
            "type": "string"
        },
        "nds": {
            "type": "boolean"
        },
        "unlock_id": {
            "type": "integer"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "amount": {
            "type": "number"
        },
        "counterparty_pay": {
            "type": "boolean"
        },
        "created_dt": {
            "type": "string"
        },
        "error_message": {
            "type": "string"
        },
        "escrowId": {
            "type": "integer"
        },
        "id": {
            "type": "integer"
        },
        "reason": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "updated_dt": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "base64": {
            "type": "string"
        },
        "entity_id": {
            "type": "integer"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "cea_file_id": {
            "type": "integer"
        },
        "created_at": {
            "type": "string"
        },
        "document_type": {
            "description": "STATEMENT, CONTRACT и т.д",
            "type": "string"
        },
        "entity_id": {
            "description": "id записи escrow или unlock и т.д",
            "type": "integer"
        },
        "entity_type": {
            "description": "тип сущности ESCROW_APPLICATION, UNLOCK_AGREES и т.д",
            "type": "string"
        },
        "err_message": {
            "type": "string"
        },
        "file_name": {
            "type": "string"
        },
        "iban": {
            "type": "string"
        },
        "id": {
            "type": "integer"
        },
        "status": {
            "type": "string"
        },
        "updated_at": {
            "type": "string"
        }
    }
}