Order
Методы возвращают значения только тех ключей, которые необходимы, остальные остаются пустыми.
Внимание!
Если платеж создан для платежной системы iban и валюты EUR, то необходимо дождаться промежуточного колбека от Any.Money, в котором будут возвращены реквизиты для отправки SEPA-перевода: payment_data. Эти данные необходимо предоставить плательщику для выполнения банковского перевода.
order params representation (full callback message)
Параметры ордера системы Any.Money
- account_amount
- сумма списания/зачисления, за вычетом комиссии
- address
- криптоадрес для оплаты пользователем в криптовалюте. При отплате несколькими платежами возвращается адрес последнего из них
- amount_paid
- параметр, возвращаемый только SCI методами, содержит сумму совершенных оплат в рамках sci-платежа
- code
- репрезентация данных кода
- confirmations
- количество подтверждений (подтвержденных блоков) для ордеров с участием криптовалют
- ctime
- время создания ордера (timestamp)
- delay
- время задержки перед выплатой(в миллисекундах). При пополнении этот параметр всегда будет равен "0"
- адрес электронной почты для отправки уведомлений об изменении состояния invoice-платежа
- externalid
- уникальный идентификатор, заданный мерчантом
- front_params
- перечень параметров мерчанта для настройки внешнего вида frontend в формате json объекта {ключ: значение} (только для ордеров типа invoice)
- ftime
- время финализирования ордера (timestamp)
- in_amount
- сумма пополнения
- in_curr
- валюта пополнения
- in_fee_amount
- сумма комиссии в валюте пополнения
- is_multipay
- флаг возможности доплаты, возврата средств, возврата переплаты по invoice-платежу. Для выплаты указывает была ли она выполнена несколькими транзакциями или одной
- lid
- локальный идентификатор ордера
- merchant_payfee
- доля комиссии за поступления, которую оплачивает мерчант (значения в интервале [0..1] c точностью до двух знаков после запятой)
- orig_amount
- оригинальная (целевая) сумма ордера (была заказана при создании ордера)
- out_amount
- сумма зачисления для данного ордера
- out_curr
- валюта зачисления
- out_fee_amount
- сумма комиссии в валюте зачисления
- owner
- идентификатор мерчанта, создавшего ордер
- payer
- идентификатор плательщика
- paylink
- поле, присущие только ордерам invoice. Содержит ссылку, ведущую на страницу оплаты
- payway_name
- имя платежной системы, используемой ордером. Заполняется только для singlepay платежей, а для multipay остаётся пустым (
"btc", "perfect", "qiwi"...и т.д.) - rate
- курс обмена валют, если проводилась конвертация. В формате
"rate": ["25.30301", "1"] - redirect_url
- URL, используемый во frontend для переадресации по умолчанию
- ref
- внутренний идентификатор ордера. Для операций с криптовалютами совпадает с tx_id
- renumeration
- пересчитанная сумма (для ордеров payout, если ордер был пересчитан), сумма возврата (для ордера invoice, если он оплачен с переплатой)
- reqdata
- оригинальные данные запроса в виде набора {ключ: значение}. Пример:
{amount: 10, externalid: 1556712010408, in_curr:UAH, out_curr:UAH, payway:privat24, userdata: {payee:4444444444444448}} - status
- актуальный статус ордера
- tgt
- мерчант, получатель платежа (для операций типа transfer)
- token
- уникальный ключ-идентификатор ордера
- tp
- тип ордера (Возможные варианты: "payin", "autopayin", "coderedeem", "payout", "convert", "transfer", "invoice", "sci_subpay", "sci_refund")
- txid
- идентификатор транзакции с участием криптовалют (значение true = в транзакции используется криптовалюта, false = только фиатные валюты)
- uaccount
- платежные реквизиты получателя платежа (для операций типов invoice, payout)
- userdata
- реквизиты получателя платежа (при использовании внешних платежных систем
{"payee": 4444444444444448}) - acs_url
- URL-адрес, на который нужно перенаправить плательщика для прохождения 3DS аутентификации. Возвращается только для платежа в статусе
wait - payment_data
- Данные для проведения платежа. Актуальные значения для выполнения платежа приходят на
callback_urlуказанный при создании ордера.- Для каждой платёжной системы будет свой набор полей:
iban:bank_address: адрес банка получателяbank_name: название банка получателяbeneficiary: имя получателя IBAN счётаbic: код банка получателяcountry: страна банкаiban: номер банковского счета в международном формате (IBAN) для перевода средств пользователемreference: назначение платежа, которое пользователь должен обязательно указать при переводе средств по номеру банковского счета IBANcard:card: номер картыreference: назначение платежа
restricted callback message representation
Сокращённое callback-сообщение, возвращаемое для ордеров типа autopayin.
Репрезентация сокращённого callback-сообщения
- account_amount
- сумма зачисления, за вычетом комиссии
- confirmations
- количество подтверждений (подтверждённых блоков)
- ctime
- время создания ордера (timestamp)
- ftime
- время финализирования ордера (timestamp)
- in_amount
- сумма пополнения
- in_curr
- валюта пополнения
- in_fee_amount
- сумма комиссии в валюте пополнения
- lid
- локальный идентификатор ордера
- out_amount
- сумма зачисления
- out_curr
- валюта зачисления
- out_fee_amount
- сумма комиссии в валюте зачисления
- payway_name
- наименование используемой платёжной системы
- status
- актуальный статус ордера
- tp
- тип ордера (autopayin)
- txid
- идентификатор транзакции с участием криптовалют (для ордеров с оплатой криптовалютой имеет значение true)
front_params fields description
Описание полей параметра front_params
- logo
- кастомный логотип для SCI (мерчант выбирает сам логотип для отображеия на SCI вместо стандартного лого ANYMONEY). Формат: изображение, конвертированное в формате base64. Пример:
logo: "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVV...." - theme
- задаёт режим день/ночь для SCI (значения: “night”, “day”, ”auto”)
- theme_color
- задаёт цветовую тему для элементов SCI, которую выбирает мерчант. Формат: “violet”, “yellow”, “red” и т.д.
order statuses description
Возможные состояния ордера
| status | final | description |
|---|---|---|
| new | no | принят на выполнение |
| partially_paid | no | invoice еще не оплачен в полном объеме но уже присутствует, как минимум, один успешно оплаченный платеж по данному invoice |
| pending | no | ожидает выполнения |
| started | no | в процессе выполнения |
| accepted | no | начато выполнение ордера после заданной задержки |
| wait | no | ожидает завершения |
| retry | no | выполнение после ошибки |
| abnormal | no | не определен (ошибка) |
| finalizing | no | в состоянии конвертации из валют поступления в валюту зачисления на invoice |
| done | yes | завершен успешно |
| partially_done | yes | платёж выплачен не полностью |
| fail | yes | завершен неуспешно |
| reject | yes | отказано |
| canceled | yes | отменен пользователем |
| expired | yes | истекло "временя жизни" (превышен lifetime или expiry) ордера |