Yedpay API Documentation

Description (Company's Barcode List)

Show the list of all the Barcode related with the company. (GET)

Queries

In order to search you can add in the url the follow parameters.

* limit - control the records show on each page (if not set, default load 40 records)
* page - control load the number of the page

Example:

https://api-h2h-staging.yedpay.com/v1/companies/{{company_id}}/barcodes?limit=50&page=1

End Point

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

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 Barcode List Success or Fail
2	data	Array	Include all Barcode Information (barcode_id, value, name, etc..)
3	meta	Array	Include all Pagination's Information (total, count, total_pages, etc..)

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	Id of the Barcode
2	user_id	String	Id of the User
3	store_id	String	Id of the Store
4	company_id	String	Id of the Company
5	name	String	Name of Barcode
6	value	String	Url of the Barcode
7	is_permanent	Boolean	Whether the Barcode Permanent or Not
8	_links	Array	Include Links for: - qrcode

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "e4r94oJx",
                        "user_id": "98p5OrMJ",
                        "store_id": "kJr45vDY",
                        "company_id": "qQvy0rl3",
                        "name": "xxxx",
                        "value": "https://qr.alipay.com/ocx08189ttp4ugzeicjvn23",
                        "is_permanent": true,
                        "_links": {
                            "qrcode": "http://localhost/q/alipay/aHR0cHM6Ly9xci5hbGlwYXkuY29tL29jeDA4MTg5dHRwNHVnemVpY2p2bjIz"
                        }
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 5,
                        "count": 5,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }

Example Error Response

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