Get List Services
GET /openapi/v1/services
API này hoạt động như một "danh bạ cấu hình dịch vụ", liệt kê toàn bộ các cổng thanh toán và dịch vụ (ví dụ: BIDV QR, VCCB QR) hiện đang được kích hoạt cho Merchant.
Truy vấn danh sách các dịch vụ và cổng thanh toán được cấp phép. Kết quả trả về mã service_code cần thiết để sử dụng trong các API khác (như tạo VA).
Không cần mã hóa — Khác với các API khác, API này không yêu cầu mã hóa Payload. Các tham số được truyền trực tiếp trên URL.
- cURL
- Python
- Go
- JavaScript
curl --location '<base_url>/openapi/v1/services?service_type=finance' \
--header 'Partner-Code: 1111111' \
--header 'Authorization: Bearer eyJhbGciOiJ...'
import requests
url = "<base_url>/openapi/v1/services"
params = {"service_type": "finance"}
headers = {
"Partner-Code": "1111111",
"Authorization": "Bearer eyJhbGciOiJ...",
}
response = requests.get(url, headers=headers, params=params)
print(response.text)
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "<base_url>/openapi/v1/services?service_type=finance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("Partner-Code", "1111111")
req.Header.Set("Authorization", "Bearer eyJhbGciOiJ...")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
}
const response = await fetch(
"<base_url>/openapi/v1/services?service_type=finance",
{
method: "GET",
headers: {
"Partner-Code": "1111111",
"Authorization": "Bearer eyJhbGciOiJ...",
},
}
);
const result = await response.text();
console.log(result);
Request
Headers
| Name | Required | Description |
|---|---|---|
Partner-Code | ✅ | Mã khách hàng (TCONNECT cung cấp) |
Authorization | ✅ | Bearer <access_token> |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
service_type | string | Loại dịch vụ (ví dụ: finance) | |
payment_method | string | Phương thức thanh toán (qr, card...) | |
code | string | Mã dịch vụ cụ thể cần lọc | |
limit | number | ✅ | Số lượng bản ghi tối đa |
page | number | ✅ | Số thứ tự trang (bắt đầu từ 1) |
Response
200 — Danh sách dịch vụ
| Field | Type | Description |
|---|---|---|
data | array | Danh sách dịch vụ |
data[].code | string | Mã service_code dùng cho các API khác |
data[].name | string | Tên hiển thị của dịch vụ |
data[].payment_method | string | Phương thức thanh toán hỗ trợ |
data[].allowed_va_creation | boolean | Cờ xác nhận cho phép tạo VA hay không |
data[].provider.provider_code | string | Mã nhà cung cấp |
data[].provider.provider_name | string | Tên nhà cung cấp |
pagination.page | integer | Trang hiện tại |
pagination.limit | integer | Số bản ghi mỗi trang |
pagination.total_items | integer | Tổng số bản ghi |
pagination.total_pages | integer | Tổng số trang |
Response Example
{
"data": [
{
"id": 28,
"code": "bidv-qr",
"name": "Dịch vụ thanh toán QR - BIDV",
"service_type": "finance",
"payment_method": "qr",
"allowed_va_creation": false,
"provider": {
"provider_code": "bidv",
"provider_name": "BIDV"
}
}
],
"pagination": {
"page": 1,
"limit": 10,
"total_items": 1,
"total_pages": 1
}
}