Skip to content

Haskaplan API (1.0.0)

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

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

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

Dev сервер

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

payments

Operations

Получить список всех выплат

Request

Возвращает все выплаты, совершенные от лица компании

Security
ClientId and ClientSecret and RequestSignature
Query
registry_idstring(uuid)

Фильтр по идентификатору реестра

pageinteger>= 1
Default 1
limitinteger[ 1 .. 100 ]
Default 50
curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/payments?registry_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=1&limit=50' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

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

Bodyapplication/json
paymentsArray of objects(PaymentInfo)required
payments[].​idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
payments[].​datestring(date-time)required
Example: "2024-01-15T10:30:00Z"
payments[].​amountnumberrequired
Example: 10250.5
payments[].​performer_idstringrequired
Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
payments[].​performer_namestringrequired
Example: "Иванов Иван Иванович"
payments[].​statusstringrequired
Enum"pending""processed""failed""refunded"
Example: "pending"
pageinteger
Example: 1
limitinteger
Example: 50
totalinteger
Example: 100
Response
application/json
{
  "payments": [
    { … }
  ],
  "page": 1,
  "limit": 50,
  "total": 100
}

Отправить реестр на обработку

Request

Отправляет реестр выплат на обработку. Платежи из реестра начисляются в фоновом режиме

Security
ClientId and ClientSecret and RequestSignature
Path
registry_idstring(uuid)required
curl -i -X POST \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/payments/{registry_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

balances

Operations

registries

Operations