📘
Integration Documentation
  • Getting Started
  • Authentication
  • Webhook
  • Customer
  • Loan
  • Wallet
  • Advancly Embed Integration (Widget)
  • Integration Overview
  • Aggregator/Lender API Integration
    • Authentication and Authorisation
    • Borrower Onboarding and Loan Application
    • Wallet
  • Aggregator Investment API
    • Aggregator Authentication and Authorisation
    • Aggregator Investment
  • Advancly Direct
  • Single and Bulk Loan Request
Powered by GitBook
On this page

Was this helpful?

Webhook

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

PreviousAuthenticationNextCustomer

Last updated 15 days ago

Was this helpful?

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.

Payout Outward Transaction

Webhook notification for payout outward transfer.

Disbursement Approval Notification Format
{
    "Event": "DisbursementApproval",
    "Status": "Approved", // Active, Rejected, Submitted_and_awaiting_approval
    "Environment": "Development", // "Production"
    "AggregatorId": 29,
    "EventId": 2,
    "WebhookData": {
        "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 Notification Format
{
    "Event": "LoanRepayment",
    "Status": "Active", // Closed, WrittenOff, Rescheduled
    "Environment": "Staging", // "Production"
    "AggregatorId": 29,
    "EventId": 2,
    "Data": {
        "Amount": 2940,
        "LoanReferenceNumber": "31B7DEA42A",
        "LoanEffectiveDate": "2024-01-26T00:00:00",
        "LoanStatus": "Active", // Closed, WrittenOff, Rescheduled
        "CustomerId": 1127
    }
}
Payout Outward Transaction Notification Format
{
    "Event": "PayoutOutwardTransaction",
    "Status": "Completed", // Processing, Completed, Failed
    "Environment": "Staging", // "Production"
    "AggregatorId": 11,
    "EventId": 4,
    "WebhookData": {
        "Currency": "NGN",
        "TransactionReference": "Advancly-HAUUSIKSNJWUWJSN617288292814A",
        "SessionId": null,
        "Narration": "Glorious test battle/Advancly-HAUUSIKSNJWUWJSN617288292814A",
        "TransactionStatus": "Completed",
        "Amount": 1200,
        "TransactionCharge": 0,
        "TransactionDate": "2025-05-07T06:15:50.2642157+00:00"
    },
}