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.

Webhook Sample

Reserved Account Payments

{
  "event": "PAYMENT_NOTIFIFICATION",
  "data": {
    "type": "RESERVED_ACCOUNT_TRANSACTION",
    "reference": "transaction_reference",
    "merchant_reference": "account_reference",
    "aspfiy_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"
    }
  }
}

Transfer Payload

{
  "event": "DISBURSEMENT",
  "data": {
    "type": "TRANSFER_NOTIFICATION",
    "reference": "transaction_reference",
    "amount": "transfer_amount",
    "status": "transaction_status",
    "created_at": "initiation_date",
    "beneficiary": {
      "account_number": "recepient_account_number",
      "bank_code": "bank_code",
      "account_name": "recepient_account_name",
      "bank_name": "recepient_bank_name"
    }
  }
}

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.
aspfiy_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.

The table below is the description of the above transfer webhook payload

event	The type of the notification. For this case, it is always “DISBURSEMENT”.
type	The method of transaction. For this case it is “TRANSFER_NOTIFICATION”.
reference	This is a reference id generated by merchant during the account transfer.
amount	This is the amount of money sent.
status	This the status of the transaction.
created_at	This is the date you initiated the transfer.
account_number	This is the account number of the recipient.
bank_code	This is the bank code of the bank sent to.
account_name	This is the account name of the recipient.
bank_name	This is the bank name of the recipient

Webhook Security

Meaning ..... any body with our webhook payload can post data to your webhook url and be at your cost, so we provide a means to secure and only authenticate payloads from our site. Here it goes:

For any webhook payload we sent to your url we include a key in the header x-wiaxy-signature and set its value to the MD5 equivalent of your secret key generated on your dashboard. so for any request make sure you check whether the key exists and the value set is equal to MD5 equivalent of your secret key.

🚧

🛏️Wake up!!!

Make sure the x-wiaxy-signature is present and equals the MD5 of your secret key!