Возврат платежа: различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
м (Merkulov переименовал страницу CASHDESK API:Запрос возврата платежа в Возврат платежа)
 
(не показаны 2 промежуточные версии этого же участника)
Строка 28: Строка 28:
* '''clientId''': ID клиента
* '''clientId''': ID клиента
* '''organizationId''': ID организации
* '''organizationId''': ID организации
* '''serviceId''': ID услуги
* '''paymentId''': ID платежа
* '''paymentId''': ID платежа
|content-right=
|content-right=
Строка 37: Строка 38:
   "clientId": <ID клиента>,
   "clientId": <ID клиента>,
   "organizationId": <ID организации>,
   "organizationId": <ID организации>,
  "serviceId": 0, <ID услуги>,
   "paymentId": <ID платежа>
   "paymentId": <ID платежа>
}
}

Текущая версия на 10:33, 8 ноября 2022

Общие сведения

API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.


Запрос возврата платежа

Запрос POST

URL: https://<URL-адрес сервера>/communal/refund
https://<URL-адрес сервера>/communal/refund


Note.svg Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .


Request body raw (JSON)

  • amount: Сумма оплаты
  • cardAmount: Сумма оплаты кредитной картой
  • cashAmount: Сумма оплаты наличными
  • clientId: ID клиента
  • organizationId: ID организации
  • serviceId: ID услуги
  • paymentId: ID платежа
{
  "amount": <Сумма оплаты>,
  "cardAmount": <Сумма оплаты кредитной картой>,
  "cashAmount": <Сумма оплаты наличными>,
  "clientId": <ID клиента>,
  "organizationId": <ID организации>,
  "serviceId": 0, <ID услуги>,
  "paymentId": <ID платежа>
}



Response

  • statusCode: Идентификатор статуса
  • statusCodeValue: Идентификатор статуса платежа
 {
  "body": {},
  "statusCode": "100",
  "statusCodeValue": 9007199254740991
}