address
Модель позволяет мерчанту создавать адреса криптовалют и получать их параметры, применяемые для отправки и приема платежей.
Используя методы модели address мерчант может:
- Создать адрес криптовалюты - метод address.create
- Получить детали криптоадреса мерчанта - метод address.get
- Получить список криптоадресов мерчанта - метод address.list
- Получить список доступных платежных направлений - метод address.payways
- Задать или изменить callback_URL созданных ранее криптоадресов - метод address.edit_cb_url
endpoint
Запросы на работу методов модели отправляются на endpoint https://api.any.money/.
address.create
Метод создает адрес криптовалюты (криптокошелек) и возвращает репрезентацию его параметров.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| in_curr | да | "BTC" | валюта создаваемого криптоадреса |
| payway | да | "btc" | наименование платежной системы создаваемого криптоадреса. * Для корреткной работы метода, необходимо передавать комбинацию платежной системы и валюты создаваемого криптоадреса согласно описанию |
| callback_url | нет | "https://any_money.redirect.com" | URL для отправки уведомлений о приходе платежа на адрес, формат уведомлений |
| comment | нет | "Комментарий" | комментарий для криптоадреса, не более 50 символов |
| out_curr | нет | "UAH" | валюта зачисления для создаваемого криптоадреса (если создается адрес с автоконвертацией) |
| override_address | нет | false | флаг перезаписи адреса. true - даже при совпадении по payer + payway + in_curr + out_curr, будет создан новый адрес, false - при совпадении по payer + payway + in_curr + out_curr, будет возвращен уже существующий адрес. По умолчанию false |
| payer | нет* | "[email protected]" | идентификатор плательщика, если будет найден криптоадрес для мерчанта с совпадением по payer + payway + in_curr + out_curr, то будет возвращен существующий адрес, в остальных случаях будет сгенерирован новый адрес |
* payway обязательный параметр в случае если передан payer
* payer обязательный параметр в случае если передан override_address
Допустимые комбинации payway и in_curr
| Криптовалюта | Параметр запроса payway | Параметр запроса in_curr |
|---|---|---|
| Bitcoin | btc | BTC |
| Ether | eth | ETH |
| Litecoin | ltc | LTC |
| USDT(токен стандарта ERC-20 в сети Ethereum) | erc20 | USDT |
| USDT(токен стандарта TRC-20 в сети TRON) | trc20 | USDT |
| TRX | tron | TRX |
Внимание!
Для типизированного мерчанта передаваемая платежная система должна совпадать с его типом, а out_curr передавать нельзя так как операция конвертации валют недоступна для такого мерчанта
Внимание!
Процесс создания криптоадреса может занять некоторое время, поэтому после успшеного выполнения запроса необходимо вызывать метод address.get пока в ответе не будет получен криптоадрес (значение параметра name).
Данные ответа метода
Параметры созданного криптоадреса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
-
- валюта in_curr отсутствует в системе
- in_curr=out_curr
- EParamFieldInvalid
- передан невалидный параметр callback_url
- EParamInvalid
-
- переданный payway не соответствует типу мерчанта
- превышена максимально допустимая длина комментария
- payway должен быть передан вместе с payer
- payer должен быть передан вместе с override_address
- EParamPaywayInvalid
-
- переданный payway не является крипто-ПС
- валюта in_curr не соответствует переданной ПС
- EStateCurrencyInactive
- валюта in_curr, out_curr деактивирована административно
- EStateCurrencyUnavail
- валюта in_curr, out_curr недоступна
- EStateExchangeUnavail
- обмен из in_curr в out_curr заблокирован для типизированного мерчанта
address.get
Метод поиска и получения информации о привязанном к мерчанту криптоадресе.
Возвращает репрезентацию найденного криптоадреса.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| id | да* | "844422933266350" | идентификатор криптоадреса |
| name | да* | "3E8sEHMof39RgSHqSZswintqaXi3fSKYJN" | сам криптоадрес |
*обязательно указать только один из параметров id или name
Данные ответа метода
Параметры криптоадреса
Возможные возвращаемые ошибки
- EParamInvalid
- не передан ни один из параметров name или id, передано неверное значение параметра id или name, переданы одновременно name и id
- EParamNotFound
- не найден ни один адрес с переданными параметрами
- EParamType
- переданы данные неверного типа для параметра id
address.list
Метод отображения перечня криптоадресов, связанных с мерчантом. Для каждого приводятся его параметры. Фильтры поиска объединены логическим И.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| begin | нет | "123456789" | фильтр начала диапазона выборки ответов по дате и времени (timestamp). Если rotate=true, то по дате и времени последнего использования адреса (timestamp), а если rotate=false, то по времени его создания. default="0" |
| count | нет | "136" | размер выборки ответов метода (значение не может превышать 200). default="20" |
| end | нет | "234567890" | фильтр окончания диапазона выборки ответов по дате и времени (timestamp). Если rotate=true, то по дате и времени последнего использования адреса (timestamp), а если rotate=false, то по времени его создания. default="now" |
| first | нет | "17" | номер объекта в полученной выборке результатов, с которого начнётся вывод перечня адресов и отсчет параметра count |
| in_curr | нет | "BTC" | фильтр криптоадресов по криптовалюте. В ответ метода попадут криптоадреса только заданной криптовалюты |
| is_autoconvert | нет | false | фильтр адресов с автоконвертацией (значение true - в выборку попадут только адреса с автоконвертацией, false - без автоконвертации) |
| name | нет | "dsf34s5t" | фильтр криптоадресов по имени адреса, включая частичное совпадение |
| ord_by | нет | "ctime" | фильтр адресов по временнЫм меткам (“ctime” - время создания, “last_used” - время последнего использования) |
| ord_dir | нет | false | направление сортировки по временнЫм меткам |
| out_curr | нет | "USD" | фильтр по валюте зачисления для криптоадресов с автоконвертацией. В ответ метода попадут только криптоадреса с автоконвертацией в заданную валюту |
| payer | нет | "[email protected]" | фильтр криптоадресов по идентификатору плательщика |
| rotate | нет | false | фильтр адресов, включенных в авторотацию (значение true - в выборку попадут только с включенной авторотацией, false - только с выключенной). default=false |
Особенности обработки пары параметров begin, end
Аргументу begin система всегда присвоит меньшее значение из переданной пары, а для end - всегда большее. Вне зависимости от того, под каким из имён они были переданы
Внимание!
Для типизированных мерчантов значение in_curr должно быть равно out_curr или оба параметра не передаются, иначе возвратится ошибка
Данные ответа метода
- count
- размер текущей выборки ответов
- data
- массив с репрезентациями данных криптоадресов
- first
- номер первого адреса в выборке ответов метода, с него начинается отсчет count
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено адресов, соответствующих фильтрам запроса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- валюта отсутствует в системе
- EParamInvalid
-
- переданы неверные значения любого из параметров first, count, begin, end, ord_by
- автоконверт запрещен для типизированного мерчанта
- EParamType
- переданы данные неверного типа для любого из параметров first, count, begin, end, is_autoconvert, rotate
- EStateExchangeUnavail
- обмен из in_curr в out_curr заблокирован для типизированного мерчанта
address.payways
Метод возвращает имена всех крипто-ПС, для которых мерчант может создать адрес. Если передан in_curr, то в ответе войдут названия только тех платежных систем, которые работают с данной валютой.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| in_curr | нет | "BTC" | название валюты |
Данные ответа метода
Перечень доступных мерчанту крипто-ПС, в которых есть валюта in_curr
Возможные возвращаемые ошибки
- EParamNotFound
- не удалось найти ни одной крипто-ПС
- EParamPaywayInvalid
- недопустимое имя крипто-ПС
- EParamCurrencyInvalid
- недопустимое имя криптовалюты
- EStateCurrencyUnavail
- не удалось найти криптовалюту с переданным именем in_curr, или валюта не является криптовалютой
address.edit_cb_url
Метод для задания или изменения callback URL созданных ранее криптоадресов.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| callback_url | нет | "https://any_money.redirect.com" | исходный callback_url криптоадреса |
| in_curr | нет | "BTC" | входящая валюта криптоадреса |
| new_callback_url | нет | "https://any_money.redirnew.com" | новый callback_url криптоадреса. Если не передать, то callback_url для адресов в выборке будет удален |
| payway | нет | "btc" | платёжная система криптоадреса |
Данные ответа метода
- updated
- количество обновлённых криптоадресов
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- валюта отсутствует в системе Any.Money
- EParamInvalid
- переданы неверные значения для callback_url, new_callback_url
- EParamNotFound
- не найдено ни одного криптоадреса для обновления
- EParamPaywayInvalid
- передана неверная платежная система