Purpose


This command is used by the partner to initiate a cancellation of a previous successfully submitted financial request. The partner can use this call when the client decides to use different payment method or if there is a pending payment request on the terminal (Error code 11 E_PENDING_REQUEST).

 

Method properties

Property

Typical value

Type

Presence

Description

version 3.0 String  M The version of the protocol used for transition.
login name@website.com String  Identifier of the partner. 
key_index 1 Int M Identifier of the private key used for the signature.
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 original call (MPRPurchase, MPRLastTxnVoid or MPRRefund).
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

version 3.0 Int ME Echo from MPRCancel..
login name@website.com String  ME  Echo from MPRCancel..
key_index 1 String ME Echo from MPRCancel..
tid 90000015 AN(8) ME  Echo from MPRCancel..
ruid 201203319999999 String  ME Echo from MPRCancel..
ruid_original 201203319999999 String ME Indicates the ruid that was presented in the original call (MPRPurchase, MPRLastTxnVoid or MPRRefund).
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:MPRCancel 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</url:ruid_original> <urn:signature>bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</urn:signature> 
</urn:MPRCancel>

 

Example of the response

<MPRCancelResponse xmlns:urn="urnIPayService"> 
<MPRCancelResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <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:status>0</a:status> 
<a:status_msg>OK</a:status_msg> 
<a:signature>bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature> 
</MPRCancelResult> 
</MPRCancelResponse>