Purchase Insurance

Purchase insurance for a specific shipment.

/insurance/purchase

POST https://api.terminal.africa/v1/insurance/purchase

This endpoint allows you to purchase insurance coverage for a shipment.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY
Content-Type	String	Set value to application/json

Request Body

Name	Type	Description
shipment*	String	Unique shipment_id reference. Insurance can only be purchased for confirmed shipment.

200: OK Insurance purchased successfully.

{
    "status": true,
    "message": "Insurance purchased successfully.",
    "data": {
        "amount": 600,
        "claim": "",
        "currency": "NGN",
        "metadata": {
            "platform": "octamile",
            "reference": "tqjiz9ch2khd3jwi02zn4ffw79t8v8su"
        },
        "parcel": "PC-09857312356",
        "partner_charge": 500,
        "shipment": "SH-18651243607",
        "status": "pending",
        "user": "USER-27450202164",
        "value": 100000,
        "_id": "637c36f314560407e635a861",
        "insurance_id": "IN-96948763342",
        "created_at": "2022-11-22T02:41:55.584Z",
        "updated_at": "2022-11-22T02:41:55.584Z",
        "__v": 0,
        "id": "637c36f314560407e635a861"
    }
}