Contract linked event

This webhook event is triggered when a merchant contract has been linked to a partner contract, indicating that the merchant is now associated with the partner agreement for billing and reporting purposes. Unlike the terminal events, a single contract may have multiple terminals attached at the time of linking, so the payload includes a terminals array describing every terminal currently active on the contract.

Webhook Example

{
    "partnerContractNumber": "73538280",
    "ssn": "1111111119",
    "merchantNumber": "7366746",
    "contractNumber": "32305",
    "hmacSignature": "G8MRsh6OAZf+anQ+0VWcp3PNRNVBqxmpW3mOimqmbdM=",
    "terminals": [
        {
            "mid": "2913122972",
            "tid": "3fdd19ef",
            "terminalIdentifier": "3703ed39e197",
            "isEcom": false,
            "street": "Borgartún 25",
            "city": "Reykjavík",
            "postalCode": "105",
            "state": "IS",
            "country": "ISL",
            "mcc": "5411",
            "shopperStatement": "Example Store",
            "terminalType": "Cards"
        },
        {
            "mid": "2913122972",
            "tid": "8a12bb47",
            "terminalIdentifier": "9c44ad81f203",
            "isEcom": true,
            "street": "Borgartún 25",
            "city": "Reykjavík",
            "postalCode": "105",
            "state": "IS",
            "country": "ISL",
            "mcc": "5411",
            "shopperStatement": "Example Store",
            "terminalType": "Cards"
        }
    ],
    "additionalData": {
        "eventType": "ContractLinked",
        "eventTime": "2026-05-20T10:14:46.6730082Z"
    }
}

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 the partner contract the merchant contract has been linked to.
ssn	string	The merchant SSN.
merchantNumber	string	Unique identifier for the merchant account whose contract was linked.
contractNumber	string	Unique identifier of the merchant contract that was linked to the partner contract.
hmacSignature	string	A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn't been tampered with.
terminals	array of terminal objects	List of terminals that are currently active on the contract at the time the link is established. May be empty when no terminals exist yet.
additionalData	object	An object for the additional details included in the event.

Terminal Fields

Each entry of the terminals array contains the following fields.

Field	Type	Description
mid	string	Unique identifier assigned to the store the terminal belongs to.
tid	string	Unique identifier assigned to the terminal device.
terminalIdentifier	nullable string	Unique terminal identifier used in payment gateway API calls to identify the terminal. Populated for eCom terminals.
isEcom	boolean	true when the terminal is an eCom solution, false for physical (POS) terminals.
street	nullable string	The street address of the store the terminal belongs to.
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.

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 contract was linked.

HMAC Signature

Unlike the terminal events, the HMAC signature for ContractLinked does not include per-terminal fields — the contract is the entity being notified, and the same signature is shared regardless of how many terminals are returned in the payload.

The signing order is: PartnerContractNumber, Ssn, MerchantNumber, ContractNumber.

See HMAC Signature for the full signing reference and code samples.