Payment API
The myPOS Payment API is designed for developers who want to build custom point-of-sale (POS) solutions for in-person payments. With this API, you can integrate myPOS payment flows and card readers into a POS system tailored to your business’s unique requirements.
Why Use myPOS Payment API?
myPOS Payment API is ideal for businesses that need more than the standard features of myPOS stand-alone devices. For example:
- Custom furniture stores may require complex order forms for personalized items.
- Museums and events might need specialized ticketing and payment flows.
- Professional services could benefit from custom order management, such as scheduling assessments and deliveries.
In all these cases, developers can create a custom POS app that integrates seamlessly with the myPOS Payment API to handle the payment process.
Key Benefits
- Fully integrated payment processing without building your own payment flow from scratch.
- Access to all myPOS tools and workflows within your specialized POS app.
- View all transactions in your myPOS Account.
- Fully PCI compliant for security.
- Competitive fees and instant payouts for sellers.
Build Your Custom POS Solution
The myPOS Payment API provides a standard protocol for communication between myPOS devices and custom POS systems via Bluetooth or USB. To simplify integration, we offer SDKs and reference guides for various platforms.
The API manages communication between your POS system and myPOS devices, handling:
- Transaction processing (checkout, returns, refunds)
- Card storage for recurring payments
- Transaction status updates, card tokens, and masked PANs
Note: No sensitive card data ever passes through or is stored on your app. All data is encrypted by the card terminal, which is fully certified to industry standards (PCI, EMV, Visa, MasterCard, Amex).
Enabling “Cash Register” Profile on myPOS Devices
To use integrated mode, enable the “Cash Register” profile on your myPOS device:
- Press F2 on the device.
- Go to Settings (page 3).
- Select 6. Change profile.
- Choose 2. Cash register.
- The device will restart.
- Select the connection type to the master device (Bluetooth or USB).
- Select the connection type to the financial host (Bluetooth, USB, SIM, WiFi).
- The device will wait for a connection from your POS system.
All sensitive cardholder data is encrypted by the myPOS device and sent securely to our servers. Your app never handles or stores sensitive card data.
Integration Options
You can integrate myPOS Traditional devices with your app using the following SDKs:
Check our GitHub repositories for the latest versions of the myPOS Payment API SDKs.
Learn more about the devices supporting myPOS Payment API on the next page.