4. Интерфейс запроса истории платежей
Этот XML-интерфейс позволяет Продавцу в любой момент получить историю платежей за период. При использовании параметра «Номер банковского платежа» Продавец имеет возможность получить список платежей, которые вошли в соответствующий банковскый платеж.
Action - https://api.paysoft.solutions/merchants/get-history
Method - POST
Формат XML-запроса:
<Command>
<LMI_MERCHANT_ID></LMI_MERCHANT_ID>
<DateFrom></DateFrom>
<DateTo></DateTo>
<BankPaymentId></BankPaymentId>
<LMI_HASH></LMI_HASH>
<LMI_PAYMENT_NO></LMI_PAYMENT_NO>
</Command>
Название | Поле в XML | Описание |
---|---|---|
Идентификатор продавца | LMI_MERCHANT_ID | Идентификатор магазина. Идентификатор Продавец может получить в Кабинете(https://merchant.paysoft.solutions). |
Дата начала | DateFrom | Дата начала периода, за который запрашивается история, в формате |
Дата конца периода | DateTo | Дата конца периода, за который запрашивается история, в формате |
Номер банковского платежа | BankPaymentId | Номер банковского платежа в системе PaySoft. |
Внутренний номер заказа в системе учета Продавца | LMI_PAYMENT_NO | Это поле является необязательным. |
Контрольная подпись | LMI_HASH | Контрольная подпись запроса. Для формирования подписи исходный текст XML-запроса с пустым значением LMI_HASH конкатенируется с секретным ключом SecretKey (без разделителя). От полученной строки формируется хеш сумма с помощью алгоритма, указанного в настройках магазина в Кабинете Продавца. Полученная подпись передается в теге LMI_HASH. Рекомендованный алгоритм хеширования SHA256.Пример формирования подписи |
Формат XML-ответа:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Retval></Retval>
<Retdesc></Retdesc>
<Retdata>
<History>
<Total></Total>
<Transaction>
<LMI_MERCHANT_ID></LMI_MERCHANT_ID>
<LMI_PAYMENT_AMOUNT></LMI_PAYMENT_AMOUNT>
<LMI_PAYMENT_NO></LMI_PAYMENT_NO>
<LMI_PAYMENT_SYSTEM></LMI_PAYMENT_SYSTEM>
<LMI_MODE></LMI_MODE>
<LMI_PAYMENT_DESC></LMI_PAYMENT_DESC>
<LMI_SYS_PAYMENT_ID></LMI_SYS_PAYMENT_ID>
<LMI_SYS_PAYMENT_DATE></LMI_SYS_PAYMENT_DATE>
<LMI_PAID_AMOUNT></LMI_PAID_AMOUNT>
<LMI_PAYER_IDENTIFIER></LMI_PAYER_IDENTIFIER>
<LMI_PAYER_PHONE_NUMBER></LMI_PAYER_PHONE_NUMBER>
<LMI_PAYER_EMAIL></LMI_PAYER_EMAIL>
<LMI_HOLD_REFUND_AMOUNT></LMI_HOLD_REFUND_AMOUNT>
<LMI_HASH></LMI_HASH>
<State></State>
<Refunds>
<Refund>
<RefundId></RefundId>
<RefundAmount></RefundAmount>
<Created></Created>
<State></State>
<Type></Type>
</Refund>
</Refunds>
</Transaction>
</History>
</Retdata>
</Response>
Название | Поле в XML | Описание |
---|---|---|
Код выполнения запроса | Retval | 1 - успешное выполнение команды 2 - некорректный тип запроса (ожидается POST) 1 - общая ошибка -2 - некорректные авторизационные данные -3 - некорректная подпись -4 - некорректный идентификатор заказ |
Описание кода выполнения | Retdesc | |
Retdata / History | История (перечень) платежей, которые были приглашены. | |
Общее количество платежей | Total | Общее количество платежей, которые попали в ответ на запрос. |
Transaction | Данные о конкретном платеже. | |
Идентификатор продавца | LMI_MERCHANT_ID | |
Сумма платежа | LMI_PAYMENT_AMOUNT | |
Внутренний номер заказа в системе учета Продавца | LMI_PAYMENT_NO | |
Идентификатор платежного инструмента | LMI_PAYMENT_SYSTEM | |
Признак тестового режима | LMI_MODE | Указывает, в каком режиме было принято платеж: 0 - рабочий режим; 1 - тестовый режим. |
Назначение платежа | LMI_PAYMENT_DESC | |
Внутренний номер платежа в системе PaySoft | LMI_SYS_PAYMENT_ID | |
Дата и время приема платежа | LMI_SYS_PAYMENT_DATE | |
Общая сумма | LMI_PAID_AMOUNT | Общая уплаченная сумма с учетом дополнительных комиссий Финансового учреждения. |
Реквизит Клиента | LMI_PAYER_IDENTIFIER | Платежная информация о Клиенте (например, маскируемый номер банковской карты). Формат зависит от платежного инструмента, с помощью которого был осуществлен платеж. |
Номер телефона Клиента | LMI_PAYER_PHONE_NUMBER | Номер телефона Клиента в формате 380xxxxxxxxx. |
Электронный адрес Клиента | LMI_PAYER_EMAIL | Электронный адрес Клиента. |
Сумма возмещения Hold | LMI_HOLD_REFUND_AMOUNT | Сумма возмещения, было возвращено клиенту при подтверждении транзакции в статусе Hold (в случае подтверждения суммы меньшей начальной) |
Контрольная подпись | LMI_HASH | Контрольный подпись формируется так же, как в «Форме оповещения о платеже». |
Статус платежа | State | 0 - ожидается оплата 1 - платеж успешно принят 2 - платеж отменен (средства возвращены Клиенту) 3 - платеж обрабатывается 4 - платеж находится на проверке 6 - платеж в статусе Hold, ожидается подтверждение или отмена |
Refunds | Список возмещений, которые проводились по этой транзакции | |
Номер заявки на возмещение | RefundId | |
Сумма возмещения | RefundAmount | |
Дата создания заявки | Created | |
Статус заявки | State | 0 - новая заявка 1 - заявка обрабатывается 2 - возврат выполнен |
Тип заявки | Type | 1 - быстрое возмещение - выполнено с помощью интерфейса возврата 2 - банковское возмещения - выполнено с помощью банковского перевода) |