Config
Terminal API configuration, capability, and status operations.
Setup commands return final SUCCESSFUL or USER_ERROR business results through TerminalCallback.onSuccess. SoftPOS restores the caller task after either business outcome. Technical failures, including setup readiness or busy rejection before dispatch, use TerminalCallback.onFailure. Capability, identity and status snapshots do not require enrollment readiness; identity still requires a configured terminal ID.
Functions
Activates this device with the six-digit code supplied by the integrator. DeviceActivationResult reports SUCCESSFUL or USER_ERROR with an error reason. A device already linked to a terminal rejects activation as INVALID_REQUEST, with non-retryable message Device is already activated. Use executeInitialisation to initialize the existing device. Activation never implicitly resets an already activated device. SoftPOS may await foreground enrollment startup within the request deadline; readiness or busy rejection is delivered through TerminalCallback.onFailure before the code reaches the backend.
Awaits the final device activation business outcome, including USER_ERROR with an error reason. An already activated device throws a non-retryable INVALID_REQUEST terminal exception. Setup readiness or busy rejection occurs before the activation code reaches the backend.
Downloads terminal configuration using SI(CONFIG).
Awaits the SI(CONFIG) business outcome, including USER_ERROR; does not run acquirer initialization. A setup readiness or busy rejection throws a terminal exception before dispatch.
Runs acquirer initialization using SI(INIT) and completes after its final business outcome. InitialisationResult reports SUCCESSFUL or USER_ERROR with an error reason. Enrollment or certificate readiness failure rejects the request as TERMINAL_NOT_READY; an active terminal operation rejects it as TERMINAL_BUSY, without dispatching SI(INIT).
Awaits the final SI(INIT) business outcome, including USER_ERROR with an error reason. A setup readiness or busy rejection throws a terminal exception before dispatch.
Returns the operations supported by the connected terminal.
Awaits the terminal capability snapshot.
Returns the terminal ID and optional metadata; only a missing terminal ID rejects the request.
Awaits the configured terminal identity snapshot.
Returns a snapshot of the current terminal state.
Awaits the current terminal status snapshot.