🎰API Details

Header

Endpoint (Staging)

https://gw-dev.saladin.vn/api/v1/trip-insurance

Endpoint (Production)

https://gw.saladin.vn/api/v1/trip-insurance

X-Sld-Timestamp

Request call time, in seconds

X-Sld-ClientKey

Client Key is issued to 3rd Party

X-Sld-Signature (param)

The signature is generated based on the request body

How to generate X-Sld-Signature

// request body
body = {
    "<field_name>": <field_value>,
    "<field_name>": <field_value>,
    "<field_name>": <field_value>,
}

payload = timestamp + "." + client_key + "." + json_stringify(data)
secret = "<client_secret>"
encoded_payload = base64_safeurl_encode_no_padding(payload)
signature = HMAC_SHA256(secret, payload)

API #01 - Calculate Premium v2

GET{{endpoint}}/vendor/accident-insurance/v2/premiums

Purpose: Enable partners to access multiple insurance products with a single request.
Trigger when: Users select to purchase the insurance for the trip.

Partners can also use an older version here; however, they can only retrieve one insurance product per API call

Headers

Name

Value

X-Sld-Timestamp

Timestamp when calling request in second

X-Sld-ClientKey

Client key which is given to partner

X-Sld-Signature

The code is generated according to the instructions in the 'How to generate X-Sld-Signature' section

Query parameters

Name

Type

Description

number_of-seat

interger

channel

enum

1 - Offline. 2 - Online.

Response

{
    "code": 0,
    "message": "OK",
    "data": {
        "products": [
            {
                "product_code": "e_trip_pa_04",
                "product_premium": "50000",
                "product_detail_url": "https://www.saladin.vn/bao-hiem-lien-ket/bao-hiem-chuyen-di-mtn200"
            },
            {
                "product_code": "e_trip_pa_05",
                "product_premium": "100000",
                "product_detail_url": "https://www.saladin.vn/bao-hiem-lien-ket/bao-hiem-chuyen-di-mtn400"
            }
        ]
    }
}

API #02 - Create Policy

Post: /vendor/accident-insurance/policies

Purpose: The partner can request this API to create the insurance contract.
Trigger when: After customers make payment successfully for their order.

Parameters

Body

Field

Data Type

Description

Required

order_id

string

The id of the order on the partner system.

product_code

string

The product code which is returned by the API#1

channel

enum

1 - Offline. 2 - Online.

buyer_name

string

Full name of the buyer

buyer_phone

string

Phone number of the buyer

buyer_email

string

email of the buyer

bus_operator

string

bus_phone_number

string

bus_number_plate

string

driver_phone

string

Phone number of the driver

contract_date

timestamp

The time that the customer confirmed and made the payment for the insurance contract.

trip_start_time

timestamp

trip_end_time

timestamp

from_city

string

e.g Thành phố Hồ Chí Minh

to_city

string

e.g Thành phố Hồ Chí Minh

from_address

string

e.g 135, Thành Thái, Quận 10, Thành phố Hồ Chí Minh

to_address

string

e.g 135, Thành Thái, Quận 10, Thành phố Hồ Chí Minh

ticket_number

string

seat_numbers

array

e.g: A4, B5, ....

price

number

Paid amount after the promotion/discount

product_premium

string

1000000

app_ref_id

string

A unique request ID from the partner to distinguish this request from others

Responses

200


{
    "code": 0,
    "message": "OK",
    "data": {
        "policy_id": "string",
        "policy_number": "string",
        "claim_url": "string"
    }
}

API #03 - Cancel ticket

Purpose: The partner can request this API to cancel the ticket of a policy.
Trigger when: When the user makes canceling the ticket on the partner's tools.

Cancel ticket

put

Path parameters

policy_idstringRequired

order_idstringRequired

ticket_numberstringRequired

Header parameters

X-Sld-TimestampnumberRequired

Timestamp when calling request in second

X-Sld-ClientKeystringRequired

Client Key which is given to partner

X-Sld-SignaturestringRequired

Client Key which is given to partner

Body

cancellation_bystringRequired

cancellation_reasonstringRequired

seat_numbersstring[]Optional

customer_namestringRequired

customer_phonestringRequired

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

put

/vendor/accident-insurance/policies/{policy_id}/orders/{order_id}/tickets/{ticket_number}

PUT /vendor/accident-insurance/policies/{policy_id}/orders/{order_id}/tickets/{ticket_number} HTTP/1.1
X-Sld-Timestamp: 1
X-Sld-ClientKey: text
X-Sld-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "cancellation_by": "text",
  "cancellation_reason": "text",
  "seat_numbers": [
    "text"
  ],
  "customer_name": "text",
  "customer_phone": "text"
}

{
  "code": 1,
  "message": "text"
}

API #04 - Create claim request

Purpose: The partner system call to submit a claim request to Saladin when the customer cancels the trip and they eligible to participate in the program "Tri ân khách hàng".
Trigger when: When the user cancels the trip and presses a CTA to submit a claim request.

Parameters

Body

Create claim

post

Header parameters

X-Sld-TimestampnumberRequired

Timestamp when calling request in second

X-Sld-ClientKeystringRequired

Client Key which is given to partner

X-Sld-SignaturestringRequired

Client Key which is given to partner

Body

policy_idstringOptional

ticket_numberstringOptional

order_idstringOptional

requested_bystringOptional

requested_datestring · int64Optional

seat_numbersstring[]Optional

customer_namestringOptional

customer_phonestringOptional

cancellation_reasonstringOptional

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

post

/vendor/trip-insurance/claims

POST /vendor/trip-insurance/claims HTTP/1.1
X-Sld-Timestamp: 1
X-Sld-ClientKey: text
X-Sld-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 207

{
  "policy_id": "text",
  "ticket_number": "text",
  "order_id": "text",
  "requested_by": "text",
  "requested_date": "text",
  "seat_numbers": [
    "text"
  ],
  "customer_name": "text",
  "customer_phone": "text",
  "cancellation_reason": "text"
}

{
  "code": 1,
  "message": "text"
}

API #05 - Update Policy

PUT : /vendor/accident-insurance/policies/:policy_id

Purpose: The partner can request this API to edit the insurance contract.
Trigger when: Customer or Admin makes changes details of the order.
Rules for update:
- All changes are only accepted before the estimated time departure of the trip.
- All of the fields on the API's body will be replaced on the insurance contract except channel.
- If the insurance premium increases, the customer must pay more or the agent must collect the difference in the payment_amount field.

Parameters

Path

Field

Data Type

Description

Required

policy_id

string

Body

Field

Data Type

Description

Required

order_id

string

The id of the order on the partner system.

channel

enum

1 - Offline. 2 - Online.

ticket_number

string

buyer_name

string

Full name of the buyer

buyer_phone

string

Phone number of the buyer

buyer_email

string

email of the buyer

bus_operator

string

bus_phone_number

string

bus_number_plate

string

driver_phone

string

Phone number of the driver

contract_date

date_time

The time that the customer confirmed and made the payment for the insurance contract.

trip_start_time

date_time

trip_end_time

date_time

from_city

string

e.g Thành phố Hồ Chí Minh

to_city

string

e.g Thành phố Hồ Chí Minh

from_address

string

e.g 135, Thành Thái, Quận 10, Thành phố Hồ Chí Minh

to_address

string

e.g 135, Thành Thái, Quận 10, Thành phố Hồ Chí Minh

string

seat_numbers

array

e.g: A4, B5, ....

price

number

Paid amount after the promotion/discount

Responses

200

{
  "code": "integer",
  "message": "string",
  "policy_id": "string"
  "policy_number": "string"
  "new_premium_amount": "integer"
  "payment_amount": "integer"
}

API #06 - Get policy information

Purpose: The partner can call this API to check the status of the policy of the order.

Get Policy

get

Query parameters

order_idstringOptional

Header parameters

X-Sld-TimestampnumberRequired

Timestamp when calling request in second

X-Sld-ClientKeystringRequired

Client Key which is given to partner

X-Sld-SignaturestringRequired

Client Key which is given to partner

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

/vendor/accident-insurance/policies

GET /api/v1/trip-insurance/vendor/accident-insurance/policies HTTP/1.1
X-Sld-Timestamp: 1
X-Sld-ClientKey: text
X-Sld-Signature: text
Accept: */*

{
  "code": 1,
  "message": "text",
  "data": {
    "order_id": "text",
    "channel": "CHANNEL_UNSPECIFIED",
    "buyer_name": "text",
    "buyer_phone": "text",
    "buyer_email": "text",
    "bus_operator": "text",
    "bus_phone_number": "text",
    "bus_number_plate": "text",
    "driver_phone": "text",
    "contract_date": 1,
    "trip_start_time": 1,
    "trip_end_time": 1,
    "from_city": "text",
    "to_city": "text",
    "from_address": "text",
    "to_address": "text",
    "ticket_number": "text",
    "seat_numbers": [
      "text"
    ],
    "price": 1,
    "product_premium": 1,
    "app_ref_id": "text",
    "policy_id": "text",
    "policy_number": "text",
    "claim_url": "text"
  }
}

API #07 - Cancel Policy

Purpose: The partner can call this API to cancel the policy.

Rules For Cancellation

The policy is only canceled 48 hours before the estimated departure time of the trip

Cancel Policy

post

Path parameters

policy_idstringRequired

Header parameters

X-Sld-TimestampnumberRequired

Timestamp when calling request in second

X-Sld-ClientKeystringRequired

Client Key which is given to partner

X-Sld-SignaturestringRequired

Client Key which is given to partner

Body

cancellation_reasonstringRequired

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

post

/vendor/cancel-policy/{policy_id}

POST /api/v1/trip-insurance/vendor/cancel-policy/{policy_id} HTTP/1.1
X-Sld-Timestamp: 1
X-Sld-ClientKey: text
X-Sld-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "cancellation_reason": "text"
}

{
  "code": 1,
  "message": "text"
}

PreviousAgent Booking - Customer Journey NextThe older version APIs

Last updated 9 months ago

hashtagHeader

hashtagHow to generate X-Sld-Signature

hashtagAPI #01 - Calculate Premium v2

hashtagAPI #02 - Create Policy

hashtagParameters

hashtagAPI #03 - Cancel ticket

hashtagCancel ticket

hashtagAPI #04 - Create claim request

hashtagParameters

hashtagCreate claim

hashtagAPI #05 - Update Policy

hashtagParameters

hashtagAPI #06 - Get policy information

hashtagGet Policy

hashtagAPI #07 - Cancel Policy

hashtagCancel Policy

Header

How to generate X-Sld-Signature

API #01 - Calculate Premium v2

API #02 - Create Policy

Parameters

API #03 - Cancel ticket

Cancel ticket

API #04 - Create claim request

Parameters

Create claim

API #05 - Update Policy

Parameters

API #06 - Get policy information

Get Policy

API #07 - Cancel Policy

Cancel Policy