Interface X3

Interface X3. Receiving Transaction History. Checking Transaction Status.

         <w3s.request>
           <reqn></reqn>
           <wmid></wmid>
           <sign></sign>
           <getoperations>
                <purse></purse>
                <wmtranid></wmtranid>
                <tranid></tranid>
                <wminvid></wminvid>
                <orderid></orderid>
                <datestart></datestart>
                <datefinish></datefinish>
           </getoperations>
         </w3s.request>
    
  • Request parameters
Name Purpose Description
reqn Request number An integer, maximum 15 digits; Should always be greater than the number of the previously submitted request!!!
wmid Signer's WMID Is used only with the WM Keeper WinPro authorization method;
sign Request signature. Consists of the parameters purse + reqn Is used only with the WM Keeper WinPro authorization method;
getoperations Parameters of the requested operation that is being searched for purse, datestart, datefinish are mandatory parameters, the rest may be left empty or set to 0;
getoperations\purse WMID purse number for which the transaction is requested;  
getoperations\wmtranid Transaction number (in the WebMoney system) An integer > 0;
getoperations\tranid Transfer number Transfer number set by sender; an integer without a delimiter (see trans\tranid in Interface X2)
getoperations\wminvid Invoice number (in the WebMoney system) for which the transaction was made An integer > 0;
getoperations\orderid Invoice number Invoice number set by merchant; an integer without a delimiter (see trans\tranid in Interface X2)
getoperations\datestart Minimum date and time of transaction execution YYYYMMDD HH:MM:SS
getoperations\datefinish Maximum date and time of transaction execution YYYYMMDD HH:MM:SS
  • Response format
<w3s.response>
    <reqn></reqn>
    <retval></retval>
    <retdesc></retdesc>
    <operations cnt="n">
        <operation id="n1" ts="n2">
            <pursesrc></pursesrc>
            <pursedest></pursedest>
            <amount></amount>
            <comiss></comiss>
            <opertype></opertype>
            <wminvid></wminvid>
            <orderid></orderid>
            <tranid></tranid>                        
            <period></period>
            <desc></desc>
            <datecrt></dateupd>
            <dateupd></dateupd>
            <corrwm></corrwm>
            <rest></rest>
            <timelock/>
        </operation>
        <operation>...</operation>
    </operations>
</w3s.response>
  • Response parameters
Name Purpose Description
reqn Request number  
retval Execution code 0 - means that the request was executed successfully;
retdesc Execution code description  
operations List of transfers received in response the cnt attribute is the number of transfers matching the request
operations\operation Transfer parameters the id attribute is a unique invoice number in the WebMoney system
ts is an internal number for the invoice in the WebMoney system
operation\pursesrc Sender’s purse number  
operation\pursedest Recipient’s purse number  
operation\amount Amount of the sum transferred  
operation\comiss Fee charged for the transfer  
operation\opertype Transfer type
-0 – simple (or protected, successfully completed),
-4 – protected (not completed),
-12 – protected (refunded).
operation\wminvid Invoice number (in the WebMoney system) of the transaction An integer > 0; 0 means that transfer is made without an invoice
operation\orderid Invoice number set by the merchant An integer > 0; 0 means that transfer is made without an invoice
operation\tranid Transaction number Transaction number set by the sender; an integer without a delimiter; it should be unique for each transaction (the same tranid may not be used for two transactions);
operation\period Protection period in days An integer in the range 0 - 255; 0 - means that protection is disabled;
operation\desc Description of the product or service  
operation\datecrt Date and time of the transaction creation  
operation\dateupd Date and time of the latest transaction status change  
operation\corrwm Correspondent’s WMID  
operation\rest Balance after transaction For protected transactions, the sender's balance is displayed as of the start of the transaction, and for the recipient – as of the end of the transaction. If the transaction has not been completed yet, the balance is displayed as of the moment the transaction started
operation\timelock Incomplete transaction with time protection Tag is present, only if the transaction has not been completed yet

See also: XML-interfaces