history
Используя методы модели history мерчант может получить:
- Историю поступивших выставленных счетов - метод history.invoice
- Историю созданных ордеров на оплату - метод history.code
- Историю созданных ордеров на выплату - метод history.payout
- Историю созданных ордеров конвертации валют - метод history.convert
- Историю созданных ордеров перевода средств - метод history.transfer
- Историю операций мерчанта - метод history.statement
- Историю криптоадресов мерчанта - метод history.address
- Историю Host-to-Host платежей - метод history.card_h2h
endpoint
Запросы на работу методов модели отправляются на endpoint https://api.any.money/.
history.invoice
Метод отображения списка ордеров типа invoice и payin, созданных мерчантом (одноплатёжное или мультиплатёжное
пополнение любыми валютами).
Результат возвращается в виде отсортированного по убыванию даты создания перечня ордеров типа invoice. Для каждого
из них доступна репрезентация параметров.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| count | нет | "100" | размер выборки ответов метода (значение не может превышать "200"). default="20" |
| first | нет | "25" | номер первого объекта в выборке результатов, с которого начнется их репрезентация и отсчёт параметра count. default="0" |
| in_curr | нет | "UAH" | фильтр ордеров по валюте пополнения |
| out_curr | нет | "GBP" | фильтр ордеров по валюте зачисления |
| payway | нет | "anycash" | фильтр платежной системы, из которой поступил платеж |
Внимание!
Если в запросе от типизированного мерчанта будет передана ПС, отличная от типа мерчанта, то метод возвратит пустой список ордеров
Данные ответа метода
- count
- размер текущей выборки ответов
- data
- массив репрезентаций ордеров типа invoice
- first
- номер первого ордера в выборке ответов метода
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено ордеров, соответствующих фильтрам запроса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- не удалось найти валюту с переданным именем in_curr, out_curr
- EParamInvalid
- передано неверное значение параметра
- EParamPaywayInvalid
- указана неверная платежная система
- EParamType
- параметр содержит некорректный тип данных
history.code
Метод отображения списка ордеров, пополняемых кодовыми (чековыми) платежами, привязанных к данному мерчанту.
Фильтры поиска объединены логическим И.
Результат возвращается в виде отсортированного по убыванию даты создания перечня ордеров типа coderedeem c
репрезентациями их параметров.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| count | нет | "100" | размер выборки ответов метода (значение не может превышать "200"). default="20" |
| first | нет | "25" | номер первого объекта в выборке результатов, с которого начнется их репрезентация и отсчёт параметра count. default="0" |
| in_curr | нет | "UAH" | фильтр ордеров по валюте пополнения |
| out_curr | нет | "GBP" | фильтр ордеров по валюте зачисления |
| payway | нет | "anycash" | фильтр платежной системы, из которой поступил платеж |
Данные ответа метода
- count
- размер текущей выборки ответов
- data
- массив репрезентаций ордеров типа invoice
- first
- номер первого ордера в выборке ответов метода
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено ордеров, соответствующих фильтрам запроса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- не удалось найти валюту с переданным именем in_curr, out_curr
- EParamInvalid
- передано неверное значение параметра
- EParamPaywayInvalid
- указана неверная платежная система
- EParamType
- параметр содержит некорректный тип данных
history.payout
Метод отображения перечня ордеров выплат, привязанных к данному мерчанту.
Фильтры поиска объединены логическим И.
Результат возвращается в виде отсортированного по убыванию даты создания перечня ордеров типа payout. Для каждого
из них доступна репрезентация его параметров.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| count | нет | "38" | размер выборки ответов метода (значение не может превышать "200"). default="20" |
| first | нет | "10" | номер первого объекта в выборке результатов, с которого начнется их репрезентация и отсчёт параметра count. default="0" |
| in_curr | нет | "UAH" | валюта пополнения. Баланс мерчанта, из которого совершен платеж |
| out_curr | нет | "USD" | валюта, в которой заказана выплата |
| payway | нет | "anycash" | платежная система, через которую проводится выплата |
Данные ответа метода
- count
- размер текущей выборки ответов
- data
- массив репрезентаций ордеров типа payout
- first
- номер первого ордера в выборке ответов метода
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено ордеров, соответствующих фильтрам запроса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- не удалось найти валюту с переданным именем in_curr, out_curr
- EParamInvalid
- передано неверное значение параметра
- EParamPaywayInvalid
- указана неверная платежная система
- EParamType
- параметр содержит некорректный тип данных
history.convert
Метод отображения ордеров конвертаций валют (типа convert),
отфильтрованных по названиям валют зачисления и/или пополнения. Фильтры
поиска объединены логическим И. Если не будет задана ни одна из них,
то метод вернет список операций конвертации мерчанта во всех валютах.
Результат возвращается в виде отсортированного по убыванию даты создания перечня ордеров типа convert. Для каждого
из них доступна репрезентация его параметров.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| count | нет | "199" | размер выборки ответов метода (значение не может превышать "200"). default="20" |
| first | нет | "03" | номер объекта в полученной выборке результатов, с которого начнётся вывод списка ордеров конвертации и отсчета параметра count. default="0" |
| in_curr | нет | "UAH" | валюта пополнения в операции конвертации |
| out_curr | нет | "GBP" | валюта зачисления в операции конвертации |
Данные ответа метода
- count
- размер текущей выборки ответов
- data
- массив репрезентаций ордеров типа convert
- first
- номер первого ордера, с которого начнется отсчет параметра count, в выборке ответов метода
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено ордеров, соответствующих фильтрам запроса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- не удалось найти валюту с переданным именем in_curr, out_curr
- EParamInvalid
- переданы неверные значения любого из параметров first, count
- EParamType
- переданы данные неверного типа для любого из параметров first, count
history.transfer
Метод отображения перечня ордеров перемещения средств, привязанных к данному мерчанту. Фильтры поиска объединены
логическим И.
Результат возвращается в виде отсортированного по убыванию даты создания перечня ордеров типа transfer. Для каждого
из них доступна репрезентация его параметров.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| count | нет | "100" | размер выборки ответов метода (значение не может превышать "200"). default="20" |
| first | нет | "13" | номер первого объекта в выборке результатов, с которого начнется их репрезентация и отсчёт параметра count. default="0" |
| in_curr | нет | "USD" | фильтр ордеров по названию валюты пополнения |
| out_curr | нет | "UAH" | фильтр ордеров по названию валюты зачисления |
Данные ответа метода
- count
- размер текущей выборки ответов
- data
- массив репрезентаций ордеров типа transfer
- first
- номер первого ордера в выборке ответов метода
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено ордеров, соответствующих фильтрам
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- не удалось найти валюту с переданным именем in_curr, out_curr
- EParamInvalid
- переданы неверные значения любого из параметров first, count
- EParamType
- переданы данные неверного типа для любого из параметров first, count
history.statement
Метод поиска и отображения движений средств по счетам мерчанта. Фильтры поиска объединяются логическим И.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| begin | нет | "123456789" | фильтр начала периода (timestamp). default="0" |
| count | нет | "132" | максимальный размер выборки ответов (значение не может превышать "200"). default="20" |
| curr | нет | "UAH" | название валюты платежа |
| end | нет | "234567890" | фильтр окончания периода (timestamp). default="now" |
| externalid | нет | "127" | фильтр по параметру externalid ордера |
| filter_amount | нет | ">123.4" | фильтр по сумме движения средств с операндом-условием. Возможные операнды: (+, -, <, <=, >, >=, =, !=). Если передано только число или число с операндом "+" или "-", то система использует логику "=". Операнды "+" или "-" могут передаваться без суммы, что будет означать только положительные или отрицательные значения соответственно |
| filter_fee | нет | ">13.4" | комиссия за данное движение средств. В его валюте с операндом-условием. Возможные операнды: (+, -, <, <=, >, >=, =, !=). Если передано только число или число с операндом "+" или "-", то система использует логику "=". Операнды "+" или "-" могут передаваться без суммы, что будет означать только положительные или отрицательные значения соответственно |
| first | нет | "32" | номер первого объекта в выборке ответов, с которого начнётся вывод набора движений средств и отсчёт параметра count. default="0" |
| group | нет | "inpay" | фильтр по типу ордера (возможные значения: "inpay", "outpay", "convert") |
| ord_by | нет | "amount" | сортировать объекты ("amount" - по сумме, "ctime" - по времени создания, "mtime" - по времени модификации) |
| ord_dir | нет | false | направление сортировки результатов, если передан ord_by(false=high->low, true=low->high). default=false |
Особенности обработки пары параметров begin, end
Аргументу begin система всегда присвоит меньшее значение из переданной пары, а для end - всегда большее. Вне зависимости от того, под каким из имён они были переданы
Данные ответа метода
Перечень параметров движения средств по счетам мерчанта в формате json массива
- count
- размер текущей выборки ответов
- data
- репрезентации найденых движений средств в формате json объекта
- amount - сумма изменения баланса мерчанта, указанная в движении средств по счетам
- balance - состояние баланса сразу после выполнения данного движения средств
- ctime - время (timestamp) создания движения средств по счетам мерчанта
- curr - валюта баланса
- externalid - внешний идентификатор ордера
- fee - сумма комиссии за операцию в валюте баланса
- model - общая модель, к которой относится платеж
- oid - идентификатор движения средств по счетам мерчанта
- other_curr - валюта ордера, по которому сформировано движение средств по счетам мерчанта
- payway - имя платежного метода (платежной системы)
- tp - тип ордера, по которому сформировано движение средств по счетам мерчанта
- masspay_lid - идентификатор массовой выплаты, если это обычный ордер значение будет
null
- first
- номер первого объекта в выборке ответов метода
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено объектов, соответствующих фильтрам запроса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- не удалось найти валюту с переданным именем curr
- EParamInvalid
- передано неверное значение параметра
- EParamType
- параметр содержит некорректный тип данных
- EStateCurrencyInactive
- валюта с переданным именем curr не активна(отключена)
history.address
Метод отображения перечня ордеров прямых пополнений криптоадреса с переданным addr_id и их параметров. В ответ попадут ордера только тех пополнений, которые были инициированы пользователями, а не системой (ордера типов payin и autopayin).
Фильтры поиска объединены логическим И.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| addr_id | да | "4356" | идентификатор криптоадреса |
| begin | нет | "123456789" | фильтр начала периода (timestamp). default="0" |
| count | нет | "99" | максимальный размер выборки ответов (значение не может превышать "200"). default="20" |
| end | нет | "234567890" | фильтр окончания периода (timestamp). default="now" |
| first | нет | "5" | номер объекта в полученной выборке результатов, с которого начнётся вывод JSON Array адресов и отсчет параметра count. default="0" |
| out_curr | нет | "USD" | фильтр по валюте зачисления для ордеров с автоконвертацией. В ответ метода попадут только ордера с автоконвертацией в переданную валюту |
| status | нет | "done" | фильтр по текущему статусу ордера (допустимые значения: "unfinished", "done", "fail") |
| tp | нет | "autopayin" | фильтр ордеров по типу (допустимые значения "payin, "invoice и "autopayin") |
Данные ответа метода
Перечень ордеров в формате json массива
- count
- размер текущей выборки ответов
- data
- репрезентации найденых ордеров в формате json объекта
- first
- номер первого ордера в выборке ответов метода
- page
- текущая страница ответов
- page_total
- всего страниц ответов
- total
- всего найдено ордеров, соответствующих фильтрам запроса
Возможные возвращаемые ошибки
- EParamCurrencyInvalid
- не удалось найти валюту с переданным именем out_curr
- EParamInvalid
- переданы неверные значения любого из параметров first, count, begin, end, tp, status
- EParamType
- переданы данные неверного типа для любого из параметров addr_id, is_autoconvert, first, count, begin, end, status
- EStateCurrencyInactive
- валюта с переданным именем out_curr не активна(отключена)
history.card_h2h
Метод отображения списка платежей типа card_h2h, созданных мерчантом. Результат возвращается в виде отсортированного по убыванию даты создания перечня платежей.
Входящие параметры метода
| Параметр | Обязательный параметр | Тип | Пример | Описание |
|---|---|---|---|---|
| count | нет | str | "10" |
ожидаемое количество платежей. По умолчанию "20". Значение не может превышать "200" |
| currency | нет | str | "UAH" |
валюта платежа |
| first | нет | str | "5" |
порядковый номер платежа с которого начнется отсчёт параметра count. По умолчанию "0" |
Данные ответа метода
| Параметр | Обязательный параметр | Тип | Пример | Описание |
|---|---|---|---|---|
| account_amount | да | str | "145.50" |
сумма зачисления на счёт мерчанта в валюте платежа за вычетом комиссии |
| amount | да | str | "150.75" |
сумма платежа |
| ctime | да | bigint | 1652701264396 |
время создания платежа (timestamp) |
| currency | да | str | "UAH" |
трехбуквенный код валюты платежа (согласно ISO 4217) |
| да | str or null | "[email protected]" |
адрес электронной почты плательщика, указанный при создании платежа. Будет null если адрес не был указан при создании |
|
| externalid | да | str | "1234567890" |
уникальный идентификатор созданного платежа, заданный мерчантом |
| fee_amount | да | str | "5.25" |
сумма комиссии в валюте платежа |
| lid | да | int | 47893 |
уникальный идентификатор созданного платежа в системе AnyMoney |
| merchant_payfee | да | str | "0.55" |
часть от общей суммы комиссии за платеж, которую оплачивает мерчант. Значение в интервале [0..1] c точностью до двух знаков после запятой |
| owner | да | int | 26 |
уникальный идентификатор мерчанта, создавшего пополнение |
| status | да | enum | "wait" |
текущий статус платежа, один из следующих: wait, done, fail, expired |
| tp | да | str | "card_h2h" |
тип платежа (всегда будет card_h2h) |
| acs_url | нет | str | "https://any.money/form/uxcERpIwkYLicBZGHr6jczDcLnCgQQBd6yPEOQd8bV_wyrTbPo2q2YRwVaBtb_P6m4_R" |
URL-адрес, на который нужно перенаправить плательщика для прохождения 3DS аутентификации. Возвращается только для платежа в статусе wait |
| card_mask | нет | str | "582703******3202" |
замаскированный номер карты, при помощи которой выполнялся платёж. Возвращается только в случае успешного завершения платежа (статус done) |
| card_token | нет | str | "4929a4cf-c2иe-5da9-b210-161b553a03a8" |
токен карты, при помощи которой выполнялся платёж. Возвращается только в случае успешного завершения платежа (статус done) и если при создании был указан "return_card_token": true |
| ftime | нет | bigint | 1655134605974 |
время финализации платежа (timestamp). Возвращается только для финализированных платежей в статусах done, fail, expired |
Возможные возвращаемые ошибки
- EParamType
- Неверный тип данных
- EParamCurrencyInvalid
- Указана неверная валюта платежа
- EParamInvalid
- Указано неверное значение переданного параметра