Yedpay

Description (Company Store BR List)

Show the Store Business Registration List of selected company. (GET)

Can include the follow parameters separated by comma "," adding the parameter "include" in the url to get more information:

  • * file - provide information of the corresponding file

Example:

https://api.yedpay.com/v1/companies/{{company_id}}/store-brs?include=file

End Point

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

Request Header

# Key Value Description
1 Authorization Bearer {{access_token}} Login Token

Body

# Name Type Description
1 company_id String ID of the Company

Response

# Name Type Description
1 success Boolean Request Store BR List Success or Fail
2 data Array Include all Store BR Information (id, file_id 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 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": "xxxxxx",
                        "file_id": "xxxxxx",
                        "company_id": "xxxxxx",
                        "company_name": "xxxxxxx",
                        "store_id": "xxxxxx",
                        "store_name": "xxxxxxx",
                        "br_number": "12345678",
                        "branch_number": "000",
                        "expiry_date": "2018-12-03",
                        "updated_at": "2019-01-30 15:48:10"
                    },
                    {
                        "id": "xxxxxx",
                        "file_id": "xxxxxx",
                        "company_id": "xxxxxx",
                        "company_name": "xxxxxxx",
                        "store_id": "xxxxxx",
                        "store_name": "xxxxxxx",
                        "br_number": "87654321",
                        "branch_number": "000",
                        "expiry_date": "2018-12-03",
                        "updated_at": "2019-01-30 15:48:10"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 2,
                        "count": 2,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }
        

Example Error Response

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

v1.30.1-20191128 © The Payment Cards Group Limited. All rights reserved.