Interface ATM1

Interface ATM1. Preliminary payment availability query

It is recommended that you perform this prior to accepting funds from the Recipient. The query controls the serviceability of the technical devices (connection, efficiency, etc.) and the availability of funds.

<w3s.request>
 <wmid></wmid>
 <sign type=""></sign>
 <payment currency="">
  <purse></purse>
  <price></price>
 </payment> 
</w3s.request>
  • query parameters:
name reference comment
wmid WMID signing a query used for authorization with the keys WM Keeper WinPro or X.509 certificate WM Keeper WebPro
sign query signature formed out of: wmid + currency + purse + price
sign/@type query signature type 1 - signature formed using a special authentication module for keys WM Keeper WinPro, 2 - Signature formed using a X.509 certificate WM Keeper WebPro base64 encoded
payment/@currency payment currency determines payment currency, "USD"- payment accepted in USD, "EUR" - in Euros.
payment/purse payment details of the RECIPIENT - is not an obligatory parameter line – 13 symbols, first symbol latin letter Z or E and 12 digits; no space between symbols allowed
payment/price amount, received from the Payer in Eur or USD. Set up in @currency figure with a floating point (point - .(dot) ) for ten and half can look as follows: 10.5; nonsignificant zeroes at the end and a point, if the figure is a counting number it should be omitted, e.g, 10.50 - wrong, 10.5 - correct, 9. - wrong, 9 - correct)
  • response format:
<w3s.response>
 <retval></retval>
 <retdesc></retdesc>
 <payment currency="">
  <purse></purse>
  <price></price>
  <limit></limit>
 </payment> 
</w3s.response>
  • response parameters:
name reference comment
retval кStatus or error code 0 - query successful. other codes show unsuccessful query processing
retdesc error text description/empty "error text description. random line from 0 to 255 symbols; encoding: win-1251"
payment/@currency payment currency determines payment currency, "USD"- payment accepted in USD, "EUR" - in Euros.
payment/purse payment details of the RECIPIENT line – 13 symbols, first symbol latin letter Z or E and 12 digits; no space between symbols allowed
payment/price amount, received from the Payer in Eur or USD. Set up in @currency figure with a floating point (point - .(dot) ) for ten and half can look as follows: 10.5; nonsignificant zeroes at the end and a point, if the figure is a counting number it should be omitted, e.g, 10.50 - wrong, 10.5 - correct, 9. - wrong, 9 - correct)
payment/limit Maximum amount available for sending to the User's payment details figure with a floating point (decimal point - .(dot) )

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