Create Order
V1
post /insurance/travel/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.
Min length: 10 |
lang | string | Conditional |
Policy language
The possible values are:
|
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 | Optional | The quotation id is used for issuing the policy |
total_premium | decimal(18,2) | Conditional |
Total premium according to quotation
|
sale_channel | string | Conditional |
Sales channel code to collect transactions.
|
selling_method_code | string | Required |
Method to sell the insurance policy, which affects to the version of policy wording.
|
agent_code | string | Conditional |
Intermediary code
|
staff_code | string | Conditional | Staff code that takes care of that sales channel. Provided by AXA
|
tourism | string | Conditional |
Types of Tourism.
|
policy_type | string | Conditional |
Types of Policy Type.
|
travel_plan | string | Conditional |
Types of Travel Plan.
|
plan_code | string | Conditional | Plan code. Provided by AXA
|
origins | array[string] | Conditional |
Array of starting point of the journey. Provided by AXA
Max : 10 origins
|
destinations | array[string] | Conditional |
Array of destination of the trip. Provided by AXA
Max : 10 destinations
|
inception_date | date | Conditional |
Policy effective date.
Format: yyyy-mm-dd
|
expiry_date | date | Conditional |
Policy expiration date.
Format: yyyy-mm-dd
|
policy_holder | object | Required | Json object containing details of the Policy Holder |
travellers | array[object] | Required | Array of Traveller |
delivery_options | object | Optional |
Option to send policy-related attachments via email. Json object containing details of the Delivery Options |
promo | string | Optional | Max length: 10
|
call_back | string | Optional | Callback URL is an address that a partner provides for AXA to POST back policy data |
transaction_by | string | Required | Globally unique identifier value of the user id Provided by AXA |
product | string | Required | Max length: 30 Tourism Product SelectionIf tourism is outbound, the product is outboundchoice. If tourism is inbound, the product is inbound. If tourism is domestic, the product is domestic. |
Example request [status = created] - without quotation
Example request [status = created] - with quotation
Response [status = created]
Name | Type | Description |
---|---|---|
trans_no | string | Unique string the client made the request |
status | string | Created |
message | string | |
order_id | string | Unique Order id |
net_premium | decimal(18,2) | Net premium |
discount | decimal(18,2) | Discount value |
stamp | int | Stamp duty |
vat | decimal(18,2) | VAT is an indirect tax imposed on the value added of each stage of production and distribution. |
total_premium | decimal(18,2) | Single Premium or the sum of all Limited Premiums/Regular Premiums paid till date |
policies | array[object] | Array of Policy |
Example response [status = created]
Example request [status = draft] - without quotation
Example request [status = draft] - with quotation
Response [status = draft]
Name | Type | Description |
---|---|---|
trans_no | string | Unique string the client made the request |
status | string | Draft |
message | string | |
order_id | string | Unique Order id |
net_premium | decimal(18,2) | Net premium |
discount | decimal(18,2) | Discount value |
stamp | int | Stamp duty |
vat | decimal(18,2) | VAT is an indirect tax imposed on the value added of each stage of production and distribution. |
total_premium | decimal(18,2) | Single Premium or the sum of all Limited Premiums/Regular Premiums paid till date |
policies | array[object] | always null |
Example response [status = draft]
Policy Reference
Name | Type | Description |
---|---|---|
policy_id | guid | Policy id |
policy_no | string | Policy number |
net_premium | decimal(18,2) | Net premium |
discount | decimal(18,2) | Discount value |
stamp | int | Stamp duty |
vat | decimal(18,2) | VAT is an indirect tax imposed on the value added of each stage of production and distribution. |
total_premium | decimal(18,2) | Single Premium or the sum of all Limited Premiums/Regular Premiums paid till date |
policy_holder | object | Json object containing details of the Policy Holder |
traveller | object | Json object containing details of the Traveller |
downloads | array [object] | Json array object containing details of the Download |
links | array [object] | Json array object containing details of the Link |
Download Reference
Name | Type | Description |
---|---|---|
type | string |
Type of download
|
layer | string |
Type of layer
|
link | string | Hyperlink points to a whole document |
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 |
Policy Holder Reference
Name | Type | Required | Description |
---|---|---|---|
client_type | string | Required |
Client Type
|
corporate_name1 | string | Conditional | Max length: 60 Condition: This field is required when client_type is "C"
|
corporate_name2 | string | Optional | Max length: 60 |
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"
|
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
|
passport_no | string | Required | Max length: 20
|
tax_id | string | Conditional | Max length: 13
|
address_type | string | Required |
Address Type
|
address1 | string | Required | Address/Street Max length: 30 |
address2 | string | Optional | Max length: 30 |
address3 | string | Optional | Max length: 30
|
address4 | string | Optional | Max length: 30
|
address5 | string | Optional | Max length: 30
|
sub_district_code | string | Conditional |
Sub district code
Refer to Master Sub District
|
district_code | string | Conditional |
District code
Refer to Master District
|
province_code | string | Conditional |
Province code
Refer to Master Province
|
postal_code | string | Conditional |
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 |
long_names | array[object] | Optional | Json object containing details of the Array |
phone_number1 | string | Optional | |
phone_number2 | string | Optional | |
phone_number3 | string | Optional | |
string | Optional | Email address |
Traveller Reference
Name | Type | Required | Description |
---|---|---|---|
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
|
passport_no | string | Required | Max length: 20
|
tax_id | string | Conditional | Max length: 13
|
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
|
address4 | string | Optional | Max length: 30
|
address5 | string | Optional | Max length: 30
|
sub_district_code | string | Conditional |
Sub district code
Refer to Master Sub District
|
district_code | string | Conditional |
District code
Refer to Master District
|
province_code | string | Conditional |
Province code
Refer to Master Province
|
postal_code | string | Conditional |
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 | Optional | |
phone_number2 | string | Optional | |
phone_number3 | string | Optional | |
string | Optional | Email address | |
domicile | string | Conditional |
Country code (Based on ISO 3166)
Refer to Master Country
|
pre_existing_disease | string | Optional | Pre-existing disease |
beneficiaries | array[object] | Optional | Json array object containing details of the Beneficiary |
Beneficiary Reference
Name | Type | Required | Description |
---|---|---|---|
name | string | Required |
Beneficiary person's name
Max length: 50 |
relation_code | string | Required |
A person who is connected by blood or marriage; a kinsman or kinswoman. Refer to Master Relation |
ratio | int | Required |
Beneficiary Ratio
Condition: The sum of all beneficiaries' ratios must be 100.
|
tel | string | Optional |
Insured Response Reference
Name | Type | Description |
---|---|---|
name | string | full name |
address | string | Address |
branch | string | Branch name of customer company |
passport_no | string | Passport Number |
tax_id | string | Citizen ID |
birth_date | date | Date of birth e.g. 1985-09-27 |
string | 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"
|