Webhook Payloads

This documentation page provides sample webhook payloads that our system sends when specific events occur. These examples will help you understand the structure and content of the payloads so you can properly handle them in your application.

These samples serve as reference implementations to help you quickly integrate with our webhook system.

Reserved account creation

{
  "requestId": "05b01e9c-144e-4a85-8c47-4086564c2fab",
  "accountName": "John Doe -  Business Name",
  "type": "RESERVE",
  "accountNumber": "9083634531",
  "status": "ACTIVE"
}

Deposit into a reserved virtual account

{
  "institution": "ACCESS BANK",
  "status": "COMPLETE",
  "institution_code": "090531",
  "reference": "e2c0febb-f731-4729-8c45-2bf896c2d212",
  "external_reference": "000014250113204947173679778727",
  "type": "RESERVE",
  "recipient_account": "4534534434",
  "sender_account": "0123456789",
  "request_id": "6735472a-e95e-477d-8dff-3c715e476ada",
  "amount": "300"
}

Deposit into a temporary virtual account

{
  "institution_code": "090531",
  "status": "COMPLETE",
  "type": "COLLECTION",
  "sender_account": "6081311150",
  "request_id": "22eb2a8c-1c6a-4399-b9de-f781839ea9d9",
  "reference": "053ea45a-e3c9-42ba-88a5-6b083e4caed8",
  "institution": "Aku MFB",
  "recipient_account": "2067837289",
  "external_reference": "053ea45a-e3c9-42ba-88a5-6b083e4caed8",
  "amount": "100.00"
}

Deposit into a temporary dynamic virtual account


{
  "status": "COMPLETE",
  "recipient_account": "2064517522",
  "request_id": "23884289428942424242",
  "amount": "3000.00",
  "reference": "f4ef11a8-cd46-4de5-8386-2aea8850be4b",
  "institution_code": "090531",
  "external_reference": "000014250429085829174591350958",
  "sender_account": "0123456789",
  "institution": "ACCESS BANK",
  "type": "COLLECTION"
}

Deposit into a master account

{
  "status": "COMPLETE",
  "institution": "Aku MFB",
  "type": "BUSINESS",
  "amount": "210.00",
  "reference": "24f644c1-cea6-450f-8b4d-c602b1b2623d",
  "external_reference": "24f644c1-cea6-450f-8b4d-c602b1b2623d",
  "institution_code": "090531",
  "request_id": "24f644c1-cea6-450f-8b4d-c602b1b2623d",
  "sender_account": "5048313695",
  "recipient_account": "4534534434"
}

Bank transfer to a local bank

{
  "status": "COMPLETE",
  "institution": "PROVIDUS BANK",
  "type": "LOCK",
  "amount": "200.00",
  "reference": "2e058692-624d-44b2-a34b-c918a847fd2a",
  "external_reference": "000023250115110750000000000001",
  "institution_code": "000023",
  "request_id": "b197835c-ba5e-496a-8e83-ed1418e339dc",
  "sender_account": "3011357099",
  "recipient_account": "0164387486"
}

Payment gateway

{
  "status": "00",
  "amount": 200,
  "external_reference": "250114145661125371696",
  "institution_code": "47dc8cfe-ce46-44a2-ad47-19db138567d1",
  "request_id": "123ff56ggd7890zx"
}