Get a single debit note
GET/v1/debit-notes/:code
This endpoint allows you to retrieve a debit note by its unique code
Request
Path Parameters
The unique identifier for the debit note
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
data object
Debit Note
The unique identifier for debit note
Current status of the policy
The debit note premium
Date when premium will be due
Date of creation
payment_details object
The name of the bank
bank account number
Six digits bank sort code
customer object
The the customer's information
Unique identifier for the customer on your system
The customer's email address
insurer object
An insurance provider
The unique code of the insurer
The name of the insurer
A link to the Insurer's logo
Insurer's terms and conditions
product object
An individual insurance product or plan
The name of the product
The unique identifier for technical purposes
Unique Id of the product.
insurer object
An insurance provider
The unique code of the insurer
The name of the insurer
A link to the Insurer's logo
Insurer's terms and conditions
product type object
A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc
The generally accepted human friendly name
The unique identifier for technical purposes
list of the nefits covered.
Date of product creation
Price of product
Define the product premium tier.
Possible values: [monthly, quarterly, annually]
Default value: annually
{
"data": {
"code": "CN-34243TF",
"status": "active",
"premium": 800000,
"premium_due_date": "2022-03-24",
"current_date": "2022-03-24",
"payment_details": {
"bank_name": "fisrt bank",
"account_number": 3083137524,
"sort_code": 19201
},
"customer": {
"ref": "string",
"email": "string",
"phone": "408-867-5309",
"first_name": "Jane",
"last_name": "Doe"
},
"insurer": {
"code": "AXA",
"name": "Axa Mansard",
"logo_url": null,
"terms_conditions": null
},
"product": {
"title": "Comprehensive Car Plan XYZ",
"code": "auto-com-xyz",
"id": 1,
"insurer": {
"code": "AXA",
"name": "Axa Mansard",
"logo_url": null,
"terms_conditions": null
},
"product type": {
"name": "Goods in Transit",
"slug": "GIT"
},
"cover-benefits": {},
"created-at": "string",
"price": 0,
"premium-type": "string",
"premium-rate-unit": 0,
"premium-rate": 0,
"premium": 0,
"partner-commision-rate": 0,
"min-premium": "string",
"premium-rules": "string",
"premium_frequency": "annually"
}
}
}
Unauthenticated