Getting started
To integrate with the CloudLink API, you must obtain an API key from Rapyd. The API communicates with terminals through the Rapyd CloudLink app. The app must be installed on all terminals and is accessible through the MAXSTORE client pre-installed on all PAX devices.
Environments and Base URLs
The CloudLink API is available in the following environments, use the appropriate base URL for your requests:
Production:
https://cloudlink.valitor.com/CloudLinkApiUAT (User Acceptance Testing):
https://cloudlink.uat.valitor.com/CloudLinkApiTest:
https://cloudlink.test.iteron.org/CloudLinkApi
Terminal Activation
Before sending transactions to a terminal, the terminal must be activated. The activation process generates a device token that must be included in all future requests intended for that specific terminal. For detailed instructions, see the webhook activation process or the polling activation process.
Rate Limits
If you use status polling, note the strict rate limits enforced on the polling endpoints. These limits apply per serialNumber or pollId:
/poll/devicetoken/{serialNumber}: 1 request per second./poll/terminalresponse/{pollId}: 1 request per 500ms./poll/reportResponse/{pollId}: 1 request per 500ms./poll/terminalConfigResponse/{pollId}: 1 request per 500ms.