Skip to main content

Make a new Insurance credit request for a customer

POST 
/v1/insurance-credit-requests

Submit a request for insurance credits to be granted a customer based on a purchase made by the customer

Request​

Body

Details about the transaction

    ref stringrequired

    The unique identifier for the transaction on your system

    narration string

    Transaction narration

    customer objectrequired
    ref stringrequired

    Unique identifier of the customer on your system

    email stringrequired

    The customer's email address

    phone string
    first_name stringrequired
    last_name stringrequired
    total_amount_paid numberrequired

    The amount paid by the customer. This would be the sum of the item original amount and markup amount added.

    item_original_price numberrequired

    The original price of the product or service purchased by the customer.

Responses​

created

Schema
    data object
    credits_issued number

    The number of insurance credits issued for the transaction

    total_amount_paid number
    item_original_price number
    markup_amount number
    markup_config object

    The markup setting as is agreed and configured on your account as at the time of the transaction

    rate number

    The percentage by which all original prices would be marked up

    max_cap number

    The maximum markup that should be allowed irrespective of the rate.

    currency string
Loading...