Yedpay

Description (Company's Barcode List)

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

End Point

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

Variable

# Name Type Description
1 company_id String Company'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 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

# 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
            }
        

v1.19.0-20190522 © The Payment Cards Group Limited. All rights reserved.