Инструменты пользователя
api-2.0
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Both sides previous revision Предыдущая версия Следущая версия | Предыдущая версия | ||
|
api-2.0 [2017/07/25 12:57] admin [Pay] |
api-2.0 [2017/07/27 12:07] admin удалено |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ==== API 2.0 ==== | ||
| - | API построено на REST архитектуре. JSON возвращается в ответ на все запросы к API, в том числе и при возникновении ошибок. Имеет предсказуемые, ресурсо-ориентированные URL-адреса, использует HTTP-коды для передачи состояния ошибок, а также использует встроенные функции HTTP-аутентификации и методы GET, POST, PUT, DELETE. | ||
| - | ==== Запросы от OnPay к сайту мерчанта ==== | ||
| ===== Check ===== | ===== Check ===== | ||
| Строка 18: | Строка 15: | ||
| Пример запроса: | Пример запроса: | ||
| - | <pre><code class="json">{ | + | <code class="json"> |
| - | "type":"check", | + | { |
| - | "pay_for":"55446", | + | "type":"check", |
| - | "expired_at":"2014-02-03T18:43:21+04:00" | + | "pay_for":"55446", |
| - | "amount":50000, | + | "expired_at":"2014-02-03T18:43:21+04:00" |
| - | "way":"RUR", | + | "amount":50000, |
| - | "mode":"fix", | + | "way":"RUR", |
| - | "signature":"82f67760dbc5331963b7e00bc6df77f1" | + | "mode":"fix", |
| - | }</code></pre> | + | "signature":"82f67760dbc5331963b7e00bc6df77f1" |
| + | } | ||
| + | </code> | ||
| Ответ мерчанта | Ответ мерчанта | ||
| Строка 37: | Строка 36: | ||
| Пример: | Пример: | ||
| - | <pre><code class="json"> | + | <code class="json"> |
| - | { | + | { |
| - | "code":0, | + | "code":0, |
| - | "type":"check", | + | "type":"check", |
| - | "pay_for":"55446", | + | "pay_for":"55446", |
| - | "signature":"172de16ada92791b3753b3121d471f5c" | + | "signature":"172de16ada92791b3753b3121d471f5c" |
| - | } | + | } |
| - | </code></pre> | + | </code> |
| ===== Pay ===== | ===== Pay ===== | ||
| Строка 97: | Строка 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": [ | ||
| Строка 118: | Строка 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> | ||
| Строка 151: | Строка 156: | ||
| Пример запроса: | Пример запроса: | ||
| - | <pre><code class="json"> | + | <code class="json"> |
| - | { | + | { |
| - | "login":"onpay", | + | "login":"onpay", |
| - | "signature":"1d15f90df20da53d7206e9f7db7d2c9d" | + | "signature":"1d15f90df20da53d7206e9f7db7d2c9d" |
| - | } | + | } |
| - | </code></pre> | + | </code> |
| В ответ будет выдан JSON с данными: | В ответ будет выдан JSON с данными: | ||
| Строка 174: | Строка 179: | ||
| Пример ответа: | Пример ответа: | ||
| - | <pre><code class="json"> | + | <code class="json"> |
| - | { | + | { |
| - | "signature":"172de16ada92791b3753b3121d471f5c", | + | "signature": "172de16ada92791b3753b3121d471f5c", |
| - | "user":{ | + | "user": { |
| - | "email":"mail@mail.ru", | + | "email": "mail@mail.ru", |
| - | "phone":"9631478946", | + | "phone": "9631478946", |
| - | "note":"" | + | "note": "" |
| - | }, | + | }, |
| - | "payment":{ | + | "payment": { |
| - | "id":"7121064", | + | "id": "7121064", |
| - | "date_time":"2013-12-05T12:07:09+04:00", | + | "date_time": "2013-12-05T12:07:09+04:00", |
| - | "amount":10200, | + | "amount": 10200, |
| - | "way":"USD", | + | "way": "USD", |
| - | "rate":33121445, | + | "rate": 33121445, |
| - | "release_at":null | + | "release_at": null |
| - | }, | + | }, |
| - | "balance":{ | + | "balance": { |
| - | "amount":"3300", | + | "amount": "3300", |
| - | "way":"RUR" | + | "way": "RUR" |
| - | } | + | } |
| - | } | + | } |
| - | </pre></code> | + | </code> |
| ===== Получить курс обмена ===== | ===== Получить курс обмена ===== | ||
| Строка 207: | Строка 212: | ||
| Пример запроса: | Пример запроса: | ||
| - | <pre><code class="json"> | + | <code class="json"> |
| - | { | + | { |
| - | "login":"onpay", | + | "login":"onpay", |
| - | "signature":"65ded5353c5ee48d0b7d48c591b8f430" | + | "signature":"65ded5353c5ee48d0b7d48c591b8f430" |
| - | }</code></pre> | + | } |
| + | </code> | ||
| В ответ будет выдан JSON с данными: | В ответ будет выдан JSON с данными: | ||
| Строка 221: | Строка 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> |