v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

DEVICE

Execute a custom activity

Launches the specified activity that has been previously installed to the device.

post/v1/device/custom/activity

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Request body

actionstring required

The Intent action used to launch the Activity.

blockboolean

Whether or not the operation should wait for the launched activity to complete, or return immediately after launching.

payloadstring

Additional payload data packaged with the starting intent for the activity.

Response

If blocking, indicates that the user specified activity was launched and has completed. Otherwise, indicates that the activity was launched and it will continue to run until another FOREGROUND operation is executed.

payloadstring

Payload data provided by the completed Android activity. Note that this field will not be set if the request was for a non-blocking activity.