TÀI LIỆU API

  1. Trước hết để sử dụng API bạn phải tạo thông tin kết nối API tại https://www.vnkash.com/api.html.
  2. PHƯƠNG PHÁP XÁC THỰC TRUY VẪN:
    1. Thông tin xác thực yêu cầu truy vấn gửi đến bằng phường thức HTTP Headers.
    2. Kết quả trả về dưới dạng JSON.
    3. Khi có lỗi phát sinh trả về: {"error": 1}.
    4. KEY: Khóa Công Khai. Quý khách lấy tại thông tin kết nối API.
      Ví dụ: VYTTA-ZCY9N-DBM0A-DDOHN-IPOUU-ZSRIL-V9EKT
    5. SIGNATURE: Chữ ký. Tất cả dữ liệu data "thamso1=dulieu1&thamso2=dulieu2&Nonce=1234567890" được ký bởi Khóa Bí Mật sử dụng thuật toán SHA512.
      Ví dụ: 9c6135179f9b57624faebbaa31add9e2...bd1e227a7280b3e04e4
    6. Nonce: Nhận giá trị từ 0.01 đến 99999999999999.99. Lần gọi sau Nonce phải lớn hơn gọi lần trước. Nếu đạt đến 99999999999999.99 bạn phải xóa API cũ và tạo lại API mới.
  3. TRA CỨU SỐ DƯ TÀI KHOẢN:
    1. Địa chỉ nhận truy vấn: https://api.vnkash.com/v1/balance.json.
    2. Tham số:
      Tham số Kiểu dữ liệu Yêu cầu Giá trị có thể nhận
      Không có tham số
    3. Bảng Mã Lỗi:
      Mã Lỗi Mô tả
      1 Tài khoản sở hữu API đang bị khóa.
      2 Địa chỉ IP truy vấn không có trong danh sách cho phép.
      3 Chữ ký không hợp lệ.
      4 Tham số Nonce không hợp lệ.
      5 Tài khoản API không được phép tra cứu số dư.
      6 Tài khoản API đang khóa.
      7 Khóa công khai không tồn tại.
      8 Thiếu tham số KEY hoặc SIGNATURE.
    4. Kết quả trả về:
      [
                  {
                      "code":"VND",
                      "name":"Vietnam Dong",
                      "sign":"\u20ab",
                      "decimal":"0",
                      "balance":370000
                  }
              ]
                                  
  4. KIỂM TRA TÊN NGƯỜI DÙNG:
    1. Địa chỉ nhận truy vấn: https://api.vnkash.com/v1/name.json.
    2. Tham số:
      Tham số Kiểu dữ liệu Yêu cầu Giá trị có thể nhận
      account Chuỗi Số điện thoại hoặc địa chỉ hòm thư điện tử.
    3. Bảng Mã Lỗi:
      Mã Lỗi Mô tả
      1 Tài khoản người dùng không tồn tại.
      2 Địa chỉ IP truy vấn không có trong danh sách cho phép.
      3 Chữ ký không hợp lệ.
      4 Tham số Nonce không hợp lệ.
      5 Tài khoản API không được phép kiểm tra tài khoản người dùng.
      6 Tài khoản API đang khóa.
      7 Khóa công khai không tồn tại.
      8 Thiếu tham số KEY hoặc SIGNATURE.
    4. Kết quả trả về:
      {
                  "account":"840909090909",
                  "name":"Nguyen Hong Duc"
              }
                                  
  5. KIẾM TRA TÀI KHOẢN NGÂN HÀNG:
    1. Địa chỉ nhận truy vấn: https://api.vnkash.com/v1/bank.json.
    2. Tham số:
      Tham số Kiểu dữ liệu Yêu cầu Giá trị có thể nhận
      payment Chuỗi ACB - CTG - DAB - VCB - CARD
      account Chuỗi Số tài khoản ngân hàng hoặc số thẻ.
    3. Bảng Mã Lỗi:
      Mã Lỗi Mô tả
      1 Tài khoản ngân hàng đang tạm khóa.
      2 Số tài khoản ngân hàng / số thẻ không đúng.
      3 Mất kết nối với ngân hàng.
      4 Số tài khoản không đúng định dạng.
      5 Tham số payment không hợp lê.
      6 Thiếu tham số account.
      7 Tham số payment không hợp lệ hoặc đang tạm khóa.
      8 Thiếu tham số payment.
      9 Địa chỉ IP truy vấn không có trong danh sách cho phép.
      10 Chữ ký không hợp lệ.
      11 Tham số Nonce không hợp lệ.
      12 Tài khoản API không được phép kiểm tra tài khoản ngân hàng.
      13 Tài khoản API đang khóa.
      14 Khóa công khai không tồn tại.
      15 Thiếu tham số KEY hoặc SIGNATURE.
    4. Kết quả trả về:
      {
                  "payment":"DAB",
                  "account":"0102030405",
                  "name":"LE DUONG SY MY"
              }
                                  
  6. TẠO ĐƠN NẠP TIỀN:
    1. Địa chỉ nhận truy vấn: https://api.vnkash.com/v1/deposit.json.
    2. Tham số:
      Tham số Kiểu dữ liệu Yêu cầu Giá trị có thể nhận
      currency Chuỗi Mã tiền tệ
      amount Số Số tiền muốn nạp.
      payment Chuỗi ACB - CTG - DAB - VCB
      callback Chuỗi Không URL nhận kết quả khi giao dịch hoàn tất.
    3. Bảng Mã Lỗi:
      Mã Lỗi Mô tả
      1 Tạo đơn nạp tiền không thành công.
      2 Không cho phép nạp tiền bằng cổng thanh toán hiện tại.
      3 Số tiền muốn nạp nhỏ hơn mức quy định.
      4 Mã tiền tệ không đúng.
      5 Tài khoản người dùng đang tạm khóa chức năng nạp tiền.
      6 Tài khoản người dùng đang tạm khóa.
      7 Địa chỉ IP truy vấn không có trong danh sách cho phép.
      8 Chữ ký không hợp lệ.
      9 Tham số Nonce không hợp lệ.
      10 Tài khoản API không được phép kiểm tra tài khoản ngân hàng.
      11 Tài khoản API đang khóa.
      12 Khóa công khai không tồn tại.
      13 Thiếu tham số KEY hoặc SIGNATURE.
    4. Kết quả trả về:
      {
                  "success":true,
                  "deposit":{
                      "id":1,
                      "payee":"0102030405",
                      "name":"LE DUONG SY MY",
                      "description":"1-56665F8E445C0"
                  }
              }
                                  
  7. KIỂM TRA LỊCH SỬ GIAO DỊCH:
    1. Địa chỉ nhận truy vấn: https://api.vnkash.com/v1/history.json.
    2. Tham số:
      Tham số Kiểu dữ liệu Yêu cầu Giá trị có thể nhận
      currency Chuỗi Không Mã tiền tệ.
      order Chuỗi Không Mã đơn hàng của đối tác.
      batch Chuỗi Không Mã tham chiếu.
      record Số Nguyên Không Số lượng bản ghi trả về. Tối đa không quá 250.
      from - to Chuỗi Không Chuỗi thời gian. Định dạng: Y-m-d H:i:s. Ví dụ: 2015-12-31 15:11:00
    3. Bảng Mã Lỗi:
      Mã Lỗi Mô tả
      1 Tài khoản người dùng đang tạm khóa chức năng xem lịch sử giao dịch.
      2 Tài khoản người dùng đang tạm khóa.
      3 Địa chỉ IP truy vấn không có trong danh sách cho phép.
      4 Chữ ký không hợp lệ.
      5 Tham số Nonce không hợp lệ.
      6 Tài khoản API không được phép kiểm tra tài khoản ngân hàng.
      7 Tài khoản API đang khóa.
      8 Khóa công khai không tồn tại.
      9 Thiếu tham số KEY hoặc SIGNATURE.
    4. Kết quả trả về:
      [
                  {
                      "batch":"56602A4DAA807",
                      "source":"WEB",
                      "type":"DEPOSIT",
                      "currency":"VND",
                      "amount":"200000.00",
                      "fee":"0.00",
                      "description":{
                          "index":1
                      },
                      "date":"03\/12\/2015 11:41"
                  },
                  ...
                  {
                      "batch":"5666476D4C24D",
                      "source":"WEB",
                      "type":"DEPOSIT",
                      "currency":"VND",
                      "amount":"50000.00",
                      "fee":"0.00",
                      "description":{
                          "index":10
                      },
                      "date":"08\/12\/2015 02:58"
                  }
              ]
                                  
  8. RÚT TIỀN VỀ TÀI KHOẢN NGÂN HÀNG:
    1. Địa chỉ nhận truy vấn: https://api.vnkash.com/v1/withdraw.json.
    2. Tham số:
      Tham số Kiểu dữ liệu Yêu cầu Giá trị có thể nhận
      account Chuỗi Số tài khoản ngân hàng / số thẻ.
      name Chuỗi Tên của tài khoản ngân hàng / số thẻ.
      amount Số Số tiền muốn rút.
      currency Chuỗi Mã tiền tệ.
      payment Chuỗi ACB - CTG - DAB - VCB - CARD.
      callback Chuỗi Không URL nhận kết quả khi giao dịch hoàn tất.
    3. Bảng Mã Lỗi:
      Mã Lỗi Mô tả
      1 Rút tiền không thành công.
      2 Số dư tài khoản không đủ để thực hiện giao dịch.
      3 Không kiểm tra được số dư.
      4 Số tiền muốn rút nhỏ hơn mức tối thiểu quy định.
      5 Số tiền là một số thập phân.
      6 Số tài khoản ngân hàng không hợp lệ.
      7 Mã tiền tệ không đúng.
      8 Tài khoản người dùng đang tạm khóa chức năng rút tiền.
      9 Tài khoản người dùng đang tạm khóa.
      10 Địa chỉ IP truy vấn không có trong danh sách cho phép.
      11 Chữ ký không hợp lệ.
      12 Tham số Nonce không hợp lệ.
      13 Tài khoản API không được phép kiểm tra tài khoản ngân hàng.
      14 Tài khoản API đang khóa.
      15 Khóa công khai không tồn tại.
      16 Thiếu tham số KEY hoặc SIGNATURE.
    4. Kết quả trả về:
      {
                  "success":true,
                  "withdrawal":{
                      "id":1,
                      "amount":100000,
                      "currency":"VND",
                      "payment":"DAB",
                      "account":"0102030405",
                      "name":"LE DUONG SY MY"
                  }
              }
                                  
  9. CHUYỂN TIỀN ĐẾN TÀI KHOẢN KHÁC:
    1. Địa chỉ nhận truy vấn: https://api.vnkash.com/v1/transfer.json.
    2. Tham số:
      Tham số Kiểu dữ liệu Yêu cầu Giá trị có thể nhận
      account Chuỗi Số điện thoại hoặc hòm thư.
      amount Số Số tiền muốn chuyển.
      currency Chuỗi Mã tiền tệ.
      memo Chuỗi Nội dung chuyển tiền.
    3. Bảng Mã Lỗi:
      Mã Lỗi Mô tả
      1 Chuyển tiền không thành công.
      2 Số dư tài khoản không đủ để thực hiện giao dịch.
      3 Không kiểm tra được số dư.
      4 Tài khoản người nhận đang tạm khóa chức năng nhận tiền.
      5 Tài khoản người nhận không đúng hoặc đang tạm khóa.
      6 Tài khoản người gửi đang tạm khóa chức năng gửi tiền.
      7 Tài khoản người gửi đang tạm khóa.
      8 Số tiền là một số thập phân.
      9 Mã tiền tệ không đúng.
      10 Địa chỉ IP truy vấn không có trong danh sách cho phép.
      12 Chữ ký không hợp lệ.
      12 Tham số Nonce không hợp lệ.
      13 Tài khoản API không được phép kiểm tra tài khoản ngân hàng.
      14 Tài khoản API đang khóa.
      15 Khóa công khai không tồn tại.
      16 Thiếu tham số KEY hoặc SIGNATURE.
    4. Kết quả trả về:
      {
                  "date":"08\/12\/2015 07:17",
                  "memo":"Mua Hang Online",
                  "currency":"VND",
                  "amount":100000,
                  "account":"84909090909",
                  "batch":"566683F44C47B",
                  "fee":0
              }
                                  
  10. MÃ NGUỒN MẪU : C# - Tài Về PHP - Tài Về