Terminology
Rapyd CloudLink app - An Android app that needs to be installed on the PAX terminal to handle communications with the Cloud Link API. The app is accessible through the MAXSTORE client that comes pre-installed on all PAX terminals.
DeviceToken - Once the Rapyd CloudLink app is installed on the terminal it provides a token, through the terminal activation process. The cash registry system must include this token in all requests intended for the given terminal.
CallbackUrl - A url that the Cloud Link API uses to deliver terminal status updates back to the cash registry system. Only used if the client has chosen to use the webhook communication implementation.
PollId - A UUID, created by the client and used for status polling.
TimeToLive - The maximum time, in seconds, allowed for a request to reach the physical terminal. The default value is 5 seconds.
When you send a request to the Cloud Link API, you immediately receive a 202 Accepted response if the request is valid. This indicates the request is queued but has not yet reached the terminal. If the terminal does not receive the request within the TimeToLive window, CloudLink automatically deletes it. This allows you to safely retry the request without the risk of duplicate transactions or the need for manual cleanup.
CorrelationId - The correlationId is a value that the cash registry system adds to the initial sale request in order to perform message matching in the status update. The Cloud Link API will include the value in each status update.
TerminalId - Used to select a specific merchant profile on multi-merchant terminals. Discover available values via
requestMerchantConfig.EventType - Types of event that the terminal uses to report status updates. Types functionality can vary slightly depending on the method used for status updates. See here for webhooks and here for polling.