Purpose
This method initiates the beginning of the payment 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 total amount
- Valid KeyIndex & corresponding Signature
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 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. |
| 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 IPCPurchaseNotify API call will send the parameters for the successful payment. |
| PaymentMethod | 1 | N(1) | NO |
Conditional If a property is not set, the customer is redirected to a myPOS Hosted payment page with selection of all payment methods myPOS Checkout supports; 1 – Redirects the customer to a card-only checkout. 2 – Redirects the customer to iDEAL-only checkout. 3 – Redirects the customer to а chekout where both options are available. |
| CardTokenRequest | 0 | N(1) | YES |
0 – Do not request a payment card token |
| PaymentParametersRequired | 1 | N(1) | YES |
1- Full request (All parameters described as conditional are required in the request. The client will not be able to edit them on the payment page.) 2 – Simplified request (All parameters described as conditional are not required in the request. The client will be forced to fill them in on the payment page.) 3 – Simplified request & Simplified payment page (All parameters described as conditional are not required in the request. On the payment page the client will see and fills in only the payment card details.) |
| CustomerEmail | name@website.com | String | Conditional |
Conditional. The parameter is required when PaymentParametersRequired = 1 This is a customer’s email. |
| CustomerPhone | +23568956958 | String | NO | This is a customer’s phone. |
| CustomerFirstNames | John Santamaria | String | Conditional |
Conditional. The parameter is required when PaymentParametersRequired = 1 All customer’s names without the surname. |
| CustomerFamilyName | Smith | String | Conditional |
Conditional. The parameter is required when PaymentParametersRequired = 1 The customer’s surname. |
| CustomerCountry | DEU | String | NO | ISO3 country code |
| CustomerCity | Hamburg | String | NO | |
| CustomerZIPCode | 20095 | String | NO | |
| CustomerAddress | Kleine Bahnstr. 41 | String | NO | Customer’s address. |
| AccountSettlement | 11111111119 | N(11) | NO | Account for payment settlement. |
| Note | String | NO | Text associated with the purchase. | |
| CartItems | 2 | Int | Conditional |
The number of rows (items) in the logical record Cart. If there will be some additional fees/taxes for the cardholder, they need to be added as new items. |
| Cart | Logical Holder | Logical Record | Conditional | Array provided by the Merchant. The array describes the content of the shopping cart. The content will be displayed on the myPOS Checkout API payment page. |
| Delivery | 5 | Double | NO | You can specify your delivery price. |
NOTE: * The URL_Notify URL should be SSL-enabled address only (i.e. it must start with "https://"). Unsecured URLs will cause a communication error.
URLs must not have the port specified.
https://example.com/ - Correct
https://www.example.com/ - Correct
Same OrderID is used for the request of a partner, except in a case where the order has been marked as paid. Then OrderID is a unique identifier and myPOS Checkout API will reject duplicated transmission.
Cart Logical Record
Cart logical record consists of standard POST parameters with the form name=value. For every consequent item, an index is added that shows the logical record number for the item (ex. Atricle_1). Indexes are from 1 to <CartItems>.
|
Property |
Typical value |
Type |
Description |
|---|---|---|---|
|
Article |
HP ProBook 6360b sticker |
String |
Name of an article in the shopping cart. |
|
Quantity |
2 |
Int |
How many pieces of an article. |
|
Price |
2.34 |
Double |
Price of a single unit. |
|
Amount |
4.68 |
Double |
Quantity*Price for the article. |
|
Currency |
EUR |
A(3) |
Should be the same currency as in the purchase amount. |
Example
New lines and tabulators are included for better reading and do not exist in the POST request.
IPCmethod=IPCPurchase&
IPCVersion=1.4&
IPCLanguage=EN&
SID=000000000000010&
walletnumber=61938166610&
Amount=20.55&
Currency=EUR&
OrderID=1600091872&
URL_OK=https://site.ext/paymentOK&
URL_Cancel=https://site.ext/paymentNOK&
URL_Notify=https://site.ext/paymentNotify&
CardTokenRequest=0&
KeyIndex=1&
PaymentParametersRequired=1&
PaymentMethod=1&
customeremail=name@website.com&
customerfirstnames=John Santamari&
customerfamilyname=Smith&
customerphone=+359888222333&
customercountry=DEU&
customercity=Hamburg&
customerzipcode=20095&
customeraddress=Kleine Bahnstr. 41&&
Note=Some note here &
Source=&
CartItems=2&
Article_1=HP ProBook 6360b sticker &
Quantity_1=2&
Price_1=10&
Currency_1=EUR&
Amount_1=20&
Article_2=Discount&
Quantity_2=1&
Price_2=-3.45&
Currency_2=EUR&
Amount_2=-3.45&
delivery=4&
Signature=UzvTG8AKhBHsZQ6x+SjWlgZp8pAkJgMmQLYq/Pbs4a9znL4xaKEaGV82IzZjF+2UAQynjSAmHeVpJZT7R8q3lzQwKk9gmY8iDWsmig7NMPDK1Bqo3Zvrd64lCUpo19wy6kNLTljRUJ8eFqOJStTHP3TBZSnbEH5yGSjUXTMTfL0=IPCmethod=IPCPurchase&
IPCVersion=1.4&
IPCLanguage=EN&
SID=000000000000010&
walletnumber=61938166610&
Amount=23.45&
Currency=EUR&
OrderID=1600090687&
URL_OK=https://site.ext/paymentOK&
URL_Cancel=https://site.ext/paymentNOK&
URL_Notify=https://site.ext/paymentNotify&
CardTokenRequest=0&
KeyIndex=1&
PaymentParametersRequired=1&
PaymentMethod=1&
customeremail=name@website.com&
customerfirstnames=John Santamari&
customerfamilyname=Smith&
customerphone=+359888222333&
customercountry=DEU&
customercity=Hamburg&
customerzipcode=20095&
customeraddress=Kleine Bahnstr. 41&&
Note=Some note here &
Source=&
CartItems=2&
Article_1=HP ProBook 6360b sticker &
Quantity_1=2&
Price_1=10&
Currency_1=EUR&
Amount_1=20&
Article_2=Discount&
Quantity_2=1&
Price_2=-3.45&
Currency_2=EUR&
Amount_2=-3.45&
Delivery=7&
Signature=ixmOCzzrfFj8KQtuIailsceiJ0/xCL9m/tgCxe2wi88dkjMyQvtM4kxQe8+fzC3z9sPBjm90cbBNwAUF7/zjRq6GZrismvAucDjbOBHMFknH8H7gqJNq0fw85p4LLUONJfDUhE3D9/N+hyw6avCUMXOmDPKBH5bXB2S6l5AVww8=&
