Skip to main content

Danh sách các API

API Endpoint

EnvironmentEndpoint
Productionhttps://api.tiki.vn/miniapp/tikivip/
Sandboxhttps://api.tala.xyz/miniapp/tikivip/

Authentication

Để có thể tích hợp với Backend của Tini App, sau khi đăng ký tài khoản tích hợp, bạn cần sử dụng cặp key api_keyapi_secret.

Chú ý rằng cặp key này cần gắn với cặp partner_codeclient_id bạn đã sử dụng khi tích hợp ở client. Việc sử dụng sai các key sẽ dẫn tới dữ liệu sai và tích hợp bị sai.

Mọi request gọi tới backend của Tiki đều cần phải có signature. Chi tiết việc tính signature được mô tả trong tài liệu tính signature

Danh sách các API

1. API nhận IPN từ đối tác

Tài liệu mô tả API nhận IPN từ đối tác về các cập nhật của giao dịch

FieldValue
PROD URLhttps://api.tiki.vn/miniapp/tikivip/payment/ipn
UAT URLhttps://api.tala.xyz/miniapp/tikivip/payment/ipn
methodPOST

Body Params

FieldTypeRequiredDescription
reference_transaction_idstringyesTiki transaction id
transaction_amountnumberyesSố tiền của transaction
transaction_idstringyesTransaction id ở phía đối tác
statusstringyesSUCCESS / FAILURE / PENDING
partner_banking_methodstringnoPhương thức thanh toán khách hàng sử dụng tại ứng dụng của đối tác (đối tác cần cung cấp cho tiki các mã này)

Response

Trường hợp thành công
HTTP Status 200
{
"code": 0,
"message": "success",
"data": {
"transaction_id": "8A43B011-0EC9-4AA5-8D83-6FE7B2BCE4EC"
}
}
Trường hợp thất bại
HTTP Status 200
{
"code": 2,
"message": "error message"
}
Bảng chi tiết mã lỗi code
CodeDescriptionAction
0Thành công
1Request không hợp lệHoàn tiền
2Lỗi hệ thốngHoàn tiền
3Giao dịch không tìm thấyHoàn tiền
4Giao dịch không thuộc đối tácHoàn tiền
5Số tiền giao dịch không hợp lệHoàn tiền
6Giao dịch bị huỷHoàn tiền
HTTP Status 4xx, 5xx

Lỗi về hệ thống cần liên hệ với Tiki

2. API để lấy thông tin chi tiết của transaction trên Tiki

Mô tả API lấy thông tin chi tiết của transaction

FieldValue
PROD URLhttps://api.tiki.vn/miniapp/tikivip/transaction
UAT URLhttps://api.tala.xyz/miniapp/tikivip/transaction
methodGET

Params

FieldTypeRequiredDescription
tiki_transaction_idstringyesTiki transaction id

Response

FieldTypeDescription
tiki_transaction_idstringTiki transaction id
partner_transaction_idstringTransaction id của đối tác
statusstringTrạng thái transaction
amountnumberSố tiền của transaction

Các trạng thái của transaction

FieldValue
PENDINGđang chờ thanh toán
SUCCESSthanh toán thành công
FAILUREthanh toán thất bại

Response

Trường hợp thành công
HTTP Status 200
{
"code": 0,
"message": "success",
"tiki_transaction_id": "221115TIKIVIP-235784371-1668488254",
"partner_transaction_id": "8A43B011-0EC9-4AA5-8D83-6FE7B2BCE4EC",
"status": "SUCCESS",
"amount": 100000
}
Trường hợp thất bại
HTTP Status 200
{
"code": 2,
"message": "error message"
}
Bảng chi tiết mã lỗi code
CodeDescriptionAction
0Thành công
1Request không hợp lệKiểm tra lại request
2Lỗi hệ thốngThực hiện lại
3Giao dịch không tìm thấyHoàn tiền
4Giao dịch không thuộc đối tácKiểm tra lại tiki transaction id
6Giao dịch bị huỷHoàn tiền
HTTP Status 4xx, 5xx

Lỗi về hệ thống cần liên hệ với Tiki

3. Refund API

Mô tả request từ Tiki sẽ gọi tới API của đối tác, thông báo hoàn tiền một giao dịch.

Để đảm bảo bảo mật, trong API gọi tới đối tác, Tiki cũng sẽ gửi kèm các header và signature được mô tả như trong tài liệu tính signature

Body Params

Method POST

FieldTypeRequiredDescription
tiki_transaction_idstringyesTiki transaction id
transaction_amountnumberyesSố tiền hoàn của transaction
transaction_idstringyesTransaction id ở phía đối tác
reasonstringyesLý do hoàn tiền
request_idstringyesRequest id, API đối tác cần hỗ trợ idempotent

Response

Trường hợp thành công

HTTP Status 200

Trường hợp thất bại

HTTP Status 500

4. API lấy thông tin url webview

Mô tả API lấy thông tin URL webview

FieldValue
PROD URLhttps://api.tiki.vn/miniapp/tikivip/webview
UAT URLhttps://api.tala.xyz/miniapp/tikivip/webview
methodPOST

Body Params

FieldTypeRequiredDescription
identify_codestringyesmã code để xác định khách hàng
identify_phonenumberyesSố điện thoại của khách hàng
identify_fullnamestringnoHọ và tên khách hàng

Response

Trường hợp thành công
{
"code": 0,
"message": "success",
"data": {
"url_open": "https://tiki.vn/apps/vn.tiki.vip?xxxxx",
"url_checkout_result": "https://tiki.vn//apps/vn.tiki.vip/callback/index?xxxxx",
"request_id": "8A43B011-0EC9-4AA5-8D83-6FE7B2BCE4EC"
}
}
Trường hợp thất bại
{
"code": 2,
"message": "error message"
}
Bảng chi tiết mã lỗi
CodeDescription
0Thành công
1Request không hợp lệ
2Lỗi hệ thống
HTTP Status 4xx, 5xx

Lỗi về hệ thống cần liên hệ với Tiki