3. Интерфейс запроса статуса платежа
Этот XML-интерфейс позволяет Продавцу в любой момент выяснить состояние платежа.
Action - https://api.paysoft.solutions/merchants/get-transaction
Method - POST
Формат XML-запроса:
<?xml version="1.0" encoding="UTF-8"?>
<Command>
<LMI_MERCHANT_ID></LMI_MERCHANT_ID>
<LMI_PAYMENT_NO></LMI_PAYMENT_NO>
<LMI_SYS_PAYMENT_ID></LMI_SYS_PAYMENT_ID>
<LMI_HASH></LMI_HASH>
</Command>
Название | Поле в XML | Описание |
---|---|---|
Идентификатор продавца | LMI_MERCHANT_ID | Идентификатор магазина. Идентификатор Продавец может получить в Кабинете(https://merchant.paysoft.solutions). |
Идентификатор заказа | LMI_PAYMENT_NO | Должен быть указан или номер заказа в системе продавца - (LMI_PAYMENT_NO), или номер платежа в системе PaySoft (LMI_SYS_PAYMENT_ID) |
LMI_SYS_PAYMENT_ID | ||
Контрольная подпись | LMI_HASH | Контрольная подпись запроса. Для формирования подписи исходный текст XML-запроса с пустым значением LMI_HASH конкатенируется с секретным ключом SecretKey (без разделителя). От полученной строки формируется хеш сумма с помощью алгоритма, указанного в настройках магазина в Кабинете Продавца. Полученная подпись передается в теге LMI_HASH. Рекомендованный алгоритм хеширования SHA256.Пример формирования подписи |
Формат XML-ответа:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Retval></Retval>
<Retdesc></Retdesc>
<Retdata>
<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>
<ErrorCode></ErrorCode>
<ErrorMessageEN></ErrorMessageEN>
<ErrorMessageUK></ErrorMessageUK>
<ErrorMessageRU></ErrorMessageRU>
<Refunds>
<Refund>
<RefundId></RefundId>
<RefundAmount></RefundAmount>
<Created></Created>
<State></State>
<Type></Type>
</Refund>
</Refunds>
</Transaction>
</Retdata>
</Response>
Название | Поле в XML | Описание |
---|---|---|
Код выполнения запроса | Retval | 1 - успешное выполнение команды 2 - некорректный тип запроса (ожидается POST) -1 - общая ошибка -2 - некорректные авторизационные данные -3 - некорректная подпись -4 - некорректный идентификатор заказ -5 - транзакция с указанным идентификатором не найдена |
Описание кода выполнения | Retdesc | |
Retdata / 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 | Электронный адрес Клиента. |
Код авторизации | LMI_AUTH_CODE | Код авторизации в МПС |
RRN | LMI_RRN | RRN (Reference Retrieval Number) – уникальный идентификатор банковской транзакции, который назначается банком Эквайрером при инициализации платежа. |
Код эквайера | LMI_ACQUIRER_ID | Код эквайера, через которого был принят платеж |
Сумма возмещения Hold | LMI_HOLD_REFUND_AMOUNT | Сумма возмещения, что было возвращено клиенту при подтверждении транзакции в статусе Hold (в случае подтверждения суммы меньшей за начальную) |
| Контрольная подпись | LMI_HASH | Контрольная подпись формируется так же, как в «Форме оповещения о платеже» |
| Статус платежа | State | 0 - ожидается оплата
1 - платеж успешно принят
2 - платеж отменен (средства возвращены Клиенту)
3 - платеж обрабатывается
4 - платеж находится на проверке
6 - платеж в статусе Hold, ожидается подтверждение или отмена
7 - истек срок отведенный на оплату
8 - платеж неуспешный |
| Код ошибки | ErrorCode | Код ошибки |
| Описание ошибки | ErrorMessageEN,ErrorMessageUK,ErrorMessageRU | Описание ошибки |
| | Refunds | Список возвратов, которые проводились по данной транзакции |
| Номер заявки на возврат| RefundId | |
| Сумма возврата| RefundAmount | |
| Дата создания заявки | Created | |
| Статус заявки | State | 0 - новая заявка
1 - заявка обрабатывается
2 - возврат выполнен |
| Тип заявки | Type | 1 - быстрое возмещение - выполнено с помощью интерфейса возврата
2 - банковское возмещения - выполнено с помощью банковского перевода) |