Bật / tắt webhook
✧ Mở bằng AI
PATCH https://api.pay2s.vn/api/v1/oauth/webhooks/{id}
Xác thực
Bearer. Scope cần có: webhooks:write. Gửi header Authorization: Bearer ACCESS_TOKEN.
Tham số
Định dạng: application/json.
| Trường | Kiểu nhập | Yêu cầu |
|---|---|---|
id |
string | Bắt buộc |
active |
boolean | Bắt buộc |
id trong đường dẫn gồm đúng 64 ký tự hex. Body JSON chỉ gồm active kiểu boolean true/false. Chỉ bật/tắt; không đổi ngân hàng hoặc URL. Webhook phải thuộc kết nối và ứng dụng hiện tại.
Cần gói Pay2S còn hoạt động. Dữ liệu chỉ thuộc tài khoản/ngân hàng được cấp quyền; tài khoản demo chỉ đọc ngân hàng và giao dịch demo.
Cách thử
Mở Playground bằng nút đầu trang, nhập thông tin của ứng dụng hoặc Access Token đã được cấp. Hướng dẫn toàn bộ luồng. Code mẫu cURL, Node.js và PHP nằm dưới form Playground.
Lỗi cần xử lý
invalid_token (401), insufficient_scope hoặc active_plan_required (403), dữ liệu không hợp lệ (422). Xem bảng lỗi.
Request và response tham khảo
Các mẫu dưới đây giữ cấu trúc trường và kiểu dữ liệu. Khóa, chữ ký, URL phiên đã được thay bằng placeholder; danh sách chỉ giữ tối đa hai phần tử và dữ liệu ảnh/PDF/XML dài được rút gọn. Không sao chép placeholder để gọi API thật.
OAuth · Bật / tắt webhook
Đối chiếu mã nguồn backend; giá trị minh họa. id trong đường dẫn gồm đúng 64 ký tự hex. Body JSON chỉ gồm active kiểu boolean true/false. Chỉ bật/tắt; không đổi ngân hàng hoặc URL. Webhook phải thuộc kết nối và ứng dụng hiện tại.
PATCH /api/v1/oauth/webhooks/{id}
Body:
{
"id": "",
"active": false
}
HTTP 200. Response:
{
"success": true
}