You can start off your integration by doing some testing in our sandbox environment.
Once you're ready and you want to process live payments with the myPOS Checkout API or with a myPOS plug-in, you need to open a myPOS Account, if you haven't done that yet. Then, you will be able to set up your Checkout stores and start your integration.
Important notes on technical integration
- Requests should be made from a public IP address.
- Version 5.4.8 of PHP or later required.
- The URL_Notify should be an SSL-enabled address only, i.e. it must start with "https://". Unsecure URLs will be treated as wrong and transactions will be reversed by the system.
- Upon HTTP request, the Merchant should respond with header HTTP 200 OK with the following body content: “OK”. Every other response will be treated as communication error, call error, server error or system malfunctions.
Please keep in mind that your stores have to be verified by myPOS which may take up to 5 business days. Until they are successfully verified, you will be able to process transactions but within certain limits.
To set up your Checkout store:
- Log in to your myPOS Account
- Go to menu Stores
- Click on "Create store" as shown on the screen below.
Once ready, you can start the integration right away.
myPOS Оnline Store
Create a new Store
STEP 1 Integration method
Select the method you want to integrate with your new Checkout. You can choose from one of the supported shopping carts, or for more advanced integrations, select one of the provided myPOS SDKs or the myPOS Checkout API.
Next is the store setup.
STEP 2 Store details
Important note: make sure you select the same currency as the one in which you are processing your orders. For example, make sure you have enabled the EUR currency if you process orders in EUR. You can also add every other currency which you support - if you want to support orders in BGN, include a BGN account and so on for every currency.
If you didn't add all of the desired currencies when creating the store, you can do it once it is created in the menu Stores > eCommerce > Name of the store > Settings > Transaction currencies
STEP 3 REVIEW AND CONFIRM
CHECKOUT IS CREATED
Depending on the integration method you selected at the start, here you will see the guide on how to integrate your Checkout with the chosen Shopping cart, SDK, or in the case below with the API.
Configuring the New Checkout
Once added, the new Checkout will be visible in the Stores menu in the eCommerce section.
To be able to accept payments on your website, you will need to integrate the store with the myPOS Checkout via one of the listed Integration methods. You can start the integration process as soon as you create your store, or do it later by pressing the Configure button in the Store's Integration tab.
There are two possible ways to integrate your Checkout - an easy setup and an advanced setup. You can use either, depending on your preferences. More information on authentication may be found here.
To integrate your Checkout using the easy setup, you can choose between Plugins, SDKs or Custom integration.
When you select your method of choice, it will generate a new Configuration Pack which you will need to copy and paste in your settings, as per the instructions (please see below).
You can always exit the integration process and come back to it later.
Once you are ready and have everything set up in your Plugin or code, you can Complete your integration and go to your now integrated Checkout.
If you need to delete the key, you can do that from the Integration tab (shown below). However, please be aware that this will shut down your Checkout and you will stop processing payments immediately. You will need to generate a new Pack and follow the same steps.
This type of setup is a deprecated method that is based on the generation of a key pair - Private key and Public Certificate. To use that method, please select Custom integration method -> Private & Public Key -> Generate Pair Keys
Setting the Public and Private Keys
You can use these keys in any type of integration but it is easier to use the Configuration Pack, which has all mandatory settings in one package.
The Key pair will generate the two keys which you need to paste into your code. Keep in mind that the Private key is shown only once and you need to store it securely. Should you lose it, you will need to generate a new key pair.
The myPOS Public Certificate is saved in the Integration tab and can be downloaded at any time if needed.
Please NOTE that you should also set the Key Index value in your settings. It is found in the Integration tab as well, and it indicates that you will be using this key pair with your integration.
As a final step, after getting the key pair in the settings or your code, you need to set up the remaining parameters - Store ID and Client Number.
Store ID (SID) - You can find the Store ID in the general information for your Checkout.
Client Number - You can find it in the Company information menu accessible from the top right corner of your myPOS account.
Once integrated, the new Checkout will be with status “Enabled” and you are ready to start accepting payments.
You can Enable / Disable every Checkout at any time.
NOTE 1: If you plan to use one store with multiple programming languages or operating systems and need to integrate it into each one, you need to generate only one Configuration pack or Key pair and use that for every instance of code you have.
For example, if you have an Android and iOS Application and want to integrate it with one store, you generate one Configuration pack and use it in both of your app projects in the different operating systems.
NOTE 2: Request URLs should be your domain name.
https://example.com/ - Correct
https://www.example.com/ - Correct
https://example.com:8000 - NOT Correct
https://example.com/any-page-name/ - NOT Correct
IMPORTANT: Please note that each change to the configuration of your Checkout will have to be verified by myPOS which takes up to 5 business days.
Until your Checkout is verified, you may not be able to process transactions through it.
All e-commerce transactions will be visible in your myPOS Account in the menu Stores -> Transactions -> eCommerce. The merchant can filter and see the transactions processed via the myPOS Checkout and from a specific Checkout.
Details of Online Transactions
Each e-commerce transaction has the following details:
- 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 – the refund is a functionality with which the merchant can return the full or partial amount of a previously received payment to the customer. If there is a refund initiated for any payment, the merchant will see it together with the refund transaction reference, the refund amount and the applicable fee.
Making A Refund
In case the customer has lodged a justified complaint or the Merchant is unable to deliver the goods, the Merchant can refund up to 100 percent of the original amount to the customer.
When the refund is initiated, a reference will be added to the original transaction details along with a new row for the refund transaction.
Once issued, the refund cannot be canceled. If there are insufficient funds in the merchant’s myPOS Account, the refund will be denied.
If the myPOS Account balance becomes negative as a result of deducted refunds or chargebacks, myPOS will collect funds from the merchant in accordance with the Legal Agreements.
Please note that there is a fee applicable for refunds. Information about all fees is available in the "Fees" section located at the bottom left of your myPOS account.
The reserve is a percentage of money that may be withheld in a separate reserve account for a specific period of time to cover any payment reversals that may be received like chargebacks, claims, and disputes.
The reserve rate and period are specified in the merchant’s tariff and depend on the risk assessment of the particular Checkout. They will be reviewed regularly and adjusted when necessary.
If the merchant's myPOS Account is blocked by the Issuer or closed for any reason, myPOS may hold the reserve for up to 180 days after the date of the last transaction processed via the myPOS Checkout.
The reserve is individually assessed and is not imposed on all merchants who are using myPOS Checkout. It may be applied to particular business models. You can contact us for more details on the cases in which reserve could be applied.
In case a reserve is applied, the merchant can track the accumulated reserve amount and how it has been calculated. He/she can filter all transactions for which a reserve amount has been withheld and when that amount will be released.