Перейти к основному содержимому

7. Расширения API

Следующие методы являются расширениями API для выполнения определённой специализированной функции.

7.1 Подтверждение возможности оплаты (payment_check)​

Проверочный запрос к ТСП для подтверждения возможности совершения оплаты с заданными параметрами. По умолчанию режим дополнительной проверки перед тарификацией отключен, подключается технической поддержкой Миксплат. Запрос payment_check производится до момента тарификации пользователя и подразумевает бинарный ответ от ТСП: произоводить ли списание денег с пользователя, либо нет. В случае ответа "нет" пользователю будет отображена ошибка о невозможности оплаты.

Направление запроса: Миксплат → ТСП
Тип запроса: POST-JSON (см. раздел 5.6)
URL запроса: задаётся в настройках проекта в личном кабинете Миксплат

Параметры запроса:

api_versionint

Версия API. Текущая актуальная версия: 3.

requeststring

Тип уведомления. В данном методе передаётся значение payment_check.

payment_idstring

ID платежа в Миксплат.

project_idint

ID проекта в Миксплат, для которого был создан платёж.

testint

Признак тестового платежа.

  • 1: Платёж тестовый
  • 0: Платёж реальный
merchant_payment_idstring|null

ID платежа в ТСП, или NULL, если он не был указан при создании платежа.

merchant_datastring|null

Произвольные данные ТСП, связанные с возвратом, или NULL, если они не были указаны при создании платежа.

date_createdstring

Дата и время создания платежа (по UTC+03:00).
Формат: YYYY-MM-DD HH:MM:SS

currencystring

Валюта платежа (см. раздел 6.1).

amountint

Сумма платежа в минорных единицах (копейках).

payment_methodstring

Платёжный метод, который был использован для оплаты (см. раздел 6.8)

user_phonestring|null

Номер телефона абонента, если известен.

cardjson|null

Дополнительная информация, специфичная для группы платёжных методов "card" (см. раздел 3.2.3.1).

Присутствует только для платежей с payment_method_group="card"
bankjson|null

Дополнительная информация, специфичная для группы платёжных методов "bank" (см. раздел 3.2.3.2).

Присутствует только для платежей с payment_method_group="bank"
mobilejson|null

Дополнительная информация, специфичная для группы платёжных методов "mobile" (см. раздел 3.2.3.3).

Присутствует только для платежей с payment_method_group="mobile"
walletjson|null

Дополнительная информация о платеже, специфичная для группы платёжных методов "wallet" (см. раздел 3.2.3.4).

Присутствует только для платежей с payment_method_group="wallet"
signaturestring

Принцип формирования:
md5 (payment_id+API_KEY)

Символ "+" означает конкатенацию, payment_id — это строковые представления соответствующих параметров запроса, API_KEY — это секретный ключ сервиса для API запросов, узнать который можно в личном кабинете в настройках проекта.

Пример формирования:
md5(707607041c23a4398db8ef7b3ae1f4b07aeeb7c54f8e3c7c9)

Результат:
047780e4f51dc6664d333536a6b4aab8

Параметры ответа от ТСП

resultstring

Результат выполнения запроса (см. раздел 6.4).

При успешном выполнении метода "result":"ok"

error_descriptionstring

Описание ошибки, возникшей при обработке уведомления.

Необязательный, может присутствовать в случае возникновения ошибки при выполнении запроса
allowint

Подтверждает ли ТСП выполнение платежа:

  • 1: Выполнение подтверждается
  • 0: Выполнение запрещается
messagestring

Текст SMS сообщения, которое будет отправлено Плательщику.

Необязательный
amountint

Новая сумма платежа (в минорных единицах).

Необязательный

Пример уведомления и ответа

Уведомление от Миксплат

POST <URL обработчика ТСП>
{
    "api_version"          : 3,
    "request"              : "payment_check",
    "payment_id"           : "XXehOfcV7wM2z7YGFHs5vCYEeCrbD3mh",
    "project_id"           : 1203,
    "test"                 : 0,
    "amount"               : 12000,
    "currency"             : "RUB",
    "date_created"         : "2028-02-29 11:22:33",
    "user_phone"           : "79261000000",
    "mobile" :
    {
        "payment_system"    : "mobile_ru_megafon",
        "billing_type"      : "mc",
        "mccmnc"            : 25002,
        "sender"            : "3434",
        "text_raw"          : "OKR 456",
        "prefix"            : "OKR",
        "text_after_prefix" : "456"
    },
    "signature" : "d9729feb74992cc3482b350163a1a010"
}

Успешный ответ от ТСП, платёж можно продолжать

{
    "result" : "ok",
    "allow"  : 1
}

Успешный ответ от ТСП, платёж не производить

{
    "result" : "ok",
    "allow"  : 0
}

Ответ от ТСП в случае возникновения системной ошибки. Миксплат в таком случае будет направлять в ТСП повторные запросы.

{
    "result"  : "error",
    "error_description" : "database timeout"
}

7.2 Инициация низкоуровневого платежа (create_payment)​

Создание нового платежа без переадресации Плательщика на платёжную форму Миксплат. Реквизиты плательщика, требуемые для выполнения платежа, передаёт ТСП. Используйте этот метод, если у вас есть сертификат PCI DSS.

Направление запроса: ТСП → Миксплат
Тип запроса: POST-JSON (см. раздел 5.6)
URL запроса: Предоставляется после получения отчёта о соответствии требованиям PCI DSS (AOC)

Параметры запроса:

api_versionint

Версия API. Текущая актуальная версия: 3.

Обязательный параметр

project_idint

ID проекта ТСП в Миксплат, для которого создаётся платёж. Значение параметра отображается в личном кабинете Миксплат в настройках проекта.

Обязательный параметр

amountint

Сумма платежа в минорных единицах (копейках).
От 100 (1₽) до 100000000 (1млн₽) для payment_method = card
От 1000 (10₽) до 1500000 (15тыс₽) для payment_method = mobile
Для конкретных проектов могут действовать более строгие ограничения.

Обязательный параметр
signaturestring

Подпись запроса.

Обязательный параметр

Принцип формирования:
md5 (request_id+project_id+merchant_payment_id+API_KEY)

Символ "+" означает конкатенацию, request_id, project_id, merchant_payment_id — это строковые представления соответствующих параметров запроса, API_KEY — это секретный ключ сервиса для API запросов, узнать который можно в личном кабинете в настройках проекта. Если какой-либо из параметров не указан, то вместо его значения нужно использовать пустую строку.

Пример формирования:
md5(324223100057payment123c23a4398db8ef7b3ae1f4b07aeeb7c54f8e3c7c9)

Результат:
510c464ec7337858f6f662cbdeda9ac5

Пример реализации:

$api_key = '6yh9ik3f1734f29e3dc0118034277e67504rfjj9';
$project_id = 123456;
$request_id = 'test_request_id';
$merchant_payment_id = 'test_merchant_payment_id';
$signature = md5($request_id.$project_id.$merchant_payment_id.$api_key);
descriptionstring|null

Описание платежа. Отображается на платёжной форме и в личном кабинете ТСП.

Необязательный параметр. По умолчанию "Оплата заказа". От 3 до 125 символов.
request_idstring|null

Уникальный идентификатор запроса, задаваемый ТСП, обеспечивающий идемпотентность вызовов (повторные запросы с тем же request_id не будут приводить к созданию нового платежа, а параметры ответа будут полностью повторять параметры ответа первоначального вызова с данным request_id).

Рекомендуется передавать этот параметр, чтобы защититься от дублирования платежей в результате сетевых проблем, задержек ответа и т. п.

В качестве request_id можно использовать идентификатор платежа в системе ТСП (если он уникален), или хеш от ключевых параметров запроса.

Проверка наличия другого запроса с данным request_id осуществляется за последние 30 дней.

Необязательный параметр. От 1 до 64 символов.
payment_methodstring|null

Платёжный метод (см. раздел 6.8), который будет использован для совершения оплаты.

Необязательный. По умолчанию не задан (все доступные методы).
merchant_payment_idstring|null

ID платежа в ТСП. Если передан, то это же значение параметра будет приходить в уведомлениях payment_status

Необязательный параметр. От 1 до 256 символов.
merchant_campaign_idstring|null

ID кампании в ТСП. Если передан, то это же значение параметра будет приходить в уведомлениях payment_status

Необязательный параметр. От 1 до 256 символов.
merchant_datastring|null

Произвольные данные ТСП, связанные с платежом. Если передан, то это же значение параметра будет приходить в уведомлениях payment_status

Необязательный параметр. От 1 до 256 символов.
merchant_fieldsjson-object|null

Массив дополнительных сведений о транзакции, которые ТСП может передать при создании платежа.

При уведомлении о статусе оплаты этот массив будет возвращен вместе с остальными параметрами в уведомлении payment_status

Может применяться для передачи сопутствующих данных о плательщике или товаре: по значениям в массиве возможна фильтрация платежей в личном кабинете и выгружаемых XLS отчетах.

Пример:

{
    "Cookie": "HunjV5LHOvDIF",
    "client-category": "VIP",
    "Возраст": 33
}
Необязательный параметр.
user_emailstring|null

Email плательщика (если известен), для отправки email о совершённом платеже.

Необязательный параметр.
user_namestring|null

Имя плательщика (если известно), для отправки email о совершённом платеже.

Необязательный параметр.
user_phonestring|null

Номер телефона плательщика (если известен), только цифры, в международном формате, с кодом страны.

Необязательный параметр.
user_commentstring|null

Пользовательский комментарий к платежу (если есть).

Необязательный параметр.
user_account_idstring|null

Идентификатор пользователя в ТСП (если есть).

Необязательный параметр.
testint|null

Признак тестового платежа.

  • 1: Платёж тестовый
  • 0: Платёж реальный

Для тестовых платежей необходимо указывать специальные номера банковских карт/номера телефонов (раздел 5.5).

Необязательный параметр. По умолчанию 0 (Платёж реальный).
timeoutint|null

Время в секундах, отведенное на оплату.

После окончания времени на оплату платёж получит статус таймаут и оплата по данному payment_id будет невозможна. Для повторной оплаты необходимо создать новый платёж.

Необязательный параметр. По умолчанию 21600 (6 часов).
languagestring|null

Язык платёжной формы, сервисных сообщений (см. раздел 6.2).

Необязательный параметр. По умолчанию "RU" или "EN" в зависимости от IP пользователя.
currencystring|null

Валюта платежа (см. раздел 6.1).

Необязательный параметр. По умолчанию RUB.
itemsjson-object|null

Данные для чека. Описание структуры – в разделе 3.7

Пример:

[
    {
        "name": "Xiaomi MI",
        "quantity": 2,
        "sum": 3500000,
        "vat": "vat20"
    }
]
Необязательный параметр.
redirect_urlstring|null

URL на который будет перенаправлен Плательщик после ввода кода 3D Secure.

Обязательный параметр в случае payment_method=card

recurrent_paymentint|null

Признак установочного платежа для последующих безакцептных списаний в режиме рекуррентов (раздел 3.5) или в режиме подписки (раздел 3.4)

  • 1: Платёж рекуррентный
  • 0: Платёж обычный.
Необязательный параметр. По умолчанию 0 (платёж обычный).
payment_schemestring|null

Схема проведения платежа по банковским картам (см. раздел 4.3). Возможные значения см. в разделе 6.11

Необязательный параметр. По умолчанию "single".
utm_mediumstring|null

UTM-метка, определяющая тип трафика. Если параметр передан, то это же значение параметра будет приходить в уведомлениях payment_status.

Необязательный параметр.
utm_sourcestring|null

UTM-метка, определяющая источник трафика. Если параметр передан, то это же значение параметра будет приходить в уведомлениях payment_status.

Необязательный параметр.
utm_campaignstring|null

UTM-метка, определяющая рекламную кампанию. Если параметр передан, то это же значение параметра будет приходить в уведомлениях payment_status.

Необязательный параметр.
utm_termstring|null

Произвольная пользовательская UTM-метка. Если параметр передан, то это же значение параметра будет приходить в уведомлениях payment_status.

Необязательный параметр.

Параметры ответа от Миксплат

resultstring

Результат выполнения запроса (см. раздел 6.3).

При успешном выполнении метода "result": "ok"

Значение result = ok является подтверждением получения платёжного запроса, и не относится к статусу самого платежа.

error_descriptionstring

Описание ошибки, возникшей при выполнении запроса.

Присутствует только в случае ошибки при выполнения метода (result != ok).

payment_idstring|null

ID созданного платежа.

Присутствует только в случае ошибки при выполнения метода (result = ok).

recurrent_idstring|null

ID привязанной карты, далее вы можете использовать этот идентификатор и инициировать повторные платежи методом create_recurrent_payment без необходимости подтверждения со стороны плательщика.

Присутствует только в случае успешного выполнения метода (result = ok) и подключенного в настройках платёжной формы режима "подписка" или "рекуррентные платежи".
redirect_urlstring|null

URL, на который необходимо перенаправить Плательщика.

Например, при группе платёжных методов "Банковские карты" payment_method_group=card — это URL ACS страницы банка-эмитента, или иной внутренний URL банковского биллинга.

Присутствует только в случае ошибки при выполнения метода (result = ok).

Пример запроса и ответа

Запрос от ТСП

POST https://api.mixplat.com/create_payment
{
    "api_version"          : 3,
    "project_id"           : 1203,
    "request_id"           : "324223",
    "payment_method"       : "mobile"
    "user_phone"           : "79031234567"
    "merchant_payment_id"  : "571",
    "description"          : "Оплата заказа №571 по счёту от 12.08",
    "amount"               : 20000,
    "signature"            : "d9729feb74992cc3482b350163a1a010"
}

Успешный ответ от Миксплат

{
    "result"           : "ok",
    "payment_id"       : "1234567890",
    "recurrent_id"     : "7654321"
}

Ответ от Миксплат при возникновении ошибки

{
    "result"            : "error_project_not_found",
    "error_description" : "Project 1203 is not active"
}

7.3 Получение информации об операторе (phone_info)​

Получение информации об операторе и коммерческих условиях по номеру телефона абонента.

Направление запроса: ТСП → Миксплат
Тип запроса: POST-JSON (см. раздел 5.6)
URL запроса: https://api.mixplat.com/phone_info

Параметры запроса:

api_versionint

Версия API, всегда "3".

project_idint

ID проекта в Миксплат, для которого выполняется запрос.

user_phonestring

Номер телефона в международном формате без символа "+".

signaturestring

Подпись запроса.
Принцип формирования:
md5 (project_id+user_phone+API_KEY)

Символ "+" означает конкатенацию, project_id, user_phone — это строковые представления соответствующих параметров запроса, API_KEY — это секретный ключ сервиса для API запросов, узнать который можно в личном кабинете в настройках проекта. Если какой-либо из параметров не указан, то вместо его значения нужно использовать пустую строку.

Пример формирования:
md5(100079261234567c23a4398db8ef7b3ae1f4b07aeeb7c54f8e3c7c9)

Результат:
cfa1c4dc92d9257a440e623fed01d172

Параметры ответа

resultstring

Результат выполнения запроса (см. раздел 6.3).
При успешном выполнении метода "result": "ok"

error_descriptionstring

Описание ошибки, возникшей при выполнении запроса.

Присутствует только в случае возникновения ошибки при выполнении запроса.
mobile_payment_activeint

Активен ли платёжный метод "mobile" у указанного номера:

  • 1: Активен
  • 0: Неактивен
countrystring|null

Двухсимвольный код страны оператора сотовой связи

operatorstring

Символьное наименование оператора сотовой связи телефонного номера абонента.

mccmncint

Код оператора сотовой связи телефонного номера абонента в стандарте MCCMNC.

regionstring

Регион телефонного номера абонента.

fee_usernumeric|null

Процент комиссии, взымаемой с Плательщика, либо NULL, если платёжный метод не определён. Дробное число с разделителем-точкой.

fee_merchantnumeric|null

Процент комиссии, взымаемой с ТСП, либо NULL, если платёжный метод не определён. Дробное число с разделителем-точкой.

Пример запроса и ответа

Запрос от ТСП к Миксплат

POST https://api.mixplat.com/phone_info
{
    "api_version" : 3,
    "project_id"  : 1203,
    "user_phone"  : "79261000000",
    "signature"   : "d9729feb74992cc3482b350163a1a010"
}

Успешный ответ Миксплат

{
    "result"                : "ok",
    "mobile_payment_active" : 1,
    "operator"              : "МегаФон",
    "mccmnc"                : 25002,
    "region"                : "Москва",
    "country"               : "RU",
    "fee_user"              : 0,
    "fee_merchant"          : 14.5
}

Ответ Миксплат в случае возникновения ошибки

{
    "result"            : "error_project_not_found",
    "error_description" : "Project is not found"
}

7.4 Получение текста sms с короткого номера (sms)​

С помощью данного функционала можно получать текст sms на ваш обрабочик методом POST-JSON, отправленный абонентом на короткий номер. Ваш url обработчика, на который Миксплат будет отправлять запросы нужно прописать в личном кабинете Миксплат или через техническую поддержку.

Cкачать пример реализации обработчика на языке программирования PHP.

Направление запроса: Миксплат → ТСП
Тип запроса: POST-JSON (см. раздел 5.7)
URL запроса: задаётся в настройках проекта в личном кабинете Миксплат

Параметры запроса:

api_versionint

Версия API, всегда "3".

requeststring

Тип уведомления. В данном методе передаётся значение sms

project_idint

ID проекта в Миксплат.

date_createdstring

Дата и время создания SMS (по UTC+03:00).
Формат: YYYY-MM-DD HH:MM:SS

sms_idint

ID sms в Миксплат.

partsint

Количество частей, из которых состоит SMS.

user_phonestring

Номер телефона в международном формате без символа "+".

mobilejson

Дополнительная информация о sms, специфичная для мобильных операторов (см. раздел 3.2.3.3).

signaturestring

Принцип формирования:
md5 (sms_id+API_KEY)

Символ "+" означает конкатенацию, sms_id — это строковые представления соответствующих параметров запроса, API_KEY — это секретный ключ сервиса для API запросов, узнать который можно в личном кабинете в настройках проекта.

Пример формирования:
md5(260692604c23a4398db8ef7b3ae1f4b07aeeb7c54f8e3c7c9)

Результат:
5bc8837cebfd650a97fcdab650843c16

Параметры ответа от ТСП

resultstring

Результат выполнения запроса (см. раздел 6.4).

При успешном выполнении метода "result":"ok"

error_descriptionstring

Описание ошибки, возникшей при обработке уведомления.

Необязательный, может присутствовать в случае возникновения ошибки при выполнении запроса
messagestring

Текст сообщения, которое будет отправлено Плательщику (в sms или email в зависимости от настроек сервиса в ЛК).

Необязательный

Пример запроса и ответа

Пример уведомления от Миксплат

POST <URL обработчика ТСП>
{
    "api_version"       : 3,
    "request"           : "sms",
    "project_id"        : 1203,
    "sms_id"            : 260692604,
    "user_phone"        : "79031230001",
    "mobile"            :
    {
        "payment_system"      : "mobile_ru_beeline",
        "mccmnc"              : 25099,
        "sender"              : "3443",
        "text_raw"            : "Добро 100",
        "prefix"              : "добро",
        "text_after_prefix"   : "100"
    },
    "signature"         : "5bc8837cebfd650a97fcdab650843c16"
}

Успешный ответ от ТСП

{
    "result" : "ok"
}

Ответ от ТСП в случае возникновения ошибки

{
    "result"            : "error",
    "error_description" : "Payment is not found"
}

7.5 Отправка sms в сторону абонента (create_sms)​

С помощью данного функционала можно отправить sms с текстом в сторону абонента.

Направление запроса: ТСП → Миксплат
Тип запроса: POST-JSON (см. раздел 5.6)
URL запроса: https://api.mixplat.com/create_sms

Параметры запроса:

api_versionint

Версия API, всегда "3".

request_idstring|null

Уникальный идентификатор запроса, задаваемый ТСП, обеспечивающий идемпотентность вызовов (повторные запросы с тем же request_id не будут приводить к созданию нового sms, а параметры ответа будут полностью повторять параметры ответа первоначального вызова с данным request_id).

Рекомендуется передавать этот параметр, чтобы защититься от дублирования sms в результате сетевых проблем, задержек ответа и т. п.

В качестве request_id можно использовать идентификатор sms в системе ТСП (если он уникален), или хеш от ключевых параметров запроса.

Проверка наличия другого запроса с данным request_id осуществляется за последние 30 дней.

Необязательный параметр. От 1 до 64 символов.
sms_idint

ID sms, полученный в нотификации метода 7.4. Используется для асинхронной отправки sms с короткого номера. Некоторые операторы не позволяют отправлять sms с короткого номера без входящий sms от абонента.

Необязательный параметр.
project_idint

ID проекта в Миксплат.

user_phonestring

Номер телефона в международном формате без символа "+".

messagestring

Текст сообщения, которое будет отправлено Абоненту в sms.

senderstring

Альфа-имя отправителя сообщения – цифры или латинские символы.

Необязательный. По умолчанию отправляется с отправителя из настроек проекта
signaturestring

Подпись запроса.
Принцип формирования:
md5 (request_id+project_id+API_KEY)

Символ "+" означает конкатенацию, request_id, project_id — это строковые представления соответствующих параметров запроса, API_KEY — это секретный ключ сервиса для API запросов, узнать который можно в личном кабинете в настройках проекта. Если какой-либо из параметров не указан, то вместо его значения нужно использовать пустую строку.

Пример формирования:
md5(3242231000c23a4398db8ef7b3ae1f4b07aeeb7c54f8e3c7c9)

Результат:
63fd117833d3291873480d45f85846cc

Параметры ответа от Миксплат

resultstring

Результат выполнения запроса (см. раздел 6.4).

При успешном выполнении метода "result":"ok"

error_descriptionstring

Описание ошибки, возникшей при обработке уведомления.

Необязательный, может присутствовать в случае возникновения ошибки при выполнении запроса
mobilejson

Дополнительная информация о sms, специфичная для мобильных операторов (см. раздел 3.2.3.3).

Пример запроса и ответа

Пример запроса

POST https://api.mixplat.com/create_sms
{
    "api_version"       : 3,
    "project_id"        : 1203,
    "user_phone"        : "79031230001",
    "message"           : "Спасибо за участие. Ваш запрос принят.",
    "signature"         : "5bc8837cebfd650a97fcdab650843c16"
}

Успешный ответ от Миксплат

{
    "result" : "ok",
    "mobile" :
    {
        "payment_system"      : "mobile_ru_beeline",
        "mccmnc"              : 25099,
        "sender"              : "3443"
    }
}

Ответ от Миксплат в случае возникновения ошибки

{
    "result"            : "error",
    "error_description" : "SMS sending is not available for project_id 1203"
}

7.6 Получение реестра (get_register)​

Получение реестра платежей, SMS, возвратов.

Направление запроса: ТСП → Миксплат
Тип запроса: POST-JSON (см. раздел 5.6)
URL запроса: https://api.mixplat.com/get_register

Параметры запроса:

api_versionint

Версия API, всегда "3".

company_idint

ID компании ТСП в Миксплат, для которого формируется реестр.

periodstring

День, или месяц, за который требуется реестр.

  • День (в формате YYYY-MM-DD) для получения реестра за указанный день
  • Месяц (в формате YYYY-MM) для получения реестра за указанный месяц
signaturestring

Подпись запроса.
Принцип формирования:
md5 (company_id+period+API_KEY)

Символ "+" означает конкатенацию, company_id, period — это строковые представления соответствующих параметров запроса, API_KEY — это секретный ключ сервиса для API запросов, узнать который можно в личном кабинете в настройках проекта. Если какой-либо из параметров не указан, то вместо его значения нужно использовать пустую строку.

Пример формирования:
md5(10002020-12-31c23a4398db8ef7b3ae1f4b07aeeb7c54f8e3c7c9)

Результат:
0720d2e07297b0335bc568cc09e6aa1e

Параметры ответа от Миксплат

resultstring

Результат выполнения запроса (см. раздел 6.3).
При успешном выполнении метода "result": "ok"

error_descriptionstring

Описание ошибки, возникшей при выполнении запроса.

Присутствует только в случае ошибки при выполнения метода (result != ok)
payment_register_idint|null

ID реестра платежей, или NULL, если он не найден.

payment_register_download_urlstring|null

URL для скачивания реестра платежей, или NULL, если он не найден.

sms_register_idint|null

ID реестра SMS, или NULL, если он не найден.

sms_register_download_urlstring|null

URL для скачивания реестра SMS, или NULL, если он не найден.

refund_register_idint|null

ID реестра возвратов, или NULL, если он не найден.

refund_register_download_urlstring|null

URL для скачивания реестра возвратов, или NULL, если он не найден.

XML-Формат реестра платежей

idint

ID реестра платежей.

typestring

Тип реестра, всегда payment.

periodstring

Период, за который сформирован реестр.

  • daily: Ежедневный реестр
  • monthly: Ежемесячный реестр
date_beginstring

Дата начала периода в формате "YYYY-MM-DD".

date_endstring

Дата конца периода в формате "YYYY-MM-DD".

company_idint

ID компании, для которой сформирован реестр.

data
payment
payment_idstring

ID платёжа

project_idint

ID проекта в Миксплат, для которого был создан платёж

merchant_payment_idstring|null

ID платежа в ТСП, или NULL, если он не был указан при создании платежа

merchant_datastring|null

Произвольные данные ТСП, связанные с платежом, или NULL, если они не были указаны при создании платежа.

date_createdstring

Дата и время создания платежа (UTC+03:00).
Формат: YYYY-MM-DD HH:MM:SS

date_processedstring|null

Дата и время обработки платежа (UTC+03:00), или NULL, если платёж ещё обрабатывается.
Формат: YYYY-MM-DD HH:MM:SS

currencystring

Валюта платежа (см. раздел 6.1).

amountint

Сумма платежа в минорных единицах (копейках).

amount_userint|null

Сумма, фактически оплаченная плательщиком в минорных единицах (копейках), либо NULL, если платёж не находится в финальном статусе.

amount_merchantint|null

Сумма к выплате ТСП в минорных единицах (копейках), либо NULL, если платёж не находится в финальном статусе.

payment_methodstring|null

Платёжный метод, который был использован для оплаты (см. 6.8), или NULL, если он ещё не определён.

user_phonestring|null

Номер телефона абонента или NULL, если он не определён.

XML-Формат реестра возвратов

idint

ID реестра возвратов.

typestring

Тип реестра, всегда refund.

periodstring

Период, за который сформирован реестр.

  • daily: Ежедневный реестр
  • monthly: Ежемесячный реестр
date_beginstring

Дата начала периода в формате "YYYY-MM-DD".

date_endstring

Дата конца периода в формате "YYYY-MM-DD".

company_idint

ID компании, для которой сформирован реестр.

data
refund
refund_idstring

ID возврата.

payment_idstring

ID платёжа, по которому был произведён возврат

currencystring

Валюта возврата (см. раздел 6.1).

amountint

Сумма возврата в минорных единицах (копейках).

project_idint

ID проекта в Миксплат, для которого был создан возврат.

XML-Формат реестра SMS

idint

ID реестра возвратов.

typestring

Тип реестра, всегда sms.

periodstring

Период, за который сформирован реестр.

  • daily: Ежедневный реестр
  • monthly: Ежемесячный реестр
date_beginstring

Дата начала периода в формате "YYYY-MM-DD".

date_endstring

Дата конца периода в формате "YYYY-MM-DD".

company_idint

ID компании, для которой сформирован реестр.

data
sms
sms_idstring

ID SMS.

project_idint

ID проекта в Миксплат, для которого было создано SMS.

date_createdstring

Дата и время создания платежа (UTC+03:00).
Формат: YYYY-MM-DD HH:MM:SS

directionstring

Направление SMS:

  • mo: от абонента к сервису
  • mt: от сервиса к абоненту
prefixstring|null

Ключевое слово, содержащееся в тексте SMS, или NULL, если SMS не содержит ключевое слово.

text_after_prefixstring|null

Текст после ключевого слова, или NULL, если его нет.

text_rawstring|null

Исходный текст SMS без обработки, или NULL, если SMS не содержало текст.

user_phonestring

Номер телефона абонента в международном формате без символа "+".

operatorstring

Оператор, к которому принадлежит абонент.

partsint

Количество частей SMS.

amountint

Стоимость SMS в минорных долях (копейках).