Get Insurances List

Fetch list of insurances available for a user.

/insurance/?perPage=10

GET https://api.terminal.africa/v1/insurance

This endpoint allows you to retrieve a list of insurance premiums available for a user.

Query Parameters

Name	Type	Description
status	String	Status of insurance purchase. Must be one of confirmed, pending or failed.
perPage	String	Specify how many records will be included in a single response. Defaults to 100.
page	String	Specify what page will be included in a single response. Defaults to 1.

Headers

Name	Type	Description
Authorization	String	Set value to Bearer SECRET_KEY
Content-Type	String

200: OK Insurances retrieved successfully

{
    "status": true,
    "message": "Insurances retrieved successfully",
    "data": {
        "insurances": [
            {
                "amount": 600,
                "claim": "",
                "currency": "NGN",
                "metadata": {
                    "platform": "octamile",
                    "reference": "ild52fsgkfs8uu3gr736ikl2fe9s93jn"
                },
                "parcel": "PC-09857312356",
                "partner_charge": 500,
                "shipment": "SH-02314736509",
                "status": "pending",
                "user": "USER-27450202164",
                "value": 100000,
                "insurance_id": "IN-70732333028",
                "created_at": "2022-11-22T02:16:01.859Z",
                "updated_at": "2022-11-22T02:16:01.859Z",
                "__v": 0
            }
        ],
        "pagination": {
            "page": 1,
            "perPage": 10,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1,
            "total": 1,
            "pageCount": 1,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": false
        }
    }
}