Merchants

All merchant events will return the following merchant object. This is the same object as the merchant api returns. API Endpoint

{
  "merchantNumber": "string",
  "merchantName": "string",
  "merchantGroupCode": "string",
  "description": "string",
  "timezone": "string",
  "images": [
    {
      "id": "string",
      "order": 0,
      "url": "string",
      "altText": "string",
      "tag": "string"
    }
  ],
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "cityTown": "string",
  "postcode": "string",
  "state": "string",
  "country": "string",
  "longitude": 0,
  "latitude": 0,
  "webAddress": "string",
  "openHours": {
    "openHours": [
      {
        "open": {
          "day": "string",
          "time": "string"
        },
        "close": {
          "day": "string",
          "time": "string"
        }
      }
    ],
    "merchantTimezone": "string"
  },
  "businessCategories": {},
  "isReadyToProcessTransactions": true,
  "merchantLiveState": "string",
  "schemeRegistrationsState": "string",
  "offersState": "string",
  "creditAssessmentState": "string",
  "invoiceState": "string",
  "abn": "string",
  "salesChannel": "string",
  "accountName": "string",
  "bsb": "string",
  "accountNumber": "string",
  "createDate": "2025-10-14T03:33:28.486Z",
  "closeDate": "2025-10-14T03:33:28.486Z",
  "archiveDate": "2025-10-14T03:33:28.486Z",
  "invoiceEmail": "string",
  "phoneNumber": "string",
  "mobileNumber": "string",
  "contactEmail": "string",
  "menuAddress": "string",
  "facebook": "string",
  "twitter": "string",
  "instagram": "string",
  "seats": "string",
  "priceRange": "string",
  "cuisine": "string",
  "defaultOffers": [
    {
      "id": "string",
      "merchantName": "string",
      "merchantTimezone": "string",
      "defaultOfferType": "string",
      "reward": 0,
      "merchantCostPerRewardTypeUnit": 0,
      "offerType": "string",
      "fee": 0,
      "feeType": "string",
      "pointsTiers": [
        {
          "minPointsTierDollarAmount": 0,
          "maxPointsTierDollarAmount": 0,
          "pointPerDollarAmount": 0,
          "merchantCostPerPoint": 0
        }
      ],
      "spendRestrictionType": "string",
      "minimumSpend": 0,
      "maximumSpend": 0,
      "exactSpend": 0,
      "startDate": "2025-10-14T03:33:28.487Z",
      "endDate": "2025-10-14T03:33:28.487Z",
      "endedDate": "2025-10-14T03:33:28.487Z"
    }
  ],
  "schemes": [
    {
      "merchantCode": "string",
      "id": "string",
      "provider": "string",
      "bin": "string",
      "caid": "string",
      "location": "string",
      "doingBusinessAsName": "string",
      "channel": "string",
      "registeredDate": "2025-10-14T03:33:28.487Z",
      "deregisteredDate": "2025-10-14T03:33:28.487Z",
      "status": "string"
    }
  ],
  "minDaysToInvoice": 0
}

Events

merchant.added - This event will be triggered every time a merchant is added to the program.
merchant.updated - This event will be triggered every time a merchant details are updated in the program.
merchant.archived - This event will be triggered every time a merchant is archived via the protected api merchant management /archive endpoint.
merchant.closed - This event will be triggered every time a merchant is closed via the program.
merchant.removed - This event will be triggered every time a merchant is removed via the program.

Events​

Events