Webhook events

Overview

Our directpay webhook events are fired based on the following triggers:

Successful payment webhook events.
Failed payment webhook event.
Abandoned payment webhook event.
Cancelled payment webhook event.

1. Successful Payment Webhooks

After a successful payment, two webhook events will be sent:
a. Account connected event.
b. Payment successful event.

a. Account Connected event (mono.events.account_connected):
Using the Account ID here, you can fetch the customer details like Name, BVN, Account Number, and much more via our Information API

{
    "event": "mono.events.account_connected",
    "data": {
      "id": "611d575feef5d3371ca9d0d8"
    }
}

b. Payment Successful event (direct_debit.payment_successful):
With the reference here, you can verify the payment status of payment using the Verify payment status API to confirm a one-time payment.

{
    "event": "direct_debit.payment_successful",
    "data": {
      "type": "onetime-debit",
      "object": {
        "id": "txd_9AhCg0PNkwHiq6RqLLdiqKDf",
        "status": "successful",
        "amount": 30000,
        "description": "free shirt",
        "fee": 300,
        "currency": "NGN",
        "account": "611d575feef5d3371ca9d0d8",
        "customer": "611adcd9a5fda23baf58140d",
        "reference": "djdjj3939394949944",
        "liveMode": true,
        "created_at": "2021-08-18T18:54:23.491Z",
        "updated_at": "2021-08-18T18:55:16.055Z"
      }
    }
  }

B. Failed Payment Webhook

The payment failed webhook event is sent when there is a bank failure, a switch downtime or mono downtime after a user has authorised payment.

{
  "event": "direct_debit.payment_failed",
  "data": {
    "type": "onetime-debit",
    "object": {
      "description": "Wallet Funding",
      "amount": 50000,
      "fee": 4500,
      "liveMode": true,
      "customer": null,
      "account": "618d41d618d6e5538b46d1e2",
      "updated_at": "2021-11-11T16:21:40.066Z",
      "currency": "NGN",
      "reference": "wp_f4719afff583f0079eda234d60c0570e",
      "status": "failed",
      "id": "txd_XzhFBoknIjuosOz4",
      "created_at": "2021-11-11T16:16:23.851Z"
    }
  }
}

C. Cancelled Payment Webhook

This webhook event is sent when a user closes the payment modal of the directpay widget without completing the transaction.

{
  "event": "direct_debit.payment_cancelled",
  "data": {
    "type": "onetime-debit",
    "object": {
      "description": "J68ON7CHBJV",
      "amount": 11400000,
      "fee": 4500,
      "liveMode": true,
      "customer": null,
      "account": "618d0d4b18d6e5538b3761cd",
      "updated_at": "2021-11-11T12:33:33.477Z",
      "currency": "NGN",
      "reference": "J68ON7CHBJV",
      "status": "cancelled",
      "id": "txd_aSPmTQsnM4fkQWl6",
      "created_at": "2021-11-11T12:32:11.733Z"
    }
  }
}

4. Abandoned Payment Webhook

This webhook event is fired when a user opens a payment link and disregards the payment widget or the payment session has been abandoned by your user.

{
  "event": "direct_debit.payment_abandoned",
  "data": {
    "type": "onetime-debit",
    "object": {
      "description": "J68ON7CHBJV",
      "amount": 11400000,
      "fee": 4500,
      "liveMode": true,
      "customer": null,
      "account": "618d0d4b18d6e5538b3761cd",
      "updated_at": "2021-11-11T12:33:33.477Z",
      "currency": "NGN",
      "reference": "J68ON7CHBJV",
      "status": "abandoned",
      "id": "txd_aSPmTQsnM4fkQWl6",
      "created_at": "2021-11-11T12:32:11.733Z"
    }
  }
}