Yedpay API Documentation

Description (Company's Logo List using by stores)

Show the logos related with that company's stores. (GET)

Can include the parameter "include" in the url to get more information:

* stores - provide stores related to the logo

End Point

https://api-h2h-staging.yedpay.com/v1/companies/{{company_id}}/logos

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 Document List Success or Fail
2	data	Array	Include partial information of Logos. (url, name, id, etc.)

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	Id of the Document
2	name	String	Name of the Document
3	mime	String	Type of the Image
4	url	String	Public url of the logo

Example Success Response

          {
            "success": true,
            "data": [
                {
                    "id": "JwoMPpKy",
                    "name": "abc.png",
                    "mime": "image/png",
                    "url": "http://dev2.yedpay.com/api/logo/JwoMPpKy"
                },
                {
                    "id": "307XNL8O",
                    "name": "test.jpeg",
                    "mime": "image/jpeg",
                    "url": "http://dev2.yedpay.com/api/logo/307XNL8O"
                }
            ]
        }

Example Error Response

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