Здесь показаны различия между двумя версиями данной страницы.
Both sides previous revision Предыдущая версия Следущая версия | Предыдущая версия | ||
description_of_the_old_api [2014/10/20 07:20] admin [Возвращаемые ошибки] |
description_of_the_old_api [2015/10/30 11:46] (текущий) admin |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ======Описание запросов====== | + | ========API 1.0======== |
- | ====check запрос==== | + | ========Описание запросов======== |
+ | |||
+ | ======Сheck запрос====== | ||
+ | |||
+ | ====Запрос к мерчанту==== | ||
На URL отправляется Post запрос со следующими параметрами: | На URL отправляется Post запрос со следующими параметрами: | ||
Строка 25: | Строка 29: | ||
md5=* | md5=* | ||
+ | ====Ответ мерчата==== | ||
Сервер магазина на check-запрос возвращает следующие данные: | Сервер магазина на check-запрос возвращает следующие данные: | ||
Строка 39: | Строка 44: | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<result> | <result> | ||
- | <code><code>0</code></code> | + | <code>0</code> |
<pay_for>123456</pay_for> | <pay_for>123456</pay_for> | ||
<comment>OK</comment> | <comment>OK</comment> | ||
Строка 45: | Строка 50: | ||
</result> | </result> | ||
+ | === Возможные коды завершения операции === | ||
+ | |||
+ | ^ Код ^ Значение ^ | ||
+ | | 0 | ОК – означает, что “платеж может быть принят” | | ||
+ | | 2 | Платёж отклонён. Onpay не примет этот платеж. | | ||
+ | | 3 | Ошибка в параметрах. Onpay не примет этот платеж. | | ||
+ | | 7 | Ошибка авторизации. MD5 подпись неверна. Onpay не примет этот платеж. | | ||
+ | | 10 | Временная ошибка. Onpay не примет этот платеж. | | ||
+ | |||
+ | ======Pay запрос====== | ||
- | ====pay запрос==== | + | ====Запрос к мерчанту==== |
На URL отправляется Post запрос со следующими параметрами: | На URL отправляется Post запрос со следующими параметрами: | ||
Строка 58: | Строка 73: | ||
| order_amount | float | в этом параметре передается сумма платежа, которая была заявлена в платежном ордере. То есть, если в платежном ордере установлена сумма 1500.0 рублей, а клиент перечислил только 100.0 рублей, в этом параметре будет передано 1500.0 рублей. Нельзя по данному полю сделать вывод о поступивших средствах на счет мерчанта. При недоплате по свободному платежному ордеру, в этом параметре будет передано 0.0 | | | order_amount | float | в этом параметре передается сумма платежа, которая была заявлена в платежном ордере. То есть, если в платежном ордере установлена сумма 1500.0 рублей, а клиент перечислил только 100.0 рублей, в этом параметре будет передано 1500.0 рублей. Нельзя по данному полю сделать вывод о поступивших средствах на счет мерчанта. При недоплате по свободному платежному ордеру, в этом параметре будет передано 0.0 | | ||
| order_currency | string | платежная система, в которой был создан ордер | | | order_currency | string | платежная система, в которой был создан ордер | | ||
- | | exchange_rate | float | курс обмена между платежными системами balance_currency/order_currency | | + | | exchange_rate | float | курс обмена между платежными системами: входящей платежной системой и order_currency | |
| pay_for | string | номер платежа или его описание, содержит значение пришедшее в параметре платежной ссылки "pay_for" или введенное плательщиков в поле на форме "Платеж за" | | | pay_for | string | номер платежа или его описание, содержит значение пришедшее в параметре платежной ссылки "pay_for" или введенное плательщиков в поле на форме "Платеж за" | | ||
| paymentDateTime | string | дата создания платежа в формате "CCYY-MM-DDThh:mm:ssTZD" где TZD смещение часового пояса в формате [+-]hh:mm. | | | paymentDateTime | string | дата создания платежа в формате "CCYY-MM-DDThh:mm:ssTZD" где TZD смещение часового пояса в формате [+-]hh:mm. | | ||
Строка 91: | Строка 106: | ||
day_to_expiry=* - срок действия кода протекции | day_to_expiry=* - срок действия кода протекции | ||
paid_amount=* - сумма, которую должен был заплатить плательщик | paid_amount=* - сумма, которую должен был заплатить плательщик | ||
+ | |||
+ | ====Ответ мерчанта==== | ||
Сервер магазина на pay-запрос возвращает следующие данные: | Сервер магазина на pay-запрос возвращает следующие данные: | ||
Строка 117: | Строка 134: | ||
- | ==== Возможные коды завершения операции ==== | + | === Возможные коды завершения операции === |
^ Код ^ Значение ^ | ^ Код ^ Значение ^ | ||
- | | 0 | ОК – означает, что “уведомление о платеже принято” если тип запроса был “pay” или “может быть принято” если тип запроса был “check” | | + | | 0 | ОК – означает, что “уведомление о платеже принято” | |
- | | 2 | Только для запросов типа “check” Платёж отклонён. В этом случае Onpay.ru не примет платёж от Клиента. | | + | | 3 | Ошибка в параметрах. Onpay.ru не будет пытаться повторно послать это уведомление в систему Продавца и отметит этот платёж статусом “уведомление не доставлено в API” если тип запроса “pay” | |
- | | 3 | Ошибка в параметрах. Onpay.ru не будет пытаться повторно послать это уведомление в систему Продавца и отметит этот платёж статусом “уведомление не доставлено в API” если тип запроса “pay”. Если тип запроса “check” – Onpay не примет этот платеж. | | + | |
| 7 | Ошибка авторизации. MD5 подпись неверна. | | | 7 | Ошибка авторизации. MD5 подпись неверна. | | ||
| 10 | Временная ошибка. Onpay.ru попробует повторно послать это уведомление несколько раз в течение следующих 72 часов после чего пометит платёж статусом “уведомление не доставлено в API” | | | 10 | Временная ошибка. Onpay.ru попробует повторно послать это уведомление несколько раз в течение следующих 72 часов после чего пометит платёж статусом “уведомление не доставлено в API” | | ||
- | ==== Упрощенный формат ==== | + | ====== Упрощенный формат ====== |
Для ответов на запросы, сервер магазина может использовать упрощенный формат. | Для ответов на запросы, сервер магазина может использовать упрощенный формат. | ||
Строка 152: | Строка 168: | ||
====== Справочная информация ====== | ====== Справочная информация ====== | ||
- | |||
- | |||
- | |||
====Значения полей, содержащих информацию о суммах и платежных системах(на примере)==== | ====Значения полей, содержащих информацию о суммах и платежных системах(на примере)==== | ||
Строка 208: | Строка 221: | ||
В платеж и в pay запрос к серверу магазина попадает сумма, вычисленная по новому курсу на момент создания платежа. В pay запросе к серверу магазина приходит старый курс, который был на момент создания ордера. | В платеж и в pay запрос к серверу магазина попадает сумма, вычисленная по новому курсу на момент создания платежа. В pay запросе к серверу магазина приходит старый курс, который был на момент создания ордера. | ||
- | |||