API Giao dịch
Tài liệu về cách sử dụng API giao dịch thông qua OAuth2 trong SePay.
Giới thiệu
API giao dịch của SePay cho phép bạn truy vấn thông tin về các giao dịch ngân hàng đã phát sinh. Bạn có thể lấy danh sách giao dịch, lọc theo nhiều tiêu chí khác nhau và xem chi tiết từng giao dịch.
Để sử dụng API này, bạn cần có quyền
transaction:readtrong phạm vi (scope) của Access Token.
Lấy danh sách giao dịch
GET
/api/v1/transactionsAuthorization: Bearer {YOUR_ACCESS_TOKEN}
Endpoint này trả về danh sách giao dịch thuộc công ty của bạn. Bạn có thể lọc kết quả theo nhiều tiêu chí khác nhau.
Quyền yêu cầu
- Scope:
transaction:read - Quyền người dùng: Giao dịch ngân hàng (Xem danh sách giao dịch)
- Scope:
Tham số truy vấn
Tên Loại Bắt buộc Mô tả bank_account_idinteger Không bắt buộc Lọc theo ID tài khoản ngân hàngaccount_numberstring Không bắt buộc Lọc theo số tài khoản ngân hàngreference_numberstring Không bắt buộc Lọc theo mã tham chiếu giao dịchfrom_datedate Không bắt buộc Lọc giao dịch từ ngày (định dạng YYYY-MM-DD)to_datedate Không bắt buộc Lọc giao dịch đến ngày (định dạng YYYY-MM-DD)amount_outnumeric Không bắt buộc Lọc theo số tiền chuyển raamount_innumeric Không bắt buộc Lọc theo số tiền chuyển vàopageinteger Không bắt buộc Số trang, bắt đầu từ 1limitinteger Không bắt buộc Số lượng kết quả trên mỗi trang
Mã lỗi
- Dưới đây là các mã lỗi có thể gặp khi sử dụng API giao dịch:
| Mã Http | Mã lỗi | Mô tả |
|---|---|---|
| 400 | validation_error | Lỗi xác thực dữ liệu đầu vào |
| 401 | unauthorized | Token không hợp lệ hoặc hết hạn |
| 403 | forbidden | Không có quyền truy cập vào tài nguyên này |