Yedpay

Description (Company's Store List)

Show the information of the store related with that company. (GET)

Can include the follow parameters separated by comma "," adding the parameter "include" in the url to get more information:

  • * daily_balance - provide the daily balance of the store
  • * logo_info - provides Logo information
  • * store_br - provides Store BR information
  • * district - provides District information
To include available gateways for creating transactions, add parameter "include_gateways" with value 1 / true

Example:

https://api.yedpay.com/v1/companies/{{company_id}}/stores?include=daily_balance,logo_info&include_gateways=1

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/stores

Variable

Variable
# Name Type Description
1 company_id String Company's ID

Request Header

Request Header
# Key Value Description
1 Authorization Bearer {{access_token}} Login Token

Body

Body
# Name Type Description

Response

Response
# Name Type Description
1 success Boolean Request Success or Fail
2 data Array Include all Store's Information (ID, Name, Phone etc..)
3 meta Array Include all pagination's Information (total, count, per_page etc..)

Success Response - data

Success Response - data
# Name Type Description
1 id String Id of the Store
2 company_id String Id of the Company
3 company_name String Name of the Company
4 name String Name of the Store
5 english_name String English name of the Store
6 phone String Phone of the Store
7 district_id Integer Unique Identifier of the District
8 address String Address of the Store
9 store_identifier String Store Identifier
10 type Integer Store Type:
1 - OFFLINE
2 - ONLINE
11 logo String Logo of the Store
12 logo_url String Url of the Logo
13 created_at String Date when the Store was created "YYYY-mm-dd h:i:s"

Example Success Response

            Normal Response:
            {
                "success": true,
                "data": [
                    {
                        "id": "JwoMPpKy",
                        "company_id": "I19OID2P",
                        "company_name": "xxxxxxxxx",
                        "name": "xxxx",
                        "english_name": "xxxx",
                        "phone": "7287381",
                        "district_id": 1,
                        "address": "Kowloon",
                        "store_identifier": "LZXE",
                        "type": 1,
                        "logo": "xxxxxxxxxx",
                        "logo_url": "xxxxxxxxxx",
                        "created_at": "2099-01-02 12:00:00"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 1,
                        "count": 1,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }

            Include Available Gateway Response:
            {
                "success": true,
                "data": [
                    {
                        "id": "JwoMPpKy",
                        "company_id": "I19OID2P",
                        "company_name": "xxxxxxxxx",
                        "name": "xxxx",
                        "english_name": "xxxx",
                        "phone": "7287381",
                        "district_id": 2,
                        "address": "Kowloon",
                        "logo": "xxxxxxxxxx",
                        "logo_url": "xxxxxxxxxx",
                        "created_at": "2099-01-02 12:00:00",
                        "active_gateways": {
                            "1_1": false,
                            "2_1": true,
                            "4_1": true,
                            "4_2": true,
                            "6_1": true,
                            "8_1": true
                        }
                    }
                ],
                "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
            }
        

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