Здесь показаны различия между двумя версиями данной страницы.
Both sides previous revision Предыдущая версия Следущая версия | Предыдущая версия Следущая версия Both sides next revision | ||
api-bills [2011/10/20 10:32] admin |
api-bills [2014/09/26 10:52] admin [Форматы параметров] |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | Для того чтобы выставить счет за определенный товар на определенную сумму следует использовать механизм создания ссылок-счетов с использованием API Onpay.\\ | + | Для того чтобы автоматически выставить счет за определенный товар на определенную сумму можно использовать механизм создания ссылок-счетов с использованием API Onpay. А можно просто вручную сделать ссылку через интерфейс Кабинета продавца https://secure.onpay.ru/payment_links - для этого не потребуется никаких специальных знаний.\\ |
\\ | \\ | ||
==== Параметры ==== | ==== Параметры ==== | ||
Строка 5: | Строка 5: | ||
**pay_amount** - сумма счета\\ | **pay_amount** - сумма счета\\ | ||
**pay_for** - назначение платежа\\ | **pay_for** - назначение платежа\\ | ||
- | **currency** - тикер валюты оплаты\\ | + | **one_way** - форма оплаты одним способом (тикер валюты) (не обязательно)\\ |
+ | **ticker** - тикер валюты оплаты\\ | ||
**user_login** - адрес платежной формы (обычно тот же, что и логин пользователя)\\ | **user_login** - адрес платежной формы (обычно тот же, что и логин пользователя)\\ | ||
- | user_email - адрес электронной почты плательщика (не обязательно)\\ | + | **user_email** - адрес электронной почты плательщика (не обязательно)\\ |
**price_final** - комиссию платежной системы взымать с продавца (true или false)\\ | **price_final** - комиссию платежной системы взымать с продавца (true или false)\\ | ||
**pay_type** - конвертировать все платежи в выбранную валюту (1 - да, 2 - нет)\\ | **pay_type** - конвертировать все платежи в выбранную валюту (1 - да, 2 - нет)\\ | ||
- | **notify_by_api** - проверять возможность оплаты через API мерчанта\\ | + | **notify_by_api** - проверять возможность оплаты через API мерчанта (Если True - при оплате мерчант получит запрос через указанный им в зеленом кабинете URL API IN. Если на запрос не будет ответа или ответ будет негативным, оплата не пройдет)\\ |
- | **md5** - строка, полученная вычислением MD5 от конкатенации pay_amount, pay_for, currency, user_login, price_final, pay_type, notify_by_api, api_in_key, разделенных двоеточием (:) - после конкатенации через двоеточие строку перед вычислением MD5 надо перевести в верхний регистр.\\ | + | **md5** - строка, полученная вычислением MD5 от конкатенации pay_amount, pay_for, ticker, user_login, price_final, pay_type, notify_by_api, api_in_key, разделенных двоеточием (:)\\ |
\\ | \\ | ||
- | !!! В запросе также обязательно должен присутствовать параметр **api_in_key** - пароль для API [[http://wiki.onpay.ru/doku.php?id=merchant|Мерчанта]]\\ | + | Все параметры, содержащие символы не относящиеся к ASCII должны быть переданы в кодировке utf8.\\ |
\\ | \\ | ||
В случае успеха статус ответа будет 200 и в теле ответа будет сгенерированная ссылка.\\ | В случае успеха статус ответа будет 200 и в теле ответа будет сгенерированная ссылка.\\ | ||
Строка 21: | Строка 22: | ||
\\ | \\ | ||
==== Форматы параметров ==== | ==== Форматы параметров ==== | ||
- | **pay_amount**: число, будет округлено до 2 знаков после запятой\\ | + | **pay_amount**: число, разделитель - точка, будет округлено до 2 знаков после разделителя\\ |
**pay_for**: строка \\ | **pay_for**: строка \\ | ||
**user_email**: строка\\ | **user_email**: строка\\ | ||
- | **currency**: 3-символьное обозначение валюты оплаты (тикер), строка\\ | + | **ticker**: строка, 3-символьное обозначение валюты оплаты(в верхнем регистре)\\ |
- | **user_login**: строка, адрес платежной формы (обычно тот же, что и логин пользователя)\\ | + | **user_login**: строка, логин магазина в системе Onpay)\\ |
+ | **one_way**: строка, 3-символьное обозначение валюты для оплаты одним способом\\ | ||
**price_final**: булевское значение, значения '1', 'true', 'TRUE', 't', 'T' будут интерпретированы как "да", любые другие - как "нет" (в том числе, к примеру 'True' дает false)\\ | **price_final**: булевское значение, значения '1', 'true', 'TRUE', 't', 'T' будут интерпретированы как "да", любые другие - как "нет" (в том числе, к примеру 'True' дает false)\\ | ||
**pay_type**: 1 или 2, любое другое значение вызовет ошибку\\ | **pay_type**: 1 или 2, любое другое значение вызовет ошибку\\ | ||
- | **notify_by_ap**i: булевское значение, значения '1', 'true', 'TRUE', 't', 'T' будут интерпретированы как "да", любые другие - как "нет" (в том числе, к примеру 'True' дает false)\\ | + | **notify_by_ap**i: строка, '1' или '0'\\ |
**md5 - строка**\\ | **md5 - строка**\\ | ||
\\ | \\ | ||
+ | **Все параметры, содержащие символы не относящиеся к ASCII должны быть переданы в кодировке utf8.**\\ | ||
==== Пример GET запроса ==== | ==== Пример GET запроса ==== | ||
- | https://secure.onpay.ru/pay/make_payment_link?pay_amount=100&pay_for=Order%20342&user_email=user@pochta.ru¤cy=RUR&user_login=onpay&price_final=true&md5=cf653b4c4a7861b2224bd31eb3e3f291&pay_type=1¬ify_by_api=true \\ | + | https://secure.onpay.ru/pay/make_payment_link?pay_amount=100&pay_for=Order%20342&user_email=user@pochta.ru&ticker=RUR&user_login=onpay&price_final=true&md5=cf653b4c4a7861b2224bd31eb3e3f291&pay_type=1¬ify_by_api=true \\ |
==== Пример POST запроса ==== | ==== Пример POST запроса ==== | ||
Строка 43: | Строка 46: | ||
"pay_type"=>"1", | "pay_type"=>"1", | ||
"pay_amount"=>"100", | "pay_amount"=>"100", | ||
- | "currency"=>"RUR", | + | "ticker"=>"RUR", |
"md5"=>"cf653b4c4a7861b2224bd31eb3e3f291", | "md5"=>"cf653b4c4a7861b2224bd31eb3e3f291", | ||
"pay_for"=>"Order 342", | "pay_for"=>"Order 342", | ||
"user_email"=>"user@pochta.ru" | "user_email"=>"user@pochta.ru" | ||
} | } |