logo (3).svg
 

Поддержка: `support@haskaplan.ru`

Стать клиентом: `clients@haskaplan.ru`

[Пользовательское соглашение](https://haskaplan.net/app-document/user-agreement.pdf)




 

## Haskaplan API

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

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

* создание выплат и получение информации по выплатам;
* получение информации по банковским счетам;
* получение информации об исполнителях;
* получение информации о подписанных документах (договорах, актах, выбитых чеках);
* управление группами исполнителей и комиссиями на вывод.


#### 📌 Авторизация

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

*Пример*:


```
  GET /api/resource HTTP/1.1
  Host: example.com
  clientID: your-client-id
  clientSecret: your-client-secret
```

Получить ключи клиента можно, обратившись к нам на почту `clients@haskaplan.ru`

 

#### 🔍 Справочники

**Типы договоров исполнителей `agreement_type`**

- `ФЛ` - Физлицо;
- `СЗ` - Самозанятый;
- `ИП` - Индивидуальный предприниматель.


**Статус реестра**

- `created` - В очереди на обработку;
- `processing` - В обработке;
- `completed` - Реестр успешно начислен;
- `partially_completed` - Реестр начислен, часть платежей завершились с ошибкой;
- `failed` - Все платежи в реестре завершились с ошибкой.


**Статус платежа**

- `pending` - Платеж в процессе обработки;
- `processed` - Платеж успешно проведен;
- `failed` - Ошибка проведения платежа;
- `refunded` - Ошибка проведения платежа после отправки в банк.


**Типы списаний**

- `card_direct` — выплата напрямую на карту;
- `sbp_direct` — выплата напрямую через СБП;
- `card_app` — вывод исполнителем из приложения Хаскаплан на карту;
- `sbp_app` — вывод из приложения Хаскаплан через СБП.


#### ⚠️ Основные коды ошибок

| Код | Название ошибки | Описание |
|  --- | --- | --- |
| 10001 | InvalidQueryParametersErrorCode | Неверные параметры запроса |
| 10002 | InterpayFailedErrorCode | Ошибка при выполнении платежа Interpay |
| 10003 | FailedToAcquirePaymentErrorCode | Не удалось получить платёж |
| 10004 | NotFoundErrorCode | Ресурс не найден |
| 10005 | EmptyRequestErrorCode | Пустой запрос |
| 10006 | FailedToCreatePaymentsErrorCode | Не удалось создать платежи |
| 10007 | FailedToParseRequestBodyErrorCode | Ошибка при разборе тела запроса |
| 10008 | UnexpectedErrorCode | Неожиданная ошибка |
| 10009 | UnauthorizedErrorCode | Доступ запрещён (неавторизован) |
| 10010 | NothingToUpdateErrorCode | Нет данных для обновления |
| 10011 | InvalidCardNumberErrorCode | Неверный номер карты |
| 10012 | NotImplementedErrorCode | Функция не реализована |
| 10013 | InvalidId | Неверный идентификатор |
| 10014 | FailedToGenerateExcel | Ошибка при генерации Excel |
| 10015 | InvalidUserId | Неверный ID пользователя |
| 10016 | InvalidAgreementType | Неверный тип соглашения |
| 10017 | InvalidTransactionStatus | Неверный статус транзакции |
| 10018 | InvalidBalance | Неверный баланс |
| 10019 | InvalidConfirmationCode | Неверный код подтверждения |
| 10020 | InvalidPhoneNumberErrorCode | Неверный номер телефона |
| 10021 | InvalidEmailErrorCode | Неверный email |
| 10022 | InvalidCpfErrorCode | Неверный CPF |
| 10023 | InvalidBankAccountErrorCode | Неверные банковские реквизиты |
| 10024 | ServiceIsUnavailable | Сервис недоступен |
| 10025 | InvalidCompanyData | Неверные данные компании |




 

#### ⭐ Поддержка и обратная связь

Если у вас возникнут вопросы или потребуется помощь, пожалуйста, свяжитесь с нашей службой поддержки через `support@haskaplan.ru`.