Yedpay

Description (Company's Document List)

Show the business registration related with the company. (GET)

End Point

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

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 Document List Success or Fail
2 data Array Include all Business Registration Information (id, file_id etc..)

Success Response - data

1 id String ID of the BR
2 file_id String ID of the BR file
3 company_id String ID of the company related to the BR
4 company_name String Name of the company related to the BR
5 br_number String Business Registration number of the company
6 branch_number Numeric String Branch number of the company
7 expiry_date Date Expiry date of the Business Registration
8 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",
                    "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
            }
        

v1.30.0-20191113 © The Payment Cards Group Limited. All rights reserved.