Switch to author mode

Interface A3

INTERFACE A3. Query to receive the register of the unique codes

We recommend sending this query to control unique codes issued by the Agent for the current period. The register is available for no more than a one month period.

<w3s.query>
 <wmid></wmid>
 <sign type=""></sign>
 <datestart></datestart>
 <dateend></dateend>
 <test></test> 
</w3s.query>
  • query parameters:
title purpose note
wmid WMID of the signatory Used for the authorization via WM Keeper WinPro keys or X.509 WM Keeper WebPro certificate
sign The query signature Formed by the parameters: wmid + datestart+dateend
sign/@type Type of query signature 1 – the signature is formed by the special authentication module for WM Keeper WinPro keys, 2 – the signature is formed by X.509 WM Keeper WebPro certificate, encoding base64
datestart Start date Time slot according to WebMoney Transfer YYYYMMDD, where YYYY – the year, MM – the month, DD – the day
dateend Ending date Time slot according to WebMoney Transfer YYYYMMDD, where YYYY – the year, MM – the month, DD – the day
test - OPTIONAL PARAMETER! Type of payment The register of payments has two values, "1"- payment in the test mode, "0" – in the operation mode. If there are no tags a register with all payment types will be formed.
  • response format:
<w3s.response>
 <retval></retval>
 <retdesc></retdesc>
 <datestart></datestart>
 <dateend></dateend>
 <history cnt=""> 
  <payment id="" test="">
   <pspname></pspname>
   <pspcode></pspcode>
   <pspnumber></pspnumber>
   <pspdate></pspdate>
   <price></price>
   <amount></amount>
   <comiss></comiss>
   <purse></purse>
   <cheque></cheque>
   <date></date>
   <kiosk_id></kiosk_id>
   <wmtranid></wmtranid>
   <dateupd></dateupd>
  </payment> 
 ......................... 
 </history> 
</w3s.response>
  • response parameters:
title purpose note
retval Error code or status code 0 – query is successfully completed
retdesc Text description of the error/empty Random line from 0 to 255 symbols; encoding win-1251
startdate Start date Time slot according to WebMoney Transfer YYYYMMDD, where YYYY – the year, MM – the month, DD – the day
enddate Ending date Time slot according to WebMoney Transfer YYYYMMDD, where YYYY – the year, MM – the month, DD – the day
history/@cnt Quantity of payments in the register A whole number that shows the number of “payment” tags in the tag “history”.
history/payment/pspname Full name of the RECIPIENT Passport details of the RECIPIENT (full name), no gaps in the beginning and at the end, encoding win-1251
history/payment/pspcode Country code in the RECIPIENT passport Country code in the RECIPIENT passport (Country code of the RECIPIENT (possible codes ABH,AZE,ARM,BLR,GEO,KAZ,KGZ,LVA,LTU,MDA,RUS,TJK,TKM,USB,UKR,EST), no gaps at the beginning and at the end, encoding win-1251.
history/payment/pspnumber Passport number of the RECIPIENT Passport number of the RECIPIENT (SERIES, NUMBER), no N sign and gaps, encoding win-1251
history/payment/pspdate Date of issue of the RECIPIENT passport Passport details of the RECIPIENT (DATE OF ISSUE), in the format YYYYMMDD, where YYYY – the year, MM – the month, DD – the day
history/payment/purse Payment details of the RECIPIENT 13 symbols, the first symbol is the Latin letter Z or E and 12 digits; no gaps
history/payment/price The amount in Euro or USD received from the payer Figures with a floating point (point - .(dot) ) for ten and a half should look like: 10.5; nonsignificant zeroes at the end and after the point are not required for the whole number, e.g., 10.50 - wrong, 10.5 - correct, 9. - wrong, 9 - correct)
history/payment/amount Replenishment amount Figures with a floating point (point - .(dot) ) for ten and a half should look like: 10.5; nonsignificant zeroes at the end and after the point are not required for the whole number, e.g., 10.50 - wrong, 10.5 - correct, 9. - wrong, 9 - correct)
history/payment/comiss Commission Figures with a floating point (point - .(dot) ) for ten and a half should look like: 10.5; nonsignificant zeros at the end and after the point are not required for the whole number, e.g., 10.50 - wrong, 10.5 - correct, 9. - wrong, 9 - correct)
history/payment/rest balance Shows the available balance. A decimal number rounded to two places after the decimals (). The next payment amount can not exceed the balance.
history/payment/cheque Number of the code confirmation issued by the Agent for the User A whole decimal number that contains no more than 16 digits. It corresponds to the «Document number» on the code confirmation.
history/payment/date Date of the transaction according to the Agent time Specifies the date and time of the payment according to the Agent time. Corresponds to the «Payment date» on the code confirmation. YYYYMMDD HH:mm:ss, where YYYY – the year, MM – the month, DD – the day, HH – hours, mm – minutes, ss – seconds
history/payment/kiosk_id Unique number issued by the Agent A whole decimal number that contains no more than 16 digits. Corresponds to the «Unique number» on the code confirmation.
history/payment/wmtranid Transaction number in WebMoney Transfer system Unique transaction number in the WebMoney Transfer System
history/payment/dateupd Transaction date, WebMoney Transfer time YYYYMMDD HH:mm:ss, where YYYY – the year, MM – the month, DD – the day, HH – hours, mm – minutes, ss – seconds

See also:
XML-interfaces to top-up WMZ and WME
XML-interfaces