Refund event payloads include shiftLocation, the station where the agent had an open shift when the refund was created. For the full object description (including timeZone, externalId, and other fields), see Shift location (shiftLocation) in the structure documentation.

Events

Payload example

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "string",
  "data": {
    "productType": "string",
    "penalty": "int",
    "ticketId": "string",
    "itemType": "string",
    "accountId": "string",
    "taxes": [
      {
        "value": "int",
        "name": "string",
        "calculated": "int",
        "displayCalculated": "int"
      }
    ],
    "shiftNumber": "string",
    "overridedCancelFees": [],
    "email": "string",
    "agentId": "string",
    "firstName": "string",
    "productId": "string",
    "penaltyReason": "string",
    "refundId": "string",
    "amountToRefund": "int",
    "displayAmountToRefund": "int",
    "refunded": "int",
    "displayRefunded": "int",
    "status": "string",
    "createdBy": "string",
    "extra": {},
    "customerNumber": "string",
    "_id": "string",
    "rounding": {
      "policy": "string",
      "decimals": "string"
    },
    "userComments": "string",
    "transactionId": "string",
    "associatedTransactionId": "string",
    "agencyId": "string",
    "type": "string",
    "createdByUserEmail": "string",
    "itemToCancelPreTax": "int",
    "displayItemToCancelPreTax": "int",
    "associatedTrxId": "string",
    "shiftLocation": {
      "stationId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "shortcode": "string",
      "latitude": "string",
      "longitude": "string",
      "costCenter": "string",
      "operatingCompanyId": "string",
      "operatingCompanyName": "string",
      "locationPurchaseLimits": {},
      "primaryCurrencyCode": "string",
      "acceptedCurrencies": [],
      "externalId": "string",
      "timeZone": "string"
    },
    "fees": [],
    "trxId": "string",
    "ticketNumber": "string",
    "userId": "string",
    "amount": "int",
    "displayAmount": "int",
    "lastName": "string",
    "agencyName": "string",
    "payment": [
      {
        "type": "cash",
        "result": {},
        "provider": "string",
        "percentage": "int",
        "lastName": "string",
        "firstName": "string",
        "externalName": "string",
        "externalId": "string",
        "cardType": "string",
        "authCode": "string",
        "amount": "float",
        "acceptedCurrencyAmount": "float",
        "acceptedCurrency": {
          "buy": "float",
          "sell": "float",
          "isocode": "string",
          "symbol": "string",
        }
      }
    ],
    "deleted": "boolean",
    "createdAt": {
      "value": "string",
      "offset": "int"
    },
    "updatedAt": {
      "value": "string",
      "offset": "int"
    },
    "displayCurrency": {
      "buy": "float",
      "sell": "float",
      "isocode": "string",
      "symbol": "string"
    }
  }
}