Webhook Events

The available_events endpoint provides a list of all the events that can be subscribed to using the webhook functionality. The response field returns an array containing the event names that can be used in webhook configurations.

Our webhook events are fired based on the following triggers:

Transaction Created Event
Transaction Processing Event
Transaction Completed Event
Transaction Failed Event
Statement Generated Event

`Transaction Created Event`

{
  id: '9056bf05-83ab-4cbf-9f40-4d9e3e233541',
  type: 'transaction.created',
  timestamp: 1693411665205,
  data: {
    id: 'wz_trsf_ViJt_1693411664614',
    state: 'PENDING',
    amount: 1200000,
    sender: {
      dob: '2000-01-23',
      name: 'Emmanuel Igbodudu',
      address: 'Optional',
      country: 'US',
      send_amount: 500,
      send_currency: 'USD'
    },
    country: 'NG',
    currency: 'NGN',
    metadata: { invoiceId: 'Payment from APP' },
    company_id: '164b7e88-cba6-4ec3-a023-e2ab2ed43669',
    beneficiary: {
      type: 'BANK_ACCOUNT',
      bank_code: '000014',
      bank_name: 'ACCESS BANK',
      account_name: 'Felix Abubakar',
      account_number: '123400001'
    },
    created_date: '2023-08-30T16:07:44.614Z',
    balance_after: 89984399314,
    response_code: 'O1',
    balance_before: 89985599314,
    customer_reference: 'testingdefdf',
    response_description: 'Transfer Accepted'
  }
}

`Transaction Processing Event`

{
  id: '9056bf05-83ab-4cbf-9f40-4d9e3e233541',
  type: 'transaction.created',
  timestamp: 1693411665205,
  data: {
    id: 'wz_trsf_ViJt_1693411664614',
    state: 'PENDING',
    amount: 1200000,
    sender: {
      dob: '2000-01-23',
      name: 'Emmanuel Igbodudu',
      address: 'Optional',
      country: 'US',
      send_amount: 500,
      send_currency: 'USD'
    },
    country: 'NG',
    currency: 'NGN',
    metadata: { invoiceId: 'Payment from APP' },
    company_id: '164b7e88-cba6-4ec3-a023-e2ab2ed43669',
    beneficiary: {
      type: 'BANK_ACCOUNT',
      bank_code: '000014',
      bank_name: 'ACCESS BANK',
      account_name: 'Felix Abubakar',
      account_number: '123400001'
    },
    created_date: '2023-08-30T16:07:44.614Z',
    balance_after: 89984399314,
    response_code: 'O1',
    balance_before: 89985599314,
    customer_reference: 'testingdefdf',
    response_description: 'Transfer Accepted'
  }
}

`Transaction Completed Event`

{
  id: '702617c4-30c9-46fc-9626-bac62f00cdb0',
  type: 'transaction.completed',
  timestamp: 1693411669771,
  data: {
    id: 'wz_trsf_ViJt_1693411664614',
    state: 'COMPLETED',
    amount: 1200000,
    sender: {
      dob: '2000-01-23',
      name: 'Emmanuel Igbodudu',
      address: 'Optional',
      country: 'US',
      send_amount: 500,
      send_currency: 'USD'
    },
    country: 'NG',
    currency: 'NGN',
    metadata: { invoiceId: 'Payment from APP' },
    company_id: '164b7e88-cba6-4ec3-a023-e2ab2ed43669',
    beneficiary: {
      type: 'BANK_ACCOUNT',
      bank_code: '000014',
      bank_name: 'ACCESS BANK',
      account_name: 'Felix Abubakar',
      account_number: '123400001'
    },
    created_date: '2023-08-30T16:07:44.614Z',
    balance_after: 89984399314,
    response_code: 'OO',
    balance_before: 89985599314,
    completion_date: '2023-08-30T16:07:48.709Z',
    customer_reference: 'testingdefdf',
    response_description: 'Transfer Completed successfully'
  }
}

`Statement Generated Event`

{
  id: '9d2d5bf8-efec-42fe-98d6-afd20374ee30',
  type: 'statement.generated',
  timestamp: 1693411722120,
  data: {
    id: 'e9c7c0e3-62f2-4d1a-99b3-d5a1353608fc',
    to: '2023-08-07',
    from: '2023-07-01',
    state: 'COMPLETE',
    accountId: '1fbc064f-5fd6-488f-869f-18f879cd4073',
    created_at: '2023-08-30T16:08:40.749Z',
    updated_at: '2023-08-30T16:08:41.597Z'
  }
}

❗️
Usage Notes

When creating or updating a webhook using the endpoints, ensure that you only specify events from the list returned in the available_events endpoint.

The events represent various stages or outcomes in the resource lifecycle, enabling you to set up custom listeners for specific events that are relevant to your use-case.