Здесь показаны различия между двумя версиями данной страницы.
Both sides previous revision Предыдущая версия Следущая версия | Предыдущая версия Следущая версия Both sides next revision | ||
api-for-pay-form [2015/10/19 10:12] admin |
api-for-pay-form [2015/10/19 10:25] admin |
||
---|---|---|---|
Строка 9: | Строка 9: | ||
2) **Запрос на создание платежного ордера**. Ответом является инструкция для дальнейшего перенаправления плательщика для оплаты или показа инструкции. | 2) **Запрос на создание платежного ордера**. Ответом является инструкция для дальнейшего перенаправления плательщика для оплаты или показа инструкции. | ||
- | POST запрос отправялется в формате json на url - https://secure.onpay.ru/pay | + | POST запрос отправялется в формате JSON на url - https://secure.onpay.ru/pay |
Шаг получения информации является НЕобязательным для создания платежного ордера. Но он необходим для получения свежих данных, в том числе о курсах обмена. Сайт магазина может делать его раз в сутки, либо после получения ошибки об изменении курса обмена, либо при изменении настроек платежных систем в своем кабинете. | Шаг получения информации является НЕобязательным для создания платежного ордера. Но он необходим для получения свежих данных, в том числе о курсах обмена. Сайт магазина может делать его раз в сутки, либо после получения ошибки об изменении курса обмена, либо при изменении настроек платежных систем в своем кабинете. | ||
Строка 16: | Строка 16: | ||
Для получения информации следует отправить GET запрос в формате JSON на URL " https://secure.onpay.ru/pay/merchant_login", где merchant_login - идентификатор сайта. | Для получения информации следует отправить GET запрос в формате JSON на URL " https://secure.onpay.ru/pay/merchant_login", где merchant_login - идентификатор сайта. | ||
В ответ будет получен JSON следующего формата: | В ответ будет получен JSON следующего формата: | ||
- | { | + | { |
"paysystem_interfaces":{...}, | "paysystem_interfaces":{...}, | ||
"paysystems":{...}, | "paysystems":{...}, | ||
Строка 22: | Строка 22: | ||
"phone_codes":{...}, | "phone_codes":{...}, | ||
"locales":{...} | "locales":{...} | ||
- | } | + | } |
в случае ошибки вида: | в случае ошибки вида: | ||
- | { | + | { |
"errors":{"key":["text1","text2",...]}, | "errors":{"key":["text1","text2",...]}, | ||
- | } | + | } |
где key - ключ ошибки, значение которого массив текстовых описаний ошибок(может быть одно или несколько). | где key - ключ ошибки, значение которого массив текстовых описаний ошибок(может быть одно или несколько). | ||
Пример ответа с ошибкой: | Пример ответа с ошибкой: | ||
- | { | + | { |
"errors": { | "errors": { | ||
"recipient": [ | "recipient": [ | ||
Строка 37: | Строка 37: | ||
] | ] | ||
} | } | ||
- | } | + | } |
Пример полного успешного ответа см. в разделе "Пример расчета параметров" | Пример полного успешного ответа см. в разделе "Пример расчета параметров" | ||
Строка 49: | Строка 49: | ||
Пример: | Пример: | ||
- | "paysystem_interfaces":{ | + | "paysystem_interfaces": |
+ | { | ||
"SBR":{ | "SBR":{ | ||
"paysystem":"BBR", | "paysystem":"BBR", | ||
"logo":"/assets/payment_systems/logo/SBR.png" | "logo":"/assets/payment_systems/logo/SBR.png" | ||
} | } | ||
- | } | + | } |
=== paysystems === | === paysystems === | ||
Строка 87: | Строка 88: | ||
Пример: | Пример: | ||
- | + | "BBR": | |
- | "BBR":{ | + | { |
- | "data":[ | + | "data": |
- | {"name":"first_name","regexp":"^[A-ZА-Яa-zа-яёЁ\\-\\s']{2,30}$","label":"pay_form_add_p_label.first_name","message":"pay_form_add_p_message.first_name"}, | + | [ |
- | {"name":"middle_name","regexp":"^[A-ZА-Яa-zа-яёЁ\\-\\s']{2,30}$","label":"pay_form_add_p_label.middle_name","message":"pay_form_add_p_message.middle_name"}, | + | {"name":"first_name","regexp":"^[A-ZА-Яa-zа-яёЁ\\-\\s'] |
- | {"name":"last_name","regexp":"^[A-ZА-Яa-zа-яёЁ\\-\\s']{2,30}$","label":"pay_form_add_p_label.last_name","message":"pay_form_add_p_message.last_name"}, | + | {2,30}$","label":"pay_form_add_p_label.first_name","message":"pay_form_add_p_message.first_name"}, |
- | {"name":"address","regexp":"^[a-zA-Z\\s'0-9,\\-А-Яа-яЁё,\\d\\/\\\\.\\,\"]{4,250}$","label":"pay_form_add_p_label.address","message":"pay_form_add_p_message.address"} | + | {"name":"middle_name","regexp":"^[A-ZА-Яa-zа-яёЁ\\-\\s'] |
+ | {2,30}$","label":"pay_form_add_p_label.middle_name","message":"pay_form_add_p_message.middle_name"}, | ||
+ | {"name":"last_name","regexp":"^[A-ZА-Яa-zа-яёЁ\\-\\s'] | ||
+ | {2,30}$","label":"pay_form_add_p_label.last_name","message":"pay_form_add_p_message.last_name"}, | ||
+ | {"name":"address","regexp":"^[a-zA-Z\\s'0-9,\\-А-Яа-яЁё,\\d\\/\\\\.\\,\"] | ||
+ | {4,250}$","label":"pay_form_add_p_label.address","message":"pay_form_add_p_message.address"} | ||
], | ], | ||
"SBR":[] | "SBR":[] | ||
Строка 123: | Строка 129: | ||
=== phone_codes === | === phone_codes === | ||
Значением является hash вида: | Значением является hash вида: | ||
- | { | + | { |
"ru":"+7", | "ru":"+7", | ||
"ua":"+38", | "ua":"+38", | ||
Строка 149: | Строка 155: | ||
=== locales === | === locales === | ||
значением является hash вида: | значением является hash вида: | ||
- | { | + | { |
"ru":"https://secure.onpay.ru/pay_app/i18n/ru.json", | "ru":"https://secure.onpay.ru/pay_app/i18n/ru.json", | ||
"en":"https://secure.onpay.ru/pay_app/i18n/en.json" | "en":"https://secure.onpay.ru/pay_app/i18n/en.json" | ||
Строка 159: | Строка 165: | ||
Пример: | Пример: | ||
Если требуется отобразить ключ локализации "user_phone.errors.required" то нужно использовать значение из файла локализации | Если требуется отобразить ключ локализации "user_phone.errors.required" то нужно использовать значение из файла локализации | ||
- | { "user_phone":{ | + | { "user_phone":{ |
"errors":{ | "errors":{ | ||
"required":"This field is required" | "required":"This field is required" | ||
} | } | ||
- | } | + | } |
==== Пример расчета параметров ==== | ==== Пример расчета параметров ==== | ||
=== Пример полного ответа на запрос получения информации === | === Пример полного ответа на запрос получения информации === | ||
- | { | + | { |
"paysystem_interfaces":{ | "paysystem_interfaces":{ | ||
"SBR":{ | "SBR":{ | ||
Строка 258: | Строка 264: | ||
"en":"https://secure.onpay.ru/pay_app/i18n/en.json" | "en":"https://secure.onpay.ru/pay_app/i18n/en.json" | ||
} | } | ||
- | } | + | } |
В данном случае сайт мерчанта должен отобразить плательщику 3 способа оплаты (из раздела "paysystem_interfaces"): "SBR", "BBR" и "USD" с логотипами, ссылки которых указаны в том же разделе.\\ | В данном случае сайт мерчанта должен отобразить плательщику 3 способа оплаты (из раздела "paysystem_interfaces"): "SBR", "BBR" и "USD" с логотипами, ссылки которых указаны в том же разделе.\\ | ||
Названия должны быть взяты из нужного файла локализации по ключам "paysystem_interface.SBR.name", "paysystem_interface.BBR.name", "paysystem_interface.USD.name". В качестве доп описания можно использовать ключи вида "paysystem_interface.XXX.description".\\ | Названия должны быть взяты из нужного файла локализации по ключам "paysystem_interface.SBR.name", "paysystem_interface.BBR.name", "paysystem_interface.USD.name". В качестве доп описания можно использовать ключи вида "paysystem_interface.XXX.description".\\ | ||
Строка 283: | Строка 289: | ||
**3) Считаем сумму в BBR, которая должна поступить от плательщика в платежную систему, чтобы в систему Onpay поступило 6261.740763932373 BBR* | **3) Считаем сумму в BBR, которая должна поступить от плательщика в платежную систему, чтобы в систему Onpay поступило 6261.740763932373 BBR* | ||
Используем комиссии платежной системы BBR** | Используем комиссии платежной системы BBR** | ||
- | { | + | { |
"pip":1.0, | "pip":1.0, | ||
"pif":5.0, | "pif":5.0, | ||
"mci":0.0 | "mci":0.0 | ||
- | } | + | } |
сумма = (6261.740763932373 + pif) / (1 - (pip / 100)) (обратный расчет комиссии) = (6261.740763932373 + 5.0) / (1 - (1.0 / 100)) = 6330.041175689265 = 6330.04 (математическое округление до 2-ого знака) | сумма = (6261.740763932373 + pif) / (1 - (pip / 100)) (обратный расчет комиссии) = (6261.740763932373 + 5.0) / (1 - (1.0 / 100)) = 6330.041175689265 = 6330.04 (математическое округление до 2-ого знака) | ||
Строка 298: | Строка 304: | ||
**5) Проверяем сумму на ограничения платежного интерфейса** | **5) Проверяем сумму на ограничения платежного интерфейса** | ||
Берем ограничения от платежной системы BBR | Берем ограничения от платежной системы BBR | ||
- | { | + | { |
"min":100.0, | "min":100.0, | ||
"max":150000.0 | "max":150000.0 | ||
- | } | + | } |
значение 6330.04 находится в данном диапозоне, следовательно плательщик сможет оплатить через данный способ (в случае превышения лимита НЕ стоит предлагать плательщику платежный интерфейс. У разных интерфейсов разные ограничения) | значение 6330.04 находится в данном диапозоне, следовательно плательщик сможет оплатить через данный способ (в случае превышения лимита НЕ стоит предлагать плательщику платежный интерфейс. У разных интерфейсов разные ограничения) | ||
Строка 308: | Строка 314: | ||
**7) Формируем данные для запроса на создание платежного ордера** | **7) Формируем данные для запроса на создание платежного ордера** | ||
- | { | + | { |
"ticker":"USD", | "ticker":"USD", | ||
"interface_ticker":"SBR", | "interface_ticker":"SBR", | ||
"pay_amoun":6330.04, | "pay_amoun":6330.04, | ||
"receive_amount":100.0 | "receive_amount":100.0 | ||
- | } | + | } |
**8) Отображаем плательщику форму для ввода дополнительных полей** | **8) Отображаем плательщику форму для ввода дополнительных полей** | ||
Строка 352: | Строка 358: | ||
=== Пример запроса === | === Пример запроса === | ||
Пример запроса на создание ордера через системы BBR, которая имеет 4 дополнительных поля(first_name, last_name, middle_name, address): | Пример запроса на создание ордера через системы BBR, которая имеет 4 дополнительных поля(first_name, last_name, middle_name, address): | ||
- | { | + | { |
"user_email":"test@email.com", | "user_email":"test@email.com", | ||
"pay_for":"test_pay_for", | "pay_for":"test_pay_for", | ||
Строка 370: | Строка 376: | ||
"number":"9001234567" | "number":"9001234567" | ||
} | } | ||
- | } | + | } |
Маски для первичной валидации и сообщения об ошибках для дополнительных полей можно получить при помощи запроса информации. | Маски для первичной валидации и сообщения об ошибках для дополнительных полей можно получить при помощи запроса информации. | ||
Строка 378: | Строка 384: | ||
=== Формат и общее описание === | === Формат и общее описание === | ||
Сервер Onpay отвечает в формате JSON | Сервер Onpay отвечает в формате JSON | ||
- | { | + | { |
"redirect_to": {}, | "redirect_to": {}, | ||
"po_psi_data_request": {}, | "po_psi_data_request": {}, | ||
"errors": {} | "errors": {} | ||
- | } | + | } |
Где, одно из полей, errors, redirect_to или po_psi_data_request НЕ пустое(НЕ пустыми могут быть несколько полей). | Где, одно из полей, errors, redirect_to или po_psi_data_request НЕ пустое(НЕ пустыми могут быть несколько полей). | ||
Алгоритм обработки ответа:\\ | Алгоритм обработки ответа:\\ | ||
- | **Если НЕ пустое "errors"**\\ | + | **Если НЕ пустое "errors"** сайт магазина должен отобразить ошибки плательщику и переформировать данные для отправки(пример: в случае отсутствия обязательного поля - заполнить данное поле). (подробнее читать в разделе "errors")\\ |
- | сайт магазина должен отобразить ошибки плательщику и переформировать данные для отправки(пример: в случае отсутствия обязательного поля - заполнить данное поле). (подробнее читать в разделе "errors")\\ | + | **Иначе**\\ |
- | Иначе | + | \\ |
- | **Если НЕ пустое "redirect_to"** | + | **Если НЕ пустое "redirect_to"** сайт магазина должен перенаправить плательщика на url, указанный в этом параметре. (подробнее читать в разделе "redirect_to")\\ |
- | сайт магазина должен перенаправить плательщика на url, указанный в этом параметре. (подробнее читать в разделе "redirect_to") | + | **Иначе** сайт магазина, должен сформировать форму из данных, содержащихся в поле "po_psi_data_request", и перенаправить пользователя сабмитом данной формы. (подробнее читать в разделе "po_psi_data_request")\\ |
- | Иначе | + | |
- | сайт магазина, должен сформировать форму из данных, содержащихся в поле "po_psi_data_request", и перенаправить пользователя сабмитом данной формы. (подробнее читать в разделе "po_psi_data_request") | + | |
=== errors === | === errors === | ||
в качестве значения errors выступает hash. | в качестве значения errors выступает hash. | ||
- | |||
Примеры: | Примеры: | ||
"errors": { | "errors": { | ||
Строка 424: | Строка 426: | ||
=== redirect_to === | === redirect_to === | ||
в качестве значения redirect_to выступает hash вида | в качестве значения redirect_to выступает hash вида | ||
- | { | + | { |
"url": "https://secure.onpay.ru/1234567890/instruction", | "url": "https://secure.onpay.ru/1234567890/instruction", | ||
"...": "..." | "...": "..." | ||
- | } | + | } |
сайт магазина должен осуществить перенаправление плательщика GET запросом на URL, указанный как значение ключа "url". В ответе могут присутствовать другие ключи, они являются служебными и должны игнорироваться сайтом магазина. | сайт магазина должен осуществить перенаправление плательщика GET запросом на URL, указанный как значение ключа "url". В ответе могут присутствовать другие ключи, они являются служебными и должны игнорироваться сайтом магазина. | ||