Create Order
V1
post /insurance/motor/v1/orders
This endpoint to create order.
Request Header
Name | Type | Required | Description |
---|---|---|---|
authorization | string | Required | Bearer token |
content-type | string | Required | application/json |
Request Body
Name | Type | Required | Description |
---|---|---|---|
trans_no | string | Required | Unique string that the client can create to track the current request call. |
lang | string | Required |
Policy language
|
status | string | Required |
The intent to either create insurance policy immediately or create the policy after order confirmation.
The possible values are:
|
quotation_id | guid | Required | The quotation id is used for issuing the policy |
total_premium | decimal(18,2) | Required | Total premium according to quotation |
reg_no | string | Conditional |
Vehicle license plate
|
engine | string | Optional | Engine number Max length: 30 |
chassis | string | Required |
Chassis number is a serial number used to identify a motor vehicle
Max length: 19 |
color_code | string | Required | Color |
battery_serial_no | string | Optional | Replacement battery serial number |
insured | object | Required | Json object containing details of the Insured |
long_names | array[object] | Optional | Json object containing details of the Array |
drivers | array[object] | Conditional |
Json object containing details of the Driver
|
beneficiaries | array[object] | Optional | Json object containing details of the Beneficiary |
accessories | array[object] | Optional | Json object containing details of the accessory |
call_back | string | Optional | Callback URL is an address that a partner provides for AXA to POST back policy data |
delivery_options | object | Optional |
Option to send policy-related attachments via email. Json object containing details of the Delivery Options |
transaction_by | string | Required | Globally unique identifier value of the user id Provided by AXA |
Example request
Response
Name | Type | Description |
---|---|---|
trans_no | string | Unique string the client made the request |
status | string |
Order status
|
message | string | |
order_id | string | Unique Order id |
policies | array[object] | Array of Policy |
Example response : create order with "created" status
Example response : create order with "draft" status
Policy Reference
Name | Type | Description |
---|---|---|
policy_id | guid | Policy id |
policy_no | string | Policy number |
policy_type | string |
Type of policy
|
package | string | Package name |
downloads | array[object] | Array of Download |
links | array[object] | Array of Link |
Download Reference
Name | Type | Description |
---|---|---|
type | string |
Type of download
|
layer | string |
Type of layer
|
link | string | Hyperlink points to a whole document |
header | bool | With document header |
Link Reference
Name | Type | Description |
---|---|---|
method | string |
HTTP method
e.g. GET, PUT, POST |
rel | string |
Used to describe the action of a link
e.g. cancel_policy |
href | string | Endpoint to take action |
Array Reference
Name | Type | Required | Description |
---|---|---|---|
text | string | Required | Text is anything that conveys a set of meanings |
Driver Reference
Name | Type | Required | Description |
---|---|---|---|
title_code | string | Conditional |
Title code
Refer to Master Title |
first_name | string | Required |
First name
Max length: 30 |
last_name | string | Required |
Last name
Max length: 30 |
birth_date | date | Required |
Date of birth e.g. 1985-09-27
Format: yyyy-mm-dd
|
gender | string | Required |
Type of gender
|
marital_code | string | Required |
Marital status
|
tax_id | string | Required | Max length: 20
|
country_code | string | Required |
Country code (Based on ISO 3166)
Refer to Master Country |
nationality_code | string | Required |
Nationality code (Based on ISO 3166)
Refer to Master Nationality |
driver_license | string | Required | Car driving licence number |
Beneficiary Reference
Name | Type | Required | Description |
---|---|---|---|
code | string | Conditional | Beneficiary Code
Refer to Beneficiary |
client_type | string | Required | Client Type
|
title_code | string | Required |
Title code
Refer to Master Title |
first_name | string | Required |
Beneficiary person's first name
Max length: 30 Condition: This field is required when client_type is "P"
|
last_name | string | Required |
Beneficiary person's last name
Max length: 30 Condition: This field is required when client_type is "P"
|
corporate_name | string | Required | Max length: 60 Condition: This field is required when client_type is "C"
|
relation_code | string | Required |
Relation code
|
tel | string | Optional |
Accessory Reference
Name | Type | Required | Description |
---|---|---|---|
brand | string | Required |
Accessory brand
e.g. Recaro Max length: 100 |
item | string | Required |
Text is anything that conveys a set of meanings
e.g. Recaro Sportster CS(Black) Max length: 100 |
amount | int | Optional | e.g. 10000 |
Insured Reference
Name | Type | Required | Description |
---|---|---|---|
client_type | string | Required | Client Type
|
title_code | string | Conditional |
Title code
Refer to Master Title |
first_name | string | Conditional |
First name
Max length: 30 Condition: This field is required when client_type is "P"
|
last_name | string | Conditional |
Last name
Max length: 30 Condition: This field is required when client_type is "P"
|
birth_date | date | Required |
Date of birth e.g. 1985-09-27
Format: yyyy-mm-dd
|
gender | string | Required |
Type of gender
|
marital_code | string | Required |
Marital status
|
card_type | string | Conditional | Card Type
- This field must be "I" when client_type is "C" - This field must be "I" or "P" when client_type" is "P" |
corporate_name1 | string | Conditional | Max length: 60 Condition: This field is required when client_type is "C"
|
corporate_name2 | string | Optional | Max length: 60 |
tax_id | string | Required | Max length: 20
|
branch | string | Conditional |
Branch name of customer company
Max length: 30 Note: If there is no branch, specify สำนักงานใหญ่ or Head Office Condition: This field is required when client_type is "C"
|
address_type | string | Required |
Address Type
|
address1 | string | Required | Address Max length: 30 |
address2 | string | Optional | Max length: 30 |
address3 | string | Optional | Max length: 30 |
sub_district_code | string | Required |
Sub district code
Refer to Master Sub District |
district_code | string | Required |
District code
Refer to Master District |
province_code | string | Required |
Province code
Refer to Master Province |
postal_code | string | Required | Postal code e.g. 12000 |
country_code | string | Required |
Country code (Based on ISO 3166)
Refer to Master Country |
nationality_code | string | Required |
Nationality code (Based on ISO 3166)
Refer to Master Nationality |
phone_number1 | string | Conditional |
|
phone_number2 | string | Optional | |
phone_number3 | string | Optional | |
string | Optional | Email address |
Delivery Options Reference
Name | Type | Required | Description |
---|---|---|---|
option_key | string | Required |
The possible values are
|
option_value | string | Conditional |
Use ";" as a delimiter for multiple emails. e.g. example@axa.co.th; partner@axa.co.th Max length: 2000 Condition: This field is required when option_key is "EmailOther"
|