Skip to main content

Merchant status changed event

This webhook event is triggered when a merchant's status changes between enabled and disabled — for example when a merchant is enabled after completing onboarding, or disabled by an administrator. A merchant can have several contracts linked to the same partner contract, so this event is raised once per partner contract, listing every one of the merchant's contracts that is linked to it in additionalData.contractNumbers. Unlike ContractStatusChanged, there is no single contractNumber field at the root of the payload.

Webhook Example

{
"partnerContractNumber": "73538280",
"ssn": "1111111119",
"merchantNumber": "7366746",
"hmacSignature": "UxiaWOwq65I/eSj/BDX76egIHhvm3fyAp5HRjDuC3/E=",
"additionalData": {
"eventType": "MerchantStatusChanged",
"eventTime": "2026-07-01T10:14:46.6730082Z",
"status": "Enabled",
"contractNumbers": ["32305", "32306"]
}
}
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 merchant's contracts are linked to.
ssnstringThe merchant SSN.
merchantNumberstringUnique identifier for the merchant account 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 merchant status changed.
statusstringThe merchant's new status. Possible values: Enabled, Disabled.
contractNumbersarray of stringEvery one of the merchant's contracts that is linked to the partnerContractNumber above.

HMAC Signature

The HMAC signature for MerchantStatusChanged is calculated over only three fields, since there is no single contract this event applies to.

The signing order is: PartnerContractNumber, Ssn, MerchantNumber.

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