Create Order

V2

post /insurance/travel/v2/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
Max length: 30

lang string Conditional Policy language

The possible values are:

  • en
  • th

Condition: must be 'en' for inbound tourism

status string Required The intent to either create insurance policy immediately or create the policy after order confirmation.

The possible values are:

  • Created Partner intends to create policy after the customer makes a order.
  • Draft Partner intends to create order and continue after the customer makes a payment. Order are best captured within one day before the coverage start date. After that, the order expires and you must re-create the order.
quotation_id guid Optional The quotation id is used for issuing the policy
total_premium decimal(18,2) Conditional Total premium according to quotation

Condition: This field is required when quotation id not empty

sale_channel string Conditional Sales channel code to collect transactions.
  • BKO

Condition: This field is required when quotation id not empty

selling_method_code string Required Method to sell the insurance policy, which affects to the version of policy wording.
  • F2F: Face to face
  • Online: Online
agent_code string Conditional Intermediary code

Condition: This field is required when quotation id not empty

staff_code string Conditional Staff code that takes care of that sales channel. Provided by AXA

Condition: This field is required when quotation id not empty

tourism string Conditional Types of Tourism.
  • Inbound
  • Outbound
  • Domestic

Condition: This field is required when quotation id not empty

policy_type string Conditional Types of Policy Type.
  • Individual

Condition: This field is required when quotation id not empty

travel_plan string Conditional Types of Travel Plan.
  • Single
  • Annual

Condition: This field is required when quotation id not empty

plan_code string Conditional Plan code. Provided by AXA

Condition: This field is required when quotation id not empty

origins array[string] Conditional Array of starting point of the journey. Provided by AXA

Max : 10 origins

Condition:

  1. This field is required when tourism is "Inbound", "Domestic"
  2. This field is required when quotation id not empty

destinations array[string] Conditional Array of destination of the trip. Provided by AXA

Max : 10 destinations

Condition:

  1. This field is required when tourism is "Outbound", "Domestic"
  2. This field is required when quotation id not empty

inception_date date Conditional Policy effective date.

Format: yyyy-mm-dd

Condition: This field is required when quotation id not empty

expiry_date date Conditional Policy expiration date.

Format: yyyy-mm-dd

Condition: This field is required when quotation id not empty

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

Condition: This field does not take effect when quotation id not empty

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
add_on array[string] Optional Array of Add On
product string Required

Max length: 30

Tourism Product Selection

If 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
{
    "trans_no": "BB083044acf0140044",
    "status":"Created",
    "sale_channel": "BKO",
    "selling_method_code": "Online",
    "agent_code": "XXXXX",
    "staff_code": "XB",
    "lang": "th",
    "tourism": "Outbound",
    "policy_type": "Individual",
    "travel_plan": "Single",
    "plan_code": "OS6",
    "destinations": ["SHN","SGS","UMI","HMD","VCT","BES","IOT","ATF","SPM","CAF"],
    "inception_date": "2023-07-22",
    "expiry_date": "2023-07-23",
    "promo": "",
    "policy_holder": {
        "client_type": "P",
        "first_name": "Partner",
        "last_name": "Test",
        "birth_date": "1986-01-01",
        "gender": "M",
        "marital_code": "S",
        "passport_no": "",
        "tax_id": "",
        "address_type": "B",
        "address1": "1168 Lumpini Tower",
        "address2": "",
        "sub_district_code": "500104",
        "district_code": "5001",
        "province_code": "50",
        "postal_code": "50300",
        "country_code": "THA",
        "nationality_code": "THA",
        "phone_number1": "",
        "phone_number2": "",
        "phone_number3": "",
        "email": "example@partner.com"
    },
    "travellers": [{
            "first_name": "Partner",
            "last_name": "Test",
            "birth_date": "1986-01-01",
            "gender": "M",
            "marital_code": "S",
            "passport_no": "",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "50300",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": ""
        },
        {
            "first_name": "Partner",
            "last_name": "System",
            "birth_date": "1985-11-01",
            "gender": "F",
            "marital_code": "S",
            "passport_no": "",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "50300",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": "",
            "beneficiaries": [{
                    "name": "Broker",
                    "relation_code": "001",
                    "ratio": 100,
                    "tel": ""
                }
            ]
        }
    ],
    "call_back":"",
    "transaction_by": "8C890CB2-9FAD-4953-BCC7-E54B9ACE827C"ม
    "add_on": null,
    "product": "outboundchoice"
}
Example request [status = created] - with quotation
{
    "trans_no": "BB083044acf0140044",
    "quotation_id":"0ecadc0d-97bd-47fe-9350-8b643e3c2828",
    "selling_method_code": "Online",
    "status":"Created",
    "lang":"th",
    "policy_holder": {
        "client_type": "P",
        "first_name": "Partner",
        "last_name": "Test",
        "birth_date": "2021-08-01",
        "gender": "M",
        "marital_code": "S",
        "passport_no": "",
        "tax_id": "",
        "address_type": "B",
        "address1": "1168 Lumpini Tower",
        "address2": "",
        "sub_district_code": "500104",
        "district_code": "5001",
        "province_code": "50",
        "postal_code": "50300",
        "country_code": "THA",
        "nationality_code": "THA",
        "phone_number1": "",
        "phone_number2": "",
        "phone_number3": "",
        "email": "example@partner.com"
    },
    "travellers": [{
            "first_name": "Partner",
            "last_name": "Test",
            "birth_date": "1986-01-01",
            "gender": "M",
            "marital_code": "S",
            "passport_no": "",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "5030",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": ""
        },
        {
            "first_name": "Partner",
            "last_name": "System",
            "birth_date": "1986-01-01",
            "gender": "M",
            "marital_code": "S",
            "passport_no": "",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "50300",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": "",
            "beneficiaries": [{
                    "name": "Broker",
                    "relation_code": "001",
                    "ratio": 100,
                    "tel": ""
                }
            ]
        }
    ],
    "call_back":"",
    "transaction_by": "8C890CB2-9FAD-4953-BCC7-E54B9ACE827C",
    "add_on": null,
    "product": "outboundchoice"
}
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]
{
    "trans_no": "AXA-22-000246",
    "status": "Created",
    "message": "",
    "order_id": "4e762df1-3bb5-40ec-3565-08qa439ae0fd",
    "net_premium": 348.49,
    "discount": 0.00,
    "stamp": 2,
    "vat": 0,
    "total_premium": 375.02,
    "policies": [
        {
            "policy_id": "d6fe1816-d847-4563-8a95-38fcb085276c",
            "policy_no": "Q61000001",
            "net_premium": 348.49,
            "discount": 0.00,
            "stamp": 2,
            "vat": 0,
            "total_premium": 375.02,
            "policy_holder": {
                "name": "Partner Test",
                "address": "1168 Lumpini Tower ช้างม่อย, เมืองเชียงใหม่, เชียงใหม่, 50300",
                "branch": "",
                "passport_no": "uuV7kfViKGpPxbG",
                "tax_id": "",
                "email": ""
            },
            "traveller": {
                "name": "Partner Test",
                "address": "1168 Lumpini Tower ช้างม่อย, เมืองเชียงใหม่, เชียงใหม่, 5030",
                "passport_no": "uuV7kfViKGpPxbG",
                "tax_id": "aHclxizXIHd2ez2",
                "birth_date": "1986-01-01",
                "email": ""
            },
            "downloads": [
                {
                    "type": "Schedule",
                    "layer": "Original",
                    "link": "https://uatapiconnect.axa.co.th/report/d312af4ae978432596ed1b3931be74c8"
                },
                {
                    "type": "Taxinvoice",
                    "layer": "Original",
                    "link": "https://uatapiconnect.axa.co.th/report/d1b756345d6c4dcfb3268ca79d09b3b7"
                },
                {
                    "type": "PolicyWording",
                    "layer": "Original",
                    "link": "https://uatapiconnect.axa.co.th/report/5d99a4841cd7493ca0328ecfd3194ffe"
                },
                {
                    "type": "Schedule",
                    "layer": "Copy",
                    "link": "https://uatapiconnect.axa.co.th/report/b89742e607cd4763ab5f571ddb843078"
                },
                {
                    "type": "Taxinvoice",
                    "layer": "Copy",
                    "link": "https://uatapiconnect.axa.co.th/report/3a89d7e3e51d4a8f8f43d67ad8f7c3d5"
                }
            ],
            "links": []
        }
    ]
}
Example request [status = draft] - without quotation
{
    "trans_no": "BB083044acf0140044",
    "sale_channel": "BKO",
    "selling_method_code": "Online",
    "agent_code": "XXXXX",
    "staff_code": "HG",
    "status":"Draft",
    "lang": "th",
    "tourism": "Outbound",
    "policy_type": "Individual",
    "travel_plan": "Single",
    "plan_code": "OS6",
    "destinations": ["SHN","SGS","UMI","HMD","VCT","BES","IOT","ATF","SPM","CAF"],
    "inception_date": "2023-07-22",
    "expiry_date": "2023-07-23",
    "promo": "",
    "policy_holder": {
        "client_type": "P",
        "first_name": "Partner",
        "last_name": "Test",
        "birth_date": "2021-08-01",
        "gender": "M",
        "marital_code": "M",
        "passport_no": "Passport",
        "tax_id": "",
        "address_type": "B",
        "address1": "1168 Lumpini Tower",
        "address2": "",
        "sub_district_code": "500104",
        "district_code": "5001",
        "province_code": "50",
        "postal_code": "50300",
        "country_code": "THA",
        "nationality_code": "THA",
        "phone_number1": "",
        "phone_number2": "",
        "phone_number3": "",
        "email": "example@partner.com"
    },
    "travellers": [{
            "first_name": "Partner",
            "last_name": "Test",
            "birth_date": "1986-01-01",
            "gender": "M",
            "marital_code": "M",
            "passport_no": "Passport",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "5030",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": ""
        },
        {
            "first_name": "Partner",
            "last_name": "System",
            "birth_date": "1986-01-01",
            "gender": "M",
            "marital_code": "M",
            "passport_no": "Passport",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "50300",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": "",
            "beneficiaries": [{
                    "name": "Broker",
                    "relation_code": "001",
                    "ratio": 100,
                    "tel": ""
                }
            ]
        }
    ],
    "call_back":"",
    "transaction_by": "8C890CB2-9FAD-4953-BCC7-E54B9ACE827C"
}
Example request [status = draft] - with quotation
{
    "trans_no": "BB083044acf0140044",
    "quotation_id":"0ecadc0d-97bd-47fe-9350-8b643e3c2828",
    "selling_method_code": "Online",
    "status":"Draft",
    "lang":"th",
    "policy_holder": {
        "client_type": "P",
        "first_name": "Partner",
        "last_name": "Test",
        "birth_date": "2021-08-01",
        "gender": "M",
        "marital_code": "M",
        "passport_no": "Passport",
        "tax_id": "",
        "address_type": "B",
        "address1": "1168 Lumpini Tower",
        "address2": "",
        "sub_district_code": "500104",
        "district_code": "5001",
        "province_code": "50",
        "postal_code": "50300",
        "country_code": "THA",
        "nationality_code": "THA",
        "phone_number1": "",
        "phone_number2": "",
        "phone_number3": "",
        "email": "example@partner.com"
    },
    "travellers": [{
            "first_name": "Partner",
            "last_name": "Test",
            "birth_date": "1986-01-01",
            "gender": "M",
            "marital_code": "M",
            "passport_no": "Passport",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "5030",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": ""
        },
        {
            "first_name": "Partner",
            "last_name": "System",
            "birth_date": "1986-01-01",
            "gender": "M",
            "marital_code": "M",
            "passport_no": "Passport",
            "tax_id": "",
            "address_type": "B",
            "address1": "1168 Lumpini Tower",
            "address2": "",
            "sub_district_code": "500104",
            "district_code": "5001",
            "province_code": "50",
            "postal_code": "50300",
            "country_code": "THA",
            "nationality_code": "THA",
            "phone_number1": "",
            "phone_number2": "",
            "phone_number3": "",
            "email": "",
            "beneficiaries": [{
                    "name": "Broker",
                    "relation_code": "001",
                    "ratio": 100,
                    "tel": ""
                }
            ]
        }
    ],
    "call_back":"",
    "transaction_by": "8C890CB2-9FAD-4953-BCC7-E54B9ACE827C"
}
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]
{
    "trans_no": "AXA-22-000246",
    "status": "Draft",
    "message": "",
    "order_id": "4e762df1-3bb5-40ec-3565-08qa439ae0fd",
    "net_premium": 348.49,
    "discount": 0.00,
    "stamp": 2,
    "vat": 0,
    "total_premium": 375.02,
    "policies": null
}
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
  • Schedule
  • Taxinvoice
  • PolicyWording
layer string Type of layer
  • Original
  • Copy
link string Hyperlink points to a whole document
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
  • C : Corporate
  • P : Personal
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

Condition:

  1. The policy holder is at least 6 months old but not over 80 years old when tourism is "Inbound"
  2. The policy holder is at least 1 years old but not over 74 years old when tourism is "Domestic"
  3. The policy holder is at least 1 years old but not over 80 years old when tourism is "Outbound"

gender string Required Type of gender
  • M : Male
  • F : Female
  • Z : Unknow
marital_code string Required Marital status
  • S : Single
  • M : Married
  • W : Widowed
  • D : Divorced
  • Z : Unknow
passport_no string Required

Max length: 20

Condition:

  1. This field is required when tourism is "Inbound", "Outbound"
  2. This field is required when nationality_code is not "THA"

tax_id string Conditional

Max length: 13

Condition:

  1. This field is required when nationality_code is "THA"
  2. This field is required when client_type is "C"

address_type string Required Address Type
  • B : Office
  • R : Home
  • P : Postal
address1 string Required Address/Street

Max length: 30

address2 string Optional

Max length: 30

address3 string Optional

Max length: 30

Condition: Effective only when tourism is "Inbound"

address4 string Optional

Max length: 30

Condition: Effective only when tourism is "Inbound"

address5 string Optional

Max length: 30

Condition: Effective only when tourism is "Inbound"

sub_district_code string Conditional Sub district code

Refer to Master Sub District

Condition: This field is required when tourism is "Outbound", "Domestic"

district_code string Conditional District code

Refer to Master District

Condition: This field is required when tourism is "Outbound", "Domestic"

province_code string Conditional Province code

Refer to Master Province

Condition: This field is required when tourism is "Outbound", "Domestic"

postal_code string Conditional Postal code e.g. 12000

Condition: This field is required when tourism is "Outbound", "Domestic"

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
email 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

Condition:

  1. The policy holder is at least 6 months old but not over 80 years old when tourism is "Inbound"
  2. The policy holder is at least 1 years old but not over 74 years old when tourism is "Domestic"
  3. The policy holder is at least 1 years old but not over 80 years old when tourism is "Outbound"

gender string Required Type of gender
  • M : Male
  • F : Female
  • Z : Unknow
marital_code string Required Marital status
  • S : Single
  • M : Married
  • W : Widowed
  • D : Divorced
  • Z : Unknow
passport_no string Required

Max length: 20

Condition:

  1. This field is required when tourism is "Inbound", "Outbound"
  2. This field is required when nationality_code is not "THA"

tax_id string Conditional

Max length: 13

Condition: This field is required when nationality_code is "THA"

address_type string Required Address Type
  • B : Office
  • R : Home
  • P : Postal
address1 string Required Address

Max length: 30

address2 string Optional

Max length: 30

address3 string Optional

Max length: 30

Condition: Effective only when tourism is "Inbound"

address4 string Optional

Max length: 30

Condition: Effective only when tourism is "Inbound"

address5 string Optional

Max length: 30

Condition: Effective only when tourism is "Inbound"

sub_district_code string Conditional Sub district code

Refer to Master Sub District

Condition: This field is required when tourism is "Outbound", "Domestic"

district_code string Conditional District code

Refer to Master District

Condition: This field is required when tourism is "Outbound", "Domestic"

province_code string Conditional Province code

Refer to Master Province

Condition: This field is required when tourism is "Outbound", "Domestic"

postal_code string Conditional Postal code e.g. 12000

Condition: This field is required when tourism is "Outbound", "Domestic"

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

Condition: This field must match a quote when quotation id not empty

phone_number1 string Optional
phone_number2 string Optional
phone_number3 string Optional
email string Optional Email address
domicile string Conditional Country code (Based on ISO 3166)

Refer to Master Country

Condition:

  1. This field is required when tourism is "Inbound"
  2. This field must match a quote when quotation id not empty

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
email string Email address
Delivery Options Reference
Name Type Required Description
option_key string Required The possible values are
  • EmailPolicyHolder
  • EmailOther
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"