Supported Events
We currently support the following loan-related webhook events:loan.rejected
Triggered when a loan application is rejected.loan.counter
Triggered when a counter-offer is made on a loan application.loan.approved
Triggered when a loan application is approved.loan.disbursed
Triggered when a loan is disbursed to the borrower.Webhook Payload Structure
All webhook payloads follow this general structure:event: The event type (string)data: Event-specific data (object)
data object contains loan details including:
loanId: Loan referenceamount: Loan amounttenure: Loan tenure in monthsinterest: Interest amountinterestRate: Rate of interestprocessingFee: Processing fee charged for the loanprocessingFeeRate: Rate of processing feereceivableAmount: Total amount receivable by the lender (principal amount)monthlyPayment: Monthly paymenttotalAmountRepayable: Total amount repayable (principal + interest + fees)totalAmountPaid: Total amount already paidstatus: Current loan statuscomment: Optional comment from the lenderloanAccount: Associated loan accountproduct: Loan product nameghanaCardNumber: Ghana card number of the borrowerstartDate: Loan start date (YYYY-MM-DD)endDate: Loan end/repayment date (YYYY-MM-DD)counterOffer: Counter-offer details (if applicable)
counterOffer object (when present) contains:
id: Counter-offer IDamount: Counter-offer amounttenure: Counter-offer tenure in monthsinterest: Interest amount on the counter-offerinterestRate: Rate of interest for counter-offerprocessingFee: Processing fee for counter-offerprocessingFeeRate: Rate of processing feemonthlyPayment: Monthly payment for counter-offerreceivableAmount: Receivable amount for counter-offertotalRepayment: Total repayment amount for counter-offerstatus: Counter-offer statustype: Counter-offer typenarration: Additional notes for counter-offerrepaymentDate: Repayment date for counter-offer- Other loan-related fields
Handling Webhooks
Your webhook endpoint should:- Return a
200status code quickly to acknowledge receipt - Process the event asynchronously
- Handle duplicate events gracefully (events may be retried)
