8. Інтерфейс запиту списку банківських платежів
Цей XML-інтерфейс дозволяє Продавцю в будь-який момент запитати список банківських платежів, що було раніше надіслано Продавцю за певний період.
Action - https://api.paysoft.solutions/merchants/get-bank-payments
Method - POST
Формат XML-запиту:
<Command>
<LMI_MERCHANT_ID></LMI_MERCHANT_ID>
<DateFrom></DateFrom>
<DateTo></DateTo>
<LMI_HASH></LMI_HASH>
</Command>
| Назва | Поле в XML | Опис |
|---|---|---|
| Ідентифікатор Продавця | LMI_MERCHANT_ID | Ідентифікатор торгової точки Продавця, на яку Продавець мав прийняти платіж. |
| Дата початку періоду | DateFrom | Дата початку періоду, за який запитується список банківських платежів, у форматі YYYY-MM-DD |
| Дата кінця періоду | DateTo | Дата кінця періоду, за який запитується список банківських платежів, у форматі YYYY-MM-DD |
| Контрольний підпис | 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>
<BankPayment>
<Value></Value>
<RR></RR>
<MFO></MFO>
<BankKorrespondent></BankKorrespondent>
<SendConfirmed></SendConfirmed>
<PaymentOrder></PaymentOrder>
<ExecutedMin></ExecutedMin>
<ExecutedMax></ExecutedMax>
<BankPaymentDescription></BankPaymentDescription>
<RegistryId></RegistryId>
<IsRegistryFormed></IsRegistryFormed>
</BankPayment>
</History>
</Retdata>
</Response>
| Назва | Поле в XML | Опис |
|---|---|---|
| Код виконання запиту | Retval | 1 (одиниця) - успішне виконання команди |
| Опис коду виконання | Retdesc | |
| Retdata / History | Історія (перелік) платежів, яку було запрошено. | |
| Загальна кількість платежів | Total | Загальна кількість платежів, що потрапили у відповідь на запит. |
| BankPayment | Дані про конкретний платіж. | |
| Номер банківського платежу | BankPaymentId | Номер банківського платежу в системі PaySoft |
| Сума платежу | Value | |
| Розрахунковий рахунок | RR | |
| МФО | MFO | |
| Банк-отримувач | BankKorrespondent | |
| Дата відправки платежу | SendConfirmed | |
| Номер банківського доручення | PaymentOrder | |
| Дата початку періоду оплати | ExecutedMin | Дата проведення найстаршої транзакції, що входить до даного платежу |
| Дата завершення періоду оплати | ExecutedMax | Дата проведення найновішої транзакції, що входить до даного платежу |
| Призначення платежу | BankPaymentDescription | |
| Реєстр сформовано? | IsRegistryFormed | 0 – реєстр за платежем не сформовано |