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.

EventTypeDescription

Withdrawal Approval

When the customer has initiated an investment withdrawal. On approval, a notification is sent out.

Disbursement Approval

When a loan has been approved/rejected on final approval. A notification is sent out.

Withdrawal Approval Notification Format

// Some code

Disbursement Approval Notification Format

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

Last updated