Developers

Cash Register Remote API

The myPOS Cash Register Remote API (myPOS Remote API) is an Application Programming Interface, which allows the partner’s application to connect to the myPOS terminal device and accept card payments through it. The communication between the end devices will be done through the hosts of both sides (partner’s and myPOS'). The partner’s device will not have any physical connection (via BT or cable) to the myPOS devices Mini, Combo and Go, however, for the myPOS Integra, a cable connection is necessary.

Requirements

To use the myPOS Remote API protocol the partner must:

  • Be granted access by means of a login username supplied by myPOS.
  • Exchange digital signing certificates with myPOS.
  • Host a web service that will send requests to the myPOS system web service and receive notifications.

Workflow

The myPOS Cash Register Remote API grants functionality for sending a request to a device through a specific service connected directly to the myPOS Server. There is no need for the Host system/service to be physically connected with the myPOS terminal. Third-party software can communicate with a myPOS terminal over established Server to Server communication. Requests sent to the myPOS terminal have specific XML SOAP Formatting.

In general, the workflow is described below:

  1. 1Third-party software sends a request to its own server.
  2. 2The third-party server connects to the myPOS server at https://crrservice.mypos.com.
  3. 3The myPOS server sends the request to the subscribed myPOS terminal.
  4. 4The customer pays on the terminal.
  5. 5The myPOS terminal notifies the myPOS server of the payment result.
  6. 6The third-party server requests the payment status from the myPOS server.
  7. 7The third-party server notifies the merchant of the payment result.
.NET example clientCRR Example Client.zip

Endpoint

Production
https://crr-api.mypos.com/infromhttp
Test
https://demotest-crrservice.mypos.com/infromhttp

Steps for switching the device to CRR mode

  1. 1The device is initially in “Stand Alone” mode.
  2. 2Call MPRSubscribe, which returns a security code.
  3. 3On the myPOS device, open the menu and choose “Pair device”.
  4. 4The seller fills in the code.
  5. 5The device is now paired.
  6. 6The device is in “Cash Register Remote” mode and the screen shows “Check for transaction (O)”.

Login and Authentication

For authentication, we must add your Login ID / e-mail as a partner in our database. You then use that login ID in the MPRPurchase API call.

Next, generate a key pair — a private key and a public certificate — and send us the public certificate. It must be a self-signed SSL certificate, 2048 bit, in x509 format. Once we have added it, we will send you the myPOS public certificate so you can receive responses from our server.

You can generate the pair directly with this command:

...\openssllib\1.0.2\bin\openssl req -x509 -sha256 -nodes -days 3650 -newkey rsa:2048 -keyout private_key.pem -out public_cert.crt -config ...\openssllib\1.0.2\ssl\openssl.cnf

Make sure to fill in all required fields when prompted for:

  • Country Name (2 letter code) [AU]
  • State or Province Name (full name) [Some-State]
  • Locality Name (eg, city)
  • Organization Name (eg, company) [Internet Widgits Pty Ltd]
  • Organizational Unit Name (eg, section)
  • Common Name (e.g. server FQDN or YOUR name)
  • Email Address