Здесь показаны различия между двумя версиями данной страницы.
Both sides previous revision Предыдущая версия Следущая версия | Предыдущая версия Следущая версия Both sides next revision | ||
api-2.0 [2017/07/25 13:05] admin [Получить данные платежа] |
api-2.0 [2017/07/27 12:06] admin [API 2.0] |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ==== API 2.0 ==== | ||
- | |||
- | API построено на REST архитектуре. JSON возвращается в ответ на все запросы к API, в том числе и при возникновении ошибок. Имеет предсказуемые, ресурсо-ориентированные URL-адреса, использует HTTP-коды для передачи состояния ошибок, а также использует встроенные функции HTTP-аутентификации и методы GET, POST, PUT, DELETE. | ||
==== Запросы от OnPay к сайту мерчанта ==== | ==== Запросы от OnPay к сайту мерчанта ==== | ||
Строка 70: | Строка 67: | ||
| order.to_amount | float | Сумма из ордера, которая должна была поступить на баланс магазина | | | order.to_amount | float | Сумма из ордера, которая должна была поступить на баланс магазина | | ||
| order.to_way | string | Валюта из ордера, в которой должен был пополниться баланс магазина | | | order.to_way | string | Валюта из ордера, в которой должен был пополниться баланс магазина | | ||
- | | receipt | json | Содержит информацию о списке покупок в чеке | | ||
- | | receipt.items | array | Список товаров в чеке | | ||
- | | receipt.items.name | string | Название товара | | ||
- | | receipt.items.price | float | Цена за единицу товара | | ||
- | | receipt.items.quantity | float | Количество | | ||
- | | receipt.sum | float | Сумма чека | | ||
Пример запроса: | Пример запроса: | ||
Строка 105: | Строка 96: | ||
"to_amount": 3378.39, | "to_amount": 3378.39, | ||
"to_way": "RUR" | "to_way": "RUR" | ||
- | }, | + | } |
+ | } | ||
+ | </code> | ||
+ | |||
+ | Ответ мерчанта | ||
+ | |||
+ | | Название | Тип | Описание | | ||
+ | | code | int | Код ответа, 0 для подтверждения, 1 для отказа(отказ не является отказом от платежа, а лишь информацией о том, что мерчант не знает о таком платеже, при этом у платежа проставится статус как "не было уведомления", и мерчант сможет активировать его вручную в личном кабинете, если такой платеж в действительности имеет место быть). | | ||
+ | | type | string | Тип запроса (pay) | | ||
+ | | pay_for | string | Номер заказа | | ||
+ | | signature | string | Контрольная подпись, строка для построения "code;pay_for;api_key" | | ||
+ | | receipt | json | Содержит информацию о списке покупок в чеке | | ||
+ | | receipt.items | array | Список товаров в чеке | | ||
+ | | receipt.items.name | string | Название товара | | ||
+ | | receipt.items.price | float | Цена за единицу товара | | ||
+ | | receipt.items.quantity | float | Количество | | ||
+ | | receipt.sum | float | Сумма чека | | ||
+ | |||
+ | Пример: | ||
+ | <code class="json"> | ||
+ | { | ||
+ | "code": 0, | ||
+ | "type": "pay", | ||
+ | "pay_for": "55446", | ||
+ | "signature": "172de16ada92791b3753b3121d471f5c", | ||
"receipt": { | "receipt": { | ||
"items": [ | "items": [ | ||
Строка 126: | Строка 141: | ||
"sum": 854.00 | "sum": 854.00 | ||
} | } | ||
- | } | ||
- | </code> | ||
- | |||
- | Ответ мерчанта | ||
- | |||
- | | Название | Тип | Описание | | ||
- | | code | int | Код ответа, 0 для подтверждения, 1 для отказа(отказ не является отказом от платежа, а лишь информацией о том, что мерчант не знает о таком платеже, при этом у платежа проставится статус как "не было уведомления", и мерчант сможет активировать его вручную в личном кабинете, если такой платеж в действительности имеет место быть). | | ||
- | | type | string | Тип запроса (pay) | | ||
- | | pay_for | string | Номер заказа | | ||
- | | signature | string | Контрольная подпись, строка для построения "code;pay_for;api_key" | | ||
- | |||
- | Пример: | ||
- | <code class="json"> | ||
- | { | ||
- | "code": 0, | ||
- | "type": "pay", | ||
- | "pay_for": "55446", | ||
- | "signature": "172de16ada92791b3753b3121d471f5c" | ||
} | } | ||
</code> | </code> | ||
Строка 215: | Строка 212: | ||
Пример запроса: | Пример запроса: | ||
- | <pre><code class="json"> | + | <code class="json"> |
- | { | + | { |
- | "login":"onpay", | + | "login":"onpay", |
- | "signature":"65ded5353c5ee48d0b7d48c591b8f430" | + | "signature":"65ded5353c5ee48d0b7d48c591b8f430" |
- | }</code></pre> | + | } |
+ | </code> | ||
В ответ будет выдан JSON с данными: | В ответ будет выдан JSON с данными: | ||
Строка 229: | Строка 227: | ||
Пример ответа: | Пример ответа: | ||
- | <pre><code class="json"> | + | <code class="json"> |
- | { | + | { |
- | "from":"USD", | + | "from":"USD", |
- | "to":"RUR", | + | "to":"RUR", |
- | "rate":33121445 | + | "rate":33121445 |
- | "signature":"4671aeaf49c792689533b00664a5c3ef" | + | "signature":"4671aeaf49c792689533b00664a5c3ef" |
- | } | + | } |
- | </code></pre> | + | </code> |