Chuyển tới nội dung chính

Xác thực

PayerScan API sử dụng xác thực bằng API Key. Mỗi store có API Key riêng biệt, phải được đính kèm trong mọi request.

Header yêu cầu

Tất cả request API phải bao gồm header x-api-key:

x-api-key: YOUR_API_KEY

Request mẫu

curl -X POST https://api.payerscan.com/payment/crypto \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{"merchant_id": "YOUR_MERCHANT_ID", "amount": 10, "callback_url": "https://your-server.com/webhook"}'

Lấy API Key

  1. Đăng nhập vào Merchant Dashboard.
  2. Vào trang Stores.
  3. Tìm store trong bảng — cột API KeyMerchant ID hiển thị trực tiếp.
  4. Nhấn nút Copy để sao chép. Dùng nút Regenerate nếu cần tạo key mới.
Cảnh báo bảo mật
  • Không bao giờ để lộ API Key trong mã client-side (trình duyệt, ứng dụng di động).
  • Chỉ gọi API từ backend server của bạn.
  • Đổi API Key ngay lập tức nếu nghi ngờ bị lộ.

Cách hoạt động

Client → Backend của bạn → PayerScan API

x-api-key header
  1. Backend nhận yêu cầu thanh toán từ client.
  2. Backend gọi PayerScan API kèm header x-api-key.
  3. PayerScan xác minh API Key, kiểm tra store và tài khoản merchant đang hoạt động.
  4. Nếu hợp lệ, request được xử lý và trả về response.

Định dạng lỗi

Khi xác thực thất bại, API trả về JSON:

{
"status": "error",
"message": "Invalid API key. Please check your API key and try again.",
"error_code": "INVALID_API_KEY"
}

Mã lỗi xác thực

HTTP StatusError CodeMô tả
401MISSING_API_KEYHeader x-api-key bị thiếu hoặc rỗng.
401INVALID_API_KEYAPI Key không chính xác hoặc không thuộc store nào đang hoạt động.
403ACCOUNT_INACTIVETài khoản merchant đã bị vô hiệu hóa. Liên hệ hỗ trợ.
403STORE_INACTIVEStore đã bị vô hiệu hóa. Liên hệ hỗ trợ.
500AUTHENTICATION_FAILEDLỗi server nội bộ khi xác thực. Thử lại sau.
mẹo

Nếu bạn nhận được ACCOUNT_INACTIVE hoặc STORE_INACTIVE, vui lòng liên hệ hỗ trợ tại payerscan.com để kích hoạt lại tài khoản.