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 - реестр за платежом не сформирован |