Guest  Login
Reader

WMTransfer Wiki
Interface X18

Interface X18. Getting transaction details via merchant.wmtransfer.com.

This interface is available only to registered clients who use the merchant.wmtransfer.com service.

This interface allows the user to automatically get information about payment status and whether the payment was made or not by using payment numbers (lmi_payment_no for merchant.wmtransfer.com). If the payment was made, then the user will be able to get payment details. Interface X18 does not only have strict WMSigner, but also simple (MD5 or passing secret_key via https) authentication which allows integrating this interface easily and securely and using it to search for payments.

<merchant.request>
	<wmid></wmid>
	<lmi_payee_purse></lmi_payee_purse>
	<lmi_payment_no></lmi_payment_no>
	<sign></sign>
	<md5></md5>
	<secret_key></secret_key>
</merchant.request>
  • Request parameters:
name purpose comments
wmid WM identifier of the recipient or signature WMID of the user who owns the purse, to which lmi_payment_no payment was received via merchant.wmtransfer.com or WMID of the user who signed the request using the WMSigner authentication method. Keep in mind that if the owner of that WMID does not own the purse which received the payment, there must be trust granted to view transaction details for this purse.
lmi_payee_purse WM purse of payment recipient purse number to which lmi_payment_no payment was received and for which the status needs to be determined.
lmi_payment_no payment number The number of the payment which was generated by the service, website, other service, Internet store, etc., and was transferred to the merchant.wmtransfer.com service as a payment in a hidden lmi_payment_no field. Note that if the lmi_payee_purse purse is not configured in the merchant.wmtransfer.com service to receive only a unique lmi_payment_no, then there might be situations when the merchant through his/her fault might generate for different purchases or even purchasers one and the same lmi_payment_no. In such cases the service will register two payments with one and the same number, and this case the interface will retrieve ONLY one transaction – the last one.
sign Request signature The request is signed with WM identifier keys using the WMSigner method and takes the following parameters: wmid & lmi_payee_purse & lmi_payment_no. Keep in mind that if the owner of the WM identifier does not own the lmi_payee_purse, then this WMID must be trusted at security.wmtransfer.com to view transaction details for the lmi_payee_purse. In cases when this authentication method is used, md5 and secret_key parameters must be left empty or omitted.
md5 Request signature The request is signed using the MD5 method and takes the following parameters: wmid & lmi_payee_purse & lmi_payment_no & secret_key. If the user uses this method for authenticating the request, sign and secret_key parameters must be left empty or omitted. Bear in mind that when generating the string to which md5 algorithm will be applied, the value of secret key from the purse settings in the merchant.wmtransfer.com service is used as secret_key. The request itself must pass ONLY the result of the algorithm work in MD5 parameter and secret_key parameter must be left empty!!!
secret_key Secret key This parameter passes the value of the secret key specified in the lmi_payee_purse settings in the merchant.wmtransfer.com service. Keep in mind that when using this method, https connection authentication checking (validity and ownership of the root certificate of https://merchant.wmtransfer.com, etc) will be your responsibility to avoid DNS substitution and the like. If you use this method for authenticating the request, sign and md5 parameters must be left empty or omitted.
  • Response format:
<?xml version="1.0"?>
<merchant.response>
	<operation wmtransid="" wminvoiceid="">
		<operdate></operdate>
		<purpose></purpose>
		<pursefrom></pursefrom>
		<capitallerflag></capitallerflag>
		<enumflag></enumflag>
		<IPAddress></IPAddress>
		<telepat_phone></telepat_phone>
		<paymer_number></paymer_number>
		<paymer_email></paymer_email>
		<cashier_number></cashier_number>
		<cashier_date></cashier_date>
		<cashier_amount></cashier_amount>
	</operation> 
	<retval>0</retval> 
	<retdesc></retdesc> 
</merchant.response> 
  • Response parameters:
name purpose description
wmtransid WM transaction ID Unique transaction number in WebMoney Transfer.
wminvoiceid WM invoice ID Unique invoice number in WebMoney Transfer.
amount Amount The amount of WebMoney units transferred in this transaction to the merchant.
operdate Operation date Server date of the transaction in WebMoney Transfer.
purpose Comment The payment purpose as submitted to the merchant.wmtransfer.com service in the lmi_payment_desc field.
pursefrom Purchaser’s purse WM purse of the payer. Note that when paying via terminals or ATMs, or Paymer check or WM card the purse of the corresponding gateway or Paymer service will be passed as Payer’s purse.
wmidfrom Purchaser’s WMID WMID to which pursefrom belongs.
capitallerflag Payment parameter If the flag is set to 1 – it means that the payer used the purse of the Capitaller service and not his/her own purse for the payment; if set to 0 – the payer used his/her own purse for the payment.
enumflag Payment parameter If this flag is set to 1 – it means that the payment was made by a user who authorized via the E-num.ru service.
IPAddress Payment parameter The IP address of the user who made the payment.
telepat_phone Payment parameter The phone number of the payer, if the payment was made via WM Keeper Mobile.
paymer_number Payment parameter The number of the check or payer’s WM card if the payment was made by means of Paymer check or WM card.
paymer_email Payment parameter Payer’s e-mail address, which he/she specified when paying by means of Paymer check or WM card.
cashier_number Payment parameter The number of the payment, if payer paid via a terminal, ATM or post office.
cashier_date Payment parameter The date of the payment, if it was made via a terminal, ATM or post office.
cashier_amount Payment parameter The amount of the payment, if it was made via a terminal, ATM or post office.
retval Execution code 0 – request successful, other values mean there were errors during request.
retdesc Description of execution code

See also: XML interfaces

Category: XML-Interfaces

This article in other languages: Русский