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 | Ідентифікатор торгової точки Продавця, на яку Продавець мав прийняти платіж. |
| Дата початку періоду | DateFrom | Дата початку періоду, за який запитується історія, у форматі YYYY-MM-DD |
| Дата кінця періоду | DateTo | Дата кінця періоду, за який запитується історія, у форматі YYYY-MM-DD |
| Номер банківського платежу | 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 – банківське відшкодування – виконане за допомогою банківського переказу |