Jusan Business
API docs by Redocly

Jusan Business API (1.0)

Download OpenAPI specification:Download

Введение

Jusan Business API предназначен для создания интеграций между вашими информационными системами и сервисами Jusan Bank.

Подключение Jusan Business API

  1. Перейдите в личный кабинет Jusan Business и в левом меню выберите пункт Jusan Business API.

  2. Если у вас еще нет подключенного приложения, вы попадете на страницу с информацией об API. На ней нажмите “Подключить”.

  3. В появившейся форме заполните информацию о вашем приложении и выберите, какой функционал должен быть доступен данному приложению.

    Внимание: Если вы в последствии захотите изменить набор доступных приложению прав доступа, необходимо будет сгенерировать новые client_id и client_secret, используемые для авторизации.

  4. После успешного сохранения данных о приложении, вы увидите окно с технической информацией, которую необходимо передать разработчикам.

    Внимание: Не закрывайте окно прежде чем скопируете данные оттуда. Посмотреть повторно client_id и client_secret не получится. Но всегда можно будет сгенерировать новые, для уже созданного приложения.

  5. После копирования авторизационных данных закройте окно.

  6. Передайте client_id и client_secret вашим разработчикам вместе со ссылкой на данную документацию.

Ограничение на количество запросов к API

Вы можете отправлять суммарно до 50 запросов в минуту со всех приложений, подключенных к вашей компании. Если вы превысите количество запросов, методы начнут возвращать ошибку с кодом 429. В этом случае необходимо подождать 60 секунд и продолжить отправку запросов.

Обработка ошибок в API

Все ошибки приходят в стандартном формате.

{
    "code": "attempts_limit",
    "description": "Attempt limit exceeded for the operation",
    "timestamp": "2020-04-17T09:50:05.234"
}

В поле code приходит уникальный код ошибки, который можно использовать для локализации или обработки альтернативных сценариев.

HTTP-статус 400 используется в случае возникновения проблем разбора входящего запроса: неверные аргументы метода или не пройдена базовая валидация на тип аргументов.

HTTP-статус 401 используется в случае возникновения ошибки аутентификации или авторизации и, как правило, означает проблему на стороне клиента.

HTTP-статус 404 используется в случае, если вызван несуществующий эндпоинт.

HTTP-статус 412 используется в случае возникновения ошибки краевого сценария, уникальный код также придет в поле code.

HTTP-статус 429 используется в случае превышения количества запросов к API для одной компании.

HTTP-статус 500 используется в случае, если произошла непредвиденная ошибка на сервере.

Все code и HTTP-статусы, которые явно не указаны в спецификации к методу, стоит обрабатывать как «что-то пошло не так».

Песочница

Песочница представляет собой среду разработки и тестирования, которая позволяет разработчикам создавать и проверять функциональность своих приложений, связанных с Jusan Business API, в контролируемой и изолированной среде. Эта платформа обеспечивает безопасное и эффективное взаимодействие с банковскими сервисами, минимизирует риски и обеспечивает надежность при разработке и интеграции банковских API.

Для песочницы действуют все доступы подключаемые при создании приложения. Фунционал песочницы позволяет вам безопасно тестировать все доступные методы, но ограничивается предоставлением подготовленных данных на отправляемые запросы к ней.

Для авторизации и получения токена в песочнице используйте client_id_test, client_secret_test. Получаемый companyId используйте для запросов в песочницу.

Поддержка

В случае возникновения вопросов и предложений по работе Jusan Business API вы можете направлять их на почту: APIhelp@jusan.kz.

Аутентификация и авторизация

При регистрации приложения вы получили Client_ID и Client_Secret, которые необходимо использовать в запросе для аутентификации вашего приложения и получения авторизационного токена.

Использование токена

Полученный токен необходимо передавать во всех запросах к API в заголовке Authorization, добавляя Bearer перед значением токена.

Пример

Authorization: Bearer d25c16a1-ef1f-4da9-90af-292f525a54c9

Обновление токена

Авторизационный токен имеет время жизни, по истечении которого необходимо получить новый токен, используя тот же запрос.

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

В ответе на запрос аутентификации кроме токена возвращается идентификатор компании, к которой подключено приложение: companyId. Он должен быть передан как входной параметр в некоторых запросах.

Получить авторизационный токен

Возвращает токен для зарегистрированного приложения компании.

Для запроса к песочнице:
Используйте client_id_test, client_secret_test и получаемые companyId, accessToken для следующих запросов в песочницу.

Request Body schema: application/json
clientId
string

Уникальный идентификатор зарегистрированного приложения компании

clientSecret
string

Секретный ключ зарегистрированного приложения компании

Responses

Request samples

Content type
application/json
{
  • "clientId": "83a577f2-6df1-4b87-a448-85af410a1569",
  • "clientSecret": "QFBVY37Gj-caoJhSm_D2fdgzhOYxbwZbsSxYmLbKdhw"
}

Response samples

Content type
application/json
{
  • "accessToken": "74139200-5de2-4339-a168-49afcb53bce9",
  • "expiresIn": 3600,
  • "tokenType": "Bearer",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb"
}

Информация по счетам

Получайте актуальную информацию о счетах своей компании с помощью API.

Получить список счетов компании

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

Для запроса к песочнице:
Используйте ранее полученные companyId, accessToken. Результатом успешного запроса на получение списка счетов будет являться ответ содержащий 2 счета.

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Responses

Response samples

Content type
application/json
{
  • "id": "83a577f2-6df1-4b87-a448-85af410a1569",
  • "iban": "KZ76998KTB0001630460",
  • "accountType": "ACCOUNT",
  • "status": "OPENED",
  • "balance": {
    },
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "openDate": "2019-08-24",
  • "irreducibleBalance": 0
}

Выписки

Получайте выписку за нужный период с помощью API.

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

Доступны только по счетам с типом ACCOUNT. Возвращает выписку за нужный период в формате json.
В случае валютной операции в ответе после параметра amount будет дополнительно передаваться параметр amountLCY, представляющий перерасчёт суммы операции на KZT по указанному exchangeRate2.
В отличие от выписки по дате исполнения, выборка транзакций производится по дате операционного банковского дня, за который проведена финансовая операция. Ответ по выписке содержит в себе информацию о пагинации за весь запрашиваемый период.

Для запроса к песочнице:
Используйте ранее полученный companyId. В качестве iban используйте счет в KZT - KZ11111AAA1111111111 либо в USD - KZ11111BBB1111111111. В качестве дополнительных параметров (фильтров) используйте специально предопределенные значения, указанные ниже.
В текущей реализации песочницы, запрос может содержать не более одного дополнительного параметра (кроме пар page+pageSize и amountFrom+amountTo, которые необходимо использовать вместе). Результатом успешного запроса будет являться ответ, содержащий определенное количество транзакций, соответствующих указанному фильтру. При передаче любых альтернативных параметров dateFrom и/или dateTo, результатом успешного запроса будет являться ответ, не содержащий транзакций.

Параметры запроса для счета в тенге (KZT):

"dateFrom" = "2022-10-22" (обязательный)
"dateTo" = "2022-10-30" (обязательный)
"type" = "DEBIT or CREDIT"
"amountFrom" = "4000"
"amountTo" = "240000"
"documentNumber" = "449"
"page" = "1"
"pageSize" = "3"
"correspondentBin" = "098765432109"
"correspondentAccount" = "KZ88888LDB7778888777"

Параметры запроса для счета в валюте (USD):

"dateFrom" = "2022-04-01" (обязательный)
"dateTo" = "2022-10-01" (обязательный)
"type" = "DEBIT or CREDIT"
"amountFrom" = "27000"
"amountTo" = "37000"
"documentNumber" = "41"
"page" = "2"
"pageSize" = "2"
"correspondentBin" = "070707070707"
"correspondentAccount" = "KZ12313KKK1616161515"

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

iban
string <string>
Example: KZ76998KTB0001630460

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

query Parameters
type
string
Enum: "DEBIT" "CREDIT"

Параметр, который определяет тип операции. Принимает значения "DEBIT" или "CREDIT".

documentNumber
string

Номер документа, транзакции по которому должны попасть в выписку

correspondentBin
string

IDN номер аккаунтов, транзакции по которым должны попасть в выписку

correspondentAccount
string

IBAN аккаунтов, транзакции по которым должны попасть в выписку

dateFrom
required
string <date>

Дата начала периода, в соответствии с операционным банковским днем проведения платежа. Содержит дату в соответствии с часовым поясом Алматы (GMT+6).

dateTo
required
string <date>

Дата окончания периода, в соответствии с операционным банковским днем проведения платежа. Содержит дату в соответствии с часовым поясом Алматы (GMT+6). Период между датой окончания и датой начала не должен превышать 365 дней.

amountFrom
number <double>

Указывается ограничение снизу на сумму транзакций, которые попадут в выписку

amountTo
number <double>

Указывается ограничение сверху на сумму транзакций, которые попадут в выписку

page
required
integer
Default: 1

Номер страницы для пагинации результатов. Указывает номер запрашиваемой страницы.

pageSize
required
integer [ 1 .. 200 ]
Default: 100

Размер страницы для пагинации результатов. Определяет количество операций на одной странице.

Responses

Response samples

Content type
application/json
{
  • "iban": "KZ76998KTB0001630460",
  • "statementDate": "2023-08-10T13:32:27.103258",
  • "dateFrom": "2022-10-07",
  • "dateTo": "2022-10-20",
  • "transactions": [
    ],
  • "paginationInfo": {
    }
}

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

Доступны только по счетам с типом ACCOUNT. Возвращает выписку за нужный период в формате json.
В случае валютной операции в ответе после параметра amount будет дополнительно передаваться параметр amountLCY, представляющий перерасчёт суммы операции на KZT по указанному exchangeRate2.

Для запроса к песочнице:
Используйте ранее полученный companyId. В качестве iban используйте счет в KZT - KZ11111AAA1111111111 либо в USD - KZ11111BBB1111111111. В качестве дополнительных параметров (фильтров) используйте специально предопределенные значения, указанные ниже.
В текущей реализации песочницы, запрос может содержать не более одного дополнительного параметра (кроме пар page+pageSize и amountFrom+amountTo, которые необходимо использовать вместе). Результатом успешного запроса будет являться ответ, содержащий определенное количество транзакций, соответствующих указанному фильтру. При передаче любых альтернативных параметров executionDateFrom и/или executionDateTo, результатом успешного запроса будет являться ответ, не содержащий транзакций.

Параметры запроса для счета в тенге (KZT):

"executionDateFrom" = "2022-10-22T00:00:00" (обязательный)
"executionDateTo" = "2022-10-30T00:00:00" (обязательный)
"type" = "DEBIT or CREDIT"
"amountFrom" = "4000"
"amountTo" = "240000"
"documentNumber" = "449"
"page" = "1"
"pageSize" = "3"
"correspondentBin" = "098765432109"
"correspondentAccount" = "KZ88888LDB7778888777"

Параметры запроса для счета в валюте (USD):

"executionDateFrom" = "2022-04-01T00:00:00" (обязательный)
"executionDateTo" = "2022-10-01T00:00:00" (обязательный)
"type" = "DEBIT or CREDIT"
"amountFrom" = "27000"
"amountTo" = "37000"
"documentNumber" = "41"
"page" = "2"
"pageSize" = "2"
"correspondentBin" = "070707070707"
"correspondentAccount" = "KZ12313KKK1616161515"

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

iban
string <string>
Example: KZ76998KTB0001630460

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

query Parameters
type
string
Enum: "DEBIT" "CREDIT"

Параметр, который определяет тип операции. Принимает значения "DEBIT" или "CREDIT".

documentNumber
string

Номер документа, транзакции по которому должны попасть в выписку

correspondentBin
string

IDN номер аккаунтов, транзакции по которым должны попасть в выписку

correspondentAccount
string

IBAN аккаунтов, транзакции по которым должны попасть в выписку

executionDateFrom
required
string <date-time>

Время начала периода, должен содержать дату и время в часовом поясе Алматы (GMT+6)

executionDateTo
required
string <date-time>

Время окончания периода, должен содержать дату и время в часовом поясе Алматы (GMT+6). Период между датой окончания и датой начала не должен превышать 365 дней или быть меньше 1 минуты.

amountFrom
number <double>

Указывается ограничение снизу на сумму транзакций, которые попадут в выписку

amountTo
number <double>

Указывается ограничение сверху на сумму транзакций, которые попадут в выписку

page
required
integer
Default: 1

Номер страницы для пагинации результатов. Указывает номер запрашиваемой страницы.

pageSize
required
integer [ 1 .. 200 ]
Default: 100

Размер страницы для пагинации результатов. Определяет количество операций на одной странице.

Responses

Response samples

Content type
application/json
{
  • "iban": "KZ76998KTB0001630460",
  • "statementDate": "2023-08-10T13:32:27.103258",
  • "dateFrom": "2022-10-07T00:00:00",
  • "dateTo": "2022-10-20T00:00:00",
  • "transactions": [
    ],
  • "paginationInfo": {
    }
}

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

Информация по пагинации - общая информация по списку транзакций за период времени.

Доступны только по счетам с типом ACCOUNT. Возвращает информацию по пагинации выписок за нужный период в формате json.
Результатом успешного запроса будет являться ответ, содержащий параметры фактического запроса и информация по пагинации, соответствующая указанному фильтру.

Для запроса к песочнице:
Используйте специально предопределенные значения, для всех параметров (такие же, как и для Получения выписки по дате исполнения кроме параметра “page”, который исключен).
В текущей реализации песочницы, запрос может содержать не более одного дополнительного параметра (кроме пары amountFrom+amountTo, которую необходимо использовать вместе).

Параметры запроса для счета в тенге (KZT), iban = KZ11111AAA1111111111:

"executionDateFrom" = "2022-10-22T00:00:00" (обязательный)
"executionDateTo" = "2022-10-30T00:00:00" (обязательный)
"type" = "DEBIT or CREDIT"
"amountFrom" = "4000"
"amountTo" = "240000"
"documentNumber" = "449"
"pageSize" = "3"
"correspondentBin" = "098765432109"
"correspondentAccount" = "KZ88888LDB7778888777"

Параметры запроса для счета в валюте (USD), iban = KZ11111BBB1111111111:

"executionDateFrom" = "2022-04-01T00:00:00" (обязательный)
"executionDateTo" = "2022-10-01T00:00:00" (обязательный)
"type" = "DEBIT or CREDIT"
"amountFrom" = "27000"
"amountTo" = "37000"
"documentNumber" = "41"
"pageSize" = "2"
"correspondentBin" = "070707070707"
"correspondentAccount" = "KZ12313KKK1616161515"

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

iban
string <string>
Example: KZ76998KTB0001630460

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

query Parameters
type
string
Enum: "DEBIT" "CREDIT"

Параметр, который определяет тип операции. Принимает значения "DEBIT" или "CREDIT".

documentNumber
string

Номер документа, транзакции по которому должны быть подсчитаны в информации по пагинации

correspondentBin
string

IDN номер аккаунтов, транзакции по которым должны быть подсчитаны в информации по пагинации

correspondentAccount
string

IBAN аккаунтов, транзакции по которым должны быть подсчитаны в информации по пагинации

executionDateFrom
required
string <date-time>

Время начала периода, должен содержать дату и время в часовом поясе Алматы (GMT+6)

executionDateTo
required
string <date-time>

Время окончания периода, должен содержать дату и время в часовом поясе Алматы (GMT+6). Период между датой окончания и датой начала не должен превышать 365 дней или быть меньше 1 минуты.

amountFrom
number <double>

Указывается ограничение снизу на сумму транзакций, которые должны быть подсчитаны в информации по пагинации

amountTo
number <double>

Указывается ограничение сверху на сумму транзакций, которые должны быть подсчитаны в информации по пагинации

pageSize
required
integer [ 1 .. 200 ]
Default: 100

Размер страницы в соответствии с которым должна быть рассчитана информация по пагинации. Определяет количество операций на одной странице.

Responses

Response samples

Content type
application/json
{
  • "iban": "KZ76998KTB0001630460",
  • "statementDate": "2023-08-10T13:32:27.103258",
  • "dateFrom": "2022-10-07T00:00:00",
  • "dateTo": "2022-10-20T00:00:00",
  • "paginationInfo": {
    }
}

Получение сальдо счета

Получение сальдо по текущему счету на начало и конец указанного периода.

Для запроса к песочнице:
Используйте ранее полученные companyId, iban. Для параметров dateFrom, dateTo используйте предоставленные ниже значения.
При передаче указанных параметров запроса, результатом успешного запроса будет являться ответ содержащий параметры с определенными значениями. При передаче альтернативных параметров в запросе, результатом успешного запроса будет являться ответ содержащий параметры с нулевыми значениями.

Для счета в тенге:

"dateFrom": "2022-10-22"
"dateTo": "2022-10-30"

Для счета в валюте:

"dateFrom": "2022-08-01"
"dateTo"; "2022-10-01"

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

iban
string <string>
Example: KZ76998KTB0001630460

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

query Parameters
dateFrom
required
string <date>

Поле должно содержать дату yyyy-mm-dd

dateTo
required
string <date>

Поле должно содержать дату yyyy-mm-dd

Responses

Response samples

Content type
application/json
{
  • "iban": "KZ76998KTB0001630460",
  • "statementDate": "2023-07-22",
  • "dateFrom": "2022-10-22",
  • "dateTo": "2022-10-30",
  • "balanceIn": {
    },
  • "balanceOut": {
    },
  • "balanceInLCY": {
    },
  • "balanceOutLCY": {
    }
}

Создание черновиков платежей

Создайте черновик платежа, для того чтобы затем подписать его в личном кабинете вашей компании.

Для создания черновиков в песочнице: используйте ранее полученный companyId и передавайте значения соответствующие спецификации в тело запроса. Результатом успешного запроса на создание черновика будет являться ответ создающий черновик платежа, отражающего передаваемые параметры.

Создать черновик перевода между своими текущими счетами

Создает черновик перевода между своими счетами

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Request Body schema: application/json
required
object

Информация о получателе

required
object

Детальная информация

Responses

Request samples

Content type
application/json
{
  • "paymentRecipient": {
    },
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "id": "1f5f7806-8951-4d89-8734-727f38b31cb2",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "status": {
    },
  • "category": "DOMESTIC",
  • "type": "IN_BETWEEN",
  • "paymentRecipient": {
    },
  • "details": {
    },
  • "signatureScheme": "SINGLE_SIGN",
  • "userCanSignCustomSignature": false
}

Создать черновик платежа контрагенту

Создает черновик платежа контрагенту

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Request Body schema: application/json
type
required
string
Enum: "INTERNAL" "EXTERNAL"

Тип платежа
Может принимать одно и следующих значений:
INTERNAL для платежа в Jusan Bank
EXTERNAL для платежа в другой банк Казахстана

Для INTERNAL, значение поля bic = TSESKZKA, название Банка получателя bankName = АО "Jusan Bank". Для EXTERNAL эти параметры могут принимать любые значения.

category
required
string
Value: "DOMESTIC"

Категория платежа

required
object

Информация о получателе

required
object

Детальная информация

Responses

Request samples

Content type
application/json
{
  • "type": "INTERNAL",
  • "category": "DOMESTIC",
  • "paymentRecipient": {
    },
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "id": "1f5f7806-8951-4d89-8734-727f38b31cb2",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "status": {
    },
  • "category": "DOMESTIC",
  • "type": "INTERNAL",
  • "paymentRecipient": {
    },
  • "details": {
    },
  • "signatureScheme": "SINGLE_SIGN",
  • "userCanSignCustomSignature": false
}

Создать черновик налогового платежа

Создает черновик налогового платежа

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Request Body schema: application/json
required
object

Информация о получателе

required
object

Детальная информация

Responses

Request samples

Content type
application/json
{
  • "paymentRecipient": {
    },
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d42006a6-8e72-495b-9e6f-9b5ea1267d80",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "status": {
    },
  • "category": "DOMESTIC",
  • "type": "TAX",
  • "paymentRecipient": {
    },
  • "details": {
    },
  • "signatureScheme": "SINGLE_SIGN",
  • "userCanSignCustomSignature": false
}

Создать черновик пенсионного платежа

Создает черновик пенсионного платежа

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Request Body schema: application/json
required
object

Детальная информация

required
Array of objects

Список сотрудников к платежу

Responses

Request samples

Content type
application/json
{
  • "details": {
    },
  • "paymentEmployees": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "ac5b8a67-aef0-44a5-a7b2-364b4f38c764",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "status": {
    },
  • "category": "DOMESTIC",
  • "type": "PENSION",
  • "paymentRecipient": {
    },
  • "details": {
    },
  • "paymentEmployees": [
    ],
  • "signatureScheme": "SINGLE_SIGN",
  • "userCanSignCustomSignature": false
}

Создать черновик социального платежа

Создает черновик социального платежа

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Request Body schema: application/json
required
object

Детальная информация

required
Array of objects

Список сотрудников к платежу

Responses

Request samples

Content type
application/json
{
  • "details": {
    },
  • "paymentEmployees": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "ac5b8a67-aef0-44a5-a7b2-364b4f38c764",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "status": {
    },
  • "category": "DOMESTIC",
  • "type": "SOCIAL",
  • "paymentRecipient": {
    },
  • "details": {
    },
  • "paymentEmployees": [
    ],
  • "signatureScheme": "SINGLE_SIGN",
  • "userCanSignCustomSignature": false
}

Создать черновик платежа в фонд медицинского страхования

Создает черновик платежа в фонд медицинского страхования

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Request Body schema: application/json
required
object

Детальная информация

required
Array of objects

Список сотрудников к платежу

Responses

Request samples

Content type
application/json
{
  • "details": {
    },
  • "paymentEmployees": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "ac5b8a67-aef0-44a5-a7b2-364b4f38c764",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "status": {
    },
  • "category": "DOMESTIC",
  • "type": "MEDICAL",
  • "paymentRecipient": {
    },
  • "details": {
    },
  • "paymentEmployees": [
    ],
  • "signatureScheme": "SINGLE_SIGN",
  • "userCanSignCustomSignature": false
}

Создать черновик зарплатного платежа

Создает черновик социального платежа

Authorizations:
Bearer
path Parameters
companyId
string <uuid>
Example: 333a4b56-7d8e-90ab-12c3-a1b123456ddb

Уникальный идентификатор компании, к которой привязано приложение — клиент Jusan Business API. Получить идентификатор можно в запросе аутентификации.

Request Body schema: application/json
required
object

Детальная информация

required
Array of objects

Список сотрудников к платежу

required
object

Информация о получателе

Responses

Request samples

Content type
application/json
{
  • "details": {
    },
  • "paymentEmployees": [
    ],
  • "paymentRecipient": {
    }
}

Response samples

Content type
application/json
{
  • "id": "ac5b8a67-aef0-44a5-a7b2-364b4f38c764",
  • "companyId": "333a4b56-7d8e-90ab-12c3-a1b123456ddb",
  • "status": {
    },
  • "category": "DOMESTIC",
  • "type": "SALARY",
  • "paymentRecipient": {
    },
  • "details": {
    },
  • "paymentEmployees": [
    ],
  • "signatureScheme": "SINGLE_SIGN",
  • "userCanSignCustomSignature": false
}

Справочники

В данном разделе содержатся методы, с помощью которых вы можете получить информацию о кодах КНП и КБЕ, а также реквизиты банков Казахстана. Эта информация может быть использована при создании платежей.

Получение списка кодов: КБЕ, КНП, КБК

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

Authorizations:
Bearer
query Parameters
code
required
string
Enum: "KBE" "KNP" "KBK"

Код для получения доменных значений (возможные значения: КБЕ, КНП, КБК)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получение списка банков с реквизитами

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

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]