Skip to main content
Version: 3.2

Getting Started

Phase 1: First Steps​

To get started with the PayperCloud API, we recommend following these steps:

  1. Retrieve your remotePos PID (sourcePid, starts with 21....) and your pos PID (targetPid, starts with 20....) from the PayperCloud Backoffice see.
  2. Implement Auth to retrieve an access token.
  3. Then : Purchase call make a purchase.
  4. Then : Get Remote Action Status By Id to check the status of the purchase.

With this, you can validate that you can successfully call the API, you don't necessarily need a physical terminal at this stage.

Phase 2: Better POS/Terminal relationships​

  1. Use Get Targets to retrieve the list of terminals (targets) reachable by your POS (source).
  2. Use Cancel Remote Action to cancel a pending remote action (for example, if you want to cancel the purchase before the terminal has received it).
Documentation work in progress

We appologize for the delay, in order to publish the current documentation as fast as possible, we already published this draft but the copy-writing for the next parts is still ongoing. This will be updated by 18/02/2026.

Phase 3: Last requirements for go to production​

  1. Implement Void that allows you to rollback a purchase/refund. (cannot be done after the closing has been executed)

  2. Implement Closing that will (re)synchronize everything from the Point of Payment to the backoffice + execute the Banking closing (that triggers the payment to day+x for the merchant)

DRAFT : To be continued.

Phase 4: Get KPI and stats.​