Добавление платежа
Версия от 12:42, 1 июня 2022; Merkulov (обсуждение | вклад)
Общие сведения
API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.
Запрос добавления платежа
Запрос | POST |
URL: https://<URL-адрес сервера>/communal/payment |
https://<URL-адрес сервера>/communal/payment |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .
Request body | raw (JSON) |
|
{
"amount": <Сумма оплаты>,
"cardAmount": <Сумма оплаты кредитной картой>,
"cashAmount": <Сумма оплаты наличными>,
"clientId": <ID клиента>,
"organizationId": <ID организации>,
"serviceId": <ID услуги>
}
|
Response | |
|
{
"paymentId": <ID платежа>
}
|
Для получения платежа подготовьте POST запрос следующего вида:
base URL: https://<URL-адрес сервера>/communal/payment
В AUTHORIZATION укажите значение access_token согласно:
Bearer token : token <значение acces_token>
В BODY запроса укажите данные в формате JSON:
{
"amount": <Сумма оплаты>,
"cardAmount": <Сумма оплаты кредитной картой>,
"cashAmount": <Сумма оплаты наличными>,
"clientId": <ID клиента>,
"organizationId": <ID организации>,
"serviceId": <ID услуги>
}
Пример ответа на запрос
{
"paymentId": <ID платежа>
}