Reader
For signing the requests keeper should have merchant passport? or higher
<w3s.request>
<reqn></reqn>
<wmid></wmid>
<sign></sign>
<invoice>
<orderid></orderid>
<customerwmid></customerwmid>
<storepurse></storepurse>
<amount></amount>
<desc></desc>
<address></address>
<period></period>
<expiration></expiration>
</invoice>
</w3s.request>Request properties:
| Name | Purpose | Description | |
| reqn | Request number | An integer, maximum 15 digits;Should always be larger than number of previous request submitted!!! | |
| wmid | Signer’s WMID | Is used only with WM Keeper Classic authorization method; | |
| sign | Request signature | Contains the following parameters: reqn+tranid+pursesrc+pursedest+amount+period+pcode+desc+wminvid. Is used only with WM Keeper Classic authorization method; | |
| invoice | Invoice attributes | ||
| invoice\orderid | Invoice ID number | Account number in the storage accounting system. An integer; | |
| invoice\customerwmid | Customer’s WMID | ||
| invoice\storepurse | Number of the purse where funds will be sent to | Number of the purse where funds will be sent to; | |
| invoice\amount | Amount of funds that customer needs to pay | A floating-point number. Separator – .(point). For example: 10.5; 9; 7.36; | |
| invoice\desc | Description of the product or service | String of 0 – 255 characters length. No spaces in the beginning and in the end. Codepage: Win-1251; | |
| invoice\address | Delivery address | Line in the range of 0 – 255 characters. No spaces in the beginning and in the end | |
| invoice\period | Maximum protection period | Maximum protection period allowed in days; An integer in the range 0 – 255; zero means that no protection will be used; | |
| invoice\expiration | Maximum valid period | Maximum valid payment period in days; An integer in the range 0 – 255; zero means that period is not defined |
Response format:
<w3s.response>
<reqn></reqn>
<retval></retval>
<retdesc></retdesc>
<invoice id="n1" ts="n2">
<orderid></orderid>
<customerwmid></customerwmid>
<storepurse></storepurse>
<amount></amount>
<desc></desc>
<address></address>
<period></period>
<expiration></expiration>
<state>0</state>
<datecrt></datecrt>
<dateupd></dateupd>
</invoice>
</w3s.response>Response properties:
| Name | Purpose | Description |
| reqn | Request number | |
| retval | Execution code | Zero means that the request was executed successfully; Check the execution code table for detailed information; |
| retdesc | Execution code interpretation | |
| invoice | Invoice attributes | |
| invoice\orderid | Invoice number | Serial invoice number in the merchants accounting system. Integer; |
| invoice\customerwmid | Customer’s WMID | |
| invoice\storepurse | Number of the purse where funds will be sent to | |
| invoice\amount | Amount of funds that customer needs to pay | A floating-point number. Separator – .(point). For example: 10.5; 9; 7.36; |
| invoice\desc | Description of the product or service | Line in the range of 0 – 255 characters. No spaces in the beginning and in the end. |
| invoice\period | Maximum protection? period | Maximum protection period allowed in days; An integer in the range 0 – 255; zero means that protection is prohibited; |
| invoice\expiration | Maximum valid period | Maximum valid payment period in days; An integer in the range 0 – 255; zero means that period is not defined |
| invoice\state | Invoice state | 0 – unpaid 1 – paid with protection 2 – fully paid or paid without protection 3 – rejected |
| invoice\datecrt | Date and time of invoice creation | YYYYMMDD HH:MM:SS |
| invoice\dateupd | Date and time of invoice status change | YYYYMMDD HH:MM:SS |
| Code | Description | |
| -100 | General parsing error. Incorrect request format. | |
| -9 | Invalid value in w3s.request/reqn field | |
| -8 | Invalid value in w3s.request/sign field | |
| -1 | Invalid value in w3s.request/invoice/orderid field | |
| -2 | Invalid value in w3s.request/invoice/customerwmid field | |
| -3 | Invalid value in w3s.request/invoice/storepurse field | |
| -5 | Invalid value in w3s.request/invoice/amount field | |
| -6 | Field in w3s.request/invoice/desc is too long | |
| -7 | Field in w3s.request/invoice/address is too long | |
| -11 | Identifier sent in w3s.request/wmid is not registered | |
| -12 | Signature verification failed | |
| 102 | Requirement of steady increase of w3s.request/reqn property was not executed | |
| 110 | No permission for using the interface; Certificate does not meet the requirements | |
| 111 | Attempt of sending invoice for purse which does not belong to WMID used to sign request; Security trust is also not set; | |
| 6 | Invoice recipient was not found | |
| 5,7 | Invoice sender was not found | |
| 35 | Payer is not authorized by correspondent for executing this operation |
Category: XML-Interfaces
This article in other languages: Русский