Equipment Activation

The Equipment Activation webhook is a callback process that enables payment terminal activation for merchants. The Activation Webhook allows clients to notify the activations-service when terminal activations are ready to be processed. The service then forwards API keys to the merchant's endpoint.

Endpoint details

Item	Value
Service	activations-service
HTTP Method	POST
URL Path	/activations/{merchantId}/callback
Parameters	merchantId (URL parameter)

Request format

The endpoint accepts a request with the following components:

• merchantId as a URL parameter

• JSON body containing an external identifier

Refer to the below sample request body:

{
  "externalId": "12345"
}

The externalId is typically initiated through the Partner Portal.

Process flow

When the service receives a callback request, it:

1. Validates that an equipment order exists for the specified merchantId.

2. Retrieves the merchant URL for the given merchantId.

   1. If no merchant URL is found, it returns the parent HNK URL.

3. Forwards API keys for terminals in the placed order to the merchant URL.

4. Records the callback in the ActivationDetails table of the Equipment database.

Callback to merchant

The service sends a POST request to the merchant URL with API keys for each terminal in the order. Refer to the below sample code:

{
    "externalIdentifier": "12345",
    "merchantAccountNumber": "6588000001234567",
    "keys": [
    {
       "type": "cnp",
       "productName": "Pi Technologies (ASeries)",
       "apiKey": "abc16ed42a9a99dd1f7890e4f00",
       "terminalid": "80608483",
       "publicKey": "301406072a8648ce3d0201060....459a12d5780d65e5a7a624a4ca005"
    }
 ]
}

Response codes

Status Code	Meaning	Description
200 (OK)	Success	The activation process completed successfully (no response payload)
424 (Failed Dependency)	Failure	The activation process failed (no response payload)