Giới thiệu AllPay API

AllPay cung cấp thêm API để bạn có thể gọi và truy vấn giao dịch ngân hàng,... Ngoài ra nếu muốn AllPay tự động gọi đến ứng dụng của bạn, hãy sử dụng webhooks.

API Rate Limits

AllPay giới hạn số lần request đến là 60 lần/ phút. Nếu vượt quá giới hạn này, sẽ trả về lỗi 429 Too Many Requests.

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

• Method: GET
• Endpoint: https://app.allpay.vn/api/transactions/{API_TOKEN}
  • Mặc định sẽ get về 5 giao dịch mới nhất, bạn thể thêm query params limit để tăng số lượng giao dịch, ví dụ ?limit=10
• Response:

{
  "data": [
    {
      "id": 10,
      "transaction_date": "2024-06-01 19:25:28",
      "transaction_id": "5389 - 60339",
      "amount": 500000,
      "description": "020097041506011925282024u8Uk340399.60339.192528.MAI QUOC NHAT chuyen tien",
      "type": "in"
    },
    {
      "id": 11,
      "transaction_date": "2024-06-01 14:53:03",
      "transaction_id": "5189 - 26247",
      "amount": 300000,
      "description": "020097042206011453022024TZFV638661.26247.145303.LE DINH TOAN chuyen khoan",
      "type": "in"
    },
    ...
  ]
}

Key	Giải thích
id	ID giao dịch trên hệ thống AllPay
transaction_date	Ngày giao dịch
transaction_id	ID giao dịch của hệ thống ngân hàng
amount	Số tiền vào hoặc ra
description	Nội dung giao dịch
type	Tiền vào: in, tiền ra: out

API lấy danh sách ngân hàng Việt Nam

• Method: GET
• Endpoint: https://app.allpay.vn/api/banks
• Response:

[
  {
    "id": 1,
    "name": "Ngân hàng TMCP An Bình",
    "code": "ABB",
    "bin": "970425",
    "shortName": "ABBANK",
    "logo": "ABB.png",
    "created_at": null,
    "updated_at": null
  },
  {
    "id": 2,
    "name": "Ngân hàng TMCP Á Châu",
    "code": "ACB",
    "bin": "970416",
    "shortName": "ACB",
    "logo": "ACB.png",
    "created_at": null,
    "updated_at": null
  },
  ...
]

Hướng dẫn lấy API TOKEN

Với mỗi tài khoản sau khi liên kết với AllPay sẽ có một API TOKEN riêng để sử dụng API truy vấn giao dịch

1. Truy cập vào mục danh sách tài khoản đã liên kết

2. Click vào API Token để copy

3. Cấp API TOKEN mới