OCBOCB

API OCB của SePay giúp bạn truy vấn thông tin giao dịch ngân hàng OCB (Ngân hàng thương mại cổ phần Phương Đông) qua API. Hỗ trợ danh sách giao dịch OCB, lấy thông tin chi tiết một giao dịch cụ thể như: Ngày giao dịch, số tiền, mã tham chiếu, số dư tài khoản, nội dung thanh toán.

Các bước thực hiện:

Bước 1: Đăng ký tài khoản SePay tại my.sepay.vn/register, sau đó thêm tài khoản ngân hàng OCB.

Bước 2: Vào my.sepay.vn -> API Access, tạo API Token. API Token cần được đưa vào header mỗi khi request đến SePay API. Với cấu trúc header:

  • Authorization: Bearer API-TOKEN
  • Content-Type: application/json

Lưu ý: Nếu bạn muốn các bước kết nối ngân hàng được thực hiện ở phía phần mềm của bạn, mà người dùng không phải đăng ký tài khoản tại SePay, hãy tham khảo giải pháp SePay Bank Hub

Bước 3: Bạn có thể sử dụng API OCB như sau:

API OCB để lấy danh sách giao dịch ngân hàng

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

Bạn có thể lọc theo các tham số sau khi gửi API:

account_number Số tài khoản ngân hàng
transaction_date_min Hiển thị các giao dịch được tạo sau thời gian (>=). Định dạng yyyy-mm-dd
transaction_date_max Hiển thị các giao dịch được tạo trước thời gian (<=). Định dạng yyyy-mm-dd
since_id Hiển thị giao dịch từ ID chỉ định (>=)
limit Giới hạn giao dịch trả về. Tối đa 5000, mặc định là 5000.
reference_number Lấy giao dịch theo mã tham chiếu
amount_in Lấy giao dịch tiền vào khớp với
amount_out Lấy giao dịch tiền ra khớp với

Ví dụ API OCB:

API lấy tất cả giao dịch gần nhất

Mặc định chỉ hiển thị 5000 giao dịch gần nhất.

  • GET https://my.sepay.vn/userapi/transactions/list
HTTP/1.1 200 OK
----
{
    "status": 200,
    "error": null,
    "messages": {
        "success": true
    },
    "transactions": [
        {
            "id": "49682",
            "bank_brand_name": "OCB",
            "account_number": "0029100058237009",
            "transaction_date": "2024-05-05 19:59:48",
            "amount_out": "0.00",
            "amount_in": "18067000.00",
            "accumulated": "1200541768.00",
            "transaction_content": "NGUYEN TIEN LUAT chuyen tien...",
            "reference_number": null,
            "code": null,
            "sub_account": null,
            "bank_account_id": "21"
        },
        {
            "id": "49582",
            "bank_brand_name": "OCB",
            "account_number": "0071000899999",
            "transaction_date": "2024-05-05 17:59:47",
            "amount_out": "0.00",
            "amount_in": "13646000.00",
            "accumulated": "1384635819.00",
            "transaction_content": "DINH NHU TOAN chuyen tien...",
            "reference_number": null,
            "code": null,
            "sub_account": null,
            "bank_account_id": "20"
        },
        {
            "id": "49465",
            "bank_brand_name": "OCB",
            "account_number": "0029100058237009",
            "transaction_date": "2024-05-05 15:59:47",
            "amount_out": "0.00",
            "amount_in": "21782000.00",
            "accumulated": "1182474768.00",
            "transaction_content": "NGUYEN TIEN LUAT chuyen tien...",
            "reference_number": null,
            "code": null,
            "sub_account": null,
            "bank_account_id": "21"
        }
    ]
}

API lấy giao dịch sau 08h00 ngày 30/04/2023 và trước 12h00 ngày 02/05/2023.

  • GET https://my.sepay.vn/userapi/transactions/list?transaction_date_min=2024-04-30 08:00:00&transaction_date_max=2024-05-02 12:00:00

API  lấy giao dịch từ ID 49050 trở về sau.

  • GET https://my.sepay.vn/userapi/transactions/list?since_id=49050

API  lấy 20 giao dịch gần đây của tài khoản ngân hàng số 0029100058237009.

  • GET https://my.sepay.vn/userapi/transactions/list?account_number=0029100058237009&limit=20

API  lọc giao dịch có mã tham chiếu là 171158.050523.060001

  • GET https://my.sepay.vn/userapi/transactions/list?reference_number=171158.050523.060001

API  lấy các giao dịch với số tiền chuyển vào là 16,848,000

  • GET https://my.sepay.vn/userapi/transactions/list?amount_in=16848000

API OCB đếm số lượng giao dịch 

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

Đếm số lượng giao dịch. Bạn có thể lọc theo các tham số sau:

account_number Số tài khoản ngân hàng
transaction_date_min Hiển thị các giao dịch được tạo sau thời gian (>=). Định dạng yyyy-mm-dd
transaction_date_max Hiển thị các giao dịch được tạo trước thời gian (<=). Định dạng yyyy-mm-dd
since_id Hiển thị giao dịch từ ID chỉ định (>=)

Ví dụ đếm tổng số lượng giao dịch.

  • GET https://my.sepay.vn/userapi/transactions/count
HTTP/1.1 200 OK
----
{
    "status": 200,
    "error": null,
    "messages": {
        "success": true
    },
    "count_transactions": 2322
}

Ví dụ đếm tổng số lượng giao dịch của tài khoản ngân hàng 0029100058237009.

  • GET https://my.sepay.vn/userapi/transactions/count?account_number=0029100058237009

API OCB lấy chi tiết một giao dịch 

GET https://my.sepay.vn/userapi/transactions/details/{transaction_id}

Lấy chi tiết thông tin một giao dịch theo ID

Ví dụ:

  • GET https://my.sepay.vn/userapi/transactions/details/48673
HTTP/1.1 200 OK
----
{
    "status": 200,
    "error": null,
    "messages": {
        "success": true
    },
    "transaction": {
        "id": "48673",
        "transaction_date": "2024-05-04 11:59:47",
        "account_number": "0029100058237009",
        "sub_account": null,
        "amount_in": "19689000.00",
        "amount_out": "0.00",
        "accumulated": "1128200335.00",
        "code": null,
        "transaction_content": "TRAN THIEN THAO chuyen tien...",
        "reference_number": null,
        "bank_brand_name": "OCB",
        "bank_account_id": "21"
    }
}

Xem thêm API cho các ngân hàng khác tại đây.

5/5 - (7 votes)