Admin requests (activation and update)

  • Updated

Admin requests handle terminal management tasks — activating the terminal and triggering a software/parameter update. Both go through one method, sendAdminRequest, differing only in the action you pass.

Prerequisite: a live session.


The calls

Both actions use a ManagementAdminExtensions wrapped in AdminRequestMessageArguments. The action string selects the task.

Activation:

viewModelScope.launch {
    clientSDK.sendAdminRequest(
        RetailerMessageArguments.AdminRequestMessageArguments(
            RetailerAdminExtension.ManagementAdminExtensions(
                action = "Activation",
                timeout = 500000,
                serviceId = null
            )
        )
    )
}

Update (software / latest parameters):

viewModelScope.launch {
    clientSDK.sendAdminRequest(
        RetailerMessageArguments.AdminRequestMessageArguments(
            RetailerAdminExtension.ManagementAdminExtensions(
                action = "Update",
                timeout = 500000,
                serviceId = null
            )
        )
    )
}
  • action"Activation" or "Update".
  • timeout — how long to allow the operation; admin tasks (especially updates) can be slow, so this is generous.
  • serviceIdnull for standard activation/update.

1.3.2 note. RetailerAdminExtension is an interface; ManagementAdminExtensions is the concrete implementation you instantiate. It lives in pl.novelpay.retailer.converter.utils. Earlier SDK examples that show RetailerAdminExtension.Update as a value are out of date.


Reading the result

Admin doesn't have a single tidy success/error super-type pair like payments do. Handle the admin responses your terminal emits via the interceptor, and treat a timeout as "operation did not confirm in time." Because updates can take a while, prefer fire-and-forget here rather than blocking your UI on a response.


When to use it

  • Activation — part of bringing a terminal into service.
  • Update — pull the latest software or configuration parameters, e.g. as part of a maintenance routine or when instructed by Market Pay.

Related

  • Session and login lifecycle — admin requests need a live session too.
  • How the message model works — handling responses in the interceptor.
  • API reference (sdk-doc.zip) — RetailerAdminExtension implementations and AdminRequestMessageArguments fields.

Was this article helpful?

0 out of 0 found this helpful