Purchase an insurance product for a customer
POST/v1/orders
Submit an order for an insurance product for a customer.
Request
- application/json
Body
Details of the customer and the product to be purchased.
- GITPurchaseData
- ThirdPartyAutoPurchaseData
- ComprehensiveAutoPurchaseData
- MarinePurchaseData
- HealthPurchaseData
- JobLossPurchaseData
- GadgetPurchaseData
- CreditLifePurchaseData
- FireBurglaryPurchaseData
- InvestmentLifePurchaseData
- LifePurchaseData
- PersonalAccidentPurchaseData
- MicroHealthPurchaseData
- TravelPurchaseData
- InvestmentPurchaseData
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Value of the insured goods
Possible values: [single, recurring]
Default value: recurring
Single or recurring trip
Required for recurring trips. This is the number of trips made per day.
Required for recurring trips. Number of days in a year the trips are made (365 max)
The pickup address of the shipment/parcel.
destination address of the shipment/parcel.
If this order has attachments, supply their IDs as an array. These attachments must have been previously created using the attachments endpoint.
For brokers only. The premium rate for the product.
For brokers only. A percentage of the premium to be added as tax
Possible values: [monthly, quarterly, annually]
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Estimated value of the insured vehicle.
Meta field for this order. Will be included in webhooks
The customer's driver's license number
The id of the attachment containing the customer's driver's license
the vehicle registration number
Possible values: [car, sedan, suv]
the class of the vehicle
The brand of the vehicle
The model of the vehicle
The vehicle's year of manufacture
The color of the vehicle
Possible values: [monthly, quarterly, annually]
Upload a valid driver's license
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Estimated value of the insured vehicle.
Meta field for this order. Will be included in webhooks
the vehicle registration number
Possible values: [car, sedan, suv]
the class of the vehicle
The brand of the vehicle
The model of the vehicle
The vehicle's year of manufacture
The customer's driver's license number
Required for the Kenyan market. The id of the attachment containing the customer's driver's license
The id of the attachment containing the vehicle valuation report
The color of the vehicle
If this order has other attachments, supply their IDs as an array. These attachments must have been previously created using the attachments endpoint.
For brokers only. The premium rate for the product.
For brokers only. A percentage of the premium to be added as tax
Possible values: [monthly, quarterly, annually]
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Value of the insured goods
The originating port of the shipment.
destination port of the shipment.
If this order has attachments, supply their IDs as an array. These attachments must have been previously created using the attachments endpoint.
For brokers only. The premium rate for the product.
For brokers only. A percentage of the premium to be added as tax
Possible values: [monthly, quarterly, annually]
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer. The customer data must contain the following details - sex - birth_date
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
The start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Preferred hospital location for claims
Kindly write down any previous health complication you may have
beneficiaries object[]required
Your relationship with the beneficiary
next_of_kin object
Next of kin details. Required if not set when creating the customer record. If customer record has next of kin, this will be used for this transaction instead.
If this order has attachments, supply their IDs as an array. These attachments must have been previously created using the attachments endpoint.
For brokers only. The premium rate for the product.
For brokers only. A percentage of the premium to be added as tax
height of the policy holder in meters
weight of the policy holder in Kg
Possible values: [monthly, quarterly, annually]
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
The customer's net monthly income
The name of the customer's employer
The role of the user in the company
employment date
Gross monthly income before taxes or deductions
Net monthly income before taxes or deductions
Attach a copy of the employments letter.
For brokers only. The premium rate for the product.
For brokers only. A percentage of the premium to be added as tax
Possible values: [monthly, quarterly, annually]
The id of the attachment to employment letter
Default value: NGN
The currency used for gross income
Default value: NGN
The currency used for net income
next_of_kin object[]required
Possible values: <= 1
Your relationship with the beneficiary
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
The value or price of the gadget
The type of gadget.
The name (model and brand) of the gadget.
The IMEI or serial number of the gadget
Date when the gadget was purchased
Upload the following files via the attachments API - Picture of device - Receipt of Ownership Then supply their IDs as an array.
beneficiaries object[]required
Your relationship with the beneficiary
The id of the attachment to receipt of ownership
The id of the attachent of device attachment
For brokers only. The premium rate for the product.
For brokers only. A percentage of the premium to be added as tax
Possible values: [monthly, quarterly, annually]
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer; the recipient of the loan.
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
The amount insured
Duration of the loan to be insured in months, should not exceed 12 months.
For loans lasting more than one month, the amount returned every month by the customer.
Business address of the customer
Nature of Customer's business
height of the policy holder in meters
weight of the policy holder in Kg
If this order has attachments, supply their IDs as an array. These attachments must have been previously created using the attachments endpoint.
Possible values: [monthly, quarterly, annually]
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer; the recipient of the loan. The customer data must contain the following details - sex - birth_date
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
The value of the insured property
Address of the insured property
If this order has attachments, supply their IDs as an array. These attachments must have been previously created using the attachments endpoint.
For brokers only. The premium rate for the product.
For brokers only. A percentage of the premium to be added as tax
Possible values: [monthly, quarterly, annually]
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [card]
Default value: wallet
How you would like to pay for the product. Only card payment is allowed for this product at this time.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Possible values: [single, group]
beneficiaries object[]required
A maximum of 5 beneficiaries
The percentage of cover to be recieved by the beneficiary
How much would be saved on monthly basis. Note that if a quarterly savings_frequency is chosen, then expected amount every quarter is monthly_savings_amount multiplied by 3. The same applies to other frequencies.
Possible values: [monthly, quarterly, half-yearly, yearly, one-off]
How often savings will be made until the duration is complete.
The savings duration in months
The amount of life insurance coverage chosen
If you are creating this order for a child partner, add the partner key to the request
height of the policy holder in meters
weight of the policy holder in Kg
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Possible values: [single, group]
beneficiaries object[]required
A maximum of 5 beneficiaries
The percentage of cover to be recieved by the beneficiary
The savings duration.
If you are creating this order for a child partner, add the partner key to the request
height of the policy holder
weight of the policy holder
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product. Only card payment is allowed for this product at this time.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Occupation of the policy holder
Any previous injuries of the policy holder
Circumstances/Mode of Life/Hobbies that make the policyholder liable to injury
The policy holder's identificaition attachment ID. Upload document using the attachments endpoint and submit the ID here.
height of the policy holder
weight of the policy holder
dependants object[]
If you would also like to purchase personal accident plans for your dependants, please specify the details here.
The dependant's date of birth
Possible values: [M, F]
relationship to the parent policy holder
occupation of the dependant
The ID of the personal accident plan for this dependant
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [wallet, web_link, card]
Default value: wallet
How you would like to pay for the product. Only card payment is allowed for this product at this time.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
The current health condition of the policy holder
The policy holder's identificaition attachment ID. Upload document using the attachments endpoint and submit the ID here.
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [card, wallet, web_link]
Default value: wallet
How you would like to pay for the product. Only card payment is allowed for this product at this time.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Possible values: [Business, Tourism, Study, Pilgrimage]
Purpose of travel
The number of days the travel
international passport number
upload the internation passport using the attachments endpoint and supply the Id
Optional: The nationality of customer's next of kin. Provide if missing from the customer record
Optional: The address of customer Provide if residential_address is missing from the customer record
Optional: The state of customer's address. Provide if missing from the customer record
Optional: The country of customer's address. Provide if missing from the customer record
Optional: The name of customer's next of kin. Provide if missing from the customer record
Optional: The phone of customers's next of kin. Provide if missing from the customer record
travellers object[]
If the customer is travelling with others and wishes to purchase same insurance for them, then the detials of the extra travellers should be specified here.
personal_info objectrequired
Possible values: [M, F]
Must be either M or F
Traveller's date of birth e.g 1990-10-10
The name of traveller's next of kin
The phone of traveller's next of kin
contact_info objectrequired
traveller's email address.
Traveller's phone number.
travel_info objectrequired
Possible values: [Business, Tourism, Study, Pilgrimage]
Purpose of travel
international passport number
upload the internation passport using the attachments endpoint and supply the Id
If you are creating this order for a child partner, add the partner key to the request
the code of the insurance product to purchase
the ref of the customer who owns this order, this would have been supplied when creating the customer
Possible values: [card]
Default value: wallet
How you would like to pay for the product. Only card payment is allowed for this product at this time.
the start date of the intended policy coverage
Meta field for this order. Will be included in webhooks
Possible values: [single, group]
beneficiaries object[]required
A maximum of 5 beneficiaries
The percentage of cover to be recieved by the beneficiary
How much would be saved on monthly basis. Note that if a quarterly savings_frequency is chosen, then expected amount every quarter is monthly_savings_amount multiplied by 3. The same applies to other frequencies.
Possible values: [monthly, quarterly, half-yearly, yearly, one-off]
How often savings will be made until the duration is complete.
The savings duration in months
height of the policy holder in meters
weight of the policy holder in Kg
If you are creating this order for a child partner, add the partner key to the request
Responses
- 200
- 422
OK
- application/json
- Schema
- Example (from schema)
Schema
order object
payment_instructions object
{
"order": {
"id": 23,
"asset_ref": "rwt345",
"product_price": 1200.89,
"partner_commission": 20.76,
"amount_due": 1180.13,
"currency": "NGN",
"payment_instructions": {
"message": "Payment successful",
"success": true
},
"payment_gateway_charge": null
}
}
Unprocessable Content
- application/json
- Schema
- Example (from schema)
Schema
errors object
{
"message": "The given data was invalid",
"errors": {
"customer_ref": [
"The selected customer ref is invalid"
],
"product_code": [
"The product code field is required"
]
}
}