Purpose
This method completes a pre-authorization made for a customer.
myPOS Checkout will check for:
- Valid myPOS Account number (also referred to as Client number)
- Valid Online Store ID (SID) corresponding with this myPOS Account number
- Valid status of the Online Store (enabled)
- Valid currency and amount
- Valid KeyIndex & corresponding Signature
- Valid OrderID
Method Properties
Please note all properties must be in PascalCase!
Property |
Typical value |
Type |
Required |
Description |
---|---|---|---|---|
Amount | 23.45 | Double | YES | The amount of the payment requested. |
Currency | EUR | A(3) | YES | ISO 3-character currency code. The currency for the payment should be registered and approved. |
OrderID | 20120331999999 | String | YES | Placeholder for the merchant. Used to put some data that will help the merchant to recognize for which order is the payment. Up to 255 characters. |
SID | 000000000000010 | String | YES | Store ID (SID) - Reference number for the Merchant Store in the myPOS system |
WalletNumber | 61938166610 | String | YES | myPOS Client Number |
KeyIndex | 1 | Int | YES | Indicates which key pair is being used. |
Response properties
Property |
Typical value |
Type |
Description |
---|---|---|---|
Amount |
23.45 |
Double |
Echo from IPCPreAuthCompletion. |
Currency |
EUR |
A(3) |
Echo from IPCPreAuthCompletion. |
OrderID |
201203319999999 |
string |
Echo from IPCPreAuthCompletion. |
Example request
New lines and tabulators are included for better reading and do not exist in the POST request.
IPCmethod=IPCPreAuthCompletion&
IPCVersion=1.4&
IPCLanguage=EN&
SID=000000000000010&
WalletNumber=61938166610&
Amount=23.45&
Currency=EUR&
OrderID=944212f3-2232-4f3e-9199-42700bc33198&
KeyIndex=1&
Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHNbq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817
Example response
<ipc_response is-array="true">
<IPCmethod>IPCPreAuthCompletion</IPCmethod>
<Amount>1.23</Amount>
<Currency>EUR</Amount>
<OrderID>944212f3-2232-4f3e-9199-42700bc33198</OrderID>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
<Signature>AMYjnI3eo4QZy2cT66Ybdl1U+sDjHz9Le1PBjeyBZbWDZN/tHkAkhF3A4UJUkJE0huF/yaakmGwFssqpp95nlZ7KUdKYpJG7XYmAVM7sHzWbACtvf98lYE7MgghylpjXzpxg6l92i/8QpW9Flqc6xvxHXPC6PzIGvLxaLOe+R9Y=</Signature>
</ipc_response>
{
"IPCmethod": "IPCPreAuthCompletion",
"Amount": "1.23",
"Currency": "EUR",
"OrderId": "944212f3-2232-4f3e-9199-42700bc33198",
"Status": 0,
"StatusMsg": "Success",
"Signature": "AMYjnI3eo4QZy2cT66Ybdl1U+sDjHz9Le1PBjeyBZbWDZN/tHkAkhF3A4UJUkJE0huF/yaakmGwFssqpp95nlZ7KUdKYpJG7XYmAVM7sHzWbACtvf98lYE7MgghylpjXzpxg6l92i/8QpW9Flqc6xvxHXPC6PzIGvLxaLOe+R9Y="
}