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

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


base URL: https://<URL-адрес сервера>/communal/payment
== Запрос добавления платежа ==


{{ProductTable-2
|title-left='''Запрос'''
|title-right='''POST'''
|content-left= <br>URL: https://<URL-адрес сервера>/communal/payment
|content-right=
<syntaxhighlight>
https://<URL-адрес сервера>/communal/payment
</syntaxhighlight>
|}}<br>


В '''AUTHORIZATION''' укажите значение access_token согласно:
{{Note|'''''Важно!'''''<br>
 
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''access_token'''> .|800}}
Bearer token : token <значение '''acces_token'''>
 


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


{{ProductTable-2
|title-left= '''Request body'''
|title-right= '''raw''' (JSON)
|content-left= <br>
* '''amount''': Сумма оплаты
* '''cardAmount''': Сумма оплаты кредитной картой
* '''cashAmount''': Сумма оплаты наличными
* '''clientId''': ID клиента
* '''organizationId''': ID организации
* '''serviceId''': ID услуги
* '''payId''': ID платежа (Не используется в текущей реализации)
* '''payDate''': Дата оплаты
* '''personalAccount''': Номер лицевого счета в системе Расчетного центра (РЦ)
* '''externalId''': Id платежа в Расчетном центре (РЦ) (Используется для возврата)
|content-right=
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
Строка 19: Строка 41:
   "organizationId": <ID организации>,
   "organizationId": <ID организации>,
   "serviceId": <ID услуги>
   "serviceId": <ID услуги>
  "payId": 0, <ID платежа>
  "payDate": 0, <Дата оплаты>
  "personalAccount": "string", <Номер лицевого счета в системе Расчетного центра (РЦ)>
  "externalId": "string" <Id платежа в Расчетном центре (РЦ) (Используется для возврата)>
}
}
</syntaxhighlight>
</syntaxhighlight>
|}}<br>




''Пример ответа на запрос''
{{ProductTable-2
|title-left= '''Response'''
|title-right=
|content-left= <br>
* '''paymentId''': ID платежа
|content-right=
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
  {
  {
Строка 29: Строка 62:
  }
  }
</syntaxhighlight>
</syntaxhighlight>
|}}<br>

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

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

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

Запрос добавления платежа

Запрос POST

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


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


Request body raw (JSON)

  • amount: Сумма оплаты
  • cardAmount: Сумма оплаты кредитной картой
  • cashAmount: Сумма оплаты наличными
  • clientId: ID клиента
  • organizationId: ID организации
  • serviceId: ID услуги
  • payId: ID платежа (Не используется в текущей реализации)
  • payDate: Дата оплаты
  • personalAccount: Номер лицевого счета в системе Расчетного центра (РЦ)
  • externalId: Id платежа в Расчетном центре (РЦ) (Используется для возврата)
 
{
  "amount": <Сумма оплаты>,
  "cardAmount": <Сумма оплаты кредитной картой>,
  "cashAmount": <Сумма оплаты наличными>,
  "clientId": <ID клиента>,
  "organizationId": <ID организации>,
  "serviceId": <ID услуги>
  "payId": 0, <ID платежа>
  "payDate": 0, <Дата оплаты>
  "personalAccount": "string", <Номер лицевого счета в системе Расчетного центра (РЦ)>
  "externalId": "string" <Id платежа в Расчетном центре (РЦ) (Используется для возврата)>
}



Response

  • paymentId: ID платежа
 
 {
 "paymentId": <ID платежа>
 }


Источник — http://kassa.bifit.com/wiki/index.php?title=Добавление_платежа&oldid=36890