WMTransfer Wiki
Interface X4
Interface X4. Receiving the history of issued invoices. Verifying whether invoices were paid.
<w3s.request>
<reqn></reqn>
<wmid></wmid>
<sign></sign>
<getoutinvoices>
<purse></purse>
<wminvid></wminvid>
<orderid></orderid>
<datestart></datestart>
<datefinish></datefinish>
</getoutinvoices>
</w3s.request>
| Name |
Purpose |
Description |
| reqn |
Request number |
An integer, maximum 15 digits;Should always be larger than the number of previous request submitted!!! |
| wmid |
Signer’s WMID |
Is used only with WM Keeper Classic authorization method; |
| sign |
Request’s signature Uses the following parameters: purse + reqn |
Is used only with WM Keeper Classic authorization method; |
| getoutinvoices |
Properties of the requsted invoice(invoices) which will be used during the search |
purse, datestart, datefinish are required, the rest may be left undefined or set to 0; |
| getoutinvoices\purse |
Number of the purse for which the invoice was issued; |
|
| getoutinvoices\wminvid |
Invoice number (in the WebMoney system) |
An integer > 0; |
| getoutinvoices\orderid |
Serial invoice number |
Serial invoice number set by the sender; |
| getoutinvoices\datestart |
Minimum date and time of invoice creation |
YYYYMMDD HH:MM:SS |
| getoutinvoices\datefinish |
Maximum date and time of invoice creation |
YYYYMMDD HH:MM:SS |
<w3s.response>
<reqn></reqn>
<retval></retval>
<retdesc></retdesc>
<outinvoices cnt="n" >
<outinvoice id="n1" ts="n2">
<orderid></orderid>
<customerwmid></customerwmid>
<storepurse></storepurse>
<amount></amount>
<desc></desc>
<address></address>
<period></period>
<expiration></expiration>
<state></state>
<datecrt></datecrt>
<dateupd></dateupd>
<wmtranid></wmtranid>
</outinvoice>
<outinvoice>...</outinvoice>
</outinvoices>
</w3s.response>
| 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 |
|
| outinvoices |
List of issued invoices received in response |
n property stands for the number of invoices satisfying the request |
| outinvoices\outinvoice |
Invoice properties |
id defines unique invoice number in the WebMoney system; ts stands for a auxiliary number of the invoice in the WebMoney system; |
| outinvoice\orderid |
Invoice number |
Invoice number set by the sender |
| outinvoice\customerwmid |
Customer’s WMID |
|
| outinvoice\storepurse |
Number of the purse where funds should be sent to |
|
| outinvoice\amount |
Amount that customer should pay |
|
| outinvoice\desc |
Description of the product or service |
|
| outinvoice\address |
Delivery address |
|
| outinvoice\period |
Maximum protection period allowed in days |
|
| outinvoice\expiration |
Maximum valid period in days |
|
| outinvoice\state |
Payment status |
-0 – paid, -1 – paid with protection, -2 – paid, -3 – rejected |
| outinvoice\datecrt |
Date and time of the invoice creation |
|
| outinvoice\dateupd |
Date and time of the latest invoice status change |
|
| outinvoice\wmtranid |
Transaction number in the WebMoney system(if the invoice was paid) |
|
| outinvoice\customerpurse |
Payer’s purse (if the invoice was paid) |
|
Category: XML-Interfaces
This article in other languages: Русский
Revised August 17, 2009 20:56
by:
trubnikoff
(3916 characters / 1.0 pages)
4 views today.