Інтерфейс створення транзакції
Цей XML-інтерфейс дозволяє Продавцю створити запит на списання коштів з Клієнта.
Для магазинів, що знаходяться у тестовому режимі, є можливим налагодження системи створення запитів списання без відправлення повідомлень та створення транзакцій (див. «Код виконання запиту» у таблиці полів відповіді).
Action - https://card.paysoft.solutions/api/xml/payment-create
Method - POST
Формат XML-запиту:
<Command>
<LMI_MERCHANT_ID></LMI_MERCHANT_ID>
<LMI_HASH></LMI_HASH>
<LMI_PAYMENT_NO></LMI_PAYMENT_NO>
<LMI_PAYMENT_AMOUNT></LMI_PAYMENT_AMOUNT>
<LMI_PAYMENT_DESC></LMI_PAYMENT_DESC>
<LMI_CARDNUMBER></LMI_CARDNUMBER>
<LMI_EXPIRE_YEAR></LMI_EXPIRE_YEAR>
<LMI_EXPIRE_MONTH></LMI_EXPIRE_MONTH>
<LMI_CVV></LMI_CVV>
<LMI_PAYER_IP></LMI_PAYER_IP>
<LMI_MERCHANT_URL></LMI_MERCHANT_URL>
</Command>
Назва | Назва параметра в html-формі | Обов'язковий? | Опис |
---|---|---|---|
Ідентифікатор Продавця | LMI_MERCHANT_ID | Так | Ідентифікатор торгової точки, на який буде прийнято платіж. Ідентифікатор Продавець може отримати в Кабінеті. |
Сума платежу | LMI_PAYMENT_AMOUNT | Так | Сума платежу, яку Продавець бажає одержати від Клієнта. Сума повинна бути більше нуля, дробова частина відокремлюється крапкою. |
Внутрішній номер замовлення в системі обліку Продавця | LMI_PAYMENT_NO | Ні | У цьому полі Продавець визначає номер замовлення у відповідності зі своєю системою обліку. Незважаючи на те, що параметр не є обов'язковим, рекомендується завжди задавати його, оскільки він потрібен для коректної роботи інших інтерфейсів. Бажано використовувати унікальний номер для кожного платежу. Номер може містити букви англійського алфавіту, цифри та знак дефісу «-». Максимальна довжина – 64 символи. |
Призначення платежу | LMI_PAYMENT_DESC | Так | Опис товару/роботи/послуги, що сплачується. Максимальна довжина - 255 символів. Кодування – UTF8. |
Номер карти | LMI_CARDNUMBER | Так | |
Термін дії картки, рік | LMI_EXPIRE_YEAR | Так | У форматі: РР |
Термін дії картки, місяць | LMI_EXPIRE_MONTH | Так | У форматі: ММ |
CVV/CVV2 | LMI_CVV | Так | 3 цифри |
Електронна адреса Клієнта | LMI_PAYER_EMAIL | Ні** | Електронна адреса Клієнта |
Ідентифікатор Клієнта | LMI_PAYER_ID | Нет | Може містити букви англійського алфавіту, цифри та знак дефісу «-». Максимальна довжина – 250 символів. |
Прізвище Клієнта | LMI_PAYER_SURNAME | Ні*** | Прізвище Клієнта |
Ім'я Клієнта | LMI_PAYER_FIRSTNAME | Ні*** | Ім'я Клієнта |
По-батькові Клієнта | LMI_PAYER_PATRONYMIC | Ні*** | По-батькові Клієнта |
Дата народження Клієнта | LMI_PAYER_BIRTHDAY | Ні*** | Дата народження Клієнта у форматі "РРРР-ММ-ДД" |
РНОКПП Клієнта | LMI_PAYER_TAX_ID | Ні*** | Реєстраційний номер облікової картки платника податків Клієнта |
Збереження реквізитів картки | LMI_CREATE_TOKEN | Ні | Приймає значення 0 або 1. Якщо дорівнює 1, то після успішної оплати реквізити картки буде збережено і повернено параметр LMI_PAYMENT_TOKEN. Див Списання за збереженою картою |
Оплата за збереженим токеном картки | LMI_PAYMENT_TOKEN | Ні | Передається збережений токен карти. Оплата буде здійснюватися з підтвердженням CVV та 3DSecure |
Розділення платежу | LMI_SPLIT | Ні | Платіж із розщепленням суми на кількох одержувачів. У цьому параметрі вказується масив JSON з правилами розщеплення платежу. При використанні параметра LMI_SPLIT відбувається одне списання з клієнта та кілька зарахувань одержувачам. Приклад JSON рядка: [{"CompanyId": 1, "Amount": 20,"CompanyName":"","Description":"","EDRPOU":"","IBAN":""}, {"CompanyId": 2, "Amount": 12,"CompanyName":"","Description":"","EDRPOU":"","IBAN":""}] |
IP платника | LMI_PAYER_IP | Так | IP адреса платника |
URL сайту | LMI_MERCHANT_URL | Так | URL сайту, на якому здійснювався платіж |
Контрольний підпис | LMI_HASH | Так | Контрольний підпис запиту, що формується шляхом шифрування вихідного тексту XML-запиту із порожнім значенням LMI_HASH та секретного ключа SecretKey за допомогою алгоритму, зазначеного у Кабінеті Продавця. Отриманий підпис передається у тегу LMI_HASH. Рекомендованим алгоритмом шифрування є SHA256. |
Формат XML-відповіді:
<Response>
<Retval></Retval>
<Retdesc></Retdesc>
<Retdata>
<LMI_SYS_PAYMENT_ID></LMI_SYS_PAYMENT_ID>
</Retdata>
</Response>
Назва | Поле в XML | Опис |
---|---|---|
Код виконання запиту | Retval | 1 (одиниця) - успішне виконання команди (лише для магазинів у робочому режимі) |
Опис коду виконання | Retdesc | |
Внутрішній номер платежу в системі PaySoft | Retdata/LMI_SYS_PAYMENT_ID | Номер прийнятого платежу в системі PaySoft. |