Yedpay

Description (District List)

Show the list of the District. (GET)

End Point

https://api.yedpay.com/v1/districts

Request Header

Request Header
# Key Value Description
1 Content-Type application/x-www-form-urlencoded x-www-form-urlencoded Format

Body

Body
# Name Type Description

Response

Response
# Name Type Description
1 success Boolean Request device list Success or Fail
2 data Array Include all device's information (id, platform, token)

Success Response - data

Success Response - data
# Name Type Description
1 id String Id of the District
2 district_id Integer Unique identifier of the District
3 name String Name of the District in English
4 name_zh String Name of the District in Traditional Chinese

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "xxxxxx",
                        "district_id": 1,
                        "name": "Kowloon City",
                        "name_zh": "九龍城"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 1,
                        "count": 1,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }
        

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }
        

Available districts

Available districts
District ID Name Name in Chinese
1 Central 中區
2 Sheung Wan 上環
3 Kowloon City 九龍城
4 Yuen Long/Tuen Mun 元朗/屯門
5 North 北區
6 Wan Chai/Causeway Bay 灣仔/銅鑼灣
7 Tai Po 大埔
8 Tin Shui Wai 天水圍
9 Tseung Kwan O 將軍澳
10 North Point/Quarry Bay 北角/鰂魚涌
11 Sha Tin 沙田
12 Hung Hom/To Kwa Wan 紅磡/土瓜灣
13 Tsim Sha Tsui 尖沙咀
14 Yau Ma Tei/Mong Kok 油麻地/旺角
15 Sham Shui Po 深水埗
16 Southern District 南區
17 Kwai Tsing 葵青
18 Kwun Tong 觀塘
19 Islands 離島
20 Wong Tai Sin 黃大仙
21 Sai Kung 西貢
22 Tsuen Wan 荃灣

v1.61.4-20221124 © The Payment Cards Group Limited. All rights reserved.