Bỏ qua để đến nội dung chính
Phiên bản: 1.2.2 (Latest)

Đăng ký nhận biến động ghi nợ

API này dùng để đăng ký nhận thông báo giao dịch ghi nợ (tiền ra) trên số tài khoản gốc ACB. Sau khi đăng ký thành công, mỗi khi tài khoản phát sinh giao dịch trừ tiền, TINGEE sẽ gửi Webhook về hệ thống của đối tác.

Phạm vi áp dụng
  • Chỉ hỗ trợ ngân hàng ACB (bankBin = "970416"), áp dụng cho tài khoản Cá nhân, Hộ kinh doanh và Doanh nghiệp.
  • API đăng ký trên số tài khoản gốc, không tạo tài khoản ảo (VA).
  • Nếu số tài khoản đã đăng ký nhận biến động ghi có (tạo bằng Tạo/Liên kết số tài khoản với isNotifyAccountNumber = true), hệ thống sẽ chuyển đăng ký sang nhận cả ghi có và ghi nợ.

Quy trình​

  1. Gọi API này để gửi yêu cầu đăng ký. Ngân hàng ACB gửi mã OTP tới số điện thoại mobile của chủ tài khoản, kết quả trả về confirmId.
  2. Gọi API Xác nhận số tài khoản với confirmId và otpNumber để hoàn tất. confirmId có hiệu lực trong 4 phút.
POST
URLhttps://open-api.tingee.vn/v1/create-debit

Khởi tạo yêu cầu đăng ký nhận biến động ghi nợ trên tài khoản ACB. Kết quả trả về confirmId dùng cho bước xác nhận OTP.

Header Request​

HeaderBắt buộcMô tả
Content-Type✓application/json
x-client-id✓Mã định danh của đối tác do TINGEE cung cấp.
x-signature✓Chữ ký xác thực HMAC SHA512. Xem thêm tại Cách sinh chữ ký.
x-request-timestamp✓Thời gian gửi request (format: yyyyMMddHHmmssSSS, múi giờ UTC+7)

Body Parameter​

TrườngKiểuBắt buộcMô tả
bankBinstring✓Truyền cố định 970416 (ACB).
accountTypestring✓Loại tài khoản: personal-account, business-account, business-household-account.
accountNumberstring✓Số tài khoản ACB cần đăng ký.
accountNamestring✓Tên chủ tài khoản (viết hoa không dấu).
mobilestring✓Số điện thoại đăng ký với ACB, dùng để nhận OTP. Định dạng: 10 chữ số, bắt đầu bằng 0.
acbUserIdstring~User ID đăng nhập ACB Online / Biz.
Bắt buộc với tài khoản Doanh nghiệp và Hộ kinh doanh.
merchantIdnumber~ID của Merchant
(Bắt buộc nếu kết nối bằng tài khoản Master Merchant).
shopIdnumber✕ID cửa hàng muốn gán tài khoản vào. Nếu để trống, hệ thống tự tạo cửa hàng mới khi xác nhận.
namestring✕Tên gợi nhớ của tài khoản. Mặc định: ACB - {accountNumber} - Ghi nợ.
merchantNamestring✕Tên cửa hàng (dùng khi hệ thống tự tạo cửa hàng mới).
merchantAddressstring✕Địa chỉ cửa hàng (dùng khi hệ thống tự tạo cửa hàng mới).

Ví dụ mã nguồn​

curl --location --request POST 'https://open-api.tingee.vn/v1/create-debit' \
--header 'accept: application/json' \
--header 'x-client-id: YOUR_CLIENT_ID' \
--header 'x-request-timestamp: 20240509154004003' \
--header 'x-signature: YOUR_SIGNATURE' \
--header 'Content-Type: application/json' \
--data '{
"bankBin": "970416",
"accountType": "personal-account",
"accountNumber": "12345678",
"accountName": "NGUYEN VAN A",
"mobile": "0935926988"
}'

Response mẫu​

{
"code": "00",
"message": "Success",
"data": {
"confirmId": "c2a8f3e0-4b1d-4e0a-9a51-7d2f0e6b9c11"
}
}
TrườngKiểuMô tả
codestringMã kết quả (00 = Thành công).
messagestringThông điệp phản hồi.
data.confirmIdstringMã xác nhận, dùng để gọi API Xác nhận số tài khoản trong vòng 4 phút.

Mã lỗi thường gặp​

CodeMô tảHướng xử lý
1059Ngân hàng không hỗ trợ thao tác nàyAPI chỉ áp dụng cho ngân hàng ACB.
1048Số tài khoản đã đăng kýTài khoản đã đăng ký nhận biến động ghi nợ trước đó.
1022Tài khoản đã tồn tạiTài khoản đã đăng ký đủ cả ghi có và ghi nợ.
1031, 1085Cửa hàng không tồn tại hoặc ngừng hoạt độngKiểm tra shopId, hoặc bỏ trống để hệ thống tự tạo cửa hàng.
1037, 1103Thiết bị TingeeBox của cửa hàng không hỗ trợ ngân hàng nàyChọn cửa hàng khác phù hợp với cấu hình thiết bị.
1095, 1096Lỗi merchantId của Master MerchantTruyền merchantId thuộc Master Merchant đang gọi API.
400Dữ liệu không hợp lệ hoặc lỗi từ ACBmessage mô tả chi tiết (ví dụ số điện thoại không khớp với thông tin tại ACB).
90, 91, 92, 97Lỗi xác thực request (timestamp, client-id, chữ ký)Xem Mã lỗi hệ thống.
OthersLỗi khácXem Danh sách mã lỗi.