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
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 parameterJSON body containing an external identifier
Refer to the below sample request body:
Note: The externalId
is typically initiated through the Partner Portal.
Process Flow
When the service receives a callback request, it:
Validates that an equipment order exists for the specified merchantId.
Retrieves the merchant URL for the given merchantId.
If no merchant URL is found, it returns the parent HNK URL.
Forwards API keys for terminals in the placed order to the merchant URL.
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:
Response Codes
200 (OK)
Success
The activation process completed successfully (no response payload)
424 (Failed Dependency)
Failure
The activation process failed (no response payload)
Last updated
Was this helpful?