Fetch a list of insurance credit requests

GET 
/v1/insurance-credit-requests

Get all previously created insurance credit requests

Request

Query Parameters

status string

Possible values: [completed, pending]

Filter the results by the status of the credit request

currency string

Filter the results by currency

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
ref string
unique ref of the credit request
credits_earned float
The amount of insurance credits earned
currency string
Default value: NGN
The currency used to purchase the credits
original_price float
The orginal price of the item purchased by the user
markup_amount number
Extra amount added to the original price. This is used to purchase the insurance credit.
status string
Possible values: [completed, pending]
The status of the request
created_at date
The date the request was made
customer object
The the customer's information
ref stringrequired
Unique identifier for the customer on your system
email stringrequired
The customer's email address
phone string
first_name stringrequired
last_name stringrequired
]

Example (from schema)

{
  "data": [
    {
      "ref": "abcd1234",
      "credits_earned": 123,
      "currency": "NGN",
      "original_price": 1500,
      "markup_amount": 50.49,
      "status": "completed",
      "created_at": "2024-03-21",
      "customer": {
        "ref": "string",
        "email": "string",
        "phone": "408-867-5309",
        "first_name": "Jane",
        "last_name": "Doe"
      }
    }
  ]
}

401

Unauthenticated

403

Unauthorized

Loading...