payout
Используя методы модели payout мерчант может:
- Создать ордер выплаты - метод payout.create
- Рассчитать предварительные параметры ордера выплаты - метод payout.calc
- Получить информацию по выбранной операции выплаты - метод payout.get
- Отменить ордер выплаты - метод payout.cancel
endpoint
Запросы на работу методов модели отправляются на endpoint https://api.any.money/.
payout.create
Метод создает ордер операции выплаты и возвращает его репрезентацию.
Если параметр in_curr не передан, то его значение будет принято равным значению out_curr.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| amount | да | "128" | сумма выплаты |
| externalid | да | "123" | уникальный идентификатор, заданный мерчантом |
| out_curr | да | "UAH" | название валюты зачисления |
| payway | да | "anycash" | платежная система, через которую проводится выплата. * При отправке криптовалют необходимо передавать корректную комбинацию платежной системы и валюты согласно описания, иначе метод вернет ошибку |
| callback_url | нет | "https://any_money.redirect.com" | url-адрес для уведомлений про изменения состояния ордера, формат уведомлений |
| in_curr | нет | "USD" | название валюты списания |
| is_multipay | нет | true | указывает можно ли дробить на несколько транзакций данную выплату. По умолчанию true. В случае выплаты одной транзакцией, данная выплата ограничивается максимальным лимитом out_singlepay_max (см. метод payway.list) |
Комбинации payway и out_curr
| Криптовалюта | Параметр запроса payway | Параметр запроса out_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 |
В перечне входящих данных метода в зависимости от используемой платежной системы (payway) в запросе необходимо дополнительно передать следующие значения:
Обязательные параметры для указанных платёжных систем
- advcash, nixmoney, qiwi, payeer, perfect, webmoney
-
- payee - реквизиты получателя в ПС (номер кошелька)
- BTC, LTC, USDT, ETH
-
- payee - адрес криптовалюты
- cash
-
- contact - номер телефона или telegram username (e.g. "380441232344")
- region - наименование региона платежа (e.g. "kiev")
- iban UAH
-
- payee - номер счёта IBAN получателя
- individual_tax_number - ИНН получателя
- recipient_name - полное имя получателя (имя и фамилия латиницей или кирилицей)
- sender_name - ФИО отправителя
- iban EUR
-
- payee - номер счёта IBAN получателя
- recipient_name - полное имя получателя (имя и фамилия латиницей e.g. "Elon Musk")
- mobile
-
- payee - телефонный номер получателя. В международном формате, без "+" (e.g. "380661234567")
- privat24, monobank, sberbank, alfa_bank, tinkoff_cs, vtb24, card UAH, visamc_p2p
-
- payee - номер платежной карты
- card EUR/USD
-
- payee - номер платежной карты
- recipient_name - полное имя получателя (имя и фамилия латиницей e.g. "Elon Musk")
- recipient_phone - телефонный номер получателя. В международном формате, без "+" (e.g. "380661234567")
Внимание!
Для типизированных мерчантов передаваемая платежная система должна совпадать с типом мерчанта, а значение in_curr должно быть равно out_curr или отсутствовать, иначе будут возвращены ошибки
Внимание!
Сразу после поступления запроса создается ордер и вызывается его обработка, а после выполнения метода деньги будут списаны с баланса
Данные ответа метода
репрезентация ордера операции выплаты
Возможные возвращаемые ошибки
- EParamAmountFormatInvalid
- неверное значение или формат параметра amount
- EParamAmountTooBig
- amount больше максимальной суммы операции
- EParamAmountTooSmall
- amount меньше минимальной суммы операции
- EParamCurrencyInvalid
- валюта отсутствует в Any.Money
- EParamFieldInvalid
- передан невалидный параметр callback_url
- EParamInvalid
-
- передано неверное значение параметра
- переданная ПС не соответствует типу мерчанта
- EParamOffLimits
- передан параметр, превышающий ограничения
- EParamPaywayInvalid
- передана неверная платежная система
- EParamUnique
- ордер с таким externalid уже существует
- EStateCurrencyInactive
- передана неактивная валюта списания и/или зачисления
- EStateCurrencyUnavail
- передана валюта недоступная в переданной ПС
- EStateExchangeUnavail
-
- данное направление обмена недоступно
- in_curr отличается от out_curr для типизированного мерчанта
- EStateInsufficientFunds
- amount больше чем баланс мерчанта в валюте списания
- EStateOutPayUnavailable
- выплаты во всей системе Any.Money или для данного мерчанта заблокированы
- EStatePaywayInactive
-
- платежная система неактивна в данный момент
- данная платежная система заблокирована в Any.Money административно
- EStatePaywayUnavail
- платежная система недоступна для данного мерчанта
- EStatePwcurrencyUnavail
- данная валюта платежной системы недоступна
- EStatePwcurrencyInactive
- данная валюта платежной системы неактивна
payout.calc
Метод расчета параметров выплаты с учётом суммы.
Если параметр in_curr не передан, то будет произведен расчет выплаты в валюте out_curr и снятие средств с баланса out_curr с учетом комиссии для переданной платежной системы payway.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| amount | да | "238" | сумма выплаты |
| out_curr | да | "USD" | название валюты зачисления |
| payway | да | "anycash" | платежная система, через которую проводится выплата |
| in_curr | нет | "UAH" | название валюты списания |
Внимание!
Для типизированных мерчантов передаваемая платежная система должна совпадать с типом мерчанта, а значение in_curr должно быть равно out_curr или отсутствовать, иначе будут возвращены ошибки
Данные ответа метода
Параметры ордера выплаты
- account_amount
- сумма списания за вычетом комиссии
- in_amount
- сумма списания
- in_fee_amount
- сумма комиссии в валюте списания
- orig_amount
- оригинальная сумма выплаты, которая была заказана при создании ордера
- out_amount
- сумма зачисления
- out_fee_amount
- сумма комиссии в валюте зачисления
- rate
- курс обмена валют, если проводилась конвертация. В формате
"rate": ["25.30301", "1"]
Возможные возвращаемые ошибки
- EParamAmountFormatInvalid
- неправильный формат параметра amount
- EParamAmountTooBig
- amount больше максимальной суммы операции выплаты
- EParamAmountTooSmall
- amount меньше минимальной суммы операции выплаты
- EParamCurrencyInvalid
- валюта отсутствует в системе
- EParamInvalid
-
- передано неверное значение параметра in_curr
- переданная ПС не соответствует типу мерчанта
- EParamPaywayInvalid
- передана неверная платежная система
- EStateCurrencyInactive
- зачисления в валюте не могут быть совершены - она неактивна в переданной ПС
- EStateExchangeUnavail
-
- данное направление обмена недоступно
- in_curr отличается от out_curr для типизированного мерчанта
- EStateInsufficientFunds
- обрабатываемая сумма больше чем баланс мерчанта в валюте пополнения
- EStatePaywayInactive
-
- платежная система неактивна в данный момент
- данная платежная система заблокирована в Any.Money административно
- EStatePaywayUnavail
- платежная система недоступна для данного мерчанта
- EStatePwcurrencyUnavail
- данная валюта платежной системы недоступна
- EStatePwcurrencyInactive
- данная валюта платежной системы неактивна
payout.get
Метод получения репрезентации параметров ордера выплаты по его идентификатору (externalid).
Входящий параметр метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| externalid | да | "221" | уникальный идентификатор ордера, заданный мерчантом |
Данные ответа метода
репрезентация ордера операции выплаты
Возможные возвращаемые ошибки
- EParamInvalid
- передано неверное значение параметра externalid
- EParamNotFound
- не найден ордер c соответствующим externalid
- EParamType
- формат переданного externalid не соответствует ожидаемому
payout.cancel
Метод отмены ордера выплаты по его идентификатору (externalid). Возвращает репрезентацию отменённого ордера.
Входящий параметр метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| externalid | да | "221" | уникальный идентификатор ордера, заданный мерчантом |
Данные ответа метода
репрезентация данных отменённого ордера операции выплаты
Возможные возвращаемые ошибки
- EParamInvalid
- не передано или передано неверное значение параметра externalid
- EParamNotFound
- не найден ордер c соответствующим externalid
- EParamType
- формат переданного externalid не соответствует ожидаемому
- EStateForbidden
- ордер финализирован, отменить его невозможно