Skip to main content

Contract status changed event

This webhook event is triggered when a single merchant contract's status changes between enabled and disabled — for example when a contract is enabled after onboarding is complete, or disabled by an administrator. Unlike MerchantStatusChanged, this event is only raised for the specific contract whose status changed.

Webhook Example

{
"partnerContractNumber": "73538280",
"ssn": "1111111119",
"merchantNumber": "7366746",
"contractNumber": "32305",
"hmacSignature": "G8MRsh6OAZf+anQ+0VWcp3PNRNVBqxmpW3mOimqmbdM=",
"additionalData": {
"eventType": "ContractStatusChanged",
"eventTime": "2026-07-01T10:14:46.6730082Z",
"status": "Disabled"
}
}
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.

FieldTypeDescription
partnerContractNumberstringUnique identifier of the partner contract the affected merchant contract is linked to.
ssnstringThe merchant SSN.
merchantNumberstringUnique identifier for the merchant account that owns the contract.
contractNumberstringUnique identifier of the merchant contract whose status changed.
hmacSignaturestringA cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn't been tampered with.
additionalDataobjectAn object for the additional details included in the event.

Additional Data Fields

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

FieldTypeDescription
eventTypestringA string representing the type of event that occurred.
eventTimestringISO 8601 timestamp indicating when the contract status changed.
statusstringThe contract's new status. Possible values: Enabled, Disabled.

HMAC Signature

The HMAC signature for ContractStatusChanged uses the same four-field signing path as ContractLinked and ContractUnlinked.

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

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