Skip to content
/
Получить список всех груп...

Документация Haskaplan API (1.0.0)

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

Возможности OpenAPI Хаскаплан:

  • создание выплат и получение информации по выплатам бизнеса;
  • получение информации по банковским счетам;
  • получение информации об исполнителях;
  • получение информации о подписанных документах (договорах, актах, выбитых чеках);
  • управление группами исполнителей и комиссиями на вывод.
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://open-api.haskaplan.ru/_mock/openapi/

https://client-api.dev.haskaplan.net/

Балансы и исполнители

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

Исполнители выполняют работы и получают за это вознаграждение. В Хаскаплан исполнители создаются автоматически при первом начислении средств.

Operations

Выплаты

Методы предназначены для проведения платежей исполнителям — на баланс в приложении Хаскаплан или напрямую на карту или через СБП

Operations

Группы исполнителей

Группы определяют условия комиссии для исполнителей. У компании может быть только одна “группа по умолчанию” - в нее автоматически попадают все новые исполнители

Operations

Получить список всех групп исполнителей

Request

Получить список всех групп исполнителей

Security
clientID and clientSecret and requestSignature
curl -i -X GET \
  https://open-api.haskaplan.ru/_mock/openapi/v1/groups \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Успешный запрос

Bodyapplication/json
groupsArray of objects(GroupInfo)
Response
application/json
{
  "groups": [
    { … }
  ]
}

Создать новую группу исполнителей

Request

Метод также позволяет отредактировать существующую группу

Security
clientID and clientSecret and requestSignature
Bodyapplication/jsonrequired
idstring(uuid)

Required for edit, null for create

Example: "4b41b0ee-c144-40b4-87c0-6d2f59cb2915"
namestringrequired
Example: "name"
fee_ratenumber
Example: 10.25
min_feenumber
Example: 10.25
curl -i -X POST \
  https://open-api.haskaplan.ru/_mock/openapi/v1/groups \
  -H 'Content-Type: application/json' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE' \
  -d '{
    "id": "4b41b0ee-c144-40b4-87c0-6d2f59cb2915",
    "name": "name",
    "fee_rate": 10.25,
    "min_fee": 10.25
  }'

Responses

Успешный запрос

Bodyapplication/json
idstring(uuid)required
Example: "4b41b0ee-c144-40b4-87c0-6d2f59cb2915"
Response
application/json
{
  "id": "4b41b0ee-c144-40b4-87c0-6d2f59cb2915"
}

Удалить группу исполнителей

Request

Удалить можно только пустую группу - перед выполнением действия необходимо перенести всех исполнителей в другие группы. Группу по умолчанию удалить нельзя

Security
clientID and clientSecret and requestSignature
Path
group_idstring(uuid)required
curl -i -X DELETE \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/groups/{group_id}' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Группа успешно удалена

Response
No content

Получить список исполнителей в группе

Request

Получить список исполнителей в группе

Security
clientID and clientSecret and requestSignature
Path
group_idstring(uuid)required
curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/groups/{group_id}' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Успешный запрос

Bodyapplication/json
performersArray of objects(PerformerInfo)
Response
application/json
{
  "performers": [
    { … }
  ]
}

Перенести исполнителей в другую группу

Request

Перенести исполнителей в другую группу

Security
clientID and clientSecret and requestSignature
Bodyapplication/jsonrequired
group_idstring(uuid)required
Example: "4b41b0ee-c144-40b4-87c0-6d2f59cb2915"
performer_idsArray of stringsrequired
curl -i -X POST \
  https://open-api.haskaplan.ru/_mock/openapi/v1/groups/transfer \
  -H 'Content-Type: application/json' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE' \
  -d '{
    "group_id": "4b41b0ee-c144-40b4-87c0-6d2f59cb2915",
    "performer_ids": [
      "string"
    ]
  }'

Responses

Операция успешно

Bodyapplication/json
transferred_countintegerrequired
Example: 0
failed_countintegerrequired
Example: 0
failed_performersArray of strings
Response
application/json
{
  "transferred_count": 0,
  "failed_count": 0,
  "failed_performers": [
    "string"
  ]
}

Работа с документами

В Хаскаплан документы исполнителей создаются автоматически: договоры — перед получением первого начисления, акты и чеки — при выводе средств.

Все типы документов можно отфильтровать по дате от / до и исполнителю performer_id.

Operations