Возврат платежа: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) (Новая страница: «Для возврата платежа подготовьте POST запрос следующего вида: base URL: https://<URL-адрес сервера>/communal/refund В '''AUTHORIZATION''' укажите значение access_token согласно: Bearer token : token <значение '''acces_token'''> В '''BODY''' запроса укажите данные в формате JSON: <syntaxhighlight lang="JSON"> { "amount": <Сум...») |
Merkulov (обсуждение | вклад) м (Merkulov переименовал страницу CASHDESK API:Запрос возврата платежа в Возврат платежа) |
||
| (не показаны 4 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
Для | == Общие сведения == | ||
'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи. | |||
== Запрос возврата платежа == | |||
{{ProductTable-2 | |||
|title-left='''Запрос''' | |||
|title-right='''POST''' | |||
|content-left= <br>URL: https://<URL-адрес сервера>/communal/refund | |||
|content-right= | |||
<syntaxhighlight> | |||
https://<URL-адрес сервера>/communal/refund | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{Note|'''''Важно!'''''<br> | |||
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''access_token'''> .|800}} | |||
{{ProductTable-2 | |||
|title-left= '''Request body''' | |||
|title-right= '''raw''' (JSON) | |||
|content-left= <br> | |||
* '''amount''': Сумма оплаты | |||
* '''cardAmount''': Сумма оплаты кредитной картой | |||
* '''cashAmount''': Сумма оплаты наличными | |||
* '''clientId''': ID клиента | |||
* '''organizationId''': ID организации | |||
* '''serviceId''': ID услуги | |||
* '''paymentId''': ID платежа | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
| Строка 18: | Строка 38: | ||
"clientId": <ID клиента>, | "clientId": <ID клиента>, | ||
"organizationId": <ID организации>, | "organizationId": <ID организации>, | ||
"serviceId": 0, <ID услуги>, | |||
"paymentId": <ID платежа> | "paymentId": <ID платежа> | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> | |||
'' | {{ProductTable-2 | ||
|title-left= '''Response''' | |||
|title-right= | |||
|content-left= <br> | |||
* '''statusCode''': Идентификатор статуса | |||
* '''statusCodeValue''': Идентификатор статуса платежа | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"body": {}, | "body": {}, | ||
"statusCode": "100", | "statusCode": "100", | ||
"statusCodeValue": 9007199254740991 | "statusCodeValue": 9007199254740991 | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> | |||
Текущая версия на 10:33, 8 ноября 2022
Общие сведения
API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.
Запрос возврата платежа
| Запрос | POST |
URL: https://<URL-адрес сервера>/communal/refund |
https://<URL-адрес сервера>/communal/refund |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .
| Request body | raw (JSON) |
|
{
"amount": <Сумма оплаты>,
"cardAmount": <Сумма оплаты кредитной картой>,
"cashAmount": <Сумма оплаты наличными>,
"clientId": <ID клиента>,
"organizationId": <ID организации>,
"serviceId": 0, <ID услуги>,
"paymentId": <ID платежа>
}
|
| Response | |
|
{
"body": {},
"statusCode": "100",
"statusCodeValue": 9007199254740991
}
|