payway
Используя методы модели payway мерчант может:
- Получить список доступных для работы платежных систем и их параметров - метод payway.list
- Активировать для работы с мерчантом платежную систему - метод payway.activate
- Деактивировать для работы с мерчантом платежную систему - метод payway.deactivate
endpoint
Запросы на работу методов модели отправляются на endpoint https://api.any.money/.
payway.list
Метод возвращает перечень платежных систем, доступных мерчанту, и их параметры и валюты.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| - | - | - | - |
Данные ответа метода
- active_in_system
- активна ли ПС в системе Any.Money
- active_for_merchant
- активна ли ПС для данного мерчанта
- is_public
- может ли мерчант активировать/деактивировать данную ПС
- payin_allowed
- ПС может принимать входящие платежи
- tp
- тип платежной системы. Возможные значения: "sci", "crypto", "cheque", "cash"
- {Наименование валюты в данной ПС}, ее параметры:
- in_fee - репрезентация комиссии пополнения в данной валюте
- add - фиксированная сумма комиссии пополнения
- max - максимальная сумма комиссии пополнения
- method - метод округления комиссии пополнения
- min - минимальная сумма комиссии пополнения
- mult - процентная ставка комиссии пополнения
- in_tech_max - максимальная сумма пополнения (если пополнение доступно)
- in_tech_min - минимальная сумма пополнения (если пополнение доступно)
- out_fee - репрезентация комиссии зачисления в данной валюте
- add - фиксированная сумма комиссии зачисления
- max - максимальная сумма комиссии зачисления
- method - метод округления комиссии зачисления
- min - минимальная сумма комиссии зачисления
- mult - процентная ставка комиссии зачисления
- out_multipay_max - максимальная сумма зачисления несколькими транзакциями (если зачисление доступно)
- out_singlepay_max - максимальная сумма зачисления одной транзакцией (если зачисление доступно)
- out_tech_max - максимальная сумма зачисления, эквивалентна значению
out_multipay_maxилиout_singlepay_maxисходя из настройки "Дробление переводов" в личном кабинете - out_tech_min - минимальная сумма зачисления (если зачисление доступно)
- prec - значение минимального зерна валюты
Возможные возвращаемые ошибки
payway.activate
Метод изменяет статус (активирует) переданного платежного метода (ПС) для запросившего мерчанта и возвращает результат изменения.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| payway | да | "anycash" | наименование платежного метода (платежной системы), который нужно активировать |
| is_out | нет | False | направление платежной системы, которую нужно активировать(True = выплаты, False = зачисления). Если не указано активируюет оба направления. |
Данные ответа метода
- is_active
- состояние ПС для актуального мерчанта
- m_lid
- локальный идентификатор мерчанта
- payway
- наименование платежного метода (ПС)
Возможные возвращаемые ошибки
- EParamMerchantInvalid
- мерчант неактивен, запрос поступил от удаленного ранее или скрытого мерчанта
- EParamNotFound
- мерчант не найден
- EParamPaywayInvalid
- не найдена ПС с таким именем
- EStateForbidden
- запрещено менять статус ПС, привязанной к мерчанту
- EStateMerchantInactive
- запрос поступил от заблокированного мерчанта
- EStatePaywayUnavail
- мерчант не может активировать данную ПС (она не является публичной)
payway.deactivate
Метод деактивирует платежную систему для запросившего мерчанта.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| payway | да | "anycash" | наименование платежного метода (платежной системы), которую нужно деактивировать |
| is_out | нет | False | направление платежной системы, которую нужно деактивировать. Если не указано деактивировать оба направления. |
Данные ответа метода
- is_active
- статус ПС для запросившщего мерчанта
- m_lid
- локальный идентификатор мерчанта
- payway
- наименование деактивированного платежного метода (ПС)
Возможные возвращаемые ошибки
- EParamMerchantInvalid
- мерчант неактивен, запрос поступил от удаленного ранее или скрытого мерчанта
- EParamNotFound
- мерчант не найден
- EParamPaywayInvalid
- не найдена ПС с таким именем
- EStateForbidden
- запрещено менять статус ПС, привязанной к мерчанту
- EStateMerchantInactive
- запрос поступил от заблокированного мерчанта
- EStatePaywayUnavail
- мерчант не может деактивировать данную ПС (она не является публичной)