Yedpay API Documentation

Description (Show Store BR)

Show the selected Store BR. (GET)

End Point

https://api.yedpay.com/v1/store-brs/{{storebr_id}}

Variable

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

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	ID of the Store BR
2	file_id	String	ID of the Store BR file
3	company_id	String	ID of the Company related to the Store BR
4	company_name	String	Name of the Company related to the Store BR
5	store_id	String	ID of the Store related to the Store BR
6	store_name	String	Name of the Store related to the Store BR
7	br_number	String	Store BR number
8	branch_number	Numeric String	Branch number of the Store BR
9	expiry_date	Date	Expiry date of the Store BR
10	updated_at	DateTime	Datetime business registration last updated

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "6M7V578",
                    "file_id": "6M7V578",
                    "company_id": "6M7V578",
                    "company_name": "xxxxxxx",
                    "store_id": "6M7V578",
                    "store_name": "xxxxxxx",
                    "br_number": "12345678",
                    "branch_number": "000",
                    "expiry_date": "2018-12-03",
                    "updated_at": "2018-12-03 12:12:12"
                }
            }

Example Error Response

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