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

v1.67.2-20240514 © The Payment Cards Group Limited. All rights reserved.