Activation is the initialization of a new terminal. When a terminal arrives, it contains applications but lacks the specific merchant configuration (Merchant ID, Terminal ID, and Security Keys) required to process a transaction.
POS system can trigger this first activation to avoid manual activation on the terminal.
Required Payload and Structure
The Activation request is a Asynchronous (ASYNC) operation that uses the generic AdminRequest message structure.
Activation Request
Header
The standard SaleToPOIRequest.MessageHeader object, with MessageClass set to Service and MessageCategory set to Admin.
Body
The only field is the Base64-encoded string in AdminRequest.ServiceIdentification. This string contains the actual XML command passed to the terminal's kernel.
-
Decoded Content:
PFJlcXVlc3Q+CiAgICA8QWN0aW9uPkFjdGl2YXRpb248L0FjdGlvbj4KICAgIDxUaW1lb3V0PjUwMDA8L1RpbWVvdXQ+CjwvUmVxdWVzdD4Kdecodes to XML:<Request> <Action>Activation</Action> <Timeout>5000</Timeout> </Request> Purpose: This confirms that the request triggers the
Activationaction with a specified timeout (5000 milliseconds in this example).
Activation request example JSON
{
"MessageHeader": {
"MessageClass": "Service",
"MessageCategory": "Admin",
"MessageType": "Request",
"ServiceID": "823",
"SaleID": "POS_01",
"POIID": "POI_01"
},
"AdminRequest": {
"ServiceIdentification": "PFJlcXVlc3Q+CiAgICA8QWN0aW9uPkFjdGl2YXRpb248L0FjdGlvbj4KICAgIDxUaW1lb3V0PjUwMDA8L1RpbWVvdXQ+CjwvUmVxdWVzdD4K"
}
}
Review the full schema on the API specification page for required fields.
Activation request example XML
<?xml version="1.0" encoding="UTF-8"?> <SaleToPOIRequest xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <MessageHeader MessageClass="Service" MessageCategory="Admin" MessageType="Request" ServiceID="823" SaleID="POS_01" POIID="POI_01"></MessageHeader> <AdminRequest> <ServiceIdentification>PFJlcXVlc3Q+CiAgICA8QWN0aW9uPkFjdGl2YXRpb248L0FjdGlvbj4KICAgIDxUaW1lb3V0PjUwMDA8L1RpbWVvdXQ+CjwvUmVxdWVzdD4K</ServiceIdentification> </AdminRequest> </SaleToPOIRequest>
Review the full schema on the API specification page for required fields.