Interface for creating a transaction
This XML interface creates a transaction and return information to proceed a payment.
Url: https://api.payplaypro.com/merchants/firmware-create
Method: POST
Content-Type: application/xml;charset=utf-8
Request body:
<Command>
<LMI_MERCHANT_ID></LMI_MERCHANT_ID>
<LMI_HASH></LMI_HASH>
<LMI_PAYMENT_SYSTEM></LMI_PAYMENT_SYSTEM>
<LMI_PAYMENT_NO></LMI_PAYMENT_NO>
<LMI_PAYMENT_AMOUNT></LMI_PAYMENT_AMOUNT>
<LMI_PAYMENT_DESC></LMI_PAYMENT_DESC>
<LMI_CLIENT_NUMBER></LMI_CLIENT_NUMBER>
</Command>
| Title | XML parameter | Required | Description |
|---|---|---|---|
| Merchant ID | LMI_MERCHANT_ID | Yes | The Merchant can get the identifier in the Merchant Portal. |
| Payment system ID | LMI_PAYMENT_SYSTEM | No | Payment system ID |
| Payment amount | LMI_PAYMENT_AMOUNT | Yes | The amount of payment. The amount must be greater than zero, the decimal part is separated by a dot. |
| Internal order number in the Merchant's accounting system | LMI_PAYMENT_NO | No | The order number reference number . This parameter is optional, but it is recommended to set. Use a unique number for each payment. The number can contain letters, numbers and the hyphen "_". The maximum length is 64 characters. |
| Payment details | LMI_PAYMENT_DESC | No | Description of the goods/services. The maximum length is 255 characters. Encoding - UTF8. |
| Hashsum of the request | LMI_HASH | Yes | The signature of the request is generated by hashing the original text of the XML request with an empty LMI\ _HASH value and the SecretKey using the algorithm specified in the Merchant Portal. The received signature is passed in the LMI_HASH tag. The recommended encryption algorithm is SHA256. Sign example |
| Client payment phone number or wallet | LMI_CLIENT_NUMBER | No | Required for some payment methods |
| Surname | LMI_PAYER_SURNAME | No | Surname |
| Firstname | LMI_PAYER_FIRSTNAME | No | Firstname |
| Patronymic | LMI_PAYER_PATRONYMIC | No | Patronymic |
| Customer ID | LMI_PAYER_ID | No | Can contain Latin letters, numbers and a hyphen "-". The maximum length is 25 characters. |
XML response:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Retval></Retval>
<Retdesc></Retdesc>
<Retdata>
<LMI_SYS_PAYMENT_ID></LMI_SYS_PAYMENT_ID>
<url></url>
<wallet></wallet>
</Retdata>
</Response>
| Title | Field in XML | Description |
|---|---|---|
| Result code | Retval | 1 - success; 2 - incorrect request;101 - general failure; 103 - incorrect LMI_PAYMENT_SYSTEM; 104 - incorrect LMI_PAYMENT_NO; 105 - incorrect LMI_PAYMENT_AMOUNT; -1 - general failure; -3 - Incorrect signature \ (HASH ); |
| Description of the execution code | Retdesc | |
| Payment reference in the Payplaypro system | Retdata/LMI_SYS_PAYMENT_ID | |
| Url for redirect | Retdata/url | User should be redirected to this url to proceed |
| Wallet | Retdata/wallet | Required for some payment methods |
| Bank name | Retdata/bank | Required for some payment methods |
| Cardholder name | Retdata/cardholder | Required for some payment methods |
| Country | Retdata/country | 2 letter country code ISO 3166-1 alpha-2. Required for some payment methods |
| ErrorMessage | additional error information |
Some payment methods require confirmation request after the user completes the payment. To get the status of a transaction, you can use the "Payment Status Request Interface".