Оглавление

Подготовка и добавление сайта, бота, или приложения

Вы хотите, чтобы посетители вашего сайта, бота, или приложения, могли с лёгкостью оплачивать товары и услуги прямо на вашем сервисе?
И при этом хотите получать программную обратную связь об этих платежах?

С помощью Azvox это сделать очень просто. И для этого есть несколько способов, как более простых, так и более сложных, с большей гибкостью настроек.

Но для начала, чтобы вы могли принимать платежи на вашем сайте, боте, или приложении, вам нужно добавить его в Azvox.

Добавление сайта в Azvox

Перейдите в раздел ДОБАВИТЬ САЙТ и нажмите на кнопку Добавить Сайт

Заполните название сайта
Скопируйте секретный ключ
Заполните Домен, без https://

Если вы хотите, чтобы Azvox, после оплаты клиентом, сообщал вашему сайту статус платежа и перенаправлял Клиента обратно на ваш сайт, то вам нужно заполнить StatusUrl, SuccessUrl и FailUrl.

Для этого включите переключатель Callback и перенаправление Клиента и укажите относительные пути до скриптов. Пути указывайте относительно корня вашего домена, начиная с символа /
Например:
/pay_status.php
/pay_success.php
/pay_fail.php
Пример этих скриптов и документацию по обработке ответов, вы можете найти в этом документе, ниже.

После сохранения ваш Сайт отобразится в списке сайтов в разделе ДОБАВИТЬ САЙТ.

Теперь вам нужно подтвердить, что добавленный сайт принадлежит вам и вы имеете к нему доступ.
Сделать это просто. Достаточно разместить в корне вашего сайта специальный текстовый файл.
Чтобы это сделать, в списке ваших сайтов нажмите на красную кнопку Подтвердить владение и следуйте простым инструкциям.

Поздравляем. Ваш сайт добавлен в Azvox и отправлен на проверку. Проверка сайта не требует от вас каких-либо действий и занимает не более 24 часов.
В это время сотрудники Azvox проверят, чтобы ваш сайт соответствовал требованиям Azvox с которыми вы можете ознакомиться ниже.

Во время проверки вы уже можете настраивать платежи у вас на сайте и тестировать их.
Пока ваш сайт проходит модерацию оплачивать счета, сможет только тот кошелёк, в котором вы добавили этот Сайт.

Добавление Бота или Приложения в Azvox

Используйте этот способ, если у вашего сайта, бота, или приложения, нет доменного имени и он доступен только по IP адресу.

Далеее в документации будет использоваться слово App, для обозначения бота, приложения или сайта, у которого нет доменного имени.

Для этого в Azvox есть универсальный способ подключения вашего App.

Перейдите в раздел ДОБАВИТЬ САЙТ и нажмите на кнопку Добавить Бота или приложение

Заполните название вашего App
Скопируйте секретный ключ
Укажите IP адрес и Port, указывайте в формате IP:Port. Пример: 1.1.1.1:443
Выберите протокол для соединения с вашим APP, возможные варианты Http или Https
Укажите Status Url, он будет использоваться для уведомлений. Azvox будет в реальном времени отправлять на него данные о платежах, если клиент оплатил или отказался от оплаты счёта, выставленного Клиенту вашим App.

Если вы хотите, чтобы Azvox, предоставлял Клиентам возможность перейти после оплаты, или отказа от оплаты, на нужный вам Url, то вам нужно заполнить SuccessUrl и FailUrl.

Для этого включите переключатель Перенаправление клиента и укажите полные пути до скриптов, начиная с http:// или https://.
Например:
https://yoursite.com/clients_success_page.php
http://shop.yoursite.com/success_page/
http://1.2.3.4/clients/?pay_failed=1
https://1.2.3.4:5555/clients/failed_payment/
Пример этих скриптов и документацию по обработке ответов, вы можете найти в этом документе, ниже.

После сохранения ваш App отобразится в списке сайтов в разделе ДОБАВИТЬ САЙТ.

Поздравляем. Ваш App добавлен в Azvox. Модерация вашего App не требуется и он сразу готов к работе.

Требования к сайтам
К работе допускаются любые сайты, которые не имеют отношения к следующим категориям:
Терроризм, экстремизм
Порнография
Насилие

Если ваш сайт не относится к этим категориям, то проверка вашего сайта завершится быстро и удачно.
Если же ваш сайт по каким либо причинам не прошёл проверку, не расстраивайтесь.
Вам достаточно устранить эти причины и отправить сайт на проверку заново. Причины будут указаны в списке сайтов и в разделе Поддержка в соответствующем Сообщении.

Формирование платежа

Чтобы получить оплату от посетителя вашего сайта, вам нужно сформировать счёт, который будет предложен этому посетителю для оплаты.

В Azvox есть несколько способов, для создания счетов:
Генератор платёжных форм,
При помощи Api,
Используя полный контроль
Генератор платёжных форм

Это самый простой способ принятия платежей от ваших Клиентов.

Свой сайт не обязателен, знания программирования не требуются и начать принимать платежи можно в несколько кликов.

Всё, что нужно, чтобы начать принимать платежи:
Зайти в раздел ПОДКЛЮЧЕНИЕ.
Добавить платёжную форму.
Вставить код формы на любую страницу вашего сайта, либо просто передать ссылку на эту форму любому вашему клиенту.

Если вы при создании формы выбрали сайт, на котором будете размещать эту форму, и при добавлении сайта указали Status, Success и Fail Url, то после оплаты, клиенты будут перенаправлены к вам на сайт и Azvox передаст информацию о платеже по указанному StatusUrl.

Этот способ создания счетов удобный и быстрый, но не всем подходит, так как он не позволяет автоматически генерировать описание заказа и его сумму.
Если вам это необходимо и вам не достаточно функциональности платёжных форм - смотрите следующий способ.

С помощью готового PHP класса для работы с Azvox API

Если ваш сайт использует PHP и у вас есть минимальные знания программирования, то этот способ именно то, что вам требуется.

С помощью этого класса вы можете создавать счёта, используя всего несколько строк кода.

Добавьте API в разделе API интеграция.
Добавьте следующий код на нужную страницу вашего сайта:
Создание счёта используя PHP класс cAzvox.php:Скопировать код
<?php require_once "Путь до файла Azvox API/cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); // $shop_id это ID вашего сайта в Azvox, можно найти в списке ваших сайтов. // Либо укажите 0, если хотите просто создать счёт для оплаты, не относящийся к вашему сайту. $shop_id = 12345; // $order_id это ID заказа в вашей системе учёта, если у вас нет ID заказа, укажите 0. $order_id = 123; $data = array( "m_shop" => $shop_id, "m_orderid" => $order_id, "m_amount" => 100.15, // Сумма заказа "m_curr" => "USD", // Валюта заказа USD, EUR или RUB "m_desc" => "Description", // Описание вашего заказа, которое увидит покупатель ); // Если вы хотите, чтобы Azvox при отчёте о платеже вернул вам дополнительные данные, раскоментируйте строку ниже и добавьте их в массив как указано в примере // $data["m_params"] = json_encode(array("var1" => "value1", "var2" => "value2")); $newInvoice = $api->createInvoice($data); $errors = $api->getErrors(); if (!$errors){ echo '<a href="'.$newInvoice['pay_url'].'">Оплатить</a>'; }else{ print_r($errors); } ?>
Этот код выведет на страницу ссылку, при нажатии на которую Клиент будет перенаправлен на страницу оплаты счёта.
Если запрос прошёл успешно, то в переменной $newInvoice будет массив со следующими данными:
$newInvoice:Скопировать код
Array( [invoice_id] => Номер счёта в Azvox [m_orderid] => ID заказа, который вы указали при создании счёта $order_id [pay_url] => Ссылка на страницу оплаты счёта, по которой вам нужно отправить Клиента )
Если произошла какая-либо ошибка, то $api->getErrors() будет содержать массив с подробным описанием ошибки.
Список возможных ошибок смотрите ниже, в подробной документации к API.
С помощью Azvox API

Если ваш сайт не поддерживает PHP и вы используете другой язык программирования, то вам нужно обращаться к Azvox API по протоколу HTTPS.

Подробнее об этом смотрите ниже. Для создания счёта смотрите пункт new_invoice

С полным контролем

Предыдущие способы создания счёта через API удобны, но имеют один недостаток.
У вашего API есть тарифный план, в соответствии с которым есть ограничения на количество запросов в секунду и в минуту.

По умолчанию выбран бесплатный тариф (Free)
В нём ограничение не более 1 запроса в секунду и не более 6 запросов в минуту.
Если вы хотите использовать способы создания счёта через API и считаете, что для ваших целей недостаточно такого количества запросов, тогда вы можете выбрать другой тарифный план в разделе API.

Но также вы можете создавать счета и другим способом, позволяющим получить полный контроль над формированием формы для оплаты.

На странице вашего сайта нужно сформировать форму для оплаты:

Пример формы:Скопировать код
<form method="post" action="https://azvox.cash/pay/"> <input type="hidden" name="m_shop" value="12345"> <input type="hidden" name="m_orderid" value="123"> <input type="hidden" name="m_amount" value="100.15"> <input type="hidden" name="m_curr" value="USD"> <input type="hidden" name="m_desc" value="dGVzdA=="> <input type="hidden" name="m_sign" value="12A315A26EE2E255E181EFBE35AD0C396338159B7B6ADFE2A02313EF06233678"> <input type="hidden" name="m_params" value="eyJwYXJhbV9jdXIiOiJVU0QifQ=="> <input type="submit" name="m_process" value="Pay"> </form>

Либо указать прямую ссылку на оплату, если нет возможности отправлять запрос на страницу оплаты методом POST:

Пример ссылки:Скопировать код
<a href="https://azvox.cash/pay/?m_shop=12345&m_orderid=123&m_amount=100.15&m_curr=USD&m_desc=dGVzdA==&m_sign=12A315A26EE2E255E181EFBE35AD0C396338159B7B6ADFE2A02313EF06233678"> Можно оплатить по прямой ссылке </a>

Расшифровка параметров формы

НазваниеПараметрОписание
ID сайта m_shop ID сайта в Azvox
ID указан в списке ваших сайтов в разделе ДОБАВИТЬ САЙТ.
Требования: Integer > 0
Пример: 12345
ID заказа m_orderid ID заказа в вашей системе учёта.
Должен быть уникальным для каждого нового платежа.
Требования: Integer > 0
Пример: 123
Сумма платежа m_amount Сумма платежа, которую продавец желает получить от покупателя. Сумма должна быть больше нуля, дробная часть отделяется точкой, количество знаков после точки - два знака.
Требования: >= 0.01, Формат: 0.00
Пример: 123.12
Пример 2: 100.00
Пример 3: 0.50
Валюта платежа m_curr Валюта в которой продавец желает получить деньги.
Покупатель сможет оплатить в любой валюте, независимо от указанной тут.
Возможные валюты: USD, EUR, RUB
Пример: USD
Описание платежа m_desc Описание товара или услуги.
Формируется продавцом и отображается покупателю в момент оплаты.
Кодируется алгоритмом base64.
Требования: String < 100 символов до кодирования в base64
Пример: dGVzdA==
PHP код:Скопировать код
<?php echo base64_encode('test'); ?>
Цифровая подпись m_sign Используется для проверки целостности полученной информации и однозначной идентификации отправителя.
Пример:
12A315A26EE2D255E180EFBE35AD0C37
6338159B7B6ADFE2B02313EF06233676

Дополнительные параметры m_params Учитывается, только при передаче данных методом POST.
JSON массив данных, дополнительных параметров, закодированный с помощью алгоритма base64.
Azvox передаст эти данные вашему обработчику платежей StatusUrl
Требования: количество символов строки JSON < 1000
Пример: eyJwYXJhbV9jdXIiOiJVU0QifQ==
PHP код:Скопировать код
<?php echo base64_encode(json_encode(array( "var1" => "value1", "var2" => "value2", "var3" => "value3" ))); ?>
PHP Пример генерации формы (Метод отправки POST)
PHP код:Скопировать код
<?php $m_shop = 12345; // ID вашего сайта в Azvox $m_key = 'jSp3%13v5hYLaXb'; // Секретный ключ, указанный в настройках вашего сайта $m_amount = 100.52; // Сумма платежа $m_curr = 'USD'; // Валюта платежа $m_orderid = 123; // ID заказа в вашей системе учёта $m_desc = 'Описание платежа, которое увидит клиент при оплате.'; $m_params = false; // Список необязательных параметров, которые вы можете передать в форму // Azvox отправит их вам, в скрипт обработчика платежа StatusUrl // Передавайте их только в том случае, если отправляете запрос методом POST // $m_params = array("var1" => "value1", "var2" => "value2", "var3" => "value3"); $m_amount = number_format($m_amount, 2, ".", ""); $m_desc = base64_encode($m_desc); $m_params = base64_encode(json_encode($m_params)); $arHash = array($m_shop,$m_orderid,$m_amount,$m_curr,$m_desc,$m_params,$m_key); $m_sign = strtoupper(hash('sha256', implode(':', $arHash))); ?> <form method="post" action="https://azvox.cash/pay/"> <input type="hidden" name="m_shop" value="<?=$m_shop;?>"> <input type="hidden" name="m_orderid" value="<?=$m_orderid;?>"> <input type="hidden" name="m_amount" value="<?=$m_amount;?>"> <input type="hidden" name="m_curr" value="<?=$m_curr;?>"> <input type="hidden" name="m_desc" value="<?=$m_desc;?>"> <input type="hidden" name="m_sign" value="<?=$m_sign;?>"> <input type="hidden" name="m_params" value="<?=$m_params;?>"> <input type="submit" name="m_process" value="Pay"> </form>
PHP Пример генерации ссылки для оплаты (Метод отправки GET)
PHP код:Скопировать код
<?php $m_shop = 12345; // ID вашего сайта в Azvox $m_key = 'jSp3%13v5hYLaXb'; // Секретный ключ, указанный в настройках вашего сайта $m_amount = 100.52; // Сумма платежа $m_curr = 'USD'; // Валюта платежа $m_orderid = 123; // ID заказа в вашей системе учёта $m_desc = 'Описание платежа, которое увидит клиент при оплате.'; $m_params = false; // Не учитывается при методе GET, но этот код необходим для генерации цифровой подписи m_sign $m_amount = number_format($m_amount, 2, ".", ""); $m_desc = base64_encode($m_desc); $m_params = base64_encode(json_encode($m_params)); $arHash = array($m_shop,$m_orderid,$m_amount,$m_curr,$m_desc,$m_params,$m_key); $m_sign = strtoupper(hash('sha256', implode(':', $arHash))); $pay_by_link = array("m_shop" => $m_shop, "m_orderid" => $m_orderid, "m_amount" => $m_amount, "m_curr" => $m_curr, "m_desc" => $m_desc, "m_sign" => $m_sign); $pay_by_link = "https://azvox.cash/pay/?".http_build_query($pay_by_link); ?> <a href="<?=$pay_by_link;?>">Можно оплатить по прямой ссылке</a>


Обработка внутри Success, Fail и Status URL

В процессе оплаты счёта Клиент может оплатить его, либо отказаться от оплаты.

В обоих случаях клиенту будет предложено вернуться на ваш сайт и в этом случае он будет перенаправлен на SuccessUrl или FailUrl соответственно.

Также Azvox обратится к вашему скрипту обработчику платежей (StatusUrl) и сообщит ему статус оплаты, чтобы вы могли обработать счёт(заказ) на своей стороне.

Скрипт успешной оплаты - SuccessUrl

По этому адресу Клиенту будет предложено перейти, в случае успешной оплаты счёта.

Имейте в виду, что клиент может не переходить по указанному адресу.

Не обрабатывайте платёж или какие-либо важные данные в этом скрипте, так как любой человек может перейти по этому адресу и подделать параметры, которые передаются в этот скрипт.

Используйте этот скрипт только как уведомление о том, что оплата прошла успешно, либо перенаправьте Клиента из скрипта в нужный вам раздел.

Пример скрипта успешной оплаты - SuccessUrl:Скопировать код
<?php header('Content-Type: text/html; charset=utf-8'); // Этот параметр передаётся только в том случае, если вы отправили запрос из раздела Azvox - тестирование сайта $testOnly = isset($_POST["testOnly"])?true:false; $m_shop = 0; $m_orderid = 0; $m_amount = 0; $m_curr = ""; $m_params = ""; if (isset($_GET['success'])){ if (isset($_GET['m_shop'])){$m_shop = (int)$_GET['m_shop'];} // Проверка, что переданный параметр m_shop соответствует вашему сайту if ($m_shop == "ID вашего сайта в Azvox"){ // ID заказа в вашей системе учёта if (isset($_GET['m_orderid'])){$m_orderid = (int)$_GET['m_orderid'];} // Сумма платежа, которая была зачислена продавцу(отличается от суммы, которую оплатил Клиент) if (isset($_GET['m_amount'])){$m_amount = $_GET['m_amount'];} // Валюта платежа if (isset($_GET['m_curr'])){$m_curr = $_GET['m_curr'];} // в m_params будут переданы данные, заполненные Клиентом, только в том случае, если счёт был оплачен через платёжную форму созданную в Azvox if (isset($_GET['m_params'])){$m_params = $_GET['m_params'];} if ($m_params != ""){$m_params = base64_decode($m_params);} if ($m_orderid > 0){ // В этм месте проверьте принадлежит ли этот $m_orderid тому Клиенту, который пришёл по этому адресу // Если всё верно, покажите клиенту сообщение об успешной оплате // Ни в коем случае не отмечайте в этом скрипте заказ успешным, делайте это в скрипте StatusUrl echo 'Оплата заказа номер '.$m_orderid.' успешно завершена. Сумма заказа: '.$m_amount.' '.$m_curr; exit; } } } echo "ERROR"; exit; ?>
Скрипт отказа от оплаты - FailUrl

По этому адресу Клиенту будет предложено перейти, в случае если он откажется от оплаты счёта.

Имейте в виду, что клиент может не переходить по указанному адресу.

Не обрабатывайте платёж или какие-либо важные данные в этом скрипте, так как любой человек может перейти по этому адресу и подделать параметры, которые передаются в этот скрипт.

Используйте этот скрипт только как уведомление о том, что оплата отклонена Клиентом, либо перенаправьте Клиента из скрипта в нужный вам раздел.

Пример скрипта отказа от оплаты - FailUrl:Скопировать код
<?php header('Content-Type: text/html; charset=utf-8'); // Этот параметр передаётся только в том случае, если вы отправили запрос из раздела Azvox - тестирование сайта $testOnly = isset($_POST["testOnly"])?true:false; $m_shop = 0; $m_orderid = 0; $m_amount = 0; $m_curr = ""; $m_params = ""; if (isset($_GET['fail'])){ if (isset($_GET['m_shop'])){$m_shop = (int)$_GET['m_shop'];} // Проверка, что переданный параметр m_shop соответствует вашему сайту if ($m_shop == "ID вашего сайта в Azvox"){ // ID заказа в вашей системе учёта if (isset($_GET['m_orderid'])){$m_orderid = (int)$_GET['m_orderid'];} // Сумма платежа, которая должна была быть зачислена продавцу if (isset($_GET['m_amount'])){$m_amount = $_GET['m_amount'];} // Валюта платежа if (isset($_GET['m_curr'])){$m_curr = $_GET['m_curr'];} // в m_params будут переданы данные, заполненные Клиентом, только в том случае, если счёт был создан через платёжную форму созданную в Azvox if (isset($_GET['m_params'])){$m_params = $_GET['m_params'];} if ($m_params != ""){$m_params = base64_decode($m_params);} if ($m_orderid > 0){ // В этм месте проверьте принадлежит ли этот $m_orderid тому Клиенту, который пришёл по этому адресу // Если всё верно, покажите клиенту сообщение о том, что он отказался от оплаты счёта // Ни в коем случае не отмечайте в этом скрипте заказ завершённым или отклонённым, делайте это в скрипте StatusUrl echo 'Вы отказались от оплаты заказа номер '.$m_orderid.'. Сумма заказа: '.$m_amount.' '.$m_curr; exit; } } } echo "ERROR"; exit; ?>
Скрипт обработчик платежей - StatusUrl

По этому адресу Azvox обратится когда Клиент оплатит счёт, либо откажется от оплаты счёта.

Имейте в виду, что Клиент не переходит по этому адресу и не знает его адрес.

Обрабатывайте платёж, отмечайте его оплаченным, либо отменённым, только в этом скрипте, и только после соответствующих проверок.

Обязательно проверяйте на своей стороне не обрабатывали ли вы ранее этот платёж, чтобы не зачислить покупку повторно.
В некоторых случаях Azvox может отправлять данные несколько раз.

StatusUrl должен ответить текстом $m_orderid|success.
Пример: 123|success
Иначе Azvox будет отправлять запросы повторно, с перерывом в несколько минут, пока не получит нужный ответ.
Но не более 10 раз.
Также вы можете переотправить запрос из раздела История, нажав на кнопку Подробнее, возле соответствующей транзакции.

Параметры, которые Azvox отправляет вашему StatusUrl методом POST

ПараметрОписание
m_status Статус транзакции: Оплачена (success) или отклонена (fail)
m_operation_id ID счёта в Azvox
m_operation_amount Сумма, которую оплатил Клиент.
Либо пустая строка в случае отказа от оплаты.
m_operation_curr Валюта, в которой Клиент совершал платёж.
Либо пустая строка в случае отказа от оплаты.
m_operation_timestamp Unix Timestamp дата совершения платежа.
Либо 0 в случае отказа от оплаты.
m_wallet Номер кошелька Клиента, с которого была совершена оплата.
Либо пустая строка в случае отказа от оплаты.
m_shop ID вашего сайта в Azvox
m_orderid ID заказа в вашей системе учёта
m_amount Сумма платежа, которую продавец желал получить от покупателя.
m_curr Валюта платежа, в которой продавец хотел пролучить оплату.
m_desc Описание товара или услуги, закодированное в base64.
m_params Дополнительные JSON параметры, переданные при формировании платежа, либо данные заполненные Клиентом во время оплаты, если оплата была с использованием Платёжных форм Azvox.
m_sign Цифровая подпись, с помощью которой необходимо проверить данные на целостность.
testOnly Этот параметр передаётся только в том случае, если вы отправили запрос из раздела Azvox - тестирование сайта.
Пример скрипта обработчика платежей - StatusUrl:Скопировать код
<?php header('Content-Type: text/html; charset=utf-8'); if (isset($_POST['m_status']) && isset($_POST['m_shop']) && isset($_POST['m_orderid']) && isset($_POST['m_operation_id']) && isset($_POST['m_sign'])){ $testOnly = isset($_POST["testOnly"])?true:false; $m_key = "Секретный ключ, указанный в настройках вашего сайта"; $m_shop = "ID вашего сайта в Azvox"; $arHash = array( $_POST['m_status'], $_POST['m_operation_id'], $_POST['m_operation_amount'], $_POST['m_operation_curr'], $_POST['m_operation_timestamp'], $_POST['m_wallet'], $_POST['m_shop'], $_POST['m_orderid'], $_POST['m_amount'], $_POST['m_curr'], $_POST['m_desc'], $_POST['m_params'], $m_key ); // Генерируем подпись $sign_hash = strtoupper(hash('sha256', implode(':', $arHash))); $m_status = $_POST['m_status']; $m_shopid = (int)$_POST['m_shop']; // Сверяем подпись и остальные параметры if ($_POST['m_sign'] == $sign_hash && ($m_shopid == $m_shop) && ( ($m_status == 'success') || ($m_status == 'fail') )){ $operation_id = $_POST['m_operation_id']; $operation_amount = $_POST['m_operation_amount']; $operation_curr = $_POST['m_operation_curr']; $real_pay_date = $_POST['m_operation_timestamp']; $m_wallet = $_POST['m_wallet']; $m_orderid = (int)$_POST['m_orderid']; $m_amount = $_POST['m_amount']; $m_curr = $_POST['m_curr']; $m_desc = $_POST['m_desc']; $m_params = $_POST['m_params']; $m_desc = base64_decode($m_desc); $m_params = json_decode(base64_decode($m_params), true); $is_all_ok = false; if ($m_status == 'success'){ // Счёт был оплачен и можно отметить его у вас, как оплаченный // В этом месте вам нужно найти в своей системе учёта счёт $m_orderid и проверить // существует ли данный счёт, не был ли он обработан ранее, верна ли сумма и валюта платежа // Если всё верно, то обработать его и сделать переменную $is_all_ok = true $is_all_ok = true; // Если все ваши проверки пройдены успешно и счёт вы обработали, то присваиваем переменной true }elseif ($m_status == 'fail'){ // Клиент отказался от оплаты счёта. Если требуется, найдите этот счёт у себя и отметьте, что клиент отменил счёт $is_all_ok = true; // Тут аналогично. Если все ваши проверки пройдены успешно и счёт вы обработали, то присваиваем переменной true } if ($is_all_ok){ echo $m_orderid.'|success'; exit; } } } echo "ERROR"; exit; ?>
Azvox API
Взаимодействие с вашим кошельком посредством Api

Azvox предоставляет возможность внешним разработчикам программными средствами взаимодействовать с сервисом.
Одним из способов такого взаимодействия является использование API.

API определяет набор функций для осуществления взаимодействия по протоколу HTTPS.
С помощью данных функций можно получить доступ к различным ресурсам системы, например, информацию о вашем балансе и наличии уведомлений, информацию по определённой транзакции или список транзакций в системе, Перевести деньги и многое другое.

Подготовка и добавление Api

Перейдите в раздел API интеграция и нажмите на кнопку Добавить API

Заполните Имя API
Скопируйте Пароль для доступа к API
Выберите остальные необходимые вам параметры

Для большей безопасности рекомендуем выбирать доступность только Для указанных ip, чтобы ползоваться API могли только вы с определённого ip адреса. И выбрать только необходимые разрешённые для API действия.

После сохранения ваше API отобразится в списке Ваши API в разделе API интеграция и вы уже можете пользоваться им.

Основы формирования запросов

Взаимодействие осуществляется с помощью POST запросов в кодировке UTF-8 к URL: https://azvox.cash/api/v3.6/
Каждый ответ от сервера Azvox обязательно содержит поле status, содержащий ok, либо error, что означает содержит ли запрос ошибки или запрос успешно обработан.

Если status=error, то в ответе также будет присутствувать поле error с подробным описанием ошибки.
Если status=ok, то в ответе будет присутствовать поле data с данными ответа, подробнее с которыми вы сможете ознакомиться ниже.

Для простоты работы вы можете воспользоваться готовым PHP классом, для работы с Azvox API

Каждый запрос к серверу Azvox API должен содержать несколько обязательных параметров:

ПараметрОписание
account Главный номер вашего Azvox кошелька.
Тот номер, который вы указываете при авторизации.
Пример: W12345
apiId Api ID, который вы можете найти в списке ваших API.
Пример: 12345
apiPass Пароль для доступа к этому API
Пример: oDU7XBwN%TMDUJ4
action Запрашиваемое действие.
Смотрите подробное описание возможных действий ниже.
Дополнительные данные Смотрите подробное описание этих данных ниже.
API - Проверка существования кошелька
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actioncheck_wallet Действие: Проверка существования кошелька
wallet Номер кошелька Azvox, который вы хотите проверить.
Пример: W12345
Значение, которое вы получите в ответе в параметре data:
ЗначениеОписание
wallet_ok или wallet_not_found Существует ли запрошенный номер кошелька в Azvox
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $isWalletOK = $api->isWalletExists('W12345'); if (!$api->getErrors()){ echo 'Wallet is: '.$isWalletOK; // ok|fail }else{print_r($api->getErrors());} ?>
API - Проверка баланса кошелька
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actionget_balance Действие: Получение баланса кошелька
Массив данных, который вы получите в ответе, в параметре data:
ПараметрОписание
USD USD баланс вашего кошелька.
Пример: 100.12
EUR EUR баланс вашего кошелька.
Пример: 12.00
RUB RUB баланс вашего кошелька.
Пример: 5678.20
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $balance = $api->getBalance(); if (!$api->getErrors()){ echo 'Balance USD: '.$balance['USD'].'<br>'; echo 'Balance EUR: '.$balance['EUR'].'<br>'; echo 'Balance RUB: '.$balance['RUB'].'<br>'; }else{print_r($api->getErrors());} ?>
API - Проверка наличия уведомлений
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actionget_notifications Действие: Проверка наличия уведомлений
Массив данных, который вы получите в ответе, в параметре data:
ПараметрЗначениеОписание
messages 1 или 0 Есть или нет новые сообщения в чате.
p2p_exchange_from_owner 1 или 0 Есть или нет новое событие в P2P обмене инициированное владельцем обменника.
p2p_exchange_from_client 1 или 0 Есть или нет новое событие в P2P обмене инициированное Клиентом обменника.
tickets 1 или 0 Есть или нет новое сообщение от Поддержки Azvox.
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $notifications = $api->getNotifications(); if (!$api->getErrors()){ $hasNewMessage = false; if ($notifications['messages'] == 1){ echo 'You have new Chat Message.'; $hasNewMessage = true; } if ($notifications['p2p_exchange_from_owner'] == 1){ echo 'You have new event in P2P Exchange from Exchanger.'; $hasNewMessage = true; } if ($notifications['p2p_exchange_from_client'] == 1){ echo 'You have new event in P2P Exchange from Client.'; $hasNewMessage = true; } if ($notifications['tickets'] == 1){ echo 'You have new Message from Support.'; $hasNewMessage = true; } if (!$hasNewMessage){ echo 'You have no Messages.'; } }else{print_r($api->getErrors());} ?>
API - Перевод денег
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actiontransfer Действие: Перевод денег
to_wallet Номер Azvox кошелька, на который вы хотите перевести деньги.
Пример: W54321
amount Сумма, которая поступит на кошелёк получателя.
Пример: 100.12
curUSD, EUR, RUB Валюта, которую хотите перевести.
Пример: USD
comment Комментарий для получателя.
Пример: Оплата за товар
Можно оставить пустой строкой.
Требования: не более 50 символов.
Массив данных, который вы получите в ответе, в параметре data:
ПараметрОписание
history_operation_id ID транзакции в истории Azvox
Пример: 123123123
to_wallet Номер кошелька получателя перевода
Пример: W54321
debited_amount Сумма и валюта, списанная у вас из баланса.
Пример: 101.13 USD
credited_amount Сумма и валюта, начисленная получателю.
Пример: 100.12 USD
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $transfer = $api->transfer("W54321", "100.12", "USD", "Just a comment"); if (!$api->getErrors()){ echo 'Transfer Successful. Debited amount:-'.$transfer['debited_amount'].' To Wallet: '.$transfer['to_wallet'].' Credited amount:+'.$transfer['credited_amount']; }else{print_r($api->getErrors());} ?>
API - Внутренний обмен денег
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actionexchange Действие: Внутренний обмен.
Из одной валюты вашего кошелька в другую.
amount Сумма, которую вы хотите обменять.
Пример: 100.52
from_curUSD, EUR, RUB Валюта, которую вы хотите обменять.
Пример: USD
to_curUSD, EUR, RUB Валюта, которую вы хотите получить.
Пример: EUR
Массив данных, который вы получите в ответе, в параметре data:
ПараметрОписание
history_operation_id ID транзакции в истории Azvox
Пример: 123123123
debited_amount Сумма и валюта, списанная у вас из баланса.
Пример: 100.12 USD
credited_amount Сумма и валюта, начисленная вам в процессе обмена.
Пример: 90.56 EUR
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $exchange = $api->exchange("100.12", "USD", "EUR"); if (!$api->getErrors()){ echo 'Internal Exchange Successful. Debited amount:-'.$exchange['debited_amount'].' Credited amount:+'.$exchange['credited_amount']; }else{print_r($api->getErrors());} ?>
API - Получение списка из истории транзакций
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actionget_history Действие: Получение списка из истории транзакций.
count1-10 Количество записей, которые вы хотите получить.
Пример: 5
after_id ID транзакции, записи после которой вы хотите получить.
Если вы выгружаете список транзакций, то укажите здесь 0, чтобы получить самые последние записи. И при следующем обращении укажите ID последней записи, которую вы выгружали, чтобы получить записи следующие за ней.
Сортируются по дате, по убыванию, от самой новой к более поздним.
Пример: 123456
В ответе, в параметре data, вы получите массив элементов, каждый из которых содержит различные данные, в зависимости от типа транзакции:
Тип транзакцииПараметрОписание
Передаются при любом типе транзакции operation_type Тип транзакции, полный список типов указан ниже
Пример: transfer
operation_id ID транзакции в вашей истории Azvox
Пример: 123123123
operation_status Статус транзакции.
Возможные значения:
ok - Транзакция завершена успешно
in_process - Транзакция в процессе обработки: Деньги уже отправлены получателю и Azvox отправляет данные на сайт продавца, чтобы сообщить ему об этой транзакции.
problem - Проблема с транзакцией. Деньги уже отправлены получателю и Azvox пытался отправить данные на сайт продавца, чтобы сообщить ему об этой транзакции, но не получил правильный ответ от сайта в течение длительного времени. Зайдите в подробный просмотр транзакции в истории и повторите отправку данных. Если это не ваш сайт и вы совершали платёж, тогда обратитесь к Администратору этого сайта и опишите ему проблему.
date Дата совершения транзакции в формате DD.MM.YYYY HH:MM:SS
Пример: 31.12.2024 15:59:59
date_gmt Часовой пояс даты
Пример: gmt+3
date_ts Unix Timestamp совершения транзакции
Пример: 1716151413
is_api Была ли транзакция совершена с помощью Azvox API
Возможные значения: ApiID или 0
Пример: 123456
transfer Перевод денег
operation_id_to ID транзакции в истории Azvox у получателя
Пример: 123123123
from_wallet Номер кошелька из которого была произведена оплата
Пример: W12345
to_wallet Номер кошелька на который были переведены деньги
Пример: W54321
debited_amount Сумма, списанная у вас из баланса
Пример: 100.12
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
fee_amount Сумма Azvox Fee
Пример: 0.01
fee_cur Валюта Azvox Fee. USD, EUR, RUB
Пример: USD
credited_amount Сумма, зачисленная на баланс получателя
Пример: 100.12
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: USD
comment_b64 Комментарий от отправителя закодированный с помощью алгоритма base64.
Или пустая строка.
get_transfer Получение денежного перевода
operation_id_from ID транзакции в истории Azvox у отправителя
Пример: 123123123
from_wallet Номер кошелька из которого была произведена оплата
Пример: W54321
to_wallet Номер кошелька на который были переведены деньги
Пример: W12345
credited_amount Сумма, зачисленная на ваш баланс
Пример: 100.12
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: USD
comment_b64 Комментарий от отправителя закодированный с помощью алгоритма base64.
Или пустая строка.
exchange_internal Внутренний обмен. Из одной валюты вашего кошелька в другую.
debited_amount Сумма, списанная у вас из баланса
Пример: 100.12
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
credited_amount Сумма, зачисленная на ваш баланс в процессе обмена
Пример: 99.56
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: EUR
merchant_pay Оплата счёта сформированного на сайте, из формы, или по ссылке.
operation_id_to ID транзакции в истории Azvox у получателя платежа
Пример: 123123123
debited_amount Сумма, списанная у вас из баланса
Пример: 100.12
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
from_wallet Номер кошелька из которого была произведена оплата
Пример: W12345
merchant_get_pay Получение оплаты счёта сформированного на вашем сайте, из вашей формы, или по вашей ссылке.
operation_id_from ID транзакции в истории Azvox у отправителя
Пример: 123123123
credited_amount Сумма, зачисленная на ваш баланс
Пример: 99.56
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: EUR
from_wallet Номер кошелька из которого была произведена оплата
Пример: W12345
buy_anon_wallet Покупка Анонимного номера Azvox кошелька
anon_wallet Номер купленного Анонимного Azvox кошелька
Пример: W102030
debited_amount Сумма, списанная у вас из баланса
Пример: 3.00
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
buy_api_plan Покупка тарифа для API
plan Название тарифа
Пример: Business
debited_amount Сумма, списанная у вас из баланса
Пример: 50.00
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
get_ref_earn Получение реферального дохода
to_wallet Номер вашего кошелька на который был зачислен доход
Пример: W12345
credited_amount Сумма, зачисленная на ваш баланс
Пример: 158.63
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: USD
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $count_rows = 5; // 1-10 $after_id = 0; $history_list = $api->getLastHistory( $count_rows, $after_id ); if (!$api->getErrors()){ foreach( $history_list as $operation_id => $transaction ){ $operation_type = $transaction['operation_type']; print_r($transaction); } }else{print_r($api->getErrors());} ?>
API - Подробная информация по транзакции
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actionhistory_details Действие: Получение подробной информации по транзакции.
history_operation_id ID транзакции из истории Azvox, информацию по которой вы хотите получить.
Пример: 123456
В ответе, в параметре data, вы получите массив параметров, которые могут отличаться в зависимости от типа транзакции:
Тип транзакцииПараметрОписание
Передаются при любом типе транзакции operation_type Тип транзакции, полный список типов указан ниже
Пример: transfer
operation_id ID транзакции в вашей истории Azvox
Пример: 123123123
operation_status Статус транзакции.
Возможные значения:
ok - Транзакция завершена успешно
in_process - Транзакция в процессе обработки: Деньги уже отправлены получателю и Azvox отправляет данные на сайт продавца, чтобы сообщить ему об этой транзакции.
problem - Проблема с транзакцией. Деньги уже отправлены получателю и Azvox пытался отправить данные на сайт продавца, чтобы сообщить ему об этой транзакции, но не получил правильный ответ от сайта в течение длительного времени. Зайдите в подробный просмотр транзакции в истории и повторите отправку данных. Если это не ваш сайт и вы совершали платёж, тогда обратитесь к Администратору этого сайта и опишите ему проблему.
date Дата совершения транзакции в формате DD.MM.YYYY HH:MM:SS
Пример: 31.12.2024 15:59:59
date_gmt Часовой пояс даты
Пример: gmt+3
date_ts Unix Timestamp совершения транзакции
Пример: 1716151413
is_api Была ли транзакция совершена с помощью Azvox API
Возможные значения: ApiID или 0
Пример: 123456
transfer Перевод денег
operation_id_to ID транзакции в истории Azvox у получателя
Пример: 123123123
from_wallet Номер кошелька из которого была произведена оплата
Пример: W12345
to_wallet Номер кошелька на который были переведены деньги
Пример: W54321
debited_amount Сумма, списанная у вас из баланса
Пример: 100.12
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
fee_amount Сумма Azvox Fee
Пример: 0.01
fee_cur Валюта Azvox Fee. USD, EUR, RUB
Пример: USD
credited_amount Сумма, зачисленная на баланс получателя
Пример: 100.12
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: USD
comment_b64 Комментарий от отправителя закодированный с помощью алгоритма base64.
Или пустая строка.
get_transfer Получение денежного перевода
operation_id_from ID транзакции в истории Azvox у отправителя
Пример: 123123123
from_wallet Номер кошелька из которого была произведена оплата
Пример: W54321
to_wallet Номер кошелька на который были переведены деньги
Пример: W12345
credited_amount Сумма, зачисленная на ваш баланс
Пример: 100.12
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: USD
comment_b64 Комментарий от отправителя закодированный с помощью алгоритма base64.
Или пустая строка.
exchange_internal Внутренний обмен. Из одной валюты вашего кошелька в другую.
debited_amount Сумма, списанная у вас из баланса
Пример: 100.12
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
credited_amount Сумма, зачисленная на ваш баланс в процессе обмена
Пример: 99.56
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: EUR
merchant_pay Оплата счёта сформированного на сайте, из формы, или по ссылке.
operation_id_to ID транзакции в истории Azvox у получателя платежа
Пример: 123123123
invoice_id ID счёта в Azvox
Пример: 123123123
debited_amount Сумма, списанная у вас из баланса
Пример: 98.12
debited_cur Валюта списания. USD, EUR, RUB
Пример: EUR
m_amount Сумма заказа.
Пример: 100.35
m_cur Валюта заказа. USD, EUR, RUB
Пример: USD
from_wallet Номер кошелька из которого была произведена оплата
Пример: W12345
m_name Название сайта в Azvox, если это ваш сайт, иначе пустая строка.
Пример: My_Shop
m_domain Доменное имя сайта.
Пример: shop.com
m_orderid ID заказа в системе учёта сайта.
Пример: 123
m_desc_b64 Описание заказа закодированное с помощью алгоритма base64.
Пример: dGVzdA==
m_params_b64 Передаётся только, если вы владелец сайта или формы, оплата для которой была произведена.
Дополнительные параметры или данные из полей формы, которые заполнил покупатель, упакованные в JSON и закодированные с помощью алгоритма base64.
Пример: eyJwYXJhbV9jdXIiOiJVU0QifQ==
m_shop ID сайта в Azvox, если вы владелец этого сайта.
Пример: 123123123
m_form ID формы в Azvox, если счёт был создан при помощи Платёжной формы Azvox и вы создатель этой формы.
Пример: 123123123
merchant_get_pay Получение оплаты счёта сформированного на вашем сайте, из вашей формы, или по вашей ссылке.
operation_id_from ID транзакции в истории Azvox у отправителя
Пример: 123123123
invoice_id ID счёта в Azvox
Пример: 123123123
credited_amount Сумма, зачисленная на ваш баланс
Пример: 99.56
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: EUR
m_amount Сумма заказа.
Пример: 99.56
m_cur Валюта заказа. USD, EUR, RUB
Пример: EUR
op_amount Сумма, списанная из баланса покупателя.
Пример: 100.53
op_cur Валюта суммы, списанной из баланса покупателя. USD, EUR, RUB
Пример: USD
from_wallet Номер кошелька из которого была произведена оплата
Пример: W12345
m_name Название сайта в Azvox.
Пример: My_Shop
m_domain Доменное имя сайта.
Пример: shop.com
m_orderid ID заказа в вашей системе учёта.
Пример: 123
m_desc_b64 Описание заказа закодированное с помощью алгоритма base64.
Пример: dGVzdA==
m_params_b64 Дополнительные параметры или данные из полей формы, которые заполнил покупатель, упакованные в JSON и закодированные с помощью алгоритма base64.
Пример: eyJwYXJhbV9jdXIiOiJVU0QifQ==
m_shop ID сайта в Azvox.
Пример: 123123123
m_form ID формы в Azvox, если счёт был создан при помощи Платёжной формы Azvox.
Пример: 123123123
buy_anon_wallet Покупка Анонимного номера Azvox кошелька
anon_wallet Номер купленного Анонимного Azvox кошелька
Пример: W102030
debited_amount Сумма, списанная у вас из баланса
Пример: 3.00
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
buy_api_plan Покупка тарифа для API
plan Название тарифа
Пример: Business
debited_amount Сумма, списанная у вас из баланса
Пример: 50.00
debited_cur Валюта списания. USD, EUR, RUB
Пример: USD
get_ref_earn Получение реферального дохода
to_wallet Номер вашего кошелька на который был зачислен доход
Пример: W12345
credited_amount Сумма, зачисленная на ваш баланс
Пример: 158.63
credited_cur Валюта зачисления. USD, EUR, RUB
Пример: USD
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $history_transaction_id = 123456; $history_details = $api->getHistoryDetails($history_transaction_id); if (!$api->getErrors()){ $operation_type = $history_details['operation_type']; print_r($history_details); }else{print_r($api->getErrors());} ?>
API - Подробная информация по выставленному счёту
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actionget_invoice Действие: Получение подробной информации по выставленному счёту.
invoiceid ID счёта в Azvox, информацию по которому вы хотите получить. Не путать с history_operation_id - ID из истории транзакцийПример: 123456
В ответе, в параметре data, вы получите массив параметров:
ПараметрОписание
status Статус счёта.
Возможные значения: new - счёт создан, но не оплачен клиентом и клиент не отказался от оплаты.
fail - клиент отказался от оплаты счёта.
ok - счёт оплачен.
in_process - Транзакция в процессе обработки: Деньги уже отправлены получателю и Azvox отправляет данные на сайт продавца, чтобы сообщить ему об этой транзакции.
problem - Проблема с транзакцией. Деньги уже отправлены получателю и Azvox пытался отправить данные на сайт продавца, чтобы сообщить ему об этой транзакции, но не получил правильный ответ от сайта в течение длительного времени. Зайдите в подробный просмотр транзакции в истории и повторите отправку данных. Если это не ваш сайт и вы совершали платёж, тогда обратитесь к Администратору этого сайта и опишите ему проблему.
Пример: ok
pay_url Ссылка для оплаты счёта. Заполнена, только при статусе счёта status=new
invoice_id ID счёта в Azvox
Пример: 123123123
m_orderid ID заказа в системе учёта сайта.
Пример: 123
receiver Получатель платежа. Домен сайта, или номер кошелька получателя.
Пример: shop.com или W123678
date Дата создания счёта в формате DD.MM.YYYY HH:MM:SS
Пример: 31.12.2024 15:59:59
date_gmt Часовой пояс даты создания счёта
Пример: gmt+3
date_ts Unix Timestamp создания счёта
Пример: 1716151413
op_date Дата оплаты счёта в формате DD.MM.YYYY HH:MM:SS
Пример: 31.12.2024 15:59:59
op_date_gmt Часовой пояс даты оплаты счёта
Пример: gmt+3
op_date_ts Unix Timestamp оплаты счёта
Пример: 1716151413
op_wallet Номер кошелька из которого была произведена оплата
Пример: W12345
m_amount Сумма заказа.
Пример: 100.35
m_cur Валюта заказа. USD, EUR, RUB
Пример: USD
op_amount Сумма, списанная из баланса покупателя.
Пример: 98.62
op_cur Валюта суммы, списанной из баланса покупателя. USD, EUR, RUB
Пример: EUR
m_desc_b64 Описание заказа закодированное с помощью алгоритма base64.
Пример: dGVzdA==
m_params_b64 Передаётся только, если вы владелец сайта или формы, к которой привязан данный счёт.
Дополнительные параметры или данные из полей формы, которые заполнил покупатель, упакованные в JSON и закодированные с помощью алгоритма base64.
Пример: eyJwYXJhbV9jdXIiOiJVU0QifQ==
m_shop ID сайта в Azvox, если вы владелец этого сайта.
Пример: 123123123
m_form ID формы в Azvox, если счёт был создан при помощи Платёжной формы Azvox и вы создатель этой формы.
Пример: 123123123
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); $invoice_id = 123456; $invoice = $api->getInvoice($invoice_id); if (!$api->getErrors()){ $invoice_status = $invoice['status']; print_r($invoice); }else{print_r($api->getErrors());} ?>
API - Создание нового счёта для оплаты
Прежде чем приступить к работе с API по созданию счетов, необходимо ознакомиться с документацией.
Изучите Merchant - создание и обработка платежей и приступайте к работе по созданию счетов через API.
Данные, которые вы должны передать:
ПараметрЗначениеОписание
.........Список обязательных параметров: account, apiId, apiPass.
actionnew_invoice Действие: Создание нового счёта.
m_shop ID вашего сайта в Azvox, можно найти в списке ваших сайтов.
Либо укажите 0, если хотите просто создать счёт для оплаты, не относящийся к вашему сайту.
Пример: 123456
m_orderid ID заказа в вашей системе учёта, если у вас нет ID заказа, укажите 0.
Пример: 123
m_amount Сумма заказа, которую вы хотите получить после оплаты клиентом.
Пример: 100.57
m_curr Валюта заказа, которую вы хотите получить. USD, EUR, RUB
Пример: USD
m_desc Описание вашего заказа, которое увидит покупатель.
Не более 100 символов.
Пример: Description
m_params Дополнительные данные, упакованные в JSON или пустая строка.
Укажите, если вы хотите, чтобы Azvox при отчёте о платеже вернул вам дополнительные данные в скрипт StatusUrl.
Не более 1000 символов.
Пример: Description
В ответе, в параметре data, вы получите массив параметров:
ПараметрОписание
invoice_id ID счёта в Azvox
Пример: 123123123
m_orderid ID заказа в системе учёта сайта.
Пример: 123
pay_url Ссылка для оплаты счёта.
Пример реализации с использованием PHP класса cAzvox.php:Скопировать код
<?php require_once "cAzvox.php"; $api = new cAzvox( "Главный номер вашего Azvox кошелька (W12345)", "Api ID( указан в списке ваших API )", "Пароль для доступа к API" ); // $shop_id это ID вашего сайта в Azvox, можно найти в списке ваших сайтов. // Либо укажите 0, если хотите просто создать счёт для оплаты, не относящийся к вашему сайту. $shop_id = 12345; // $order_id это ID заказа в вашей системе учёта, если у вас нет ID заказа, укажите 0. $order_id = 123; $data = array( "m_shop" => $shop_id, "m_orderid" => $order_id, "m_amount" => 100.15, // Сумма заказа "m_curr" => "USD", // Валюта заказа USD, EUR или RUB "m_desc" => "Description", // Описание вашего заказа, которое увидит покупатель ); // Если вы хотите, чтобы Azvox при отчёте о платеже вернул вам дополнительные данные, раскоментируйте строку ниже и добавьте их в массив как указано в примере // $data["m_params"] = json_encode(array("var1" => "value1", "var2" => "value2")); $newInvoice = $api->createInvoice($data); $errors = $api->getErrors(); if (!$errors){ echo '<a href="'.$newInvoice['pay_url'].'">Оплатить</a>'; }else{ print_r($errors); } ?>