Webhook Event Model

FieldTypeDescriptionNullable
event.typeEnum(String)Type of webhook event: 'transaction_success', 'transaction_updated', 'transaction_failed'false
dataTransactionTransaction Detailsfalse

Sample Successful Webhook Event response

{
  "event.type": "transaction_success",
  "data": {
    "amount": 100,
    "requestamount": 100,
    "delivered": 1,
    "failed": 0,
    "mode": 1,
    "processing": 0,
    "meta": {
      "fee": 0,
      "commission": 0,
      "charge_customer": true,
      "fee_structure": {
        "fee": 0,
        "percent": true,
        "threshold": {
          "max": 100,
          "min": 0
        },
        "commission": 0,
        "charge_customer": true
      },
      "total": 100,
    },
    "refid": "2795167047787452481",
    "currency": "ngn",
    "request": "Vendy\nDear Customer, Disu Kayode requested payment of NGN100.\nEnter the amount to pay:",
    "msisdn": "2348099990327",
    "client": "189c8ff2-18bc-46d5-a2f3-5d78cd2e6e56",
    "channel": "sterling",
    "method": "Whatsapp",
    "account": "0176899810",
    "created_on": "2023-06-29 20:52:58",
    "updated_on": "2023-06-29 20:52:58",
    "page": "pin-page"
  }
}

Sample Updated Webhook Event response

{
  "event.type": "transaction_updated",
  "data": {
    "amount": 100,
    "requestamount": 100,
    "delivered": 1,
    "mode": 1,
    "meta": {
      "fee": 0,
      "commission": 0,
      "charge_customer": true,
      "fee_structure": {
        "fee": 0,
        "percent": true,
        "threshold": {
          "max": 100,
          "min": 0
        },
        "commission": 0,
        "charge_customer": true
      },
      "total": 100,
      "historyId": "VND-TMP-80483915067414653376061751690755",
      "walletId": "VND-TMP-2639725166641892",
      "provider": "wema_wallet"
    },
    "refid": "6393585876802063049",
    "currency": "ngn",
    "request": "Vendy\nDear Customer, Disu Kayode requested payment of NGN100.\nEnter the amount to pay:",
    "msisdn": "2348099990327",
    "reason": "Awaiting transfer of NGN100.00 from 2348099990327",
    "raw_reason": "awaiting_transfer",
    "client": "189c8ff2-18bc-46d5-a2f3-5d78cd2e6e56",
    "channel": "transfer_pay",
    "method": "Whatsapp",
    "account": "8764038288",
    "created_on": "2023-06-26 07:11:22",
    "updated_on": "2023-06-26 07:11:22",
    "page": "channel-list"
  }
}

Sample Failed Webhook Event response

{
  "event.type": "transaction_failed",
  "data": {
    "amount": 100,
    "requestamount": 100,
    "failed": 1,
    "mode": 1,
    "processing": 0,
    "meta": {
      "fee": 0,
      "commission": 0,
      "charge_customer": true,
      "fee_structure": {
        "fee": 0,
        "percent": true,
        "threshold": {
          "max": 100,
          "min": 0
        },
        "commission": 0,
        "charge_customer": true
      },
      "total": 100
    },
    "refid": "6232257278849467131",
    "currency": "ngn",
    "request": "Vendy\nDear Customer, Disu Kayode requested payment of NGN100.\nEnter the amount to pay:",
    "msisdn": "2348182000655",
    "reason": "Message was not delivered",
    "client": "189c8ff2-18bc-46d5-a2f3-5d78cd2e6e56",
    "method": "Whatsapp",
    "created_on": "2023-06-18 09:14:09",
    "updated_on": "2023-06-18 09:14:09",
    "page": "consent-page"
  }
}