Skip to content

InitiateRenewal a policy with a loan batch and pay for the period in one call

POST
/credit-life/policies/{policyId}/renew/loans/pay

Authorizations

BearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

policyId*
Type
string
Required

Request Body

application/json
JSON
{
  
"loans": [
  
  
{
  
  
  
"fullName": "string",
  
  
  
"nrcNumber": "string",
  
  
  
"dateOfBirth": "string",
  
  
  
"amount": 0,
  
  
  
"startDate": "string",
  
  
  
"endDate": "string",
  
  
  
"partnerLoanReference": "string",
  
  
  
"interestRate": 0
  
  
}
  
],
  
"payment": {
  
  
"reference": "string",
  
  
"mobileMoneyAccountNumber": "string",
  
  
"cardDetails": {
  
  
  
"city": "string",
  
  
  
"country": "string",
  
  
  
"address": "string",
  
  
  
"zip": 0
  
  
}
  
}
}

Responses

The renewal batch and the collection started against it. On a prepaid policy the batch stays Pending and off risk until the gateway confirms, then incepts by itself — no second call from you.

application/json
JSON
{
  
"schedule": {
  
  
"id": "string",
  
  
"number": "string",
  
  
"status": "string",
  
  
"type": "string",
  
  
"totalLoans": 0,
  
  
"loanAmount": 0,
  
  
"netPremium": 0,
  
  
"levy": 0,
  
  
"grossPremium": 0,
  
  
"amountReceipted": 0,
  
  
"outstandingPremium": 0,
  
  
"currency": "string",
  
  
"createdAt": "string",
  
  
"loans": [
  
  
  
{
  
  
  
  
"id": {
  
  
  
  
},
  
  
  
  
"clientName": {
  
  
  
  
},
  
  
  
  
"nrcNumber": {
  
  
  
  
},
  
  
  
  
"amount": {
  
  
  
  
},
  
  
  
  
"coveredAmount": {
  
  
  
  
},
  
  
  
  
"premiumRate": {
  
  
  
  
},
  
  
  
  
"netPremium": {
  
  
  
  
},
  
  
  
  
"levy": {
  
  
  
  
},
  
  
  
  
"grossPremium": {
  
  
  
  
},
  
  
  
  
"status": {
  
  
  
  
},
  
  
  
  
"startDate": {
  
  
  
  
},
  
  
  
  
"endDate": {
  
  
  
  
},
  
  
  
  
"partnerLoanReference": {
  
  
  
  
},
  
  
  
  
"interestRate": {
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"skipped": [
  
  
  
{
  
  
  
  
"nrcNumber": {
  
  
  
  
},
  
  
  
  
"partnerLoanReference": {
  
  
  
  
},
  
  
  
  
"existingLoanId": {
  
  
  
  
}
  
  
  
}
  
  
]
  
},
  
"payment": {
  
  
"status": "string",
  
  
"message": "string",
  
  
"txnId": "string",
  
  
"referenceId": "string",
  
  
"redirectUrl": "string",
  
  
"warnings": [
  
  
  
"string"
  
  
]
  
}
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Built with ❤️ by Hobbiton Technologies