Purpose
This method cancels a pre-authorization made for a customer.
myPOS Checkout API will check for:
- Valid myPOS Account number (also referred to as Client number)
- Valid Checkout Store ID (SID) corresponding with this myPOS Account number
- Valid status of the Checkout (enabled)
- Valid KeyIndex & corresponding Signature
- Valid OrderID
Method Properties
Please note all properties must be in PascalCase!
Property |
Typical value |
Type |
Required |
Description |
---|---|---|---|---|
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 80 characters. |
SID | 000000000000010 | String | YES | Store ID (SID) - Reference number for the Merchant Checkout 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 IPCPreAuthCancellation |
Currency |
EUR |
A(3) |
Echo from IPCPreAuthCancellation |
Example request
New lines and tabulators are included for better reading and do not exist in the POST request.
IPCmethod=IPCPreAuthCancellation& IPCVersion=1.4& IPCLanguage=EN& SID=000000000000010& WalletNumber=61938166610& OrderID=944212f3-2232-4f3e-9199-42700bc33198& KeyIndex=1& Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHNbq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817
Example response
<ipc_response is-array="true"> <IPCmethod>IPCPreAuthCancellation</IPCmethod> <Amount>1.23</Amount> <Currency>EUR</Amount> <Status>0</Status> <StatusMsg>Success</StatusMsg> <Signature>rXTlLRRmgPvhsFK07bB/azoYdX7khO4EDl0abyOA9eJ6Day/kj4qzE6aHFJqZUOgMNqKx+eRbewLfuO1qKPWCS+n2vOXpusFdEEziYkgb5rhGzb1NRi4lJ90DsvKl2el1ktHGSF8kYKQsDfX4hJ02CkOrHYs8lifQwiZGYuGJ5A=</Signature> </ipc_response>
{ "IPCmethod": "IPCPreAuthCancellation", "Amount": "1.23", "Currency": "EUR", "Status": 0, "StatusMsg": "Success", "Signature": "rXTlLRRmgPvhsFK07bB/azoYdX7khO4EDl0abyOA9eJ6Day/kj4qzE6aHFJqZUOgMNqKx+eRbewLfuO1qKPWCS+n2vOXpusFdEEziYkgb5rhGzb1NRi4lJ90DsvKl2el1ktHGSF8kYKQsDfX4hJ02CkOrHYs8lifQwiZGYuGJ5A=" }