Webhook

For notifications, a webhook is shared with us so you can be notified based on the webhook that was registered.

Below are the types of notifications we currently send out.

NOTE: The webhook URL should respond with a 200 status-code once notified successfully.

EventType	Description
Withdrawal Approval	When a customer requests a withdrawal from their investment account, a notification is sent once the withdrawal is approved.
Disbursement Approval	A notification is sent when a loan application is either approved or rejected after the final review.
Loan Repayment	A webhook notification is triggered whenever a payment is made towards a loan, indicating that a repayment transaction has occurred for the loan.

Withdrawal Approval Notification Format

// Some code

Disbursement Approval Response Format

{
    "Event": "DisbursementApproval",
    "Status": "Approved", // Active, Rejected, Submitted_and_awaiting_approval
    "Environment": "Development", // "Production"
    "AggregatorId": 29,
    "EventId": 2,
    "Data": {
        "Amount": 2940,
        "LoanReferenceNumber": "31B7DEA42A",
        "LoanEffectiveDate": "2024-01-26T00:00:00",
        "LoanStatus": "Approved", // Active, Rejected, Submitted_and_awaiting_approval
        "CustomerId": 1127,
        "CustomerDisbursementAccount": {
            "CustomerBankName": "Keystone Bank",
            "CustomerAccountName": "Femi Zack",
            "CustomerAccountNumber": "1111111103"
        },
        "CustomerRepaymentAccount": {
            "CustomerBankName": "VFD",
            "CustomerAccountName": "Advancly -Busquets Hanma",
            "CustomerAccountNumber": "1001603400"
        }
    }
}

Loan Repayment Response Format

{
    "Event": "LoanRepayment",
    "Status": "Active", // Closed, WrittenOff, Rescheduled
    "Environment": "Development", // "Production"
    "AggregatorId": 29,
    "EventId": 2,
    "Data": {
        "Amount": 2940,
        "LoanReferenceNumber": "31B7DEA42A",
        "LoanEffectiveDate": "2024-01-26T00:00:00",
        "LoanStatus": "Active", // Closed, WrittenOff, Rescheduled
        "CustomerId": 1127
    }
}