Developers

myPOS Partner Integration – Quick Start

Welcome to the myPOS Partner Program! Below are the key steps to create and launch your integration.

1. Access the Partner Portal

  • Go to partners.mypos.com
  • Log in with your credentials
  • Once inside, click on the “Integrations” tab from the menu

2. Create a New Integration

  • Click the “+ Create integration” button
  • Enter your Integration Name and optional Description
  • Choose one Integration Type:
    • Online – For e-commerce platforms and websites
    • Mobile / In-App – For native Android/iOS apps
    • Smart POS – For Android-based myPOS terminals
    • Cash Register – For traditional POS systems
    • Unattended – For kiosks or vending machines
    • Soft POS – For tap-to-pay smartphones
    • Account Management – For accessing transaction data and reports
  • Review your entries and click** “Create integration”**
  • You will see a Success message when the integration is created

3. Integration Approval

  • After you have created your integration, we will review your request and approve the integration.
  • For priority cases and expedition needed please:
    • Email integrations@mypos.com to request priority approval
    • Include your Partner ID and Application ID (found in the Support tab)

4. Generate API Credentials

  • Go to the Summary tab of your new integration
  • In the Summary tab, click “Generate API Credentials” to receive Partner ID, Application ID, Partner Client ID, Partner Secret
  • Note: The Partner Secret will only be shown once - copy and store it securely

4.1. API Gateway Integration Steps

Share Approval Link

  • After creating your integration, you will receive a unique share link.
  • Send this link to the merchant so they can approve the integration.
  • The merchant needs to approve the integration for you to be able to generate credentials.

Generate Merchant Credentials

  • Once the merchant approves:
    • Go to the Merchants tab.
    • Generate the Merchant Client ID and Merchant Client Secret.
    • Note: The Merchant Secret is shown only once. Store it securely.

Generate Tokens

  • Use your Partner Client ID and Partner Secret to generate a Bearer Token.
  • Then, generate a Session ID using:
    • Merchant ID
    • Merchant Secret
    • Bearer Token

Token Expiry

  • The Bearer Token is valid for 1 hour.
  • After it expires, you must generate a new Bearer Token and a new Session ID before making further requests.

Sending API Requests

  • Include the following headers in each API request:

    • Application ID
    • Partner ID
    • Session ID

  • Use the Bearer Token for authorization.

  • Exception: The eCommerce API does not require authorization.

5. Use Resources and Documentation

  • Open the Resources tab to access:
  • API Gateway documentation
  • GitHub SDKs and sample code
  • Integration-type-specific guides

6. Integration Checklist

  • Go to the Checklist tab
  • Follow the setup steps based on your integration type
  • Checklist includes environment settings, testing tasks, and go-live preparation

7. Manage Settings

  • Edit integration details from the Settings tab

8. Use the Support tab to:

  • Send direct messages to the integration team
  • Include your Partner ID and App ID when reporting issues

9. Move to Production

  • Once your integration is approved and fully tested, switch the toggle from Demo to Live in the Partner Portal.
  • Note: This toggle only changes the mode in the portal – it does not automatically migrate your credentials or settings to production.
  • If you need any assistance with this process, our team is here to support you.

Need Help?