transfer
Используя методы модели transfer мерчант может:
- Создать ордер перевода средств методом transfer.create;
- Рассчитать предварительные параметры перевода - метод transfer.calc;
- Получить информацию о выбранном переводе - метод transfer.get
- Отменить ордер перевода средств - метод transfer.cancel
endpoint
Запросы на работу методов модели отправляются на endpoint https://api.any.money/.
transfer.create
Метод создания ордера перевода средств между балансами мерчантов. Если в запросе не указана валюта пополнения, то для расчета применяется такая же in_curr мерчанта-плательщика, как и out_curr запроса.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| amount | да | "435345,34" | сумма перевода в валюте зачисления |
| externalid | да | "123" | уникальный идентификатор, заданный мерчантом |
| out_curr | да | "USD" | валюта зачисления |
| tgt | да | "1056" | адресат трансфера средств, (lid мерчанта, которому адресован перевод) |
| callback_url | нет | "https://any_money.callback.com" | url-адрес, на который будет автоматически отправляться информация про изменения состояния ордера, формат уведомлений |
| in_curr | нет | "UAH" | валюта пополнения |
Внимание!
Для типизированных мерчантов переданный тип получателя tgt должен совпадать с типом мерчанта-плательщика, а in_curr должна быть равной out_curr или отсутствовать, иначе будут возвращены ошибки
Внимание!
Сразу после поступления запроса создается ордер и вызывается его обработка, а после выполнения метода деньги будут списаны с баланса
Данные ответа метода
репрезентация параметров ордера операции типа transfer
Возможные возвращаемые ошибки
- EParamAmountFormatInvalid
- неправильный формат параметра amount
- EParamAmountTooBig
- amount больше максимальной суммы операции трансфера
- EParamAmountTooSmall
- amount меньше минимальной суммы операции трансфера
- EParamCurrencyInvalid
- не передан out_curr параметр, либо указана несуществующая валюта
- EParamFieldInvalid
- передан невалидный параметр callback_url
- EParamInvalid
-
- передано неверное значение параметра
- переданный tgt не соответствует типу мерчанта
- EParamMerchantInvalid
- мерчант (получатель перевода) неактивен
- EParamOffLimits
- передано значение параметра, превышающее ограничения
- EParamType
- неверный тип данных параметра tgt
- EParamUnique
- ордер с таким externalid уже существует
- EStateCurrencyInactive
- указана неактивная валюта пополнения/зачисления
- EStateExchangeUnavail
-
- данное направление обмена недоступно
- in_curr отличается от out_curr для типизированного мерчанта
- EStateInsufficientFunds
- у пользователя недостаточно средств в валюте пополнения для выполнения перевода или для конвертации в заказанную сумму валюты зачисления
- EStateOutPayUnavailable
- заблокированы выплаты и переводы во всей системе или для данного мерчанта
transfer.calc
Метод расчета параметров ордера перевода средств при известной сумме.
Если в запросе не указана валюта пополнения, то для расчета будет применена такая же валюта пополнения, что и валюта зачисления (out_curr) запроса.
Метод проводит расчет и возвращает репрезентацию параметров транзакции перевода.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| amount | yes | "1000" | сумма трансфера |
| out_curr | yes | "USD" | валюта зачисления |
| in_curr | no | "USD" | валюта списания |
| tgt | no | "6489" | адресат трансфера средств (lid мерчанта, которому адресован перевод). Если параметр передан, то будет произведен расчет с учетом параметров (индивидуальных комиссий) получателя |
Внимание!
Для типизированных мерчантов переданный тип получателя tgt должен совпадать с типом мерчанта-плательщика, а in_curr должна быть равной out_curr или отсутствовать, иначе будут возвращены ошибки
Данные ответа метода
- account_amount
- сумма, снимаемая с баланса плательщика (in_amount+in_fee_amount)
- in_amount
- сумма пополнения ордера
- in_fee_amount
- сумма комиссия ордера в валюте пополнения
- orig_amount
- оригинальная сумма (которая была заказана при создании ордера)
- out_amount
- сумма зачисления ордера
- out_fee_amount
- сумма комиссии ордера в валюте зачисления
Возможные возвращаемые ошибки
- EParamAmountFormatInvalid
- неправильный формат параметра amount
- EParamAmountTooBig
- amount больше максимальной суммы операции трансфера
- EParamAmountTooSmall
- amount меньше минимальной суммы операции трансфера
- EParamCurrencyInvalid
- не передан out_curr параметр, либо указана несуществующая валюта
- EParamInvalid
-
- передано неверное значение параметра
- переданный tgt не соответствует типу мерчанта
- EStateCurrencyInactive
- указана неактивная валюта пополнения/зачисления
- EStateExchangeUnavail
-
- данное направление обмена недоступно
- in_curr отличается от out_curr для типизированного мерчанта
- EStateInsufficientFunds
- у пользователя недостаточно средств в валюте пополнения для выполнения перевода или для конвертации в заказанную сумму валюты зачисления
transfer.get
Метод поиска и отображения ордера перевода средств между балансами мерчантов (ордера типа transfer) по его идентификатору.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| externalid | да | "123" | уникальный идентификатор, заданный мерчантом |
Данные ответа метода
репрезентация параметров ордера операции типа transfer
Возможные возвращаемые ошибки
- EParamInvalid
- передано неверное значение параметра externalid
- EParamNotFound
- не найден ордер c переданным externalid
transfer.cancel
Метод отменяет ордер перевода средств по его идентификатору. Возвращает репрезентацию параметров отменённого ордера.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| externalid | да | "123" | уникальный идентификатор ордера, который необходимо отменить |
Данные ответа метода
репрезентация параметров отменённого ордера операции перевода средств
Возможные возвращаемые ошибки
- EParamInvalid
- не передано или передано неверное значение параметра externalid
- EParamNotFound
- не найден ордер c переданным externalid
- EParamType
- передан externalid несоответствующего формата
- EStateForbidden
- ордер финализирован, отменить его невозможно