This method initiates the beginning of a pre-authorization process for a customer. The customer is placed on a page that requests entering payment card details.
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 currency and amount
- Valid KeyIndex & corresponding Signature
- Valid OrderID
Please note all properties must be in PascalCase!
|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 Checkout in the myPOS system|
|WalletNumber||61938166610||String||YES||myPOS Client Number|
|KeyIndex||1||Int||YES||Indicates which key pair is being used.|
|URL_OK||http://site.ext/paymentOK||String||YES||The page where the cardholder should be redirected on successful payment.|
|URL_Cancel||http://site.ext/paymentNOK||String||YES||The page where the cardholder should be redirected when <Cancel> is pressed on the payment page.|
|URL_Notify*||https://site.ext/paymentNotify||String||YES||Address supplied by the partner, where the IPCPreAuthorization API call will send the parameters for the successful pre-authorization.|
|AccountSettlement||11111111119||N(11)||NO||Account for payment settlement.|
|Note||String||NO||Text associated with the pre-authorization.|
|ItemName||HP ProBook 6360b sticker||String||YES||The item for which the authorization is being issed.|
NOTE: * The URL_Notify URL should be SSL-enabled address only (i.e. it must start with "https://"). Unsecured URLs will cause communication error.
URLs must not have the port specified.
https://example.com/ - Correct
https://www.example.com/ - Correct
New lines and tabulators are included for better reading and do not exist in the POST request.
IPCmethod=IPCPreAuthorization& IPCVersion=1.4& IPCLanguage=EN& SID=000000000000010& WalletNumber=61938166610& Amount=23.45& Currency=EUR& OrderID=20120331999999& URL_OK=http://site.ext/paymentOK& URL_Cancel=http://site.ext/paymentNOK& URL_Notify=https://site.ext/paymentNotify& KeyIndex=1& Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHNbq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817