Yedpay API Documentation

Description (Show Store)

Get information related with the Store. (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/stores/{{store_id}}?include=daily_balance

End Point

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

Variable

Variable
#	Name	Type	Description
1	store_id	String	Store'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	Show Targeted Store's Information Success or Fail
2	data	Array	Include Targeted Store's Information (id, name, phone etc..)

Success Response - data

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	district_id	Integer	Unique Identifier of the District
5	address	String	Address of the Store
6	store_identifier	String	Store Identifier
7	type	Integer	Store Type: 1 - OFFLINE 2 - ONLINE
8	logo	String	Logo of the Store
9	logo_url	String	Url of the Logo
10	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",
                    "district_id": 2,
                    "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",
                    "district_id": 2,
                    "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
            }