API Documentation

Tài liệu API đầy đủ và dễ sử dụng cho developer

Phương thức xác thực API

Nhiều API chỉ yêu cầu Bearer Token. Một số API yêu cầu x-merchant-id (sẽ được chỉ định)

Thông tin xác thực API

Không có API Token active

Nhấn Active API để tạo token mới

Lưu ý quan trọng:

Bạn cần kích hoạt API Token để sử dụng các API
Bạn có thể vô hiệu hóa và tạo token mới bất cứ lúc nào

API Endpoints - Tổng quan

POST

API Nạp tiền

Tạo giao dịch nạp tiền vào tài khoản, trả về thông tin chuyển khoản và mã QR

Endpoint

https://api.homeproxy.vn/api/v1/transactions

Headers

Content-Type: application/json
Authorization: Bearer <accessToken>

API này chỉ yêu cầu Bearer Token từ response API đăng nhập

Request Body

amountnumberRequired

Số tiền cần nạp (đơn vị: VNĐ, tối thiểu 10,000)

Ví dụ Request

{
  "amount": 100000
}

Response thành công (200)

Ví dụ Response

{
  "code": "TXN20250113001234",
  "accountName": "ACCOUNT NAME",
  "bankCode": "BANK CODE",
  "bankName": "BANK NAME",
  "accountNumber": "0123456789",
  "amount": 100000,
  "qrCode": "QR CODE",
  "status": "PENDING",
  "description": "Nạp tiền vào tài khoản - TXN20250113001234",
  "createdAt": "2025-01-13T10:30:00.000Z"
}

Tổng hợp Status Code

Các mã trạng thái HTTP được sử dụng trong API

200

Thành công

201

CREATED

Tạo resource thành công

401

UNAUTHORIZED

Chưa xác thực hoặc token không hợp lệ

403

FORBIDDEN

Không có quyền truy cập

404

NOT_FOUND

Không tìm thấy resource

422

UNPROCESSABLE_ENTITY

Dữ liệu không hợp lệ

500

INTERNAL_SERVER_ERROR

Lỗi server nội bộ