Добавление платежа: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) м (Merkulov переименовал страницу CASHDESK API:Запрос добавления платежа в Добавление платежа) |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 15: | Строка 15: | ||
{{Note|'''''Важно!'''''<br> | {{Note|'''''Важно!'''''<br> | ||
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение ''' | В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''access_token'''> .|800}} | ||
| Строка 28: | Строка 28: | ||
* '''organizationId''': ID организации | * '''organizationId''': ID организации | ||
* '''serviceId''': ID услуги | * '''serviceId''': ID услуги | ||
* '''payId''': ID платежа (Не используется в текущей реализации) | |||
* '''payDate''': Дата оплаты | |||
* '''personalAccount''': Номер лицевого счета в системе Расчетного центра (РЦ) | |||
* '''externalId''': Id платежа в Расчетном центре (РЦ) (Используется для возврата) | |||
|content-right= | |content-right= | ||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
| Строка 37: | Строка 41: | ||
"organizationId": <ID организации>, | "organizationId": <ID организации>, | ||
"serviceId": <ID услуги> | "serviceId": <ID услуги> | ||
"payId": 0, <ID платежа> | |||
"payDate": 0, <Дата оплаты> | |||
"personalAccount": "string", <Номер лицевого счета в системе Расчетного центра (РЦ)> | |||
"externalId": "string" <Id платежа в Расчетном центре (РЦ) (Используется для возврата)> | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Текущая версия на 10:35, 8 ноября 2022
Общие сведения
API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.
Запрос добавления платежа
| Запрос | POST |
URL: https://<URL-адрес сервера>/communal/payment |
https://<URL-адрес сервера>/communal/payment |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .
| Request body | raw (JSON) |
|
{
"amount": <Сумма оплаты>,
"cardAmount": <Сумма оплаты кредитной картой>,
"cashAmount": <Сумма оплаты наличными>,
"clientId": <ID клиента>,
"organizationId": <ID организации>,
"serviceId": <ID услуги>
"payId": 0, <ID платежа>
"payDate": 0, <Дата оплаты>
"personalAccount": "string", <Номер лицевого счета в системе Расчетного центра (РЦ)>
"externalId": "string" <Id платежа в Расчетном центре (РЦ) (Используется для возврата)>
}
|
| Response | |
|
{
"paymentId": <ID платежа>
}
|