API call: MPRSubscribe
Purpose
This command is used by the partner to subscribe a myPOS device to the service. All other commands could be initiated only for myPOS terminals which are already subscribed. Within the response of MPRSubscribe call, the partner will receive a security code generated for the particular Terminal ID (TID). The code must be entered on the myPOS device in order to complete the subscription. With a successful pair, the myPOS device will switch from ‘Standalone’ mode to ‘Cash register’ mode.
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 | M | Identifier of the partner. |
| key_index | 1 | Int | M | Identifier of the private key used for the signature. |
| tid | 90000015 | AN(8) | M | Terminal ID |
| ruid | 201203319999999 | String | M | Unique identifier of the submitted request. Up to 255 characters. |
| currency | EUR | A(3) | M | ISO 3-character currency code. It must match the currency of the terminal. Otherwise, the call will return an error. |
| action | 1 | N(1) | M | 1 - Subscribe TID for the service; 2 - Cancellation of the subscription. |
| 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 | String | ME | Echo from MPRSubscribe. |
| login | name@website.com | String | ME | Echo from MPRSubscribe. |
| key_index | 1 | Int | ME | Echo from MPRSubscribe. |
| tid | 90000015 | AN(8) | ME | Echo from MPRSubscribe. |
| ruid | 201203319999999 | String | ME | Echo from MPRSubscribe. |
| currency | EUR | A(3) | ME | Echo from MPRSubscribe. |
| action | 1 | N(1) | ME | Echo from MPRSubscribe. |
| code | 78025608 | N(8) | M | This security code must be entered on the myPOS device in order to complete the subscription or to confirm the cancellation of the subscription. |
| 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 (The elements must follow this order):
<urn:MPRSubscribe xmlns:urn="urnIPayService">
<urn:version>3.0</urn:version>
<urn:login>name@website.com</urn:login>
<urn:key_index>1</urn:key_index>
<urn:tid>90000015</urn:tid>
<urn:ruid>201203319999999</urn:ruid>
<urn:currency>EUR</urn:currency>
<urn:action>1</urn:action>
<urn:signature>bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</urn:signature>
</urn:MPRSubscribe>
Example of the response:
<MPRSubscribeResponse xmlns:urn="urnIPayService">
<MPRSubscribeResult xmlns:a="http://schemas.datacontract.org/2004/07/iPay.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:version>3.0</a:version>
<a:login>name@website.com</a:login>
<a:key_index>1</a:key_index>
<a:tid>90000015</a:tid>
<a:ruid>201203319999999</a:ruid>
<a:currency>EUR</a:currency>
<a:action>1</a:action>
<a:code>78025608</a:code>
<a:status>0</a:status>
<a:status_msg>OK</a:status_msg>
<a:signature> bUViE5SzWy9iYpWzxlEVO/8Yb6bvtJVn1P6/rat5NBdgJaBU7OxeRm8rxi/fW1xuekqDM06F4MbzUPnTIA/sZ1ZwlMjSTExY5+7DqkdejN7mDgnB8zogrOfF6/P1snxuNgPRtHuJ0ZeTdTWNm9kKPGE7IadvIGtOpF+7yspfWd4=</a:signature>
</MPRSubscribeResult>
</MPRSubscribeResponse>