Interface X10

Interface X10. Retrieving list of invoices for payment.

<w3s.request>
    <reqn></reqn>
    <wmid></wmid>
    <sign></sign>
    <getininvoices>
        <wmid></wmid>
        <wminvid></wminvid>
        <datestart></datestart>
        <datefinish></datefinish>
    </getininvoices>
</w3s.request>
  • Request parameters:
name purpose comments
reqn request number An integer without delimiter, max 15 digits; It must always be greater than the number of the previous request!!!
wmid Signer's WMID Is used only with WM Keeper WinPro authorization method
sign Request signature Uses the following parameters: getininvoices/wmid + getininvoices/wminvid + getininvoices/datestart + getininvoices/datefinish + reqn
Is used only with WM Keeper WinPro authorization method
getininvoices Parameters of requested invoice(s) that are searched for mandatory parameters wmid, datestart, datefinish, you can leave the rest empty or specify '0' value
getininvoices\wmid WM-identifier, for which for which invoice(s) for payment was(were) drawn
getininvoices\wminvid Invoice number (in WebMoney system) an integer >= 0
getininvoices\datestart min time and date of invoice creation YYYYMMDD HH:MM:SS
getininvoices\datefinish max time and date of invoice creation YYYYMMDD HH:MM:SS
  • Response format:
<w3s.response>
    <reqn></reqn>
    <retval></retval>
    <retdesc></retdesc>
    <ininvoices cnt="n"> number of invoices
        <ininvoice id="n1" ts="n2">
            <orderid></orderid>
            <storewmid></storewmid>
            <storepurse></storepurse>
            <amount></amount>
            <desc></desc>
            <address></address>
            <period></period>
            <expiration></expiration>
            <state>0</state>
            <datecrt></datecrt>
            <dateupd></dateupd>
            <wmtranid></wmtranid>
        </ininvoice>
        <ininvoice>...</ininvoice>
    </ininvoices>
</w3s.response>
  • Response parameters:
name purpose comments
reqn Request number
retval Request execution code 0 - Request successful
retdesc Description of request execution code
ininvoices List of drawn invoices retrieved by request n attribute - number of invoices that meet search criteria
ininvoices\ininvoice Invoice parameters id attribute is a unique invoice number in the WebMoney accounting system; ts attribute - official invoice number in the WebMoney accounting system
ininvoice\orderid order number Invoice number in the sender's accounting system. A positive integer of 15 digits maximally, less than 999999999999999
ininvoice\storewmid WMID of the seller who drew the invoice
ininvoice\storepurse Purse number, to which payment must be made
ininvoice\amount Invoice sum submitted to the buyer
ininvoice\desc Description of a good or service, for which the invoice was drawn
ininvoice\address Delivery address
ininvoice\period max allowed deal protection period for invoice payment in days
ininvoice\expiration max allowed invoice payment period in days
ininvoice\state Invoice payment state -0 - not paid
-1 - paid by protection
-2 - paid finally
-3 - refused
ininvoice\datecrt Date and time the invoice was created
ininvoice\dateupd Date and time of the last change in invoice state
ininvoice\wmtranid Transaction number in the WebMoney system, if the invoice has been already paid

See also XML-interfaces