Merchants

The following webhooks are triggered by merchant changes.

merchant.created

This event is triggered when a new merchant was created.

Payload

{
  "event": "merchant.created",
  "params": {
    "id": "string",
    "partner_id": "string",
    "merchant_id": "string",
    "company_name": "string", // optional
    "description": "string", // optional
     "meta": {}, // optional
  },
  "entity": {
    "kind": "partnerMerchant",
    "data": {
      "id": "string",
      "merchant_id": "string",
      "company_name": "string", // optional
      "description": "string",
      "meta": {}, // optional
      "domain_partner_id": "string", // optional
      "created_at": "string, date-time"
    }
  }
}

merchant.updated

This event is triggered when the merchant information has been updated.

Payload

{
  "event": "merchant.updated",
  "params": {
    "id": "string",
    "partner_id": "string",
    "merchant_id": "string",
    "company_name": "string", // optional
    "description": "string", // optional
    "meta": {} // optional
  },
  "entity": {
    "kind": "partnerMerchant",
    "data": {
      "id": "string",
      "merchant_id": "string",
      "company_name": "string", // optional
      "description": "string",
      "meta": {}, // optional
      "domain_partner_id": "string", // optional
      "created_at": "string, date-time"
    }
  }
}

merchant.deleted

This event is triggered when a merchant was deleted.

Payload

{
  "event": "merchant.deleted",
  "params": {
    "id": "string",
    "merchant_id": "string",
    "domain_partner_id": "string" // optional
  },
  "entity": {
    "kind": "partnerMerchant",
    "data": {
      "id": "string",
      "merchant_id": "string",
      "company_name": "string", // optional
      "description": "string",
      "meta": {}, // optional
      "domain_partner_id": "string", // optional
      "created_at": "string, date-time"
    }
  }
}

merchant.registered

This event is triggered when a domain was registered to a merchant or when a merchant was assigned to a domain.

Payload

{
  "event": "merchant.registered",
  "params": {
    "id": "string",
    "merchant_id": "string",
    "domain_partner_id": "string",
    "domain": "string",
    "subscription_id": "string",
    "status": "string"
  },
  "entity": {
    "kind": "partnerMerchant",
    "data": {
      "id": "string",
      "merchant_id": "string",
      "company_name": "string", // optional
      "description": "string",
      "meta": {}, // optional
      "domain_partner_id": "string", // optional
      "created_at": "string, date-time"
    }
  }
}

merchant.bulk.created

This event is triggered when merchants have been created in bulk.

Payload

{
  "event": "merchant.bulk.created",
  "params": {
    "merchants": ["string"]
  }
}

merchant.bulk.deleted

This event is triggered when merchants have been deleted in bulk.

Payload

{
  "event": "merchant.bulk.deleted",
  "params": {
    "merchants": ["string"]
  }
}