Различия

Здесь показаны различия между двумя версиями данной страницы.

--- description_of_the_api [2015/03/18 12:13]
admin [Вывод в Кабинеты Покупателей]
+++ description_of_the_api [2017/07/27 12:05] (текущий)
admin [API 2.0]
@@ Строка 1: / Строка 1: @@
-========API 2.0========
+========API 2.1========
 ======Общая информация======
@@ Строка 20: / Строка 20: @@
 | way | string | Валюта платежа |
 | mode | string | Тип платежа, fix или free |
+| user_email | string | Email плтельщика |
 | signature | string | Контрольная подпись, SHA1 от строки - "check;pay_for;amount;way;mode;secret_key" |
+| additional_params.onpay_ap_xxx | string | Дополнительные параметры, переданные в платежной ссылке(см документацию по платежным ссылкам). Данных параметров в запросе НЕ будет, если они не были переданы в платежной ссылке. Алгоритм их формирования смотрите ниже |
   * "check"  в строке для контрольной подписи - фиксированное слово (5 букв), а не переменная
+В случае наличия параметров additional_params.onpay_ap_xxx в запросе также обязательно будет присутствовать параметр additional_params.onpay_ap_signature. Значение которого есть SHA1 от строки, полученной как конкатенация значений всех доп параметров(отсортированных по названию параметра) + НЕпередаваемого параметра onpay_ap_key, значение которого равно API_KEY в настройках сайта в кабинете мерчанта.
 Пример запроса:
+При API_KEY = 'test'
 <code class="json">{
 	"type":"check",
@@ Строка 31: / Строка 36: @@
 	"way":"RUR",
 	"mode":"fix",
-	"signature":"82f67760dbc5331963b7e00bc6df77f1"
+	"user_email":"test@test.com",
+	"signature":"37eacbf65fa2982be8e2f82d1cb6aef23bf88aa0"
+	"additional_params":{
+        	"onpay_ap_a1":"w",
+        	"onpay_ap_z1":"q",
+        	"onpay_ap_signature":"21ce6c2615c4b325ca406470b533e8ca76759dc4"
+	}
 }</code>
@@ Строка 49: / Строка 60: @@
 	"status":true,
 	"pay_for":"55446",
-	"signature":"172de16ada92791b3753b3121d471f5c"
+	"signature":"f6f250cd7d29ac9947ed97ddaeebb7934849d21e"
 }
 </code>
@@ Строка 77: / Строка 88: @@
 | order.to_amount | float | Сумма из ордера, которая должна была поступить на баланс магазина |
 | order.to_way | string | Валюта из ордера, в которой должен был пополниться баланс магазина |
+| additional_params.onpay_ap_xxx | string | Дополнительные параметры, переданные в платежной ссылке(см документацию по платежным ссылкам). Данных параметров в запросе НЕ будет, если они не были переданы в платежной ссылке. Алгоритм их формирования смотрите ниже |
   * "pay" в строке для контрольной подписи - фиксированное слово (3 буквы), а не переменная
   * при прямых платежах поля order.* отсутствуют
+В случае наличия параметров additional_params.onpay_ap_xxx в запросе также обязательно будет присутствовать параметр additional_params.onpay_ap_signature. Значение которого есть SHA1 от строки, полученной как конкатенация значений всех доп параметров(отсортированных по названию параметра) + НЕпередаваемого параметра onpay_ap_key, значение которого равно API_KEY в настройках сайта в кабинете мерчанта.
 Пример запроса:
+При API_KEY = 'test'
 <code class="json">
 {
 	"type":"pay",
-	"signature":"82f67760dbc5331963b7e00bc6df77f1",
+	"signature":"951e82110d1b796374ad3577f47e20a058c525dc",
 	"pay_for":"55446",
 	"user":{
@@ Строка 109: / Строка 124: @@
 		"to_amount":3378.39,
 		"to_way":"RUR"
+	}
+	"additional_params":{
+        	"onpay_ap_a1":"w",
+        	"onpay_ap_z1":"q",
+        	"onpay_ap_signature":"21ce6c2615c4b325ca406470b533e8ca76759dc4"
 	}
 }
@@ Строка 119: / Строка 139: @@
 | pay_for | string | Номер заказа |
 | signature | string | Контрольная подпись, SHA1 от строки - "pay;status;pay_for;secret_key" |
+| receipt | json | Содержит информацию о списке покупок в чеке |
+| receipt.items | array | Список товаров в чеке |
+| receipt.items.name | string | Название товара |
+| receipt.items.price | float | Цена за единицу товара |
+| receipt.items.quantity | float | Количество |
+| receipt.sum | float | Сумма чека |
   * "pay" в строке для контрольной подписи - фиксированное слово (3 буквы), а не переменная
@@ Строка 126: / Строка 152: @@
 <code class="json">
 {
-	"status":true,
+  "status":true,
-	"pay_for":"55446",
+  "pay_for":"55446",
-	"signature":"172de16ada92791b3753b3121d471f5c"
+  "signature":"a25de68f9516e91ce8782b11abcd5801d7af20f4"
+  "receipt": {
+    "items": [
+      {
+        "name": "product 1",
+        "price": 100.00,
+        "quantity": 2.8
+      },
+      {
+        "name": "product 2",
+        "price": 18.50,
+        "quantity": 4
+      },
+      {
+        "name": "product 3",
+        "price": 500.00,
+        "quantity": 1
+      }
+    ],
+    "sum": 854.00
+  }
 }
 </code>
@@ Строка 224: / Строка 270: @@
 ====Вывод в Кабинеты Покупателей====
+метод - POST
 адрес - /json_interfaces/wop_payouts
@@ Строка 237: / Строка 285: @@
 | phone.number | string | Телефон, на который зарегистрирован в кабинет покупателя. Допустимое значение - десять цифр без разделителей, первая цифра - 9 |
 | phone.code | string | код страны для номера телефона. Допустимое значение - "7" |
-| signature | string | Контрольная подпись, SHA1 от строки login;amount;email;api_in_key в случае передачи в запросе e-mail и SHA1 от строки login;amount;phone_codephone_number;api_in_key в случае передачи в запросе номера телефона. Во втором случае производится конкатенация phone_code и phone_number. |
+| signature | string | Контрольная подпись, SHA1 от строки login;amount;email;secret_key в случае передачи в запросе e-mail и SHA1 от строки login;amount;phone_codephone_number;secret_key в случае передачи в запросе номера телефона. Во втором случае производится конкатенация phone_code и phone_number. |
 В одном запросе могут быть переданы только хэш с номером телефона или E-mail.
@@ Строка 267: / Строка 315: @@
 ^ Название ^ Тип ^ Описание ^
 | payment_id | integer | ID исходящего платежа в системе onpay |
-| signature | string | SHA1 от строки payment_id;login;api_in_key |
+| signature | string | SHA1 от строки payment_id;login;secret_key |
 Пример ответа:
@@ Строка 278: / Строка 326: @@
 ====Выставление счета в кабинет покупателя====
+метод - POST
 адрес - /json_interfaces/payment_orders
@@ Строка 294: / Строка 344: @@
 | note | string | Комментарий к платежному ордеру. Лимит - 255 символов. Необязательный параметр |
 | login | string | Название сайта в системе Onpay |
-| signature | string | Цифровая подпись, sha1 от строки login;user_email;pay_for;way;amount;api_in_key |
+| signature | string | Цифровая подпись, sha1 от строки login;user_email;pay_for;way;amount;secret_key |
 Пример запроса:
@@ Строка 314: / Строка 364: @@
 ^ Название ^ Тип ^ Описание ^
 | uniq_id | integer | Идентификатор платежного ордера, состоящий из девяти цифр, первая из которых 3 |
-| signature | string | Цифровая подпись, sha1 от строки login;uniq_id;api_in_key |
+| signature | string | Цифровая подпись, sha1 от строки login;uniq_id;secret_key |
 Пример ответа:

Onpay.ru Wiki

Инструменты пользователя

Инструменты сайта

Различия

Инструменты страницы