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

Материал из Касса
Перейти к навигации Перейти к поиску
(Новая страница: «Для возврата платежа подготовьте POST запрос следующего вида: base URL: https://<URL-адрес сервера>/communal/refund В '''AUTHORIZATION''' укажите значение access_token согласно: Bearer token : token <значение '''acces_token'''> В '''BODY''' запроса укажите данные в формате JSON: <syntaxhighlight lang="JSON"> { "amount": <Сум...»)
 
Строка 1: Строка 1:
Для возврата платежа подготовьте POST запрос следующего вида:
== Общие сведения ==
'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.


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


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


В '''AUTHORIZATION''' укажите значение access_token согласно:
{{ProductTable-2
 
|title-left='''Запрос'''
Bearer token : token <значение '''acces_token'''>
|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 <значение '''acces_token'''> .|800}}


В '''BODY''' запроса укажите данные в формате JSON:


{{ProductTable-2
|title-left= '''Request body'''
|title-right= '''raw''' (JSON)
|content-left= <br>
* '''amount''': Сумма оплаты
* '''cardAmount''': Сумма оплаты кредитной картой
* '''cashAmount''': Сумма оплаты наличными
* '''clientId''': ID клиента
* '''organizationId''': ID организации
* '''paymentId''': ID платежа
|content-right=
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
Строка 21: Строка 40:
}
}
</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>

Версия 12:50, 1 июня 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 <значение acces_token> .


Request body raw (JSON)

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



Response

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