TÀI LIỆU TÍCH HỢP API
TÍCH HỢP VÀO CỔNG THANH TOÁN QUA VÍ MOMO, NGÂN HÀNG
Nếu bạn chưa có tài khoản, vui lòng truy cập địa chỉ: http://smart.airbox.vn/. Để đăng ký chúng tôi sẽ kiểm duyệt và phê duyệt tài khoản cho bạn
Sau khi tài khoản được kích hoạt thành công, đăng nhập vào tài khoản, vào mục “Tài khoản”, trong phần này sẽ có API Key, bạn lưu vào để sử dụng kết nối.
Phía đối tác sau đăng ký và phê duyệt thành công, quý khách có thể dùng API dưới đây để lấy thông tin API_KEY, API_KEY là duy nhất đi theo từng tài khoản và chỉ được cấp 1 lần, vui lòng lưu lại để tái sử dụng
http://api.airbox.vn/login với phương thức POST (content-type: application/x-www-form-urlencode)
Param |
Required |
Type |
Description |
|
Yes* |
String |
Email đã đăng ký với hệ thống |
password |
Yes* |
String |
Mật khẩu đã đăng ký |
Kết quả trả về:
{"status":1,"message":"Thành công","apikey":"TXH-TXHYKP3RcE2LLHZV"}
Param |
Type |
Description |
status |
Int |
Code hệ thống |
message |
String |
Thông báo |
apikey |
String |
API nhận được để sử dụng ở bước sau |
3. LẤY MÃ KẾT NỐI RIÊNG TƯ
Phía đối tác đăng nhập hệ thống quản lý qua url http://smart.airbox.vn/ tại đây có trang quản lý tài khoản bạn sẽ lấy thông tin mã kết nối riêng như hình ảnh dưới đây.
Để sử dụng kết nối riêng tư trước tiên cần thiết lập thông tin tài khoản ngân hang của đổi tác bằng cách sử dụng màn hình đăng ký tài khoản ngân hang và chủ tài khoản
4. TIỀN HÀNH GIAO DỊCH
Phía đối tác sau khi lấy thông tin API_Key ở trên,Tiến hành khởi tạo request POST (content-type: application/x-www-form-urlencode)
- Đối với giao dịch ngân hàng
http://api.airbox.vn/createbankorder
Param |
Required |
Type |
Description |
Amount |
Yes* |
String |
Số tiền thanh toán |
API_Key |
Yes* |
String |
Đã được lấy ở bước trên |
privateCode |
Yes* |
String |
Mã sử dụng api riêng. Nếu không có nhập rỗng |
CallbackUrl |
Yes* |
String |
Link nhận kết quả giao dịch, link sẽ nhận kết quả ở phương thức GET |
Kết quả trả về:
{
"status": 0,
"message": "Tạo đơn thành công",
"trans_id": "VCB210500005",
"data": {
"bankcode": "Vietcombank",
"bankname": "Ngân hàng thương mại cổ phần Ngoại thương Việt Nam",
"code": "1111111111",
"name": "PHAM VAN A",
"content": "arb217856",
"amount": 10000,
"qrcode": "xxxx"
}
}
Param |
Type |
Description |
status |
Int |
Code hệ thống |
message |
String |
Thông báo |
data |
Object |
Kết quả nhận được khi tạo đơn giao dịch |
bankcode |
String |
Mã ngân hàng |
bankname |
String |
Tên ngân hàng |
code |
String |
Số tài khoản |
name |
String |
Chủ tài khoản |
content |
String |
Nội dung chuyển tiền |
amount |
Int |
Mệnh giá chuyển |
qrcode |
String |
Url QRCode thanh toán |
- Đối với giao dịch Momo
http://api.airbox.vn/createwalletorder
Param |
Required |
Type |
Description |
Amount |
Yes* |
String |
Số tiền thanh toán |
API_Key |
Yes* |
String |
Đã được lấy ở bước trên |
privateCode |
Yes* |
String |
Mã sử dụng api riêng. Nếu không có nhập rỗng |
CallbackUrl |
Yes* |
String |
Link nhận kết quả giao dịch, link sẽ nhận kết quả ở phương thức GET |
WalletCode |
Yes* |
String |
Momo |
Kết quả trả về:
{
"status": 0,
"message": "Tạo đơn thành công",
"trans_id": "MM2105000012",
"data": {
"wallet": "MOMO",
"phone": "0912333335",
"name": "PHAM VAN A",
"content": "arb239132",
"amount": 20000,
"qrcode": "xxxx"
}
}
Param |
Type |
Description |
status |
Int |
Code hệ thống |
message |
String |
Thông báo |
data |
Object |
Kết quả nhận được khi tạo đơn giao dịch |
wallet |
String |
Mã ví điện tử |
phone |
String |
Số điện thoại người nhận |
name |
String |
Tên tài khoản người nhận |
content |
String |
Nội dung chuyển tiền |
amount |
Int |
Mệnh giá chuyển |
qrcode |
String |
Url QRCode thanh toán |
- Nhận kết quả trả về từ API
Khi khách hàng thực hiện chuyển tiền qua tài khoản ngân hàng hoặc ứng dụng momo với nội dung đã được khởi tạo. Hệ thống sẽ tự động gọi đến URL CALL_BACK đã đăng ký khi khởi tạo giao dịch Với phương thức GET trong đó có các thông số như sau:
Param |
Required |
Type |
Description |
amount |
Yes* |
Int |
Số tiền gửi lên |
real_amount |
Yes* |
Int |
Số tiền thực nhận |
trans_id |
Yes* |
String |
Mã giao dịch khi gửi lên |
trans_time |
Yes* |
String |
Thời gian thực nhận định dạng dd/MM/yyyy HH:mm:ss |
description |
Yes* |
String |
Nội dung giao dịch |
bank_code |
Yes* |
String |
Cổng nhận tiền (Momo hoặc Ngân hàng) |
provider |
Yes* |
String |
API_Key được mã hoá dạng Md5 để đối tác có thể xác nhận giao dịch |
status |
Yes* |
Int |
Tình trạng đơn hàng : 1- Thành công 0 – Thât bại do không nhận được tiền từ user
|
Lưu ý: Trường hợp nhận dữ liệu về từ callback, phía đổi tác cần phải return dữ liệu cho phía Cổng dưới dạng json như sau:
{ "errorCode": "0", "errorDescription": "Success" }
Với errorCode = 0, tức làphía đối tác đã nhận giao dịch thành công, ngược lại là chưa nhận hoặc nhận thất bại
errorCodeDescription là nội dung trả về cho Cổng (trường này phía đôi tác tự định nghĩa) Nếu như phía Cổng không nhận được dữ liệu trả về khi callback, giao dịch đó sẽ lưu lại dưới dạng chờ xử lý và sẽ không cộng vào doanh thu của user cho đến khi xử lýxong.
Phía đối tác sau khi thực hiện giao dịch thành công, muốn kiểm tra giao dịch của mình đã hoàn tất hay chưa hoặc xem lại thông tin giao dịch, có thể gửi request đến đường dẫn http://api.airbox.vn/trackorder với phương thức POST (content-type: application/x-www-form-urlencode)
Param |
Required |
Type |
Description |
API_Key |
Yes* |
String |
API Key đã cung cấp |
trans_id |
Yes* |
String |
Mã giao dịch đối tác cần tra cứu |
Kết quả trả về:
{
"status": 0,
"message": "Đã tạo đơn",
"data": {
"trans_id": "VCB210500005",
"trans_time": "05/03/2021",
"code": "Vietcombank",
"name": "Ngân hàng thương mại cổ phần Ngoại thương Việt Nam",
"content": "arb827256",
"amount": 10000,
"real_amount": 10000
}
}
Param |
Type |
Description |
status |
Int |
Code hệ thống |
message |
String |
Thông báo |
data |
Object |
Kết quả nhận được khi tạo đơn giao dịch |
trans_id |
String |
Mã giao dịch |
trans_time |
String |
Thời gian giao dịch |
code |
String |
Mã đơn vị nhận thanh toán |
name |
String |
Tên đơn vị nhận thanh toán |
content |
String |
Nội dung chuyển tiền |
amount |
Int |
Số tiền khởi tạo |
real_amount |
Int |
Số tiền thực nhận |
Lưu ý: Nếu số tiền chuyển khoản khác với số tiền khi khởi tạo giao dịch, đơn hàng này sẽ bị trừ 80% giá trị thực nhận hoặc số phần % sẽ thay đổi theo qui định của cổng thanh toán
Phía đối tác sau khi thực hiện giao dịch thành công, muốn kiểm tra giao dịch của mình đã hoàn tất theo nội dung đơn hàng hay chưa, có thể gửi request đến đường dẫn http://api.airbox.vn/orderchecking với phương thức GET.
Param |
Required |
Type |
Description |
API_Key |
Yes* |
String |
API Key đã cung cấp |
content |
Yes* |
String |
Mã giao dịch đối tác cần tra cứu |
Phía đối tác có thể thực hiện theo dõi hoặc quản lý giao dịch, thực hiện lệnh rút tiền tại địa chỉ http://smart.airbox.vn
MỌI GIAO DỊCH SỬ DỤNG SAI IP ĐĂNG KÝ ĐỀU BỊ TỪ CHỐI THANH TOÁN, VUI LÒNG SỬ DỤNG ĐÚNG MÁY CHỦ