Transactions
View purchases and renewals made by your customers
Last updated
View purchases and renewals made by your customers
Last updated
View a list of all the transactions you’ve done on your integration. This endpoint describes how to view customer purchases and renewals. You can also query specific transactions using the appropriate reference.
See a list of all the purchases made by your customers.
GET https://api.mycover.ai/v1/purchase
| Name | Type | Description |
|---|---|---|
{
"responseCode":1,
"responseText":"Purchases Retrieved!",
"data":{
"purchases":[
{
"id":"7247d8bf-8e6e-4840-a39f-027717a4a5ca",
"customer_id":"49731594-f147-4d87-a119-1963c083399f",
"product_id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
"product_category_id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"distributor_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
"provider_id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"created_at":"2022-03-17T08:37:25.957Z",
"updated_at":"2022-03-17T08:37:25.957Z",
"total":"10000.00",
"mca_profit":"2000",
"distributor_profit":"100",
"batch_id":"06f7e9f8-03be-437d-a720-d75bd1d06219",
"customer":{
"id":"49731594-f147-4d87-a119-1963c083399f",
"first_name":"Cassandra",
"business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
"user_id":"815af671-07d7-4974-949a-64ac440bb266",
"last_name":"Stewart",
"email":"terucafan@mailinator.com",
"phone_number":"+1 (148) 113-4481",
"country":null,
"gender":null,
"title":null,
"date_of_birth":null,
"state_of_residence":null,
"city":null,
"address":null,
"identity_verification":null,
"verification_type":null,
"face_image":null,
"is_kyc_complete":false,
"active":false,
"wallet_id":"1e93ec87-7a09-454c-b691-923967497f7e",
"created_at":"2022-03-17T08:37:22.290Z",
"updated_at":"2022-03-17T08:37:22.405Z"
},
"product":{
"id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
"name":"Aiico Home Content",
"product_category_id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"provider_id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"key_benefits":"none",
"full_benefits":[
{
"name":"Fire",
"description":"Covered"
}
],
"description":"Aiico Home Content Insurance Cover",
"productCategory":{
"id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"name":"Content",
"created_at":"2021-09-03T13:59:35.446Z",
"updated_at":"2021-09-03T13:59:35.446Z"
},
"meta":{
"productId":"52f33528-6325-e811-a2cc-005056a02281",
"subClassId":"3f439e93-5d25-e811-a2cc-005056a02281",
"productName":"Home Content Insurance",
"sectionType":"SL",
"subClassName":"Home Insurance"
},
"prefix":"aiico",
"route_name":"aiico-home-content-cover",
"renewable":false,
"claimable":true,
"inspectable":false,
"certificateable":true,
"is_dynamic_pricing":false,
"price":"10000.00",
"distributor_commission_percentage":"5.00",
"mca_commission_percentage":"20.00",
"cover_period":"12",
"active":true,
"created_at":"2022-03-10T17:05:38.077Z",
"updated_at":"2022-03-10T17:05:38.077Z"
},
"productCategory":{
"id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"name":"Content",
"created_at":"2021-09-03T13:59:35.446Z",
"updated_at":"2021-09-03T13:59:35.446Z"
},
"provider":{
"id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"first_name":"Chuks",
"last_name":"Efam",
"email":"drealslimguy008@gmail.com",
"phone_number":"08099776655",
"country":"Nigeria",
"company_name":"Aiico",
"verification_type":"National Passport",
"verification_images":null,
"verification_number":"1134553454",
"bvn_number":"54651333604",
"business_type":null,
"claim_email":null,
"business_email":null,
"support_email":null,
"active":true,
"bank_account_id":null,
"wallet_id":null,
"owner_id":"83dbfce7-a743-47bd-bc49-b95703054aa1",
"created_at":"2021-09-03T12:42:43.332Z",
"updated_at":"2022-03-01T16:44:16.539Z"
}
}
],
"total_count":33
}
}You can search and find claims using any of the following queries as strings;
GET https://api.mycover.ai/v1/purchase/search
{
"responseCode":1,
"responseText":"Purchases Retrieved!",
"data":{
"purchases":[
{
"id":"7247d8bf-8e6e-4840-a39f-027717a4a5ca",
"customer_id":"49731594-f147-4d87-a119-1963c083399f",
"product_id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
"product_category_id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"distributor_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
"provider_id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"created_at":"2022-03-17T08:37:25.957Z",
"updated_at":"2022-03-17T08:37:25.957Z",
"total":"10000.00",
"mca_profit":"2000",
"distributor_profit":"100",
"batch_id":"06f7e9f8-03be-437d-a720-d75bd1d06219",
"customer":{
"id":"49731594-f147-4d87-a119-1963c083399f",
"first_name":"Cassandra",
"business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
"user_id":"815af671-07d7-4974-949a-64ac440bb266",
"last_name":"Stewart",
"email":"terucafan@mailinator.com",
"phone_number":"+1 (148) 113-4481",
"country":null,
"gender":null,
"title":null,
"date_of_birth":null,
"state_of_residence":null,
"city":null,
"address":null,
"identity_verification":null,
"verification_type":null,
"face_image":null,
"is_kyc_complete":false,
"active":false,
"wallet_id":"1e93ec87-7a09-454c-b691-923967497f7e",
"created_at":"2022-03-17T08:37:22.290Z",
"updated_at":"2022-03-17T08:37:22.405Z"
},
"product":{
"id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
"name":"Aiico Home Content",
"product_category_id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"provider_id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"key_benefits":"none",
"full_benefits":[
{
"name":"Fire",
"description":"Covered"
}
],
"description":"Aiico Home Content Insurance Cover",
"productCategory":{
"id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"name":"Content",
"created_at":"2021-09-03T13:59:35.446Z",
"updated_at":"2021-09-03T13:59:35.446Z"
},
"meta":{
"productId":"52f33528-6325-e811-a2cc-005056a02281",
"subClassId":"3f439e93-5d25-e811-a2cc-005056a02281",
"productName":"Home Content Insurance",
"sectionType":"SL",
"subClassName":"Home Insurance"
},
"prefix":"aiico",
"route_name":"aiico-home-content-cover",
"renewable":false,
"claimable":true,
"inspectable":false,
"certificateable":true,
"is_dynamic_pricing":false,
"price":"10000.00",
"distributor_commission_percentage":"5.00",
"mca_commission_percentage":"20.00",
"cover_period":"12",
"active":true,
"created_at":"2022-03-10T17:05:38.077Z",
"updated_at":"2022-03-10T17:05:38.077Z"
},
"productCategory":{
"id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"name":"Content",
"created_at":"2021-09-03T13:59:35.446Z",
"updated_at":"2021-09-03T13:59:35.446Z"
},
"provider":{
"id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"first_name":"Chuks",
"last_name":"Efam",
"email":"drealslimguy008@gmail.com",
"phone_number":"08099776655",
"country":"Nigeria",
"company_name":"Aiico",
"verification_type":"National Passport",
"verification_images":null,
"verification_number":"1134553454",
"bvn_number":"54651333604",
"business_type":null,
"claim_email":null,
"business_email":null,
"support_email":null,
"active":true,
"bank_account_id":null,
"wallet_id":null,
"owner_id":"83dbfce7-a743-47bd-bc49-b95703054aa1",
"created_at":"2021-09-03T12:42:43.332Z",
"updated_at":"2022-03-01T16:44:16.539Z"
}
}
],
"total_count":33
}
}Get specific purchase details of a customer using a unique purchase ID
GET https://api.mycover.ai/v1/purchase/{purchase_id}
{
"responseCode":1,
"responseText":"Purchase Retrieved!",
"data":{
"purchase": {
"id":"7247d8bf-8e6e-4840-a39f-027717a4a5ca",
"customer_id":"49731594-f147-4d87-a119-1963c083399f",
"product_id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
"product_category_id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"distributor_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
"provider_id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"created_at":"2022-03-17T08:37:25.957Z",
"updated_at":"2022-03-17T08:37:25.957Z",
"total":"10000.00",
"mca_profit":"2000",
"distributor_profit":"100",
"batch_id":"06f7e9f8-03be-437d-a720-d75bd1d06219",
"customer":{
"id":"49731594-f147-4d87-a119-1963c083399f",
"first_name":"Cassandra",
"business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
"user_id":"815af671-07d7-4974-949a-64ac440bb266",
"last_name":"Stewart",
"email":"terucafan@mailinator.com",
"phone_number":"+1 (148) 113-4481",
"country":null,
"gender":null,
"title":null,
"date_of_birth":null,
"state_of_residence":null,
"city":null,
"address":null,
"identity_verification":null,
"verification_type":null,
"face_image":null,
"is_kyc_complete":false,
"active":false,
"wallet_id":"1e93ec87-7a09-454c-b691-923967497f7e",
"created_at":"2022-03-17T08:37:22.290Z",
"updated_at":"2022-03-17T08:37:22.405Z"
},
"product":{
"id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
"name":"Aiico Home Content",
"product_category_id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"provider_id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"key_benefits":"none",
"full_benefits":[
{
"name":"Fire",
"description":"Covered"
}
],
"description":"Aiico Home Content Insurance Cover",
"productCategory":{
"id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"name":"Content",
"created_at":"2021-09-03T13:59:35.446Z",
"updated_at":"2021-09-03T13:59:35.446Z"
},
"meta":{
"productId":"52f33528-6325-e811-a2cc-005056a02281",
"subClassId":"3f439e93-5d25-e811-a2cc-005056a02281",
"productName":"Home Content Insurance",
"sectionType":"SL",
"subClassName":"Home Insurance"
},
"prefix":"aiico",
"route_name":"aiico-home-content-cover",
"renewable":false,
"claimable":true,
"inspectable":false,
"certificateable":true,
"is_dynamic_pricing":false,
"price":"10000.00",
"distributor_commission_percentage":"5.00",
"mca_commission_percentage":"20.00",
"cover_period":"12",
"active":true,
"created_at":"2022-03-10T17:05:38.077Z",
"updated_at":"2022-03-10T17:05:38.077Z"
},
"productCategory":{
"id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
"name":"Content",
"created_at":"2021-09-03T13:59:35.446Z",
"updated_at":"2021-09-03T13:59:35.446Z"
},
"provider":{
"id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
"first_name":"Chuks",
"last_name":"Efam",
"email":"drealslimguy008@gmail.com",
"phone_number":"08099776655",
"country":"Nigeria",
"company_name":"Aiico",
"verification_type":"National Passport",
"verification_images":null,
"verification_number":"1134553454",
"bvn_number":"54651333604",
"business_type":null,
"claim_email":null,
"business_email":null,
"support_email":null,
"active":true,
"bank_account_id":null,
"wallet_id":null,
"owner_id":"83dbfce7-a743-47bd-bc49-b95703054aa1",
"created_at":"2021-09-03T12:42:43.332Z",
"updated_at":"2022-03-01T16:44:16.539Z"
}
}
}
}See a list of all the purchases made by your customers.
GET https://api.mycover.ai/v1/renewals
{
"responseCode":1,
"responseText":"Renewals Retrieved!",
"data":{
"renewals":[
],
"total_count":0
}
}You can search and find claims using any of the following queries as strings;
GET https://api.mycover.ai/v1/renewals/search
{
"responseCode":1,
"responseText":"Renewals Retrieved!",
"data":{
"renewals":[
],
"total_count":0
}
}Get specific renewal details of a customer using a unique renewal ID
GET https://api.mycover.ai/v1/renewals/{renewal_id}
{
"responseCode":1,
"responseText":"Renewal Retrieved!",
"data":{
"renewal":{
}
}
}| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|