Skip to main content

Payment

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

{
  "paymentItemNumber": "string",
  "withdrawalDate": "2025-10-14T03:33:28.495Z",
  "amount": 0,
  "memberNumber": "string",
  "status": "string",
  "referenceId": "string",
  "description": "string",
  "type": "string",
  "paymentInformation": {
    "paymentDate": "2025-10-14T03:33:28.495Z",
    "paymentRecorded": "2025-10-14T03:33:28.495Z",
    "paymentAmount": 0
  },
  "destination": {
    "id": "string",
    "accountName": "string",
    "accountNumber": "string",
    "type": "string"
  }
}

Events​

  • payment.raised - This event will be triggered every time a payment is raised for a member in the program.
  • payment.paid - This event will be triggered every time a payment has been successfully processed.