Switch to author mode

Interface A2

INTERFACE A2. Payment request

We recommend sending this query after the Preliminary query has been successfully fulfilled. If you receive the negative response for this query you should send it again (after the cause is eliminated) with the same unique id number (to avoid double crediting of funds) until you receive at positive response. The payment is considered to be made the following the receipt of the positive response <retval>0</retval>.

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

<w3s.query>
 <wmid></wmid>
 <sign type=""></sign>
 <payment id="" test="">
  <pspname></pspname>
  <pspcode></pspcode> 
  <pspnumber></pspnumber>
  <pspdate></pspdate>
  <purse></purse>
  <price></price>
  <cheque></cheque>
  <date></date>
  <kiosk_id></kiosk_id>
 </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 + id+ test + pspname+ pspcode+ pspnumber+ pspdate purse+price+cheque date+ kiosk_id
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/@id Unique transaction ID number Unique transaction ID number formed by the Agent. A decimal number in double quotes that contains no more than 18 digits. The uniqueness of the «id» allows you to resend a payment query with the same transaction number in case there are no responses to the previous query (connection error, etc.) or if the query has failed. In case of the repeated query with the same number for the payment that is already received, the payment status will be retrieved. The attribute «test» determines the query mode and has two values: "1"- payment in the test mode, "0" – operation mode. The id number should be unique for both test and operation modes. If the id was used for the test mode it cannot be used for the operation mode.
payment/@test query mode Specifies the query mode and has two values, "1"- payment in the test mode, "0" – operation mode.
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 Figure 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/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 «Document number» on the code confirmation.
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 «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
payment/kiosk_id Unique number issued by the Agent A whole decimal number that contains no more than 16 digits. Corresponds to «Unique number» on the code confirmation.
  • response format:
<w3s.response>
 <retval></retval> 
 <retdesc></retdesc>
 <payment>
  <pspname></pspname>
  <pspcode></pspcode>
  <pspnumber></pspnumber>
  <pspdate></pspdate>
  <price></price>
  <amount></amount>
  <comiss></comiss>
  <rest></rest>
  <purse></purse>
  <cheque></cheque>
  <date></date>
  <kiosk_id></kiosk_id>
  <wmtranid></wmtranid>
  <dateupd></dateupd>
 </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/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)
payment/comiss Commission 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/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.
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.
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 «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
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.
payment/wmtranid Transaction number in WebMoney Transfer system Unique transaction number in the WebMoney Transfer System
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