API Reference

Purchase an insurance product for a customer

post
https://api.playbox.grow.curacel.co/api/v1/orders

Submit an order for an insurance product for a customer.

Body Params

Details of the customer and the product to be purchased.

string
required

the code of the insurance product to purchase

string
required

the ref of the customer who owns this order, this would have been supplied when creating the customer

string
enum
Defaults to wallet

How you would like to pay for the product.

Allowed:
date
required

the start date of the intended policy coverage

string

Meta field for this order. Will be included in webhooks

float
required

Value of the insured goods

string
enum
Defaults to recurring

Single or recurring trip

Allowed:
int32

Required for recurring trips. This is the number of trips made per day.

int32

Required for recurring trips. Number of days in a year the trips are made (365 max)

string
required

The pickup address of the shipment/parcel.

string
required

destination address of the shipment/parcel.

attachments
array of integers

If this order has attachments, supply their IDs as an array. These attachments must have been previously created using the attachments endpoint.

attachments
float

For brokers only. The premium rate for the product.

float

For brokers only. A percentage of the premium to be added as tax

string
enum
Allowed:
string

If you are creating this order for a child partner, add the partner key to the request

Responses

Updated over 2 years ago

Language
Credentials
Bearer
API KEY from your account dashboard
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago