Различия

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

--- api-out [2011/12/18 14:30]
admin создано
+++ api-out [2013/09/19 17:25] (текущий)
admin
@@ Строка 1: / Строка 1: @@
+====== Автоматизация выплат через API ======
 **Автоматизация выплат через API**\\
 API используется для генерации платежных поручений от имени пользователя Onpay на перевод денег на любой кошелек moybiz.\\
 Для создания заявки на вывод в кошелек moybiz сайт пользователя выполняет POST запрос на адрес https://secure.onpay.ru/api/out_mbz со следующими параметрами:\\
-Поле запроса
+^ Поле запроса ^ Тип и возможные значение ^ Назначение ^ Комментарий ^
-Тип и возможные значения
+| operation | строка 'pay'| Тип операции | Обязательный параметр, выбирает тип операции |
-Назначение
+| amount | Число с плавающей запятой | Сумма | Обязательный параметр, сумма перечисления |
-Комментарий
+| pay_for | строка | Назначение платежа | Обязательный параметр, назначение платежа, UTF8 |
-operation
+| recipient | строка, e-mail | Получатель платежа | Обязательный параметр, email получателя платежа, служащий идентификатором в moybiz |
-строка 'pay'
+| merchant | строка | Плательщик | Обязательный параметр, адрес платежной формы сайта в системе Onpay, с которого уйдут деньги |
-Тип операции
+| protection | строка | Код протекции | Обязательный параметр - код протекции перевода в кошельке |
-Обязательный параметр, выбирает тип операции
+| days | число | Количество дней протекции | Обязательный параметр - количество дней действия протекции |
-amount
+| sign | строка, SHA1 | Подпись | Приведенная к верхнему регистру контрольная сумма в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением строк operation, merchant, merchant_psk разделенных точкой с запятой. Пример строки - "balance;onpay;uXeito3jeihe" |
-Число с плавающей запятой
+\\
-Сумма
+Пример запроса на выплату:\\
-Обязательный параметр, сумма перечисления
+  POST https://secure.onpay.ru/api/out_mbz HTTP/1.0
-pay_for
+  operation: pay
-строка
+  amount: 123.0
-Назначение платежа
+  pay_for: Заказ №170838
-Обязательный параметр, назначение платежа, UTF8
+  recipient: Vasily.Pupkin@mail.ru
-recipient
+  merchant: onpay
-строка, e-mail
+  protection: secret123
-Получатель платежа
+  days: 30
-Обязательный параметр, email получателя платежа, служащий идентификатором в moybiz
+  sign: 402BE2A3753421510F327EFFA82333EEA66F08FE
-merchant
+\\
-строка
+Onpay отвечает строкой, содержащей код ошибки (0 - успех), результат операции в текстовом виде и подписью, образованной из приведенной к верхнему регистру контрольной суммы в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением кода результата, результата и merchant_psk. В ответе может отсутствовать подпись, если запрос не позволяет идентифицировать мерчанта и получить его PSK. Примеры ответов:\\
-Плательщик
+;ОК;2D9E1AA59520BAC0D74D65ABED1A78A7502654EC
-Обязательный параметр, адрес платежной формы сайта в системе Onpay, с которого уйдут деньги
+;Signature wrong;B31599FC8287A4A21AC79B3F5C69BDC32422A4C4
-protection
+;Not enough money;949EE6AABC4E449B8D035F91C336747A36B37987
-строка
+\\
-Код протекции
+\\
-Обязательный параметр - код протекции перевода в кошельке
-days
-число
-Количество дней протекции
-Обязательный параметр - количество дней действия протекции
-sign
-строка, SHA1
-Подпись
-Приведенная к верхнему регистру контрольная сумма в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением параметров operation, amount, pay_for, recipient, merchant, protection, days, merchant_psk разделенных точкой с запятой. Здесь merchant_psk - секретный ключ мерчанта, который он вводит в зеленом кабинете. Пример строки - "pay;123.0;Заказ №170838;Vasily.Pupkin@mail.ru;onpay;secret123;30;uXeito3jeihe"
-Пример запроса на выплату:
-POST https://secure.onpay.ru/api/out_mbz HTTP/1.0
-operation: pay
-amount: 123.0
-pay_for: Заказ №170838
-recipient: Vasily.Pupkin@mail.ru
-merchant: onpay
-protection: secret123
-days: 30
-sign: 402BE2A3753421510F327EFFA82333EEA66F08FE
-Onpay отвечает строкой, содержащей код ошибки (0 - успех), результат операции в текстовом виде и подписью, образованной из приведенной к верхнему регистру контрольной суммы в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением кода результата, результата и merchant_psk. В ответе может отсутствовать подпись, если запрос не позволяет идентифицировать мерчанта и получить его PSK. Примеры ответов:
-;ОК;2D9E1AA59520BAC0D74D65ABED1A78A7502654EC
-;Signature wrong;B31599FC8287A4A21AC79B3F5C69BDC32422A4C4
-;Not enough money;949EE6AABC4E449B8D035F91C336747A36B37987
 Для получения баланса сайт пользователя выполняет POST запрос на адрес https://secure.onpay.ru/api/out_mbz со следующими параметрами:
-Поле запроса
+^ Поле запроса ^ Тип и возможные значение ^ Назначение ^ Комментарий ^
-Тип и возможные значения
+| operation | строка 'pay'| Тип операции | Обязательный параметр, выбирает тип операции |
-Назначение
+| merchant | строка | Плательщик | Обязательный параметр, адрес платежной формы сайта в системе Onpay, с которого уйдут деньги |
-Комментарий
+| sign | строка, SHA1 | Подпись | Приведенная к верхнему регистру контрольная сумма в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением параметров operation, amount, pay_for, recipient, merchant, protection, days, merchant_psk разделенных точкой с запятой. Здесь merchant_psk - секретный ключ мерчанта, который он вводит в зеленом кабинете. Пример строки - "pay;123.0;Заказ №170838;Vasily.Pupkin@mail.ru;onpay;secret123;30;uXeito3jeihe" |
-operation
+\\
-строка 'balance'
+Пример запроса на баланс:\\
-Тип операции
+  POST https://secure.onpay.ru/api/out_mbz HTTP/1.0
-Обязательный параметр, выбирает тип операции
+  operation: balance
-merchant
+  merchant: onpay
-строка
+  sign: CAFD1A5DD502758EF23851C05511C3AE61DBD3BC
-Плательщик
+\\
-Обязательный параметр, адрес платежной формы сайта в системе Onpay, с которого уйдут деньги
+\\
-sign
+Onpay отвечает строкой, содержащей код ошибки (0 - успех), результат операции в текстовом виде, баланс и подписью, образованной из приведенной к верхнему регистру контрольной суммы в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением кода результата, результата, баланса и merchant_psk. В ответе может отсутствовать подпись, если запрос не позволяет идентифицировать мерчанта и получить его PSK. Если операция не успешна, баланса не будет ни в ответе, ни в подписи. Примеры ответов:\\
-строка, SHA1
+;ОК;10000.0;6949CC86621AC1A9D831C51E65AB3B350DF5EFE1
-Подпись
+;Signature wrong;B31599FC8287A4A21AC79B3F5C69BDC32422A4C4
-Приведенная к верхнему регистру контрольная сумма в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением строк operation, merchant, merchant_psk разделенных точкой с запятой. Пример строки - "balance;onpay;uXeito3jeihe"
-Пример запроса на баланс:
-POST https://secure.onpay.ru/api/out_mbz HTTP/1.0
-operation: balance
-merchant: onpay
-sign: CAFD1A5DD502758EF23851C05511C3AE61DBD3BC
-Onpay отвечает строкой, содержащей код ошибки (0 - успех), результат операции в текстовом виде, баланс и подписью, образованной из приведенной к верхнему регистру контрольной суммы в шестнадцатиричном виде по алгоритму SHA1 от приведенной к верхнему регистру строки, полученной сложением кода результата, результата, баланса и merchant_psk. В ответе может отсутствовать подпись, если запрос не позволяет идентифицировать мерчанта и получить его PSK. Если операция не успешна, баланса не будет ни в ответе, ни в подписи. Примеры ответов:
-;ОК;10000.0;6949CC86621AC1A9D831C51E65AB3B350DF5EFE1
-;Signature wrong;B31599FC8287A4A21AC79B3F5C69BDC32422A4C4
 **Ограничения**\\

Onpay.ru Wiki

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

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

Различия

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