Get transaction status for previously submitted valid payment request

Purpose

This command is used by the partner to receive the status and the parameters of a successfully submitted payment request.
If the partner does not receive the MPRNotify call for a submitted financial request, he can initiate MPRGetTxnStatus command in order to receive the transaction status and payment details (if any).

 

Method properties

Property

Typical value

Type

Presence

Description

key_index 1 Int M Identifier of the private key used for the signature.
version 1.0  String  The version of the protocol used for transition.
login name@website.com String M Identifier of the partner. 
tid 90000015 AN(8) Terminal ID 
ruid 201203319999999 String  Unique identifier of the submitted request. Up to 255 characters.
ruid_original 201203319999999 String M Indicates the ruid that was presented in the previously submitted valid payment call (MPRPurchase, MPRLastTxnVoid or MPRRefund).
amount 23.45 N(6,2) M The amount of the requested payment.
signature Byte[] BASE64 M SHA-256 HASH for all properties in the command signed with the private key. The signature parameter is not used to calculate the hash.

 

Response properties

Property

Typical value

Type

Presence

Description

key_index 1 Int ME Echo from MPRGetTxnStatus.
version 1.0  String  ME  Echo from MPRGetTxnStatus.
login name@website.com String ME Echo from MPRGetTxnStatus.
tid 90000015 AN(8) ME  Echo from MPRGetTxnStatus.
ruid 201203319999999 String  ME Echo from MPRGetTxnStatus.
ruid_original 201203319999999 String ME Echo from MPRGetTxnStatus.
ruid_original_status 0 N(2) M The status of the executed payment command. Possible values = 0, 13, 14, 15.
original_method MPRNotify String M The name of the last executed command for this ruid.
amount 23.45 N(6,2) ME Echo from MPRSubscribe.
response_code 00   C

Response code from the issuer.
00 – transaction approved by the issuer;
≠00 – the Issuer or the card declines the transaction

auth_code VCQSIM AN(6) C Authorization code from the issuer. This code is obtained after successful authorization only. Otherwise, the field will be empty.
rrn 219159246364 N(12) C Retrieval reference number. Set by the terminal/acquirer.
stan 000029 N(6) C System Trace Audit Number / Invoice. Enumerator from the terminal. Increments on every transaction attempt. Values from 000001 to 999999. Unique when combined with date.
merch_txn_date 2015-06-29 YYYY-MM-DD C Transaction date as determined by the terminal.
merch_txn_time 18:17:25 HH:MM:SS C Transaction time as determined by the terminal.
mid 000000000000096 AN(15) C Merchant ID as specified in the terminal configuration. Setup by the acquirer at merchant contracting.
merch_name MYPOS *COMPANY AN(22) C Merchant name as specified in the terminal configuration. Setup by the acquirer at merchant contracting.
merch_address_line1 STOURPORT-ON-SEVERN AN(32) C Merchant address line 1 as specified in the terminal configuration. Setup by the acquirer at merchant contracting.
merch_address_line2 WORCESTE, UK AN(32) C Merchant address line 2 as specified in the terminal configuration. Setup by the acquirer at merchant contracting.
masked_pan *4521 AN(5) C Last 4 digits of the card PAN used for the payment.
emboss_name IVANOVA/MILENA AN(26) C Cardholder name (where applicable).
aid A0000000032020 AN(32) C AID as read from the chip card.
aid_name VISA VPay String C AID name as read from the chip card.
signature_required 1 N(1) C 0 – signature required
1 – signature not required
status 0 N(2) M Status of the request. For more information check Status Messages.
status_msg OK String O Additional details about the received status.
signature Byte[] BASE64 M SHA-256 HASH for all properties in the command signed with the private key. The signature parameter is not used to calculate the hash.

 

Example of the request:

<urn:MPRGetTxnStatus xmlns:urn="urnIPayService"> 
  <urn:key_index>1</urn:key_index> 
  <urn:version>1.0</urn:version> 
  <urn:login>name@website.com</urn:login> 
  <urn:tid>90000015</urn:tid> 
  <urn:ruid>201403319999999</urn:ruid> 
  <urn:ruid_original>201203319999999</urn:ruid_original>
 <urn:signature>bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</urn:signature> 
</urn:MPRGetTxnStatus>
<MPRGetTxnStatusResponse xmlns:urn="urnIPayService"> 
  <MPRGetTxnStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
    <a:method>MPRGetTxnStatus</a:method> 
    <a:key_index>1</a:key_index> 
    <a:version>1.0</a:version> 
    <a:login>name@website.com</a:login> 
    <a:tid>90000015</a:tid> <a:ruid>201403319999999</a:ruid> 
    <a:ruid_original>201203319999999</a:ruid_original> 
    <a:ruid_original_status>16</a:ruid_original_status> 
    <a:original_method>MPRNotify</a:original_method> 
    <a:amount>23.45</a:amount> 
    <a:response_code>00</a:response_code> <a:auth_code>VCQSIM</a:auth_code> 
    <a:rrn>219159246364</a:rrn> 
    <a:stan>000029</a:stan> 
    <a:merch_txn_date>2015-06-29</a:merch_txn_date> 
    <a:merch_txn_time>18:17:25</a:merch_txn_time> 
    <a:mid>000000000000096</a:mid> 
    <a:merch_name>MYPOS *COMPANY</a:merch_name> 
    <a:merch_address_line1>STOURPORT-ON-SEVERN</a:merch_address_line1> 
    <a:merch_address_line2>WORCESTE, UK</a:merch_address_line2> 
    <a:masked_pan>*4521</a:masked_pan> 
    <a:emboss_name>IVANOVA/MILENA</a:emboss_name>
    <a:aid>A0000000032020</a:aid> 
    <a:aid_name>VISA VPay</a:aid_name> 
    <a:signature_required>1</a:signature_required> 
    <a:status>0</a:status> 
    <a:status_msg>OK</a:status_msg> 
    <a:signature> bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature> 
  </MPRGetTxnStatusResult> 
</MPRGetTxnStatusResponse>

 

Example of the response when the payment was successfully processed (paid):

<MPRGetTxnStatusResponse xmlns:urn="urnIPayService"> 
  <MPRGetTxnStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:method>MPRGetTxnStatus</a:method> 
    <a:key_index>1</a:key_index> 
    <a:version>1.0</a:version> 
    <a:login>name@website.com</a:login> 
    <a:tid>90000015</a:tid> <a:ruid>201403319999999</a:ruid> 
    <a:ruid_original>201203319999999</a:ruid_original> 
    <a:ruid_original_status>0</a:ruid_original_status> 
    <a:original_method>MPRNotify</a:original_method> 
    <a:amount>23.45</a:amount> 
    <a:response_code>00</a:response_code> 
    <a:auth_code>VCQSIM</a:auth_code> 
    <a:rrn>219159246364</a:rrn> 
    <a:stan>000029</a:stan> 
    <a:merch_txn_date>2015-06-29</a:merch_txn_date> 
    <a:merch_txn_time>18:17:25</a:merch_txn_time> 
    <a:mid>000000000000096</a:mid> 
    <a:merch_name>MYPOS *COMPANY</a:merch_name> 
    <a:merch_address_line1>STOURPORT-ON-SEVERN</a:merch_address_line1> 
    <a:merch_address_line2>WORCESTE, UK</a:merch_address_line2> 
    <a:masked_pan>*4521</a:masked_pan> 
    <a:emboss_name>IVANOVA/MILENA</a:emboss_name> 
    <a:aid>A0000000032020</a:aid> 
    <a:aid_name>VISA VPay</a:aid_name> 
    <a:signature_required>1</a:signature_required> <a:status>0</a:status> 
    <a:status_msg>OK</a:status_msg> 
    <a:signature> bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature> 
  </MPRGetTxnStatusResult> 
</MPRGetTxnStatusResponse>

 

Example of the response when the payment was declined (not paid and finished):

<MPRGetTxnStatusResponse xmlns:urn="urnIPayService"> 
  <MPRGetTxnStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
    <a:method>MPRGetTxnStatus</a:method> 
    <a:key_index>1</a:key_index> 
    <a:version>1.0</a:version> 
    <a:login>name@website.com</a:login> 
    <a:tid>90000015</a:tid> <a:ruid>201403319999999</a:ruid> 
    <a:ruid_original>201203319999999</a:ruid_original> 
    <a:ruid_original_status>13</a:ruid_original_status> 
    <a:original_method>MPRNotify</a:original_method> 
    <a:amount>23.45</a:amount> 
    <a:response_code>05</a:response_code> 
    <a:auth_code> </a:auth_code>
    <a:rrn>219159246364</a:rrn> 
    <a:stan>000029</a:stan> 
    <a:merch_txn_date>2015-06-29</a:merch_txn_date> <a:merch_txn_time>18:17:25</a:merch_txn_time> 
    <a:mid>000000000000096</a:mid> 
    <a:merch_name>MYPOS *COMPANY</a:merch_name> 
    <a:merch_address_line1>STOURPORT-ON-SEVERN</a:merch_address_line1> 
    <a:merch_address_line2>WORCESTE, UK</a:merch_address_line2> 
    <a:masked_pan>*4521</a:masked_pan> 
    <a:emboss_name>IVANOVA/MILENA</a:emboss_name> 
    <a:aid>A0000000032020</a:aid> 
    <a:aid_name>VISA VPay</a:aid_name> 
    <a:signature_required>1</a:signature_required> 
    <a:status>0</a:status> <a:status_msg>OK</a:status_msg> 
    <a:signature> bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature> 
  </MPRGetTxnStatusResult> 
</MPRGetTxnStatusResponse>

 

Example of the response when the payment was reversed (successfully authorized and reversed afterwards):

<MPRGetTxnStatusResponse xmlns:urn="urnIPayService"> 
  <MPRGetTxnStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:method>MPRGetTxnStatus</a:method> 
    <a:key_index>1</a:key_index> 
    <a:version>1.0</a:version> 
    <a:login>name@website.com</a:login> 
    <a:tid>90000015</a:tid> 
    <a:ruid>201403319999999</a:ruid> 
    <a:ruid_original>201203319999999</a:ruid_original> 
    <a:ruid_original_status>16</a:ruid_original_status> 
    <a:original_method>MPRNotify</a:original_method> 
    <a:amount>23.45</a:amount> 
    <a:response_code>00</a:response_code> 
    <a:auth_code>VCQSIM</a:auth_code> 
    <a:rrn>219159246364</a:rrn> 
    <a:stan>000029</a:stan> 
    <a:merch_txn_date>2015-06-29</a:merch_txn_date> 
    <a:merch_txn_time>18:17:25</a:merch_txn_time> 
    <a:mid>000000000000096</a:mid> 
    <a:merch_name>MYPOS *COMPANY</a:merch_name> 
    <a:merch_address_line1>STOURPORT-ON-SEVERN</a:merch_address_line1> 
    <a:merch_address_line2>WORCESTE, UK</a:merch_address_line2> 
    <a:masked_pan>*4521</a:masked_pan> 
    <a:emboss_name>IVANOVA/MILENA</a:emboss_name> 
    <a:aid>A0000000032020</a:aid> 
    <a:aid_name>VISA VPay</a:aid_name> 
    <a:signature_required>1</a:signature_required>
    <a:status>0</a:status> 
    <a:status_msg>OK</a:status_msg> 
    <a:signature> bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature> 
  </MPRGetTxnStatusResult> 
</MPRGetTxnStatusResponse>

 

Example of the response when the payment is still pending (successfully authorized, however, the response from the terminal is still due):

<MPRGetTxnStatusResponse xmlns:urn="urnIPayService"> 
  <MPRGetTxnStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:method>MPRGetTxnStatus</a:method> 
    <a:key_index>1</a:key_index> 
    <a:version>1.0</a:version> 
    <a:login>name@website.com</a:login> 
    <a:tid>90000015</a:tid> 
    <a:ruid>201403319999999</a:ruid> 
    <a:ruid_original>201203319999999</a:ruid_original> 
    <a:ruid_original_status>15</a:ruid_original_status> 
    <a:original_method>MPRNotify</a:original_method> 
    <a:amount>23.45</a:amount> 
    <a:response_code>00</a:response_code> 
    <a:auth_code>VCQSIM</a:auth_code> 
    <a:rrn>219159246364</a:rrn> 
    <a:stan>000029</a:stan> 
    <a:merch_txn_date>2015-06-29</a:merch_txn_date> 
    <a:merch_txn_time>18:17:25</a:merch_txn_time> 
    <a:mid>000000000000096</a:mid> 
    <a:merch_name>MYPOS *COMPANY</a:merch_name> 
    <a:merch_address_line1>STOURPORT-ON-SEVERN</a:merch_address_line1> 
    <a:merch_address_line2>WORCESTE, UK</a:merch_address_line2> 
    <a:masked_pan>*4521</a:masked_pan> 
    <a:emboss_name>IVANOVA/MILENA</a:emboss_name>
    <a:aid>A0000000032020</a:aid> 
    <a:aid_name>VISA VPay</a:aid_name> 
    <a:signature_required>1</a:signature_required> 
    <a:status>0</a:status> 
    <a:status_msg>OK</a:status_msg> 
    <a:signature> bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature> 
  </MPRGetTxnStatusResult> 
</MPRGetTxnStatusResponse>

 

Example of the response when the payment is still pending (the data is received from the terminal however the transaction steps are not completed and the transaction is not sent for authorization):

<MPRGetTxnStatusResponse xmlns:urn="urnIPayService"> 
  <MPRGetTxnStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:method>MPRGetTxnStatus</a:method> 
    <a:key_index>1</a:key_index> 
    <a:version>1.0</a:version> 
    <a:login>name@website.com</a:login> 
    <a:tid>90000015</a:tid> <a:ruid>201403319999999</a:ruid> 
    <a:ruid_original>201203319999999</a:ruid_original> 
    <a:ruid_original_status>15</a:ruid_original_status> 
    <a:original_method>MPRNotify</a:original_method> 
    <a:amount>23.45</a:amount> 
    <a:response_code> </a:response_code> 
    <a:auth_code> </a:auth_code> 
    <a:rrn> </a:rrn> 
    <a:stan> </a:stan>
    <a:merch_txn_date> </a:merch_txn_date> 
    <a:merch_txn_time> </a:merch_txn_time> 
    <a:mid> </a:mid> 
    <a:merch_name> </a:merch_name> 
    <a:merch_address_line1> </a:merch_address_line1> 
    <a:merch_address_line2> </a:merch_address_line2> 
    <a:masked_pan> </a:masked_pan> 
    <a:emboss_name> </a:emboss_name> 
    <a:aid> </a:aid> 
    <a:aid_name> </a:aid_name> 
    <a:signature_required> </a:signature_required> 
    <a:status>0</a:status> 
    <a:status_msg>OK</a:status_msg> 
    <a:signature> bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature> 
  </MPRGetTxnStatusResult> 
</MPRGetTxnStatusResponse>

 

NOTE: The partner system could initiate MPRGetTxnStatus method only for ruid from previously submitted valid requests. In all other cases, the call will return error message - 4 E_INVALID_PARAMS.