Terminal added event

This webhook event is triggered when a new terminal has been added to a merchant account, indicating that a new payment terminal is now available for processing transactions. The event provides terminal identification details, merchant information, and contract references for proper terminal management and integration.

Webhook Example

{
    "partnerContractNumber": "73538280",
    "ssn": "1111111119",
    "merchantNumber": "7366746",
    "contractNumber": "32305",
    "mid": "2913122972",
    "tid": "3fdd19ef",
    "terminalIdentifier": "3703ed39e197",
    "hmacSignature": "Z3FZxGhaGu0w9tm+xBEtw/laiXr4QPRQMn0YWERrjOs=",
    "additionalData": {
        "eventType": "TerminalAdded",
        "eventTime": "2025-09-19T10:14:46.6730082Z",
        "street": "Borgartún 25",
        "city": "Reykjavík",
        "postalCode": "105",
        "state": "IS",
        "country": "ISL",
        "mcc": "5411",
        "shopperStatement": "Example Store",
        "terminalType": "Cards"
    }
}

info

HMAC key: e3cb3ecddce4e190713b89d84e618b46adb64400291f2002

Headers

In the Authorization header, we will set the matching Api key for your webhook.

Fields

You will always get these fields.

Field	Type	Description
partnerContractNumber	string	Unique identifier of partner contract that links the terminal to a specific partner agreement.
ssn	string	The merchant SSN.
merchantNumber	string	Unique identifier for the merchant account to which the terminal is being added.
contractNumber	string	Unique identifier of the merchant contract associated with the terminal.
mid	string	Unique identifier assigned to the store.
tid	string	Unique indetifier assigned to the added terminal device.
terminalIdentifier	nullable string	Unique terminal identifier used in payment gateway API calls to identify terminal.
hmacSignature	string	A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.
additionalData	object	An object for the additional details included in the event.

Additional Data Fields

Fields you will get depend on the event type of the webhook.

Field	Type	Description
eventType	string	A string representing the type of event that occurred.
eventTime	string	ISO 8601 timestamp indicating when the terminal addition event occurred.
street	nullable string	The street address of the store.
city	nullable string	The city of the store.
postalCode	nullable string	The postal code of the store.
state	nullable string	The ISO 3166-1 alpha-2 country code of the store.
country	nullable string	The ISO 3166-1 alpha-3 country identifier of the store.
mcc	nullable string	The Merchant Category Code (MCC) of the store.
shopperStatement	nullable string	The shopper statement (DBA name) displayed on cardholder statements.
terminalType	nullable string	The type of terminal. Possible values: Aur, Cards.