Skip to main content

Transactions

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

{
  "transactionId": "string",
  "date": "2025-10-14T03:33:28.497Z",
  "merchantLocalDate": "2025-10-14T03:33:28.497Z",
  "transactionState": "string",
  "source": "string",
  "state": "string",
  "amount": 0,
  "memberNumber": "string",
  "funding": {
    "total": 0,
    "invoiceNumber": "string",
    "invoiceStatus": "string"
  },
  "merchant": {
    "code": "string",
    "name": "string",
    "schemeRegistrationId": "string"
  },
  "fee": {
    "offerId": "string",
    "feeAmount": 0,
    "feeCharged": 0,
    "feeType": "string"
  },
  "reward": {
    "offerId": "string",
    "rewardPaid": 0,
    "rewardSpendAmount": 0,
    "rewardAmount": 0,
    "rewardType": "string",
    "excludedRewardReasons": {}
  },
  "card": {
    "cardId": "string",
    "prefix": "string",
    "suffix": "string",
    "cardPresent": "string"
  },
  "refund": {
    "status": "string",
    "matchedToTransactionId": "string",
    "resolvedDate": "2025-10-14T03:33:28.498Z"
  }
}

Events​

  • transaction.pending - This event will be triggered every time we see a transaction arrive with a pending state.
  • transaction.confirmed - This event will be triggered every time we see a transaction arrive with a confirmed state.
  • transaction.reversed - This event will be triggered every time we see a transaction that has been reversed.