Interface A1

INTERFACE A1. Preliminary query on the payment possibility

We recommend sending this query before you receive funds from the RECIPIENT. With this query you can check the condition of the technical equipment (connectivity, operability, etc.) and funds availability.

The signatory WMID should have the Agency Agreement signed with Leadant Solutions Ltd.

<w3s.query>
 <wmid></wmid>
 <sign type=""></sign>
 <payment>
  <pspname></pspname>
  <pspcode></pspcode>
  <pspnumber></pspnumber>
  <pspdate></pspdate>
  <purse></purse>
  <price></price>
 </payment> 
</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+ pspname+ pspcode+ pspnumber+ pspdate+ purse+ price
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
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
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,CYP,BGR,CNY,RSA,DEM,CHE,ISR,SAU,KEN), no gaps in the beginning and at the end, encoding win-1251.
payment/pspnumber Passport number of the RECIPIENT Passport number of the RECIPIENT (SERIES, NUMBER), no N sign and gaps, encoding win-1251
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
payment/purse Payment details of the RECIPIENT 13 symbols, the first symbol is the Latin letter Z or E and 12 digits; no gaps
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)
  • response format:
<w3s.response>
 <retval></retval>
 <retdesc></retdesc>
 <payment>
  <name></name>
  <pspcode></pspcode>
  <pspnumber></pspnumber>
  <pspdate></pspdate>
  <price></price>
  <purse></purse>
  <limit></limit>
 </payment> 
</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"
payment/pspname Full name of the RECIPIENT Passport details of the RECIPIENT (full name), no gaps at the beginning and at the end, encoding win-1251
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,CYP,BGR,CNY,RSA,DEM,CHE,ISR,SAU,KEN), no gaps at the beginning and at the end, encoding win-1251.
payment/pspnumber Passport number of the RECIPIENT Passport number of the RECIPIENT (SERIES, NUMBER), no N sign and gaps, encoding win-1251
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
payment/purse Payment details of the RECIPIENT 13 symbols, the first symbol is the Latin letter Z or E and 12 digits; no gaps
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)
payment/limit Maximum amount for transferring to the Recipient Figure with a floating point (point - .(dot))

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