Yedpay

Description (Show Store)

Get information related with the Store. (GET)

Can include the parameter daily_balance to get the daily balance company.

Example:

https://api.yedpay.com/v1/stores/{{store_id}}?include=daily_balance

End Point

https://api.yedpay.com/v1/stores/{{store_id}}

Variable

# Name Type Description
1 store_id String Store's ID

Request Header

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

Body

# Name Type Description

Response

# Name Type Description
1 success Boolean Show Targeted Store's Information Success or Fail
2 data Array Include Targeted Store's Information (id, name, phone etc..)

Success Response - data

# Name Type Description
1 id String Id of the Store
2 name String Name of the Store
3 phone String Phone of the Store
4 address String Address of the Store
5 store_identifier String Store Identifier
6 type Integer Store Type:
1 - OFFLINE
2 - ONLINE
7 logo String Logo of the Store
8 logo_url String Url of the Logo
9 created_at String Date when the Store was created "YYYY-mm-dd h:i:s"

Example Success Response

            Normal Response:
            {
                "success": true,
                "data": {
                    "id": "KzoONpJE",
                    "name": "xxxx",
                    "phone": "xxxx",
                    "address": "xxxx",
                    "store_identifier": "LZXE",
                    "type": 1,
                    "logo": "xxxx",
                    "logo_url": "xxxx",
                    "created_at": "2099-01-02 12:00:00"
                }
            }
            
            Include gateways response:
            {
                "success": true,
                "data": {
                    "id": "KzoONpJE",
                    "name": "xxxx",
                    "phone": "xxxx",
                    "address": "xxxx",
                    "logo": "xxxx",
                    "logo_url": "xxxx",
                    "created_at": "2099-01-02 12:00:00",
                    "available_gateways": {
                        "1_1": true,
                        "2_1": true,
                        "4_1": true,
                        "4_2": true,
                        "6_1": true,
                        "8_1": true
                    }
                }
            }
        

Example Error Response

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

v1.30.0-20191113 © The Payment Cards Group Limited. All rights reserved.