Terminal Shipping API
  • Introduction
  • Example Book Shipment Flow
  • Ship with Code
  • Authentication
  • Errors
  • Libraries & Plugins
  • API ENDPOINTS
  • Addresses
    • Create Address
    • Get Addresses
    • Get Address
    • Update Address
    • Validate Address
    • Set Default Sender Address
    • Get Default Sender Address
  • Carriers
    • Get Carriers
    • Get Carrier
    • Enable Carrier
    • Enable Multiple Carriers
    • Disable Carrier
    • Disable Multiple Carriers
    • Drop-off Locations
  • Claims
    • Get Claims
    • Get Claim
    • File Claim
  • HS Codes
    • Get HSCodes
    • Get HSCode Chapters
    • Get HSCode Categories
    • Get HSCode Details
    • Search HSCodes
  • Insurance
    • Get Insurance
    • Get Insurances List
    • Get Insurance Premium
    • Get Insurance Premium Using Parcel Value
    • Purchase Insurance
  • Packaging
    • Create Packaging
    • Update Packaging
    • Get Packaging
    • Terminal Default Packaging
    • Get Specific Packaging
  • Parcels
    • Create Parcel
    • Update Parcel
    • Get Parcels
    • Get Parcel
  • Rates
    • Get Rates for Shipment
    • Get Quotes for Shipment
    • Get Rates for Multi-Parcel Shipment
    • Get Rates
    • Get Rate
  • Simplified HS Codes
    • Get Simplified HSCodes
    • Get Simplified HSCode Chapters
    • Get Simplified HSCode Categories
    • Get Simplified HSCode Details
    • Search Simplified HSCodes
  • Shipments
    • Create Shipment
    • Create Quick Shipment
    • Update Shipment
    • Get Shipments
    • Get Shipments v2
    • Get Shipment
    • Track a Shipment
    • Cancel Shipment
    • Delete Shipment
    • Duplicate Shipment
    • Arrange Pickup & Delivery for Shipment
  • Transactions
    • Get Transactions
    • Get Transaction
  • Users
    • Get User
    • Get Wallet Info
    • Get Wallet Balance
    • Get User Carriers
  • Webhooks
    • Create Webhook
    • Delete Webhook
    • Disable Webhook
    • Enable Webhook
    • Get Webhooks
    • Get Webhook
  • MISCALLANEOUS
    • Carriers Available
    • Carrier Object
    • Cities
    • Countries
    • File Claim Object
    • Parcel Item
    • Quick Shipments
      • Parcel
      • Pickup / Delivery Address
    • Shipment Events
    • Shipment Extras
    • States
    • Webhook Events
      • Handling Webhook Events
    • Volumetric Weight
Powered by GitBook
On this page

Was this helpful?

  1. Insurance

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

{
    "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
        }
    }
}
PreviousGet InsuranceNextGet Insurance Premium

Last updated 2 years ago

Was this helpful?