📑Webhooks

Webhooks

Our system notifies you of event happening within your account through your provided url during calls to our API. Below are sample of payloads we sent to your provided call back/webhook url.

{
  "event": "PAYMENT_NOTIFIFICATION",
  "data": {
    "type": "RESERVED_ACCOUNT_TRANSACTION",
    "reference": "transaction_reference",
    "merchant_reference": "account_reference",
    "wiaxy_ref": "inter_bank_reference",
    "amount": "payment_amount",
    "created_at": "receiving_date",
    "account": {
      "account_number": "customer_account_number",
      "account_name": "customer_account_name",
      "bank_name": "customer_bank_name",
      "created_at": "account_creation_date"
    },
    "payer": {
      "account_number": "payer_acct_num",
      "first_name": " payer_first_name ",
      "last_name": " payer_last_name ",
      "createdAt": "payment_date"
    }
  }
}

The table below is the description of the above reserved account webhook payload

Key name
Description

event

The type of the notification. For this case, it is always “PAYMENT_NOTIFICATION”

type

The method of transaction. For this case it is “RESERVED_ACCOUNT_TRANSACTION”.

reference

This is a reference id generated by Wiaxy for this transaction.

merchant_reference

This is a reference id generated by merchant during the account creation.

wiaxy_ref

This is a reference id generated for inter-bank transfer.

amount

This is the amount of money received.

created_at (data)

This is the date when Wiaxy received the money.

account_number (account)

The account number of the customer..

account_name (account)

The account number of the customer.

bank_name(account)

The bank name of the customer.

created_at (account)

The date of account creation.

account_number (payer)

This is the account number of the sender.

first_name (payer)

This is the first name of the sender.

last_name (payer)

This is the last name of the sender.

createdAt (payer)

This is the date the sender sent the money.

Last updated