0% found this document useful (0 votes)

49 views60 pages

MyPOS Checkout API v1.4 en v1

The myPOS Checkout API provides a secure and efficient interface for e-commerce payment solutions, allowing merchants to accept online payments via debit or credit cards. It supports multi-currency transactions and offers features such as payment notifications, refunds, and transaction management. The document outlines the API's integration process, technical specifications, and compliance requirements for merchants using the service.

Uploaded by

houdaifaabagour

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

49 views60 pages

MyPOS Checkout API v1.4 en v1

Uploaded by

houdaifaabagour

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 60

myPOS Checkout API

Accepting online payments

Version 1.4

Document version 1.4.0

myPOS Europe Ltd.

Accepting online payments
myPOS Checkout API v.1.4

Table of Contents
Table of Contents .............................................................................................................................................. 2

Version control .................................................................................................................................................. 5

Part 1: General Overview ...................................................................................................................................... 6

Introduction ...................................................................................................................................................... 6

Scope ............................................................................................................................................................ 7

Structural features of the handbook .............................................................................................................. 7

Terms and descriptions.................................................................................................................................. 8

Where to start ................................................................................................................................................... 9

Payment Gateway details .................................................................................................................................. 9

Implementation basics .................................................................................................................................. 9

Use of Trademarks on Merchant’s website .................................................................................................. 13

Currencies accepted at myPOS Checkout API ............................................................................................... 14

Security and availability ............................................................................................................................... 14

Business myPOS Account details...................................................................................................................... 16

Integrating myPOS Checkout with online stores ........................................................................................... 16

Adding of an online store ............................................................................................................................. 16

E-commerce transactions ............................................................................................................................ 19

Reserve ....................................................................................................................................................... 19

Details ......................................................................................................................................................... 20

Part 2: Technical integration ................................................................................................................................ 21

Overview ......................................................................................................................................................... 22

HTTP POST ................................................................................................................................................... 22

Data type formats ........................................................................................................................................ 22

Signature and authentications ..................................................................................................................... 22

Test environment ........................................................................................................................................ 24

Document revision 1.4.0 myPOS Europe Ltd. Page 2

Accepting online payments
myPOS Checkout API v.1.4

The process ..................................................................................................................................................... 27

Understanding transmission mechanism ..................................................................................................... 27

Method standard properties........................................................................................................................ 28

Response standard properties ..................................................................................................................... 28

The calls .......................................................................................................................................................... 28

Purchase with payment card (API call: IPCPurchase) .................................................................................... 29

Purchase with iCard Mobile (API call: IPCPurchaseByIcard) .......................................................................... 34

Successful payment notification (API call: IPCPurchaseNotify / IPCPurchaseOK) ........................................... 37

Cancelation of payment notification (API call: IPCPurchaseCancel) .............................................................. 38

Rollback of previous notification (API call: IPCPurchaseRollback) ................................................................. 39

In-app Purchase with payment card (API call: IPCIAPurchase) ...................................................................... 39

Get transaction log for previously executed payment (API call: IPCGetTxnLog) ............................................ 42

Make a refund for previously executed payment (API call: IPCRefund)......................................................... 48

Make a reversal for previously executed payment (API call: IPСReversal)..................................................... 49

Store card data for recurring payments (API call: IPCIAStoreCard) ............................................................... 50

Update data of stored card for recurring payments (API call: IPCIAStoredCardUpdate) ................................ 51

Request money from a client’s myPOS account (API call: IPCRequestMoney)............................................... 52

Manage registrations for Request money transactions (API call: IPCMandateManagement) ........................ 53

Get transaction status for previously executed payment (API call: IPCGetTxnStatus) ................................... 54

Make a credit note to a myPOSWallet (API call: IPCSendMoney) .................................................................. 55

Appendix I – Error messages............................................................................................................................ 58

Appendix II – Testing data ............................................................................................................................... 59

Test private key ........................................................................................................................................... 59

myPOS test public certificate ....................................................................................................................... 59

Appendix III – Example for successful payment notification ............................................................................. 60

Document revision 1.4.0 myPOS Europe Ltd. Page 3

Accepting online payments
myPOS Checkout API v.1.4

Result POST data ......................................................................................................................................... 60

Appendix IV – Card types ................................................................................................................................. 60

Appendix V – Card verification......................................................................................................................... 60

Document revision 1.4.0 myPOS Europe Ltd. Page 4

Accepting online payments
myPOS Checkout API v.1.4

Version control
Date posted API Document Description
Version revision

19.08.2015 1.0 1 Version 1.0

13.11.2015 1.0 2 Review of POST requests examples
01.07.2016 1.0 3 Review of POST requests examples
20.12.2016 1.1 0 Version 1.1. Updated calls - IPCPurchase; IPCPurchaseNotify
09.01.2017 1.2 0 Version 1.2
20.02.2017 1.3 0 Version 1.3
Updated calls - IPCPurchase; IPCPurchaseNotify; IPCIAStoreCard;
IPCIAStoredCardUpdate
14.03.2017 1.3 1 Version 1.3 / Document revision 1
New calls – IPCRequestMoney, IPCMandateManagement
Appendix I and V review
Rebranding from myPOS Virtual to myPOS Checkout
19.05.2017 1.3 2 Version 1.3 / Document revision 2
Updated calls / response - IPCPurchaseNotify, IPCIAStoreCard,
IPCIAStoredCardUpdate
01.06.2017 1.3 3 Renaming Payment Gateway
11.07.2017 1.3 4 Version 1.3 / Document revision 4
New call – IPCSendMoney
12.12.2017 1.3 5 Version 1.3 / Document revision 5
New call – IPCPurchaseByIcard
30.10.2018 1.4 0 iDEAL Payments

Document revision 1.4.0 myPOS Europe Ltd. Page 5

Accepting online payments
myPOS Checkout API v.1.4

Part 1: General Overview

Introduction
myPOS Checkout API is a customer friendly interface for e-commerce payment solutions for your Online store. The
API will let your customers to pay for goods and services quickly and securely using their debit or credit card.

The API will gain access to the entry point of Payment Gateway managed by myPOS Europe Ltd. By using hosted
checkout secure pages, the merchant adhere to compliance rules for handling customer data in a secure way: data
is stored on security servers so that it is not exposed to compromise.

The API enables you quickly and easily to integrate myPOS Checkout into all your online stores as a method of
payment. The integration will give you the opportunity to receive money from your customers instantly, in multi-
currencies, to track and manage your payments from all your online stores in a single place and to manage your
online stores settings. Therewith the API will give convenience to all your customers to choose their preferred
payment method from a single source.

Using the myPOS Checkout API your customers will be temporary redirected to https://www.mypos.eu/vmypos/.
The Payment Gateway will handle and guide the customer during the payment process, will check the card sensitive
data and will process a payment transaction through card schemes (VISA, MasterCard, JCB).

Once the payment is complete, the customer will be returned to the merchant’s website. You will receive
notification about the payment along with the transaction details.

myPOS Checkout API will provide:

• Secured page and Secured communication channel with the merchant;

• Storing of merchant private data (shopping cart, amount, payment method, transaction details etc.);
• Financial transactions to VISA, MasterCard, JCB (if applicable);
• Operations for the front-end: Purchase transaction, Manage online stores settings;
• 3D secure processing for direct payments with Debit or Credit Cards.

Document revision 1.4.0 myPOS Europe Ltd. Page 6

Accepting online payments
myPOS Checkout API v.1.4

Scope
This handbook is aimed at the operators of e-commerce companies who would like to optimize their payment
processes using an innovative and complete payment solution.

The purpose of this document is to specify the myPOS Checkout API Interface and demonstrate how it is used in
the most common way, therewith to provide technical details about the system integration.

It is intended to be utilized by:

the merchant / commercial decision makers

Certain sections describe the functions, main requirements and processes of the myPOS Checkout payment system
from the stance of e-commerce Business development managers. The document provides guidance on what is a
myPOS Checkout API, how it works, getting started, setting up a myPOS Account Number, main benefits of the API
and FAQs.

the IT specialists and developers

Other sections of this manual describe the technical background of the myPOS Checkout system. The document
provides guidance on technical integration of the API with detailed working examples, use cases and error codes.

Structural features of the handbook

Important notes are indicated by the pictogram on the left.

References to another point in the text or to another document are indicated by the pictogram on the
left.

<?xml . Expressions or code examples are written in grey background with smaller font size.

Document revision 1.4.0 myPOS Europe Ltd. Page 7

Accepting online payments
myPOS Checkout API v.1.4

Terms and descriptions

API - Application Programming Interface for implementation of the myPOS Checkout system in the merchant e-
commerce application.

myPOS Account number - Unique identifier for the Business Account of the merchant.

Online store ID – Unique Identifier for any online store (website) of the merchant which will use the myPOS
Checkout API as a payment method.

PAN - Unique payment card number, which identifies the Issuer and the particular cardholder account.

Call – Call by the merchant’s e-commerce system to myPOS Checkout API.

Card Validation Code (CVC) or Card Verification Value (CVV) – Three digits encrypted in the magnetic stripe on the
back of the card. This is used as a method of verification during credit card processing.

Request - Query or request from the merchant e-commerce system to myPOS Checkout API

Response - Response from myPOS Checkout API to a Call from the e-commerce system.

3-D Secure™ (3DS) - Technical standard developed by Visa, MasterCard and JBC, designed to combat online credit
card fraud. Cardholders who have registered for Verify by Visa®, MasterCard SecureCode® or J/Secure® use their
password to validate their identity whenever they make a purchase on a participating site.

XML - XML (Extensible Markup Language) is a generally available data format which myPOS Checkout API uses for
comfortable exchange with other systems.

Document revision 1.4.0 myPOS Europe Ltd. Page 8

Accepting online payments
myPOS Checkout API v.1.4

Where to start
In order to sign up as an myPOS Checkout API merchant and start using the Payment Gateway, you need to have a
Business myPOS Account first.

1. Sign in to your myPOS Account and go to the Online / Online stores.

2. Click on the link Activate.
3. Set up your online stores and generate the keys.

Important! Please have in mind that your stores need to be verified by myPOS Europe Ltd. which will
take up to 5 business days. Until your online stores are verified, you can still process transactions but
with certain limits.

Payment Gateway details

Implementation basics
The API requires the merchants to modify their payment page at the shopping cart so to include myPOS Checkout
as a payment option. When the customer chooses myPOS Checkout as a payment method he will actually submit
a HTML form to the Payment Gateway secure web servers using HTTPS protocol. The submitted form will contain
all needed information about the payment (such as myPOS Account number, online store ID, shopping cart data,
currency, amount, etc.)

Once the myPOS Checkout API processes the payment, the system will pass the result to merchant web server and
the customer will be redirected to the online store “checkout result” page.

Document revision 1.4.0 myPOS Europe Ltd. Page 9

Accepting online payments
myPOS Checkout API v.1.4

Interaction Diagram

Document revision 1.4.0 myPOS Europe Ltd. Page 10

Accepting online payments
myPOS Checkout API v.1.4

Detailed diagram with all communications and messages between the merchant website and myPOS
Checkout API is presented in the Part 2: Technical integration of this document.

Payment process in steps

1. Internet customer chooses myPOS Checkout as a payment method at the merchant’s online store checkout
page.
2. Merchant web server initiates payment through the Payment Gateway.
3. Customer web browser is redirected to myPOS Checkout payment link along with the payment details.
4. If customer cancels the payment, he will be redirected to the merchant’s “Cancel payment” page.
5. The customer needs to fill in his payment data and to click the button “Confirm”.

Most of the customer data will be automatically filled in and the customer will need to complete just
few of the fields.

6. Payment gateway system receives the details for the payment – successful or declined.
7. Payment gateway system passes the result to merchant web server and the customer web browser is
directed to the myPOS Checkout result page.
8. If the customer clicks on the “Return to …” button he will be redirected to the merchant’s result page.

Document revision 1.4.0 myPOS Europe Ltd. Page 11

Accepting online payments
myPOS Checkout API v.1.4

myPOS Checkout payment page

Document revision 1.4.0 myPOS Europe Ltd. Page 12

Accepting online payments
myPOS Checkout API v.1.4

Refund transactions
The merchant could initiate a refund transaction for any previously executed payment. This functionality is
available in his account pages in menu Transaction/ Transaction details.

In case where the customer has lodged a justified complaint or the merchant is unable to deliver the goods, he
could refund any partial amount of the payment back to the customer.

myPOS always books the refund back in the originally used payment method.

The maximum refunded amount is 100 percent of the original amount.

Use of Trademarks on Merchant’s website

The Merchant needs to follow the instructions below:

1. General requirements

The myPOS logo and all related with the myPOS Checkout API logos may not be altered, modified, or changed in
any way, without the prior written permission of myPOS. These logos may not be used in a manner that refers
disparagingly to myPOS or the myPOS Checkout service.

The myPOS Checkout payment option must be shown along with any other payment method on the merchant’s
website. The service must be presented in a manner which shows service in equality with all other payment
methods.

The merchant may not use any of the Card scheme logos (VISA, MasterCard, JCB) separately without the myPOS
logo, except in case where the merchant has personal agreement with a specific Card scheme.

The merchant must comply with myPOS any text descriptions of the myPOS Checkout service and/or myPOS before
publishing them online.

The merchant may use on his website any logo available on mypos.eu website. If the merchant needs custom size
or solution, he must contact myPOS Customer service department.

2. Payment method page

If the merchant has separate payment method page on his website, he needs to describe the myPOS Checkout
service, complying with the above General requirements.

3. Checkout page

The myPOS Checkout payment method must be presented on the merchant’s checkout page complying with the
above General requirements.

4. Redirecting page

If the merchant has a redirecting page between his checkout page and the myPOS Checkout payment page, the
merchant needs to have the following attributes on this page:

Document revision 1.4.0 myPOS Europe Ltd. Page 13

Accepting online payments
myPOS Checkout API v.1.4

- https://www.mypos.eu
- Payments processed by mypos.eu or myPOS logo

Example:
Please wait, you are now being redirected to https://www.mypos.eu/vmp/....
You are about to pay via secure payments processed by myPOS Europe Ltd. using a debit or credit card.
If you are not redirected within 5 seconds, please click here.

The Verified by VISA & MasterCard SecureCode & J/Secure logos could be placed separately in accordance with the
requirements of the Card scheme.

Currencies accepted at myPOS Checkout API

myPOS Checkout API is accepting payments and making payouts in all currencies available for myPOS Accounts.
Please refer to www.mypos.eu in order to see the current list with all available currencies.

If the merchant needs to accept payments in any other currency, he will need to contact his customer service
representative for more information.

Security and availability

Connection between the merchant and the myPOS Checkout API is handled through internet using HTTPS protocol
(SSL over HTTP). Requests and responses are digitally signed both. myPOS host is located at Tier IV datacenter in
Luxembourg. Public address for myPOS Checkout API is BGP enabled and available through all first level internet
providers.

myPOS supplies an emergency support line via e-mail or phone which is 7x24 enabled and reaches certified
engineers.

3-D Secure payment

To make online transactions using credit cards safer and more secure, myPOS supports 3-D secure payments.

The service is available for merchant’s accounts which support 3-D secure and in case the customer credit card is
3-D secure.

Depending on the Card scheme and the Issuing bank, the customer will see an additional step in the myPOS
Checkout payment page. Please take a look at the VISA example below:

Document revision 1.4.0 myPOS Europe Ltd. Page 14

Accepting online payments
myPOS Checkout API v.1.4

Important security requirements for making requests to the myPOS Checkout API
All requests to the API are standard HTTPS requests. The 'User-Agent' HTTP request header is required by myPOS
Checkout API.

It is a means of verification of the program on the client host and if the client does not send this string, it cannot
be verified nor logged and will result in myPOS Checkout error page with the following text: “The online store has
sent myPOS a shopping cart with errors in it. We will contact the Merchant with a request to fix this problem. As
this could be a temporary issue, you can go back to try checking out again.” and a link to the merchant’s website.

Sending the 'User-Agent' is one of the principle rules of our network security and is usually a simple setting in client
programs. If you are against sending the header for tracking reasons, we inform you that this is used as a loophole
by potential attackers.

Security restrictions

Enable/Disable payments for a specific merchant’s online store

By default, the online payment processing for any approved merchant’s online store is disabled. To enable the
store the merchant needs to log in his Business Account, to go to the Online / Online stores menu and to click on
the button “Enable” beside the particular online store.

The merchant could use the “Enable/ Disable” functionality at any convenient time.

Document revision 1.4.0 myPOS Europe Ltd. Page 15

Accepting online payments
myPOS Checkout API v.1.4

Request URLs
This myPOS feature aims to further increase the security level of the merchant’s account, protecting it from
unauthorized request attempts.

The merchant must specify at least one URL from which request to the myPOS Checkout API will be made.

All requests from any other URLs will be denied.

The merchant could add new URLs at any time, however all new URLs will be reviewed and approved
first.

Signature and public/private key pairs

In every message a signature is supplied.

For signing process, both myPOS Checkout API and the merchant generate public/private key pairs and exchange
the public certificate. Key pairs are generated using RSA algorithm. The certificates must be PEM-encoded PKCS7
file. Every of the parties are using the private key to sign the message and the opposite side authenticate the sender
with corresponding public certificate.

The myPOS Checkout API provides different myPOS public certificate to everyone online store of the merchant.
They are available for download at Online / Online stores / Keys menu.

myPOS Checkout API requires from merchant to upload his public certificate so that his digital signature can be
verified from the system. The merchant can upload several public certificates. A key index is assigned to each
certificate. For each of the merchant's public certificate there is a certain myPOS public certificate. The merchant
can download each myPOS public certificate by clicking on Download in the myPOS public certificate column.

The online store public certificate can be changed at any time from the Online / Online stores / Keys
menu.

Business myPOS Account details

Integrating myPOS Checkout with online stores

From menu Online / Online stores the Merchant can activate the service.

Adding of an online store

Once the service is activated the Merchant can start adding the information of the online stores in menu Online /
Online Stores / Add new store:

Document revision 1.4.0 myPOS Europe Ltd. Page 16

Accepting online payments
myPOS Checkout API v.1.4

Setting up the new online store

Once added, the new online store will be visible at the Online / Online Stores / View all stores menu. The new
online store will be with status “Disabled”. The merchant needs to:

1. activate the store once he is ready with the test integration with the myPOS Checkout API by clicking on
the appropriate button beside the store;
2. read carefully and agree with the General terms and conditions and the Tariff for this store.
3. set key pairs for this particular website;
4. enable the store by clicking on the appropriate button beside the store.

Every online store could be enabled / disabled separately at any time by the merchant.

Document revision 1.4.0 myPOS Europe Ltd. Page 17

Accepting online payments
myPOS Checkout API v.1.4

Document revision 1.4.0 myPOS Europe Ltd. Page 18

Accepting online payments
myPOS Checkout API v.1.4

Editing the online store data

The merchant can change the main information of every online store using the “Edit” functionality at the Online /
Online Stores.

E-commerce transactions

Overview
All e-commerce transactions will be visible in the merchant’s myPOS Account under menu Online / Online Stores /
Transactions. The merchant could filter and see only the transactions which come from myPOS Checkout or from
a specific online store.

Details of e-commerce transactions

The merchant will see the following type of details for the e-commerce transactions:

• Payment details – such as payment origin and used payment method;

• Transaction details – transaction reference, exchange rate, amount, transaction fee;
• Reserve – reserve amount from the specific transaction and reimbursement date;
• Cart details – all data from the shopping cart shown to the customer during the checkout, i.e. item name,
price, quantity, order total and note;
• Refund details / functionality – refund functionality with which the merchant could initiate partial or full
amount refund transaction to a previously executed payment. If there is at least one refund transaction for
the initial payment the merchant will see it here together with refund transaction reference and refund
amount and fee.

Making a refund
In case where the customer has lodged a justified complaint or the Merchant is unable to deliver the goods, he
could refund any amount of the payment back to the customer. The merchant can refund up to 100 percent of the
original amount.

When the merchant initiate a refund, a reference will be added to the original transaction details along with new
row for the refund transaction.

Once the merchant issues a refund, it cannot be cancelled.

If there are insufficient funds in the merchant’s myPOS Account, the refund transaction will be denied.

If the myPOS Account balance becomes negative as a result of deducted refunds or chargebacks,
myPOS Europe Ltd. will collect funds from the merchant in accordance with the Legal agreements.

Reserve

Overview
The reserve is a percentage of money that must remain in the merchant’s myPOS Account for a specific period of
time to cover any payment reversals that may be received like chargebacks, claims, and disputes.

Document revision 1.4.0 myPOS Europe Ltd. Page 19

Accepting online payments
myPOS Checkout API v.1.4

The reserve rate and period is specified in the merchant’s tariff and depends on the risk assessment of the particular
online store. They will be reviewed regularly and adjusted when necessary.

If the merchant Business myPOS Account is blocked by Issuer or closed for any reason, myPOS may hold
the reserve for up to 180 days after the date of the last transaction with myPOS Checkout.

Details
The merchant can track the accumulated currency reserve amount and how exactly they are calculated at any time.
He can filter and a see all transactions which were calculated in it and when the particular amount will be
reimbursed.

Document revision 1.4.0 myPOS Europe Ltd. Page 20

Accepting online payments
myPOS Checkout API v.1.4

Part 2: Technical integration

Document revision 1.4.0 myPOS Europe Ltd. Page 21

Accepting online payments
myPOS Checkout API v.1.4

Overview

HTTP POST
Data transfer between Merchant and myPOS Checkout is made by HTTP POST. All the parameters for the requests
are in the body in [parameter=value] form. Separator between tokens is [&]. The body is URL Encoded. Character
encoding is UTF-8.

Example:
POST /somescript.php HTTP/1.1
Host: www.somesite.com
User-Agent: Mozilla/4.0
Content-Length: 39
Content-Type: application/x-www-form-urlencoded
userid=joe&password=guessme&user_type=1

Data type formats

Data Type in Description Example
document
int Integer 1
String String This is a string
Date ISO 8601 date string YYYY-MM-DD 2012-03-31
DateTime ISO 8601 datetime string YYYY-MM-DD 2012-03-31 23:59:59
HH:mm:SS
A(n) Alpha string. [n] characters required Alpha string
AN(n) Alphanumeric string. [n] characters required Alphanumeric string
N(n) Numeric string. [n] characters required. Number 000123
is left-padded with zeroes.
double Numeric string with decimal point. Only point is 34.56
used (no commas or other characters for decimal
point)
BASE64 Sting used to pass binary data. The binary data YW55IGNhcm5hbCBwbGVhc3VyZQ==
should be converted to base64 standard.
XML Simple in place XML array. <body>
<param>1</param>
<value>2</value>
</body>

Signature and authentications

Signatures are calculated using the following mechanism. All data in POST request without the Signature property
are concatenated with dash and Base64 encoded. The string is signed with the private key using the SHA-256
algorithm. Then the signature needs to be Base64 encoded. The signature property is added to the POST request.

The opposite side should concatenate all data in the POST request without the Signature property, Base64-encode
the string and then verify the obtained string with the sent signature property and the public key extracted from
the myPOS public certificate.

Document revision 1.4.0 myPOS Europe Ltd. Page 22

Accepting online payments
myPOS Checkout API v.1.4

The Merchant should always verify the signature when receiving a call from myPOS Checkout API!

Example for PHP 5.x.x

<?php

// The POST data array

$postData = array('IPCmethod'=>'IPCPurchase', ............);

// This is an example of RSA private key

$privKey = '-----BEGIN RSA PRIVATE KEY-----
MIICXAIBAAKBgQCf0TdcTuphb7X+Zwekt1XKEWZDczSGecfo6vQfqvraf5VPzcnJ
2Mc5J72HBm0u98EJHan+nle2WOZMVGItTa/2k1FRWwbt7iQ5dzDh5PEeZASg2UWe
hoR8L8MpNBqH6h7ZITwVTfRS4LsBvlEfT7Pzhm5YJKfM+CdzDM+L9WVEGwIDAQAB
AoGAYfKxwUtEbq8ulVrD3nnWhF+hk1k6KejdUq0dLYN29w8WjbCMKb9IaokmqWiQ
5iZGErYxh7G4BDP8AW/+M9HXM4oqm5SEkaxhbTlgks+E1s9dTpdFQvL76TvodqSy
l2E2BghVgLLgkdhRn9buaFzYta95JKfgyKGonNxsQA39PwECQQDKbG0Kp6KEkNgB
srCq3Cx2od5OfiPDG8g3RYZKx/O9dMy5CM160DwusVJpuywbpRhcWr3gkz0QgRMd
IRVwyxNbAkEAyh3sipmcgN7SD8xBG/MtBYPqWP1vxhSVYPfJzuPU3gS5MRJzQHBz
sVCLhTBY7hHSoqiqlqWYasi81JzBEwEuQQJBAKw9qGcZjyMH8JU5TDSGllr3jybx
FFMPj8TgJs346AB8ozqLL/ThvWPpxHttJbH8QAdNuyWdg6dIfVAa95h7Y+MCQEZg
jRDl1Bz7eWGO2c0Fq9OTz3IVLWpnmGwfW+HyaxizxFhV+FOj1GUVir9hylV7V0DU
QjIajyv/oeDWhFQ9wQECQCydhJ6NaNQOCZh+6QTrH3TC5MeBA1Yeipoe7+BhsLNr
cFG8s9sTxRnltcZl1dXaBSemvpNvBizn0Kzi8G3ZAgc=
-----END RSA PRIVATE KEY-----';

// You need to concatenate all values from $postData and to Base64-encode the result
$concData = base64_encode(implode('-', $postData));
$privKeyObj = openssl_get_privatekey($privKey);

// Signed data in binary

openssl_sign($concData, $signature, $privKeyObj, OPENSSL_ALGO_SHA256);

// Base64 encoding of the signature

$signature = base64_encode($signature);

// Now you need to add the signature to the POST request

$postData['Signature'] = $signature;
openssl_free_key($privKeyObj);

Signature verification example for PHP 5.x.x

<?php

// Save POST request data in var $data

$data = $_POST;

// myPOS certificate
$cert = '-----BEGIN CERTIFICATE-----

Document revision 1.4.0 myPOS Europe Ltd. Page 23

Accepting online payments
myPOS Checkout API v.1.4

MIIBkDCB+qADAgECAgAwDQYJKoZIhvcNAQEFBQAwDzENMAsGA1UEChMEaVBheTAe
Fw0xMzAzMTMxMTI1MTFaFw0yMzAzMTExMTI1MTFaMA8xDTALBgNVBAoTBGlQYXkw
gZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAML+VTmiY4yChoOTMZTXAIG/mk+x
f/9mjwHxWzxtBJbNncNK0OLI0VXYKW2GgVklGHHQjvew1hTFkEGjnCJ7f5CDnbgx
evtyASDGst92a6xcAedEadP0nFXhUz+cYYIgIcgfDcX3ZWeNEF5kscqy52kpD2O7
nFNCV+85vS4duJBNAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAFSfqJHH9Vp9Y4osJ
sLg1Um5LOoTgn6u4JepHMFoSiwYE0n/N3D3JIgqAzjdVJ+1rZV95VAf/+TKzWzvP
V8L01LJ8aRFkUaPGenVsGvBT2mtsbu34QUOlPgzCi3huidwk0ylMX7zo8uxu1cXv
/bg5jBGe5SjvJP8Tq257QcAGgkA=
-----END CERTIFICATE-----';

// Save signature
$signature = $data['Signature'];
// Remove signature from POST data array
unset($data['Signature']);
// Concatenate all values
$concData = base64_encode(implode('-', $data));

// Extract public key from certificate

$pubKeyId = openssl_get_publickey($cert);

// Verify signature
$res = openssl_verify($concData, base64_decode($signature), $pubKeyId, OPENSSL_ALGO_SHA256);
//Free key resource
openssl_free_key ($privKeyObj);

if($res==1){
//success
}else{
//not success
}

Test environment

Overview
The myPOS Checkout API test environment is a self-contained, virtual testing environment. Once you are ready
with the API integration, you need to use it in order to make the appropriate tests of all your myPOS Checkout API
calls and communication with the system. The test environment will let you test the API integration without
affecting any real myPOS users or their real myPOS Wallets.

The myPOS Checkout API test environment mimics myPOS's production servers, so you can format and make all
your Calls to the system as you will do in Production environment. The only difference between the Calls on both
environments is that you need to use different user credentials and endpoints.

Before you start using myPOS Checkout into production, you should test the application with all case scenarios in
myPOS Checkout API test Environment.

Document revision 1.4.0 myPOS Europe Ltd. Page 24

Accepting online payments
myPOS Checkout API v.1.4

Testing data
Test environment host: https://www.mypos.eu/vmp/checkout-test

SID: 000000000000010
Wallet number: 61938166610

POST parameters example

IPCmethod=IPCPurchase&
IPCVersion=1.3&
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&
CardTokenRequest=0&
KeyIndex=1&
PaymentParametersRequired=1&
[email protected]&
customerfirstnames=John Santamaria&
customerfamilyname=Smith&
customerphone=+23568956958&
customercountry=DEU&
customercity=Hamburg&
customerzipcode=20095&
customeraddress=Kleine Bahnstr. 41&
Note=&
CartItems=2&
Article_1=HP ProBook 6360b sticker&
Quantity_1=2&
Price_1=10&
Currency_1=EUR&
Amount_1=20&
Article_2=Delivery&
Quantity_2=1&
Price_2=3.45&
Currency_2=EUR&
Amount_2=5&
Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHN
bq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817/o

Please, have in mind that you could test with every debit or credit card number. In test environment
all card transactions will be processed as successful payment. Your card will not be charged!

Test scenarios
In order to start testing the myPOS Checkout API payments, you need to:

1. Implement the myPOS Checkout API.

Document revision 1.4.0 myPOS Europe Ltd. Page 25

Accepting online payments
myPOS Checkout API v.1.4

2. Send a POST request with all the data to the test host address.
3. Test the following scenarios:
• Error in the POST request – missing or invalid data;
• Send wrong signature to myPOS Checkout API;
• Check myPOS Checkout API message signature for authenticity;
• The Customer terminates the process on the myPOS Checkout payment page;
• Customer pays successfully;
• Customer pays successfully, however the merchant’s website does not return HTTP OK to myPOS Checkout
API.

Production environment
Once you have everything implemented and tested, you need to set your online store keys to production
environment and change your test data.

Production environment host: https://www.mypos.eu/vmp/checkout

Document revision 1.4.0 myPOS Europe Ltd. Page 26

Accepting online payments
myPOS Checkout API v.1.4

The process

Understanding transmission mechanism

Document revision 1.4.0 myPOS Europe Ltd. Page 27

Accepting online payments
myPOS Checkout API v.1.4

Method standard properties

In every request there are several parameters that are always supplied. Bellow they are called ‘standard
properties’. Once defined below, they won’t be described in every single command listed in the specification, they
should be considered as existing to every command.

Property Typical value Type Description

IPCmethod IPCPurchase String Name of the method requested for execution from
IPC.
Signature Byte[] BASE64 SHA-256 HASH for all properties in the command.
Signature is ALWAYS THE LAST PARAMETER IN THE
POST, as it is not used to calculate the hash.
KeyIndex 1 Int Identifier of the private key used for signature (if
more than 1).
IPCVersion 1.3 string Version of protocol used for transition.
IPCLanguage EN A(2) ISO 2-character code for the desired language on
the payment page. If myPOS Checkout API cannot
fulfill the requested language, it will set the English
language as defaults.
Currently supporting EN, FR, IT, DE, SV, PT, NL, EL,
BG, ES.
WalletNumber 61938166610 N(11) myPOS Account Number
SID 000000000000010 AN(15) Site ID. Identifier of the website accepting
payment.

Response standard properties

Upon HTTP request, the party should respond with header HTTP 200 OK with the following body content: “OK”.
Every other response should be treated as communication error, call error, server error or system malfunctions.

Property Typical value Type Description

IPCmethod IPCPurchase String Name of the method requested for execution from
IPC.
Status 0 N(3) Code upon command completion. 0 is success
otherwise error.
StatusMsg Success C(max) Description for <status> code.
Signature Byte[] BASE64 SHA-256 HASH for all properties in the command.
Signature is ALWAYS THE LAST PARAMETER IN THE
POST, as it is not used to calculate the hash.
Once defined these parameters should be considered as existing to every response listed in the specification.

The calls
API function call Description

MERCHANT TO MYPOS CHECKOUT

This is the standard method for checkout at a shop. The method can be used for
IPCPurchase card storage also. All sensitive data will be collected on myPOS Checkout
Payment page. Customer interaction needed.

Document revision 1.4.0 myPOS Europe Ltd. Page 28

Accepting online payments
myPOS Checkout API v.1.4

This method enables a myPOS merchant to accept payments on a website using

IPCPurchaseByIcard
iCard mobile application.
This is a standard method for checkout when the purchase will be embedded
IPCIAPurchase within the external app. All sensitive data will be collected from the external
application.
This is a method for storing a card data. All sensitive data will be collected from
IPCIAStoreCard
the external application.
This is a method used to update a data of already stored card. All sensitive data
IPCIAStoredCardUpdate
will be collected from the external application.
IPCRefund Credit to a customer, e.g. return money. No customer interaction needed.
This method cancels a previously executed payment (void). No customer
IPCReversal
interaction needed.
Make a direct withdrawal transaction (Request money) from a specific myPOS
IPCRequestMoney
account (wallet). No customer interaction needed.
Make a new registration of a mandate reference for Request money transactions
IPCMandateManagement from a myPOS account or cancel a previously registered mandate reference. No
customer interaction needed.
Returns detailed information about a previously executed payment. No
IPCGetTxnLog
customer interaction needed.
Returns the status and the parameters of a previously executed payment. No
IPCGetTxnStatus
customer interaction needed.
IPCSendMoney Credit note to a myPOS Wallet. No customer interaction needed.
MY POS CHECKOUT TO MERCHANT
myPOS Checkout will respond with this method on successful payment. The call
IPCPurchaseNotify
will be made on the previously supplied URL_Notify.
myPOS Checkout will redirect with this method on successful payment. The call
IPCPurchaseOK
will be made on the previously supplied URL_OK.
myPOS Checkout will redirect with this method when the customer chooses to
IPCPurchaseCancel cancel the payment. The call will be made on the previously supplied
URL_Cancel.
myPOS Checkout will notify that a reversal is passed for a previous successful
authorization. The merchant should mark the order as not paid (in case, the
IPCPurchaseRollback merchant has received IPCPurchaseNotify method). This is used when myPOS
Checkout API does not receive an HTTP OK from the merchant as a response for
the IPCPurchaseNotify method.
All commands described below do not include the standard properties discussed in the previous topic. However, the
standard properties are mandatory for all commands.

Purchase with payment card (API call: IPCPurchase)

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 will check for:

- Valid myPOS Account number

Document revision 1.4.0 myPOS Europe Ltd. Page 29

Accepting online payments
myPOS Checkout API v.1.4

- Valid Online Store ID corresponding with this myPOS Account number

- Valid status of the Online store (enabled)
- Valid currency and total amount
- Valid signature

Method properties
Property Typical value Type Required Description

Amount 23.45 Double YES The amount of the payment

Document revision 1.4.0 myPOS Europe Ltd. Page 30

Accepting online payments
myPOS Checkout API v.1.4

PaymentParametersR 1 N(1) YES 1- Full request (All parameters

equired 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 sees
and fills in only the payment card
details.)
CustomerEmail [email protected] 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 ISO 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 Conditional Array provided by the Merchant.
Record The array describes the content of
the shopping cart. The content will
be displayed on the myPOS
Checkout API payment page.

Document revision 1.4.0 myPOS Europe Ltd. Page 31

Accepting online payments
myPOS Checkout API v.1.4

* The URL_Notify URL should be SSL-enabled address only (i.e. it must start with "https://"). Unsecure URLs will
be treated as wrong.
Same OrderID is used for the request of a partner, except in 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. Article_1). Indexes are from 1 to <CartItems>.

Property Typical value Type Description

Article HP ProBook 6360b String Name of an article in the shopping cart.

sticker

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.

Document revision 1.4.0 myPOS Europe Ltd. Page 32

Accepting online payments
myPOS Checkout API v.1.4

customerzipcode=20095&
customeraddress=Kleine Bahnstr. 41&
Note=&
CartItems=2&
Article_1=HP ProBook 6360b sticker&
Quantity_1=2&
Price_1=10&
Currency_1=EUR&
Amount_1=20&
Article_2=Delivery&
Quantity_2=1&
Price_2=3.45&
Currency_2=EUR&
Amount_2=5&
Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHN
bq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817/o=

Document revision 1.4.0 myPOS Europe Ltd. Page 33

Accepting online payments
myPOS Checkout API v.1.4

Purchase with iCard Mobile (API call: IPCPurchaseByIcard)

Purpose
The method IPCPurchaseByIcard enables the iCard Mobile application checkout on a myPOS merchant's website.
This means that an iCard Mobile user can pay to a myPOS merchant who has integrated this method on the website.
Upon selection of iCard Mobile as a payment method on the merchant's website, customer will see an info screen
and will instantly receive a notification for payment on the mobile device where iCard Mobile is installed and
running. Customer must confirm the payment on their mobile device. No further interaction on merchant's website
is needed. After the payment is completed/rejected, the customer will be informed of the result on the merchant's
website and in the mobile app.

Payment screen example - iCard Mobile

myPOS Checkout will check for:

- Valid myPOS Account number – where money will be settled

- Valid Online Store ID corresponding with this myPOS Account number
- Valid status of the Online store (enabled)
- Valid currency and total amount
- Valid signature
- Valid customer e-mail or phone number enrolled with iCard mobile

Document revision 1.4.0 myPOS Europe Ltd. Page 34

Accepting online payments
myPOS Checkout API v.1.4

Method properties
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.
URL_OK http://site.ext/paymentO String YES The page where the cardholder
K should be redirected on successful
payment.
URL_Cancel http://site.ext/paymentN String YES The page where the cardholder
OK should be redirected when
<Cancel> is pressed on the
payment page.
URL_Notify* https://site.ext/payment String YES Address supplied by the partner,
Notify where the IPCPurchaseNotify API
call will send the parameters for
the successful payment.
CustomerEmail [email protected] String Conditional Conditional.
The parameter is required when
CustomerPhone is not provided
This is a customer’s email.
CustomerPhone +23568956958 String Conditional The parameter is required when
CustomerEmail is not provided
Must be in International Phone
Numbers Format (E.123):
(+)(country code)(client number)
Note String NO Text associated with the purchase.
CartItems 2 Int YES 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 YES Array provided by the Merchant.
Record The array describes the content of
the shopping cart. The content will
be displayed on the myPOS
Checkout API payment page.
* The URL_Notify URL should be SSL-enabled address only (i.e. it must start with "https://"). Unsecure URLs will
be treated as wrong and request will be unsuccessful.

Document revision 1.4.0 myPOS Europe Ltd. Page 35

Accepting online payments
myPOS Checkout API v.1.4

Same OrderID is used for the request of a partner, except in 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

Property Typical value Type Description

Article HP ProBook 6360b String Name of an article in the shopping cart.

sticker

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= IPCPurchaseByIcardMobile &

IPCVersion=1.3&
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&
[email protected]&
customerfirstnames=John Santamaria&
customerfamilyname=Smith&
customerphone=+23568956958&
customercountry=DEU&
customercity=Hamburg&
customerzipcode=20095&
customeraddress=Kleine Bahnstr. 41&
Note=&
CartItems=2&
Article_1=HP ProBook 6360b sticker&

Document revision 1.4.0 myPOS Europe Ltd. Page 36

Accepting online payments
myPOS Checkout API v.1.4

Quantity_1=2&
Price_1=10&
Currency_1=EUR&
Amount_1=20&
Article_2=Delivery&
Quantity_2=1&
Price_2=3.45&
Currency_2=EUR&
Amount_2=5&
Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHN
bq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817/o=

Successful payment notification (API call: IPCPurchaseNotify / IPCPurchaseOK)

Purpose
This method is used by myPOS Checkout to notify the merchant for a successful payment and to pass all needed
parameters for the payment on URL_Notify. After successful response for this method myPOS Checkout will
redirect the customer browser to URL_OK and will pass same parameters with IPCPurchaseOK method.

Method properties
Property Typical value Type Description

Amount 23.45 Double Conditional.

Echo from IPCPurchase.
Currency EUR A(3) Echo from IPCPurchase.
OrderID 201203319999999 string Echo from IPCPurchase.
IPC_Trnref 12345678923 String Used to uniquely identify a transaction in
IPC. Used as a parameter for subsequent
refund of reversal if needed.
RequestDateTime 2012-03-31 23:59:59 DateTime Date/time of the request
RequestSTAN 123456 N(6) Consequent number from 1 to 999999.
Used for request unique match.
CardToken Byte[] BASE64 Conditional.
The CardToken is returned when the card is
stored (depending on the chosen option in
CardTokenRequest).
PAN 4885 N(4) Conditional.
Last four digits of the account number
(PAN). The PAN is returned when the card
is stored (depending on the chosen option
in CardTokenRequest).
ExpDate 1703 N(4) Conditional.
The ExpDate is returned when the card is
stored (depending on the chosen option in
CardTokenRequest).

Document revision 1.4.0 myPOS Europe Ltd. Page 37

Accepting online payments
myPOS Checkout API v.1.4

CardType 1 N(1) Conditional.

The CardType is returned when the card is
stored (depending on the chosen option in
CardTokenRequest).
CustomerEmail [email protected] String Conditional.
When PaymentParametersRequired = 1; 2
CustomerPhone +23568956958 String Conditional.
When PaymentParametersRequired = 1; 2
CustomerFirstNames John Santamaria String Conditional.
When PaymentParametersRequired = 1; 2
CustomerFamilyName Smith String Conditional.
When PaymentParametersRequired = 1; 2
Signature Byte[] BASE64 SHA-256 HASH for all properties in the
command. Signature is ALWAYS THE LAST
PARAMETER IN THE POST, as it is not used
to calculate the hash.

The IPCGetTxnStatus call will return the parameters of the response.

Example
HTTP/1.1 200 OK
Date: Mon, 11 Mar 2013 08:04:50 GMT
Server: Apache/2.2.22 (Win32) PHP/5.2.17
X-Powered-By: PHP/5.2.17
Set-Cookie: PHPSESSID=a048e995f78f9e38b192f528f67d3cc3; path=/
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
Content-Length: 2
Connection: close
Content-Type: text/html; charset=utf-8

Cancelation of payment notification (API call: IPCPurchaseCancel)

Purpose
This method is used by myPOS Checkout to notify the merchant that the customer has cancelled the payment.
myPOS Checkout will redirect with this method when the customer chooses cancel payment. The call will be made
on the previously supplied URL_Cancel.

Method properties
Property Typical value Type Description

Amount 23.45 Double Echo from IPCPurchase.

Currency EUR A(3) Echo from IPCPurchase.
OrderID 201203319999999 string Echo from IPCPurchase.

Document revision 1.4.0 myPOS Europe Ltd. Page 38

Accepting online payments
myPOS Checkout API v.1.4

Signature Byte[] BASE64 SHA-256 HASH for all properties in the

command. Signature is ALWAYS THE LAST
PARAMETER IN THE POST, as it is not used
to calculate the hash.

Rollback of previous notification (API call: IPCPurchaseRollback)

Purpose
This method is used by myPOS Checkout to notify that a reversal is passed for previous successful authorization.
The merchant should mark the order as not paid (in case the merchant has received IPCPurchaseNotify method).
This is used when myPOS Checkout does not receive and HTTP OK from the merchant as a response for
IPCPurchaseNotify method. The call will be posted to URL_Notify.

Method properties
Property Typical value Type Description

Amount 23.45 Double Echo from IPCPurchase.

Currency EUR A(3) Echo from IPCPurchase.
OrderID 201203319999999 string Echo from IPCPurchase.
Signature Byte[] BASE64 SHA-256 HASH for all properties in the
command. Signature is ALWAYS THE LAST
PARAMETER IN THE POST, as it is not used
to calculate the hash.

In-app Purchase with payment card (API call: IPCIAPurchase)

Purpose
This method initiates the beginning of the payment process for a customer (purchase). However the customer will
remain within the pages of the external application. All needed data (incl. payment card details) will be collected
and submitted to myPOS Checkout API by the external application. The method can be used both for a recurring
transaction with already stored card or for an initial card payment. The myPOS Checkout API will return an xml with
the result.

myPOS Checkout will check for:

▪ Valid myPOS Account number

▪ Valid Online Store ID corresponding with this myPOS Account number
▪ Valid status of the Online store (enabled)
▪ Valid currency and total amount
▪ Valid signature

Document revision 1.4.0 myPOS Europe Ltd. Page 39

Accepting online payments
myPOS Checkout API v.1.4

Method properties
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 255 characters.
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.
CardType 1 N(1) Conditional Conditional.
CardType is required when CardToken is
not provided in the request. Please refer
to Appendix IV.
PAN Byte[] BASE64 Conditional Conditional.
PAN is required when CardToken is not
provided in the request.
CardholderName John Smith String (30) Conditional Conditional.
CardholderName is required when
CardToken is not provided in the
request.
ExpDate Byte[] BASE64 Conditional Conditional.
ExpDate is required when CardToken is
not provided in the request.
CVC Byte[] BASE64 Conditional Conditional.
CVC is required when CardToken is not
provided in the request.
ECI 6 N(1) Conditional Conditional.
ECI is required when CardToken is not
provided in the request.
AVV Byte[] BASE64 Conditional Conditional.
AVV is required when CardToken is not
provided in the request and the card is
3DS enabled.
XID Byte[] BASE64 Conditional Conditional.
AVV is required when CardToken is not
provided in the request and the card is
3DS enabled.
CardToken Byte[] BASE64 Conditional Conditional.
The CardToken is required when the card
is already stored and no additional data
is sent for the card within the request.
AccountSettlement 11111111119 N(11) NO Account for payment settlement
Note String NO Text associated with the purchase.

Document revision 1.4.0 myPOS Europe Ltd. Page 40

Accepting online payments
myPOS Checkout API v.1.4

CartItems 2 Int YES 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 YES Array provided by the Merchant. The
Record array describes the content of the
shopping cart. The content will be
displayed on the myPOS Checkout
payment page.
OutputFormat xml String NO Output format of data. The property can
be “xml” or “json”. If it is not specified in
the request, the default value is “xml”.

Cart Logical Record

Cart logical record consists of standard POST parameters with the form name=value. For each 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 String Name of an article in the shopping cart.

sticker
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.

Response properties
Property Typical value Type Description

Amount 23.45 Double Echo from IPCIAPurchase

Currency EUR A(3) Echo from IPCIAPurchase
OrderID 201203319999999 string Echo from IPCIAPurchase
IPC_Trnref 12345678923 String Used to uniquely identify a transaction in IPC.
Used as a parameter for subsequent refund of
reversal if needed.

Example of the xml response

<IPC_response>
<IPCmethod>IPCIAPurchase</IPCmethod>
<IPC_Trnref>1484134559</IPC_Trnref>
<Amount>50</Amount>
<Currency>USD</Currency>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
<Signature>b4sEVS+HKsUac3iwzYjl8PKrrPC19kuz+cNjWfo/+LmyWM6JXK9BoTwNcXrsVo/jOQORdT2ui0ZqwnbyNVckY
q1QZdnMQvsz2Xzph3PSO8gNCm/OiqKb0uYDkYXbF/HaIm9iw51hX7p92xg/9g0lApexbuO1bUEGzBIkrZRelH0=</Signature>

Document revision 1.4.0 myPOS Europe Ltd. Page 41

Accepting online payments
myPOS Checkout API v.1.4

</IPC_response>

Get transaction log for previously executed payment (API call: IPCGetTxnLog)

Purpose
This method is used by the Merchant to get information about a previously executed payment via IPCPurchase or
IPCIAPurchase. The myPOS Checkout API will return an xml with detailed information about a specific OrderID. This
method is intended to be utilized by the Merchant in his website back-end. The Merchant could decide whether or
not to use this method.

Method properties
Property Typical value Type Required Description

OrderID 201203319999999 String YES Placeholder for the merchant. Used to

put some data that will help the
merchant to refer payments to orders. Up
to 255 characters.
OutputFormat xml String NO Output format of data. The property can
be “xml” or “json”. If it is not specified in
the request, the default value is “xml”.

Response properties
Property Typical value Type Required Description

OrderID 201203319999999 String YES Placeholder for the merchant. Used to

put some data that will help the merchant
to refer payments to orders. Up to 255
characters.
log Returns detailed information about a
specific OrderID.

Example of the xml response

<ipc_response>
<IPCmethod>IPCGetTxnLog</IPCmethod>
<OrderID>201203319999999</OrderID>
<log>
<item>
<time>11.03.2013 09:42:56</time>
<action>Received new POST request</action>
<result>
<IPCmethod>IPCPurchase</IPCmethod>
<IPCVersion>1.1</IPCVersion>
<IPCLanguage>en</IPCLanguage>
<SID>000000000000010</SID>
<WalletNumber>61938166610</WalletNumber>
<Amount>23.45</Amount>
<Currency>EUR</Currency>
<OrderID>201203319999999</OrderID>
<URL_OK>http://site.ext/paymentOK<URL_OK>

Document revision 1.4.0 myPOS Europe Ltd. Page 42

Accepting online payments
myPOS Checkout API v.1.4

<URL_Cancel>http://site.ext/paymentNOK</URL_Cancel>
<URL_Notify>https://site.ext/paymentNotify</URL_Notify>
<KeyIndex>1</KeyIndex>
<CustomerEmail>[email protected]</CustomerEmail>
<CustomerPhone>+23568956958</CustomerPhone>
<CustomerFirstNames>John Santamaria</CustomerFirstNames>
<CustomerFamilyName>Smith</CustomerFamilyName>
<CustomerCountry>DEU</CustomerCountry>
<CustomerCity>Hamburg</CustomerCity>
<CustomerZIPCode>20095</CustomerZIPCode>
<CustomerAddress>Kleine Bahnstr. 41</CustomerAddress>
<Note>Some note here</Note>
<CartItems>2</CartItems>
<Article_1>HP ProBook 6360b sticker</Article_1>
<Quantity_1>1</Quantity_1>
<Price_1>20.00</Price_1>
<Currency_1>EUR</Currency_1>
<Amount_1>20.00</Amount_1>
<Article_2>Delivery</Article_2>
<Quantity_2>1</Quantity_2>
<Price_2>3.45</Price_2>
<Currency_2>EUR</Currency_2>
<Amount_2>3.45</Amount_2>
<Signature>WwSv6Hk3cH9VAnIfGxOkIY/Ph0psiWGywNuZl8dAYPQZa8qFrLDh5Ck1RDAE
7h1oSH0CZw5fVW7jAIhSGcjaOnk+wybGVbIMxP59aUEKEG8wW0N2CH6oft92W/APQ60
rZ6Qsdlge3uiAKchfvJEcy3buuWVb6C2D58isBvrMFik=</Signature>
</result>
</item>
<item>
<time>11.03.2013 09:42:56</time>
<action>Checking method</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:42:56</time>
<action>Checking signature</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:42:56</time>
<action>Check if SID match to wallet number</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:42:56</time>
<action>Checking is purchase paid on Start page</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:42:56</time>
<action>Checking is amount > 0</action>
<result>OK</result>

Document revision 1.4.0 myPOS Europe Ltd. Page 43

Accepting online payments
myPOS Checkout API v.1.4

</item>
</item>
<item>
<time>11.03.2013 09:42:58</time>
<action>Checking for request marked as paid with this order_id</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:02</time>
<action>Checking is cart items > 0</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:06</time>
<action>Checking the URLs (url_ok, url_cancel, url_notify)</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:26</time>
<action>Checking cart</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:26</time>
<action>Check post params</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:46</time>
<action>Checking method</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:46</time>
<action>Checking signature</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:46</time>
<action>Check if SID match to wallet number</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:50</time>
<action>Display page:</action>
<result>Login or join</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action>Checking method</action>
<result>OK</result>
</item>

Document revision 1.4.0 myPOS Europe Ltd. Page 44

Accepting online payments
myPOS Checkout API v.1.4

<item>
<time>11.03.2013 09:43:56</time>
<action>Checking signature</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action>Check if SID match to wallet number</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action>Validate form data</action>
<result>Required params: OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action> Validate form data </action>
<result>PAN: OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action> Validate form data </action>
<result>Expire year: OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action> Validate form data </action>
<result>Expire date: OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action> Validate form data </action>
<result>CVC: OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action> Validate form data </action>
<result>Phone code match with country: OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action> Validate form data </action>
<result>Validate phone: OK</result>
</item>
<item>
<time>11.03.2013 09:43:56</time>
<action> Validate form data </action>
<result>Validate email: OK</result>
</item>
<item>
<time>11.03.2013 09:44:00</time>

Document revision 1.4.0 myPOS Europe Ltd. Page 45

Accepting online payments
myPOS Checkout API v.1.4

<action>Payment status</action>
<result>0</result>
</item>
<item>
<time>11.03.2013 09:44:00</time>
<action>Sending POST request to Merchant with parameters:</action>
<result>
<IPCmethod>IPCPurchaseNotify</IPCmethod>
<SID>000000000000010</SID>
<Amount>23.45</Amount>
<Currency>EUR</Currency>
<OrderID>201203319999999</OrderID>
<IPC_Trnref>370</IPC_Trnref>
<RequestSTAN>000102</RequestSTAN>
<RequestDateTime>2013-03-11 09:44:01</RequestDateTime>
<Signature>mE0wMCIbyhtkwS3NNccO8iJK+RT2tsDnj9XolA6xA3bh+bPqgIC4WBRD
+IZFDRkIDFCh6tY4FvW8srbnmvIfwSOMmNqofe18mDnrdxAjy6Mj6yxCJReQsI0K
lHTryAzAnEk7NbBBw/WcyptGQHFX9uBg3lsM/Pwn5E+lpxMiHxA=</Signature>
</result>
</item>
<item>
<time>11.03.2013 09:44:00</time>
<action>Connecting with URL_NOTIFY</action>
<result>Connection with http://site.ext/paymentNotify is OK</result>
</item>
<item>
<time>11.03.2013 09:44:00</time>
<action>Merchant response</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:44:00</time>
<action>View "Thank You - Success" page</action>
<result>OK</result>
</item>
<item>
<time>11.03.2013 09:44:00</time>
<action>Order done with status</action>
<result>1</result>
</item>
<item>
<time>11.03.2013 09:44:02</time>
<action>Display page:</action>
<result>Thank you page (Success)</result>
</item>
</log>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</ipc_response>
Detailed information about possible responses in the log is shown in the following table:

Response Description

Document revision 1.4.0 myPOS Europe Ltd. Page 46

Accepting online payments
myPOS Checkout API v.1.4

IPCmethod Name of the method requested for execution from myPOS

Checkout.
Checking is purchase paid on Start page
Checking Merchant for 3DS for card scheme
Merchant is not 3DS
Merchant is 3DS
Client is redirected to "Response 3DS page”.
Display page
Checking is amount > 0 Checking for a valid amount.
Checking valid currency and if the post
currency is the currency of MID
Checking for request marked as paid with this Checking for an existing already paid request with the same
order_id order_id.
Checking is cart_items > 0
Checking the URLs (url_ok, url_cancel,
url_notify)
Checking cart
Received new POST request
Checking version Checking for version number of myPOS Checkout.
Checking method Checking for valid method.
Checking signature Checking if parameter ‘Signature’ is correct.
Payment status Returns information about the status of the payment.
View "Thank You - Success" page
View "Thank You - Error" page
Adding request in TODO table (cron) Used in case where the party’s response is different from ‘OK’
or reversal is not passed.
Checking reversal
Checking clearing
Validate form data Checking for required fields, PAN, Expire date, CVC.
Sending POST request to Merchant with Returns information about the request.
parameters
Connecting with URL_NOTIFY
Merchant response
Start checking card for 3DS
Starting payment (Without 3DS)
Redirecting to ACS Redirecting to Access control server in order to check for
3DSecure.
Error while checking card for 3DS
Redirecting to Home Page
Redirection to Merchant Cancel URL
Redirection to Merchant OK URL
Starting payment (With 3DS)
Card successfully validated
Card check for 3DS
Invalid card issuer
Check referrer URL

Document revision 1.4.0 myPOS Europe Ltd. Page 47

Accepting online payments
myPOS Checkout API v.1.4

Check post params

Check 3DS response
User is blocked by issuer
Trying to send reversal notify (cron)
Update cron table (cron)
Order done with status Returns the order’s status (0 – pending, 1 – paid, 2 – reversed,
3 – cancelled).
Check if SID match to Wallet number
Display output data
OTHER Other additional data.

Make a refund for previously executed payment (API call: IPCRefund)

Purpose
This method is used by the Merchant to initiate a refund of a previously executed payment. The myPOS Checkout
API will return an xml with the result. This method is intended to be utilized by the Merchant in his website back-
end. The Merchant could decide whether or not to use this method.

Method properties
Property Typical value Type Required Description

IPC_Trnref 12345678923 String YES Used to uniquely identify a transaction in

IPC. Used as a parameter for subsequent
refund or reversal if needed.
OrderID 201203319999999 String NO 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.
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.
OutputFormat xml String NO Output format of data. The property can
be “xml” or “json”. If it is not specified in
the request, the default value is “xml”.

Response properties
Property Typical value Type Required Description

IPC_Trnref 12345678923 String YES Used to uniquely identify a transaction in

IPC. Used as a parameter for subsequent
refund or reversal if needed.
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.

Document revision 1.4.0 myPOS Europe Ltd. Page 48

Accepting online payments
myPOS Checkout API v.1.4

Example of the xml response

<IPC_response>
<IPCmethod>IPCRefund</IPCmethod>
<IPC_Trnref>12345678923</IPC_Trnref>
<Amount>23.45</Amount>
<Currency>EUR</Currency>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>

Make a reversal for previously executed payment (API call: IPСReversal)

Purpose
This method is used by Merchant to initiate a reversal (void) of previously executed payment. The myPOS
Checkout API will return an xml with the result. This method is intended to be utilized by the Merchant in his
website back-end. The Merchant could decide whether or not to use this method.

Method properties
Property Typical value Type Required Description

IPC_Trnref 12345678923 String YES Used to uniquely identify a transaction in

myPOS Checkout API. Used as a
parameter for subsequent refund or
reversal if needed.
OutputFormat xml String NO Output format of data. The property can
be “xml” or “json”. If it is not specified in
the request, the default value is “xml”.

Response properties
Property Typical value Type Required Description

IPC_Trnref 12345678923 String YES Used to uniquely identify a transaction in

myPOS Checkout API. Used as a
parameter for subsequent refund or
reversal if needed.
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.

Example of the xml response

<IPC_response>
<IPCmethod>IPCReversal</IPCmethod>
<IPC_Trnref>12345678923</IPC_Trnref>
<Amount>23.45</Amount>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>

Document revision 1.4.0 myPOS Europe Ltd. Page 49

Accepting online payments
myPOS Checkout API v.1.4

Store card data for recurring payments (API call: IPCIAStoreCard)

Purpose
This method is used by myPOS Checkout API to allow cardholder to securely store card data which will be used
for recurring payments afterwards. The cardholder will remain within the pages of the external application. All
needed data (incl. payment card details) will be collected and submitted to myPOS Checkout API by the external
app. The myPOS Checkout API will return an xml with the result.

Method properties
Property Typical value Type Required Description

CardType 1 N(1) YES

PAN Byte[] BASE64 YES
CardholderName John Smith String (30) YES
ExpDate Byte[] BASE64 YES
CVC Byte[] BASE64 YES
ECI 6 N(1) YES
AVV Byte[] BASE64 Conditional Conditional.
AVV is required when the card is 3DS
enabled.
XID Byte[] BASE64 Conditional Conditional.
AVV is required when the card is 3DS
enabled.
CardVerification 2 N(2) YES Specify whether the inputted card data
to be verified or not before storing.
Please refer to Appendix V.
Amount 3.50 Double Conditional Conditional. Amount of the transaction.
Used in the request if CardVerification =
2.
Currency EUR A(3) Conditional Conditional. ISO 3-character currency
code. Used in the request if
CardVerification = 2.
OutputFormat xml String NO Output format of data. The property can
be “xml” or “json”. If it is not specified in
the request, the default value is “xml”.

Response properties
Property Typical value Type Description

CardToken 1041333312721BC752C1AB77 String (50) Uniquely generated token of the PAN of

43D0821AA1C9CA09 the card (returned as a response property
of IPCIAPurchase).
PAN 4885 N(4) Last four digits of the account number
(PAN).
ExpDate 1703 N(4) Card expire date. Format YYMM.
CardType 1 N(1) Please refer to Appendix IV.

Document revision 1.4.0 myPOS Europe Ltd. Page 50

Accepting online payments
myPOS Checkout API v.1.4

Example of the xml response

<IPC_response>
<IPCmethod>IPCIAStoreCard</IPCmethod>
<CardToken>70b2214c43814a99f66266c1f1f1e5ec4a8e2a01</CardToken>
<PAN>4885</PAN>
<ExpDate>1703</ExpDate>
<CardType>1</CardType>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>

Update data of stored card for recurring payments (API call: IPCIAStoredCardUpdate)

Purpose
This method is used by myPOS Checkout API to allow cardholder to securely update the expiry date, cardholder
name and the Custom name of already stored card. The customer will remain within the pages of the external
application. All needed data (incl. payment card details) will be collected and submitted to myPOS Checkout API
by the external app. The myPOS Checkout API will return an xml with the result.

Method properties
Property Typical value Type Required Description

CardToken 1041333312721B String (50) YES Uniquely generated token of the

C752C1AB7743D0 PAN of the card (returned as a
821AA1C9CA09 response property of
IPCIAPurchase).
CardholderName John Smith (30) String (30) YES
CardType 1 N(1) YES Please refer to Appendix IV.
ExpDate Byte[] BASE64 YES
CVC Byte[] BASE64 YES
ECI 6 N(1) YES
AVV Byte[] BASE64 Conditional Conditional.
AVV is required when the card is
3DS enabled.
XID Byte[] BASE64 Conditional Conditional.
AVV is required when the card is
3DS enabled.
CardVerification 2 N(2) YES Specify whether the card data to be
verified or not before storing. Please
refer to Appendix V.
Amount 23.45 Double Conditional Conditional.
Amount of the transaction. Used in
the request if CardVerification = 2.
Currency EUR A(3) Conditional Conditional.
ISO 3-character currency code. Used
in the request if CardVerification =
2.

Document revision 1.4.0 myPOS Europe Ltd. Page 51

Accepting online payments
myPOS Checkout API v.1.4

OutputFormat xml String NO Output format of data. The property

can be “xml” or “json”. If it is not
specified in the request, the default
value is “xml”.

Response properties
Property Typical value Type Description

CardToken 1041333312721BC752C1AB77 String (50) Uniquely generated token of the PAN of

Example of the xml response

<IPC_response>
<IPCmethod>IPCIAStoredCardUpdate</IPCmethod>
<PAN>4885</PAN>
<ExpDate>1703</ExpDate>
<CardType>1</CardType>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>

Request money from a client’s myPOS account (API call: IPCRequestMoney)

Purpose
This method is used by the merchant to initiate a direct withdrawal transaction from a client’s myPOS account.
The mandate with the client must be registered within the myPOS system prior to initiation of the call
IPCRequestMoney. Each client’s mandate reference must be registered via the call IPCMandateManagement.

The merchant must have fully signed contract with myPOS for the service in order to be able to use this call.

The myPOS Checkout API will return an xml with the result. This method is intended to be utilized by the
merchant in his website back-end.

Method properties
Property Typical value Type Required Description

MandateReference 126ca831-93d2- String YES A unique identifier of the agreement

4dfc-ab1f- (mandate) between the merchant
0cce1d0abe9e and the client (debtor). Up to 127
characters.
CustomerWalletNumber 61938166612 AN(11) YES Identifier of the client’s (debtor’s)
myPOS account

Document revision 1.4.0 myPOS Europe Ltd. Page 52

Accepting online payments
myPOS Checkout API v.1.4

OrderID 201203319999999 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.
ReversalIndicator 1 N(1) NO Used only if there is a system error or
no response was received. The
Merchant must submit the same data
with IPCRequestMoney method
including this parameter with value =
1 (Reversal of the previously
executed Request money
transaction).
Amount 23.45 N(18,2) YES The amount of the payment
requested.
Currency EUR A(3) YES ISO 3-character currency code.
Reason Invoice num 123456 String YES The reason for the transfer.
OutputFormat xml String NO Output format of data. The property
can be “xml” or “json”. If it is not
specified in the request, the default
value is “xml”.

Example of the xml response

<IPC_response>
<IPCmethod>IPCRequestMoney</IPCmethod>
<MandateReference>126ca831-93d2-4dfc-ab1f-0cce1d0abe9e </MandateReference>
<CustomerWalletNumber>61938166612</CustomerWalletNumber>
<IPC_Trnref>12345678923</IPC_Trnref>
<ReversalIndicator></ReversalIndicator>
<Amount>23.45</Amount>
<Currency>EUR</Currency>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>
In case of system error or missing response the merchant must call the method IPCRequestMoney
with ReversalIndicator included. The reversal of the transaction can be processed if there are enough
money at the merchant’s account.

Manage registrations for Request money transactions (API call: IPCMandateManagement)

Purpose
This method is used by the merchant to register a mandate reference for direct withdrawal transactions (Request
money) from a client’s myPOS account or to cancel a previously registered mandate reference. The merchant can
register more than one mandate reference for each client. All mandate references are registered to a specific
merchant’s myPOS account.
The myPOS Checkout API will return an xml with the result. This method is intended to be utilized by the
merchant in his website back-end.

Document revision 1.4.0 myPOS Europe Ltd. Page 53

Accepting online payments
myPOS Checkout API v.1.4

Method properties
Property Typical value Type Required Description

MandateReference 126ca831-93d2-4dfc- String YES A unique identifier of the

ab1f-0cce1d0abe9e agreement (mandate) between
the Merchant and the client
(debtor). Up to 127 characters.
CustomerWalletNumber 61938166612 AN(11) YES Identifier of the client’s (debtor’s)
myPOS account

Action 1 N(1) YES 1 – Registration of the

MandateReference; 2 –
Cancellation of a
MandateReference
MandateText This is what we agreed … String NO Text supplied from the merchant,
so the client can easily identify
the Mandate.
OutputFormat xml String NO Output format of data. The
property can be “xml” or “json”.
If it is not specified in the
request, the default value is
“xml”.

Example of the xml response

<IPC_response>
<IPCmethod>IPCMandateManagement</IPCmethod>
<CustomerWalletNumber>61938166612</CustomerWalletNumber>
<MandateReference>126ca831-93d2-4dfc-ab1f-0cce1d0abe9e </MandateReference>
<Action>1</Action>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>

Get transaction status for previously executed payment (API call: IPCGetTxnStatus)

Purpose
This method is used by Merchant to get the current status of a previously executed payment. The myPOS Checkout
API will return an xml with detailed information about a specific OrderID. This method is intended to be utilized by
the Merchant in his website back-end. The Merchant could decide whether or not to use this method.

Method properties
Property Typical value Type Required Description

OrderID 201203319999999 String YES Placeholder for the merchant. Used to

put some data that will help the
merchant to refer payments to orders. Up
to 255 characters.

Document revision 1.4.0 myPOS Europe Ltd. Page 54

Accepting online payments
myPOS Checkout API v.1.4

OutputFormat xml String NO Output format of data. The property can

be “xml” or “json”. If it is not specified in
the request, the default value is “xml”.

Response properties
Please refer to Response properties of every command in order to see the information which will be
returned by myPOS Checkout API.

Make a credit note to a myPOSWallet (API call: IPCSendMoney)

Purpose
This method is used by the Merchant to initiate a credit note to myPOSWallet. The IPC API will return an xml with
the result. This method is intended to be utilized by the Merchant in his website back-end. The Merchant could
decide whether or not to use the method.

Method properties
Property Typical value Type Required Description

CustomerWalletNumber 61938166610 AN(11) YES Identifier of myPOS Wallet

number
Amount 23.45 N(18,2) 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.
TransactionReference 12345678923 String YES Used to uniquely identify a
transaction in IPC. Used as a
parameter for subsequent refund
of reversal if needed.
Reason Invoice num 123456 String Yes The reason for the transfer.
OutputFormat xml String NO Output format of data. The
property can be “xml” or “json”. If
it is not specified in the request,
the default value is “xml”.

Example of the xml response

<IPC_response>
<IPCmethod>IPCSendMoney</IPCmethod>
<Amount>23.45</Amount>
<Currency>EUR</Currency>
<IPC_Trnref>12345678923</IPC_Trnref>
<CustomerWalletNumber>61938166610</CustomerWalletNumber>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>

Document revision 1.4.0 myPOS Europe Ltd. Page 55

Accepting online payments
myPOS Checkout API v.1.4

Document revision 1.4.0 myPOS Europe Ltd. Page 56

Accepting online payments
myPOS Checkout API v.1.4

Document revision 1.4.0 myPOS Europe Ltd. Page 57

Accepting online payments
myPOS Checkout API v.1.4

Appendix I – Error messages

Code Error Description
0 Success No errors
1 E_MISSING_REQ_PARAMS Some of the required fields from the POST request are missing.
2 E_SIGNATURE_FAILED The parameter ‘Signature’ is not correct.
3 E_IPC_ERROR Invalid or missing response from myPOS Checkout servers. Please
contact myPOS engineers.
4 E_INVALID_SID The parameter ‘SID’ is not correct.
5 E_INVALID_PARAMS One or more of the other parameters from the POST request are not
correct.
6 E_INVALID_REFERER The POST request is received from an URL which is not approved.
8 E_TRANSACTION_AUTH_FAIL The authorization of the transaction has been failed.
9 E_WRONG_AMOUNT The parameter ‘Amount’ is not correct.
10 E_ UNSUPPORTED_CALL
11 E_INACTIVE_MANDATE_REFE The error will be returned both if the registration of the mandate
RENCE reference is still not authorized, rejected or temporarily blocked.
12 E_INVALID_MANDATE_REFER
ENCE
13 E_NOT_SUFFICIENT_FUNDS
14 E_TRANSACTION_NOT_PERMI
TTED
15 E_EXCEEDED_LIMIT
16 E_MANDATE_ALREADY_REGIS
TERED
17 E_INACTIVE_ACOUNTIDENTIFI The error will be returned when the client’s payment instrument is
ER still not activated.
18 E_INVALID_ACOUNTIDENTIFIE
R
19 E_EXEEDED_ACCOUNT_LIMITS The error will be returned when the transaction cannot be processed
because of reached Wallet Account limits.
20 E_DUPLICATE_TRANSMISSION
21 E_TRANSACTION_DECLINED
99 E_UNDEFINED_ERROR Other unspecified error.

Note:
If the system returns an error on IPCPurchase call, the payment page will not be displayed. The cardholder (client)
will see an error page with the following general message:

[The online store name] has sent a shopping cart with errors in it.

We will contact the Merchant with a request to fix this problem. As this could be a temporary issue, you can go
back to try checking out again.

<< Return to [Online store name]

Document revision 1.4.0 myPOS Europe Ltd. Page 58

Accepting online payments
myPOS Checkout API v.1.4

Appendix II – Testing data

Field name Test value
myPOS Checkout payment link https://www.mypos.eu/vmp/checkout-test
SID 000000000000010
myPOS Account Number 61938166610

Test private key

myPOS test public certificate

Document revision 1.4.0 myPOS Europe Ltd. Page 59

Accepting online payments
myPOS Checkout API v.1.4

Appendix III – Example for successful payment notification

Result POST data

Array (
[IPCmethod] => IPCPurchaseNotify
[SID] => 000000000000010
[Amount] => 50
[Currency] => EUR
[OrderID] => 1440146333
[IPC_Trnref] => 813705
[RequestSTAN] => 000006
[RequestDateTime] => 2015-08-21 10:39:37
[Signature] =>
aPn96fYghN/hdLgP0oGbCglBACwJlG6TSlf7UJP9Qe9UMzBP9+B5r7enaLZNAWAHaws7iZH9INgQrHbnn/IaIKFYzjWLHqCQm2xY
PF4IAbIn5MC9UjfUXyMxZ42ENVx/Poeq0ZH1Zd34j2qbFJ8tViawUjey5BZRIeJaEmQr3ww=
);

Appendix IV – Card types

Code Card type
1 MasterCard
2 Maestro
3 VISA
4 Visa Electron
5 VPAY
6 JCB
7 Bancontact

Appendix V – Card verification

Code Description
1 The card data will be verified with a zero-amount debit transaction. Upon successful
transaction the card data will be stored successfully.
2 The card data provided will be verified with a real debit transaction. Upon successful
transaction the card data will be stored successfully.

Document revision 1.4.0 myPOS Europe Ltd. Page 60

BASE24-eps 2023-03-30 - Standard POS Device Message Specifications
100% (2)
BASE24-eps 2023-03-30 - Standard POS Device Message Specifications
253 pages
Immediate Access Engineering Fluid Mechanics 10th Edition Verified PDF Download
0% (1)
Immediate Access Engineering Fluid Mechanics 10th Edition Verified PDF Download
406 pages
FAMILY CODE - Ateneo Reviewer
100% (1)
FAMILY CODE - Ateneo Reviewer
26 pages
Ipay - API Documentation EN 2024 03 22
No ratings yet
Ipay - API Documentation EN 2024 03 22
56 pages
Modular Test 2
No ratings yet
Modular Test 2
7 pages
BASE24-Pos SPDH Device Config
No ratings yet
BASE24-Pos SPDH Device Config
462 pages
PayPal API Reference
No ratings yet
PayPal API Reference
350 pages
SV Epg-202306.1-Api-Spec en Core 20230914
No ratings yet
SV Epg-202306.1-Api-Spec en Core 20230914
541 pages
CorvusPay IntegrationManual 5.1.0
No ratings yet
CorvusPay IntegrationManual 5.1.0
69 pages
Visa Checkout Integration Guide V44
No ratings yet
Visa Checkout Integration Guide V44
201 pages
PayPal NVP API Developer Guide
100% (1)
PayPal NVP API Developer Guide
165 pages
Mobile Push Payment Program Implementation Guide
No ratings yet
Mobile Push Payment Program Implementation Guide
105 pages
Algorithms and Models For The Web Graph Anthony Bonato Download
No ratings yet
Algorithms and Models For The Web Graph Anthony Bonato Download
175 pages
Iveri Client Developers Guide 4
No ratings yet
Iveri Client Developers Guide 4
170 pages
Api Documentation
No ratings yet
Api Documentation
107 pages
IPG - Integration Guide - API - 2024-1
No ratings yet
IPG - Integration Guide - API - 2024-1
177 pages
PP NVPAPI DeveloperGuide
No ratings yet
PP NVPAPI DeveloperGuide
266 pages
TPV Virtual - Extended Merchant Manual July09
No ratings yet
TPV Virtual - Extended Merchant Manual July09
71 pages
Temenggong Securities LTD & Anor V Registrar of
100% (2)
Temenggong Securities LTD & Anor V Registrar of
7 pages
WebCollectTechnical Guide Q4 2019
No ratings yet
WebCollectTechnical Guide Q4 2019
371 pages
eCommercePaymentSolutions sg246177
No ratings yet
eCommercePaymentSolutions sg246177
352 pages
Screenshot 2025-07-29 at 12.26.13 PM
No ratings yet
Screenshot 2025-07-29 at 12.26.13 PM
31 pages
HDFC API Document
100% (1)
HDFC API Document
160 pages
Monetico Paiement Technical Documentation v2.0
No ratings yet
Monetico Paiement Technical Documentation v2.0
114 pages
PP Pay Flow Pro Guide
No ratings yet
PP Pay Flow Pro Guide
176 pages
Network Merchants (NMI) Integration Resources: Direct Post API Documentation
No ratings yet
Network Merchants (NMI) Integration Resources: Direct Post API Documentation
11 pages
Anand Sahib-Sikh Prayer-Simple Punjabi
No ratings yet
Anand Sahib-Sikh Prayer-Simple Punjabi
124 pages
HDFC API Doc v1.3
No ratings yet
HDFC API Doc v1.3
172 pages
InStore Payment API Android v04.06.11
No ratings yet
InStore Payment API Android v04.06.11
56 pages
PayflowPro Guide
No ratings yet
PayflowPro Guide
198 pages
Iot Physical Devices and Endpoints: Bahga & Madisetti, © 2015
No ratings yet
Iot Physical Devices and Endpoints: Bahga & Madisetti, © 2015
14 pages
The Introvert's Way
0% (1)
The Introvert's Way
15 pages
IPG IntegrationGuide API 2023-1
No ratings yet
IPG IntegrationGuide API 2023-1
162 pages
Avogadro's Hypothesis on Gas Molecules
No ratings yet
Avogadro's Hypothesis on Gas Molecules
11 pages
PP WebsitePaymentsPro IntegrationGuide
No ratings yet
PP WebsitePaymentsPro IntegrationGuide
68 pages
PFP ExpressCheckout PP
No ratings yet
PFP ExpressCheckout PP
84 pages
MPOST Integration
No ratings yet
MPOST Integration
56 pages
Nexi Smartpos Pax A910: With Printer
No ratings yet
Nexi Smartpos Pax A910: With Printer
17 pages
Thinking Through Drawing
No ratings yet
Thinking Through Drawing
35 pages
Visa Checkout SDKi OSV43
No ratings yet
Visa Checkout SDKi OSV43
99 pages
Digital Pay API Documentation
No ratings yet
Digital Pay API Documentation
2 pages
Payment Gateway Integration Guide
No ratings yet
Payment Gateway Integration Guide
69 pages
Check-List. Reading Check-List - 1
No ratings yet
Check-List. Reading Check-List - 1
10 pages
Easypaisa Merchant Integration Guide v4.1.2
0% (1)
Easypaisa Merchant Integration Guide v4.1.2
30 pages
ICICI API Specification V1.2
No ratings yet
ICICI API Specification V1.2
42 pages
IPG IntegrationGuide API NBD
No ratings yet
IPG IntegrationGuide API NBD
103 pages
Resolution MDC Reprogram 2019
100% (1)
Resolution MDC Reprogram 2019
8 pages
KDAY
No ratings yet
KDAY
23 pages
Jira Essentials Powerpoint
No ratings yet
Jira Essentials Powerpoint
49 pages
Amba Pancharatnam Notes
No ratings yet
Amba Pancharatnam Notes
15 pages
Payment Receipt
No ratings yet
Payment Receipt
68 pages
Handbook of Ethics in Quantitative Methodology 1st Edition A. T. Panter All Chapters Instant Download
100% (4)
Handbook of Ethics in Quantitative Methodology 1st Edition A. T. Panter All Chapters Instant Download
84 pages
HyperPay Developer Slides Explanation
No ratings yet
HyperPay Developer Slides Explanation
2 pages
Oxford Rooftops 5th - Reinforcement and Extension-26
No ratings yet
Oxford Rooftops 5th - Reinforcement and Extension-26
1 page
Google Pay: Documentation
No ratings yet
Google Pay: Documentation
5 pages
Payflowgateway Guide
No ratings yet
Payflowgateway Guide
256 pages
PP API Reference
No ratings yet
PP API Reference
272 pages
Web Service API: Integration Guide
No ratings yet
Web Service API: Integration Guide
124 pages
Example Api Documentation by Mindtrans
No ratings yet
Example Api Documentation by Mindtrans
60 pages
Swap e Roo Talk Short
No ratings yet
Swap e Roo Talk Short
21 pages
Midtrans Documentation
No ratings yet
Midtrans Documentation
95 pages
PayflowGateway Guide
No ratings yet
PayflowGateway Guide
238 pages
UMS Banking Gateway-Direct-Post-API
No ratings yet
UMS Banking Gateway-Direct-Post-API
46 pages
Skip Cash
No ratings yet
Skip Cash
27 pages
2C2P-Airline Payment v1 5 6
No ratings yet
2C2P-Airline Payment v1 5 6
43 pages
Integrate Payments Direct Post API
No ratings yet
Integrate Payments Direct Post API
31 pages
Brave New World Essay
No ratings yet
Brave New World Essay
3 pages
Swaperoo: A Simple Wallet Architecture For Payments, Exchanges, Refunds, and Other Operations
No ratings yet
Swaperoo: A Simple Wallet Architecture For Payments, Exchanges, Refunds, and Other Operations
21 pages
Mypos Go: User Manual
No ratings yet
Mypos Go: User Manual
15 pages
Technical Analyst
100% (1)
Technical Analyst
50 pages
Contents-Rules of English Grammar and Usage
No ratings yet
Contents-Rules of English Grammar and Usage
5 pages
Buurtzorg: Dutch Home Care Revolution
No ratings yet
Buurtzorg: Dutch Home Care Revolution
10 pages
Secupay API Flexv2 en 2
No ratings yet
Secupay API Flexv2 en 2
37 pages
Payscape: Integration Resources
No ratings yet
Payscape: Integration Resources
11 pages
MPOS Secure Mobile Card Acceptance Wp1
No ratings yet
MPOS Secure Mobile Card Acceptance Wp1
28 pages
Website Payments Pro Payflow Edition Developer's Guide
No ratings yet
Website Payments Pro Payflow Edition Developer's Guide
70 pages
Express Checkout Integration Guide
No ratings yet
Express Checkout Integration Guide
110 pages
NMI Direct Post API
No ratings yet
NMI Direct Post API
11 pages
Week 8 Marriage and Family Life On The Eve of Missionary Contact
No ratings yet
Week 8 Marriage and Family Life On The Eve of Missionary Contact
8 pages
Physical Health Assessment Pre-Sim Prep
No ratings yet
Physical Health Assessment Pre-Sim Prep
3 pages
Evidence of Evolution
No ratings yet
Evidence of Evolution
15 pages
20210730201058D6214 - 3. Paraphrasing, Summarising, Combining Sources
No ratings yet
20210730201058D6214 - 3. Paraphrasing, Summarising, Combining Sources
22 pages
Digital Natives Digital Immigrants - II
No ratings yet
Digital Natives Digital Immigrants - II
24 pages
The MIT Press
No ratings yet
The MIT Press
17 pages
Hematology & Drug Study Guide
No ratings yet
Hematology & Drug Study Guide
19 pages