API Reference Insurance

Insurance

Insurance Payment Service operates in two phases:

Retrieve Product Codes – Fetch the available insurance product codes.
Vend – Complete the payment transaction using the selected product code.

Insurance Get Packages

GET

Service Information

Request URL

{{baseUrl}}insurance/packages

HTTP Method

GET

Parameter Name	Type	M/O	Description
loginId	Numeric	M	Merchant id provided during integration
key	String	M	Merchants (public) key

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}"
}

Parameter Name	Type	M/O	Description
statusCode	Numeric	M	Status of the transaction. 00 signifies success
statusDescription	Collection	M	An array of Insurance packages details

{ 
    "statusCode": "00", "statusDescription": { "items": { "insuranceName": [ "LAW UNION & ROCK INSURANCE" ], "insuranceType": [ { "name":
    "TRICYCLE", "amount": "2500" }, { "name": "PRIVATE_MOTOR", "amount": "5000" }, { "name": "COMMERCIAL", "amount": "7500" } ], "vehicleColor": [ 
    "ASH", "BRONZE", "BEIGE", "BLACK", "BLUE", "BROWN", "CREAM", "CUSTOM", "GOLD", "GREEN", "GREY", "NAVY BLUE", "ORANGE", "PEACH", "PINK", 
    "PURPLE", "RED", "SILVER", "VIOLET", "WHITE", "WIINE", "YELLOW" ], "yearOfMake": [ "1990", "1991", "1992", "1993", "1994", "1995", "1996", 
    "1997", "1998", "1999", "2000", "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", 
    "2015", "2016", "2017", "2018", "2019", "2020" ] } } 
}

Insurance Recharge

POST

Service Information

Request URL

{{baseUrl}}insurance/pay

HTTP Method

POST

Parameter Name	Type	M/O	Description
loginId	Numeric	M	Merchant id provided during integration
key	String	M	Merchants (public) key
requestId	Numeric	M	Unique transaction Id for the request. Maxlength (36characters)
ServiceId	String	M	INS0
Insured Name	String	M	Customer Name
Insurance Type	String	M	Insurance Type gotten from the get Insurance package API Call
chassis_number	Numeric	M	Chassis Number of the vehicle to be Insured
engine_number	String	M	Engine Number of the vehicle to be Insured
plate_number	String	M	Plate Number of the vehicle to be Insured
vehicle_make	String	M	Make of the vehicle to be Insured, e.g Toyota, Ford
vehicle_model	Numeric	M	Model of the vehicle to be Insured, e.g Camry, Matrix
vehicle_color	String	M	Color of the vehicle to be Insured, e.g Blue, Black
year_of_make	Numeric	M	Year of the vehicle to be Insured, e.g Blue, Black
email	String	M	Email of the Customer
contact_address	Numeric	M	Contact Address of the customer

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{random12digit}}",
    "serviceId": "INS0",
    "insured_name": "David OG",
    "insurance_type": "PRIVATE_MOTOR",
    "chassis_number": "7338388393951",
    "engine_number": "1234rtrg5g5g",
    "plate_number": "AS53333Rfr5",
    "customerId": "08047621639",
    "amount": "5000",
    "vehicle_make": "TOYOTA",
    "vehicle_model": "CAMRY",
    "vehicle_color": "BLACK",
    "year_of_make": "2010",
    "email": "test123@gmail.com",
    "contact_address": "dkij"
}

Parameter Name	Type	M/O	Description
statusCode	Numeric	M	Status of the transaction. 00 signifies success
statusDescription	Collection	M	An array of Details

{
    "statusCode": "00",
    "statusDescription": "Successful",
    "detail": {
        "tranxReference": "3250422207848016318",
        "activationCode": "Complete"
    }
}

Parameter Name	Type	M/O	Description
loginId	Numeric	M	Merchant id provided during integration
key	String	M	Merchants (public) key
requestId	Numeric	M	Unique transaction Id for the request. Maxlength (36characters)
ServiceId	String	M	INS0
First Name	String	M	Customer First Name
Last Name	String	M	Customer Last Name
Email	String	M	Email of the Customer
Phone Number	Numeric	M	Customer Phone Number
Brand	String	M	Brand of Device
Model	String	M	Device Model
IMEI	String	M	IMEI of Device
Date of Birth	Numeric	M	Customer Date of Birth
Gender	Numeric	M	Customer Gender
Address	String	M	Customer Address
Amount	Numeric	M	Amount to be paid on Insurance
Product Type	Numeric	M	Insurance Type
Invoice Period	Numeric	M	Duration of Insurance

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{random12digit}}",
    "serviceId": "INS1",
    "first_name" : "David",
    "last_name" : "OG",
    "email" : "davidog@gmail.com",
    "phone_number": "08134045387",
    "brand" : "samsung",
    "model" : "s22 Ultra",
    "imei" : "123456789012345",
    "amount" : "10800",
    "invoicePeriod" : "6m"
}

Parameter Name	Type	M/O	Description
statusCode	Numeric	M	Status of the transaction. 00 signifies success
statusDescription	Collection	M	An array of Insurance packages details

{
    "statusCode": "00",
    "statusDescription": "Successful",
    "detail": {
        "tranxReference": "3240429122713171439",
        "activationCode": "CD715145"
    }
}

Parameter Name	Type	M/O	Description
loginId	Numeric	M	Merchant id provided during integration
key	String	M	Merchants (public) key
requestId	Numeric	M	Unique transaction Id for the request. Maxlength (36characters)
ServiceId	String	M	INS0
First Name	String	M	Customer First Name
Last Name	String	M	Customer Last Name
Email	String	M	Email of the Customer
Phone Number	Numeric	M	Customer Phone Number
Date of Birth	Numeric	M	Customer Date of Birth
Gender	Numeric	M	Customer Gender
Address	String	M	Customer Address
State of Residence	String	M	Customer State of Residence
LGA	String	M	Customer LGA
Genotype	String	M	Customer Genotype
Bloodgroup	String	M	Customer Bloodgroup
Amount	Numeric	M	Amount to be paid on Insurance
Product Type	Numeric	M	Insurance Type
Invoice Period	Numeric	M	Duration of Insurance

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{random12digit}}",
    "serviceId": "INS3",
    "first_name" : "David",
    "last_name" : "OG",
    "email" : "ayadisegun02@gmail.com",
    "phone_number": "08164627646",
    "dob" : "2000-04-27",
    "gender" : "m",
    "address" : "switch up",
    "stateOfResidence": "Lagos",
    "lga" : "Alimosho",
    "genotype" : "aa",
    "bloodGroup" : "o+",
    "amount" : "450",
    "invoicePeriod" : "1m",
    "productType": "basic"
}

Parameter Name	Type	M/O	Description
statusCode	Numeric	M	Status of the transaction. 00 signifies success
statusDescription	Collection	M	An array of Insurance packages details

{
    "statusCode": "00",
    "statusDescription": "Successful",
    "detail": {
        "tranxReference": "3241115136465053065",
        "activationCode": "Complete"
    }
}

Activation Policy

POST

Service Information

Request URL

{{baseUrl}}insurance/activate_policy

HTTP Method

POST

Parameter Name	Type	M/O	Description
loginId	Numeric	M	Merchant id provided during integration
key	String	M	Merchants (public) key
ServiceId	String	M	INS0
First Name	String	M	Customer First Name
Last Name	String	M	Customer Last Name
Email	String	M	Email of the Customer
Phone Number	Numeric	M	Customer Phone Number
Brand	String	M	Vehicle Brand
Model	String	M	Vehicle Model
Activation Code	String	M	Activation Code
Notify Customer	Numeric	M	Notify Customer

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "serviceId": "INS0",
    "first_name" : "David",
    "last_name" : "OG",
    "email" : "ayadisegun02@gmail.com",
    "phone_number": "08164627646",
    "brand":"LEXUS",
    "model":"RX350",
    "activationCode":"3241209961112195722",
    "notifyCustomer":"true",
}

Parameter Name	Type	M/O	Description
statusCode	Numeric	M	Status of the transaction. 00 signifies success
Activation Code	String	M	Activation Code

{
    "statusCode": "00",
    "activationCode": "Complete"
}

Parameter Name	Type	M/O	Description
loginId	Numeric	M	Merchant id provided during integration
key	String	M	Merchants (public) key
ServiceId	String	M	INS0
First Name	String	M	Customer First Name
Last Name	String	M	Customer Last Name
Email	String	M	Email of the Customer
Phone Number	Numeric	M	Customer Phone Number
Brand	String	M	Device Brand
Model	String	M	Device Model
IMEI	String	M	Device IMEI
Activation Code	String	M	Activation Code
Verification Video	File	M	Verification Video
Notify Customer	Numeric	M	Notify Customer

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "serviceId": "INS0",
    "first_name" : "David",
    "last_name" : "OG",
    "email" : "ayadisegun02@gmail.com",
    "phone_number": "08164627646",
    "brand":"HP",
    "model":"Hp Probook 440 G9 Notebook",
    "imei":"5CD2385T6C12345",
    "activationCode":"3241209961112195722",
    "verificationVideo":file
    "notifyCustomer":"true",
}

Parameter Name	Type	M/O	Description
statusCode	Numeric	M	Status of the transaction. 00 signifies success
Activation Code	String	M	Activation Code

{
    "statusCode": "00",
    "activationCode": "Complete"
}