API Tài khoản ngân hàng

API tài khoản ngân hàng giúp lấy danh sách các tài khoản ngân hàng đã được thêm vào SePay. Truy vấn thông tin chi tiết từng tài khoản, số dư từng tài khoản.

Bạn có thể làm gì với API này?

SePay cho phép bạn thực hiện những truy vấn sau với Tài khoản ngân hàng:

Lấy chi tiết một tài khoản ngân hàng

GET https://my.sepay.vn/userapi/bankaccounts/details/{bank_account_id}

Lấy chi tiết thông tin một tài khoản ngân hàng theo ID

Ví dụ:

HTTP/1.1 200 OK
----
{
    "status": 200,
    "error": null,
    "messages": {
        "success": true
    },
    "bankaccount":{
        "id": "18",                                // ID của tài khoản ngân hàng trên SePay
        "account_holder_name": "NGUYEN VAN A",     // Tên chủ tài khoản
        "account_number": "0071000899999",         // Số tài khoản
        "accumulated": "2625076186.00",            // Số dư (VND)
        "last_transaction": "2023-08-09 07:59:48", // Giao dịch gần nhất lúc
        "label": "",                                // Tên gợi nhớ
        "active": "1",                              // 1 là tài khoản đang hoạt động, 0 là tạm khóa
        "created_at": "2023-02-12 20:05:47",        // Ngày tạo tài khoản trên SePay
        "bank_short_name": "Vietcombank",           // Tên ngắn của ngân hàng (short_name)
        "bank_full_name": "Ngân hàng TMCP Ngoại Thương Việt Nam", // Tên đầy đủ của ngân hàng
        "bank_bin": "970436",                       // BIN code của ngân hàng
        "bank_code": "VCB"                          // Bank code của ngân hàng
    }
}

Lấy danh sách tài khoản ngân hàng

GET https://my.sepay.vn/userapi/bankaccounts/list

Lấy danh sách tài khoản ngân hàng. Bạn có thể lọc theo các tham số sau:

short_name Tên ngân hàng, tương ứng với trường short_name tại đây
last_transaction_date_min Lọc tài khoản có giao dịch gần nhất sau thời gian (>=). Định dạng yyyy-mm-dd
last_transaction_date_max Lọc tài khoản có giao dịch gần nhất trước thời gian (<=). Định dạng yyyy-mm-dd
since_id Hiển thị tài khoản ngân hàng từ ID chỉ định (>=)
limit Giới hạn tài khoản ngân hàng trả về. Mặc định là 100.
accumulated_min Lọc tài khoản ngân hàng có số dư lớn hơn hoặc bằng (>=)
accumulated_max Lọc tài khoản ngân hàng có số dư nhỏ hơn hoặc bằng (>=)

Lấy tất cả tài khoản ngân hàng. Mặc định chỉ hiển thị 100 tài khoản ngân hàng được thêm gần nhất.

HTTP/1.1 200 OK
----
{
    "status": 200,
    "error": null,
    "messages": {
        "success": true
    },
    "bankaccounts":[
    {
        "id": "25",
        "account_holder_name": "NGUYEN THI B",
        "account_number": "102871015203",
        "accumulated": "2525493.00",
        "last_transaction": "2023-02-16 16:16:00",
        "label": "",
        "active": "1",
        "created_at": "2023-02-16 15:57:26",
        "bank_short_name": "VietinBank",
        "bank_full_name": "Ngân hàng TMCP Công Thương Việt Nam",
        "bank_bin": "970415",
        "bank_code": "ICB"
        },
        {
        "id": "24",
        "account_holder_name": "NGUYEN VAN A",
        "account_number": "084704070006848",
        "accumulated": "551564.00",
        "last_transaction": "2023-02-16 15:38:50",
        "label": "",
        "active": "1",
        "created_at": "2023-02-16 15:33:46",
        "bank_short_name": "HDBank",
        "bank_full_name": "Ngân hàng TMCP Phát triển Thành phố Hồ Chí Minh",
        "bank_bin": "970437",
        "bank_code": "HDB"
        },
        {
        "id": "21",
        "account_holder_name": "TRAN VAN VIET",
        "account_number": "105851038",
        "accumulated": "46892169.00",
        "last_transaction": "2023-04-21 15:25:47",
        "label": "",
        "active": "1",
        "created_at": "2023-02-16 11:26:58",
        "bank_short_name": "VPB",
        "bank_full_name": "Ngân hàng TMCP Việt Nam Thịnh Vượng",
        "bank_bin": "970432",
        "bank_code": "VPB"
        },
        {
        "id": "19",
        "account_holder_name": "CONG TY TNHH DEMO",
        "account_number": "0071000888888",
        "accumulated": "1777283273.00",
        "last_transaction": "2023-08-09 11:59:47",
        "label": "Cty Demo",
        "active": "1",
        "created_at": "2023-02-12 21:09:49",
        "bank_short_name": "Vietcombank",
        "bank_full_name": "Ngân hàng TMCP Ngoại Thương Việt Nam",
        "bank_bin": "970436",
        "bank_code": "VCB"
        },
        {
        "id": "18",
        "account_holder_name": "NGUYEN VAN A",
        "account_number": "0071000899999",
        "accumulated": "2625076186.00",
        "last_transaction": "2023-08-09 07:59:48",
        "label": "",
        "active": "1",
        "created_at": "2023-02-12 20:05:47",
        "bank_short_name": "Vietcombank",
        "bank_full_name": "Ngân hàng TMCP Ngoại Thương Việt Nam",
        "bank_bin": "970436",
        "bank_code": "VCB"
        }
    ]
}

Lấy tài khoản ngân hàng có giao dịch sau 08h00 ngày 30/04/2023 và trước 12h00 ngày 02/05/2023.

Lấy tài khoản ngân hàng từ ID 20 trở về sau.

Lấy 20 tài khoản của ngân hàng Vietcombank.

Lọc tài khoản ngân hàng có số dư >= 1 VND

Đếm số lượng tài khoản ngân hàng

GET https://my.sepay.vn/userapi/bankaccounts/count

Đếm số lượng tài khoản ngân hàng. Bạn có thể lọc theo các tham số sau:

short_name Tên ngân hàng, tương ứng với trường short_name tại đây
last_transaction_date_min Lọc tài khoản có giao dịch gần nhất sau thời gian (>=). Định dạng yyyy-mm-dd
last_transaction_date_max Lọc tài khoản có giao dịch gần nhất trước thời gian (<=). Định dạng yyyy-mm-dd
since_id Hiển thị tài khoản ngân hàng từ ID chỉ định (>=)
accumulated_min Lọc tài khoản ngân hàng có số dư lớn hơn hoặc bằng (>=)
accumulated_max Lọc tài khoản ngân hàng có số dư nhỏ hơn hoặc bằng (>=)

Đếm tổng số lượng tài khoản ngân hàng đang có.

HTTP/1.1 200 OK
----
{
    "status": 200,
    "error": null,
    "messages": {
        "success": true
    },
    "count_bankaccounts": 9
}

Đếm tổng số lượng tài khoản ngân hàng của tài khoản ngân hàng có số dư >=1.