code
Методы модели code используются для предоставления мерчанту возможностей приема и выплат средств через кодовые платежные обязательства. Используя методы модели code мерчант может:
- Создать код платежа - метод code.create
- Проверить (верифицировать) код платежа - метод code.verify
- Использовать (акцептовать) код платежа - метод code.redeem
- Получить информацию о коде, использованном для платежа - метод code.get
endpoint
Запросы на работу методов модели отправляются на endpoint https://api.any.money/.
code.create
Метод создания кода заданной чековой платежной системы, в котором учитываются сумма и валюта платежа.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| amount | да | "655" | сумма выплаты (сумма, фиксированная в коде, а не снимаемая с баланса мерчанта) |
| curr | да | "UAH" | название валюты, в которой заказан платежный код |
| externalid | да | "235" | уникальный идентификатор, заданный мерчантом |
| payway | да | "anycash" | платежная система, через которую проводится выплата |
Внимание!
Для типизированных мерчантов значение payway должно совпадать с типом мерчанта, иначе возвратится ошибка
Внимание!
Сразу после поступления запроса вызывается его обработка, а после выполнения метода деньги будут списаны с баланса
Данные ответа метода
- code
- сгенерированный код
Возможные возвращаемые ошибки
- EParamAmountFormatInvalid
- неверное значение или формат параметра amount
- EParamAmountTooBig
- amount больше максимальной суммы операции
- EParamAmountTooSmall
- amount меньше минимальной суммы операции
- EParamCurrencyInvalid
- передана несуществующая входящая и/или исходящая валюта, валюта запрещена для использования данным мерчантом в указанной платёжной системе
- EParamInvalid
-
- неверное значение параметра amount
- не передан один из параметров externalid, payway, amount, curr
- payway не равен типу типизированного мерчанта
- EParamOffLimits
- передано значение параметра, превышающее ограничения
- EParamPaywayInvalid
- передана неверная платежная система, не чековая платежная система
- EParamType
- передан параметр externalid неподходящего формата
- EParamUnique
- ордер с таким externalid уже существует
- EStateCurrencyInactive
- передана неактивная валюта зачисления/пополнения
- EStateCurrencyUnavail
- передана валюта, недоступная в переданной ПС
- EStateInsufficientFunds
- amount больше чем баланс мерчанта в валюте пополнения
- EStateOutPayUnavailable
- выплаты во всей системе Any.Money или для данного мерчанта заблокированы
- EStatePaywayInactive
-
- платежная система неактивна в данный момент
- данная платежная система заблокирована в Any.Money административно
- EStatePaywayUnavail
- платежная система недоступна для данного мерчанта
- EStateUnavailable
- невозможно получить код от внешней системы
code.verify
Метод получения данных кода входящей оплаты по его полному номеру.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| code | да | "3453464745t8t8" | полный номер искомого кода |
Данные ответа метода
Репрезентация данных платежного кода
- amount
- сумма непогашенного кода (для кода ПС "EXMO" поле будет пустым)
- can_be_accepted
- возможно ли погашение кода (возможные значения: "yes", "no" или "unknown")
- currency
- наименование валюты платежа
- fee
- репрезентация комиссии погашения кода
- add - фиксированная сумма комиссии
- max - максимальная сумма комиссии
- min - минимальная сумма комиссии
- mult - процентная ставка комиссии
- method - метод взимания комиссии
- fee_value
- значение комиссии в валюте кодового платежа, если в ответе ПС указана сумма платежа. Иначе значение параметра равно "unknown"
- payway
- наименование кодовой платежной системы
Возможные возвращаемые ошибки
- EParamInvalid
- не передан параметр code, передано неверное значение параметра code
- EParamCodeInvalid
-
- код не может быть принят системой
- неверно указана валюта платежа
- зачисления не могут быть совершены - валюта зачисления платежа неактивна в переданной ПС
- код невалиден или его платежная система не поддерживается в Any.Money
- невозможно провести верификацию кода платежа
code.redeem
Метод обналичивание кодового платежа путем создания ордера пополнения кодом.
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| code | да | "3453464745t8t8" | полный номер кода внешней ПС |
| externalid | да | "123" | уникальный идентификатор, заданный мерчантом |
Данные ответа метода
Возможные возвращаемые ошибки
- EParamAmountTooBig
- сумма кодового платежа больше максимальной суммы конвертации
- EParamAmountTooSmall
- сумма кодового платежа меньше минимальной суммы операции
- EParamCodeInvalid
-
- код не может быть принят системой
- код не может быть погашен ни в одной из доступных ПС
- EParamCurrencyInvalid
- код создан в валюте, недоступной в Any.Money
- EParamInvalid
- не передан параметр externalid
- EParamType
- передан параметр externalid неподходящего формата
- EStatePaywayInactive
-
- платежная система кода неактивна в данный момент
- платежная система кода заблокирована в Any.Money административно
- EStatePaywayUnavail
- платежная система кода недоступна для данного мерчанта
code.get
Метод получения информации о коде по переданному идентификатору ордера (externalid).
Входящие параметры метода
| Параметр | Обязательный параметр | Пример | Описание |
|---|---|---|---|
| externalid | да | "123" | идентификатор ордера в системе магазина |
Данные ответа метода
- amount
- сумма платежа
- code
- сгенерированный код
- currency
- валюта платежа
Возможные возвращаемые ошибки
- EParamInvalid
- недопустимое значение externalid
- EParamNotFound
- не найден ордер c переданным externalid
- EParamType
- невалидный тип данных externalid
- EStateUnavailable
- невозможно получить информацию от внешней системы