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 type_of_business Integer Type of buisness registered via the BR
5 registered_company_name String Company name displayed on the BR
6 br_number String Business Registration number of the company
7 branch_number String Branch number of the company
8 expiry_date String Expiry date of the Business Registration (Format: YYYY-MM-DD)
9 updated_at String Datetime business registration last updated (Format: YYYY-MM-DD hh:mm:ss)

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "M3PG7YQKYPNKDXJRVE",
                    "file_id": "WJ3459ZDL3LOY1RP8V",
                    "company_id": "7E52LGO27DXK68YJDQ",
                    "company_name": "xxxxxxx",
                    "type_of_business": 2,
                    "registered_company_name": "xxxxxxx",
                    "br_number": "35111472",
                    "branch_number": "001",
                    "expiry_date": 2020-07-13,
                    "updated_at": 2020-07-13 01:00:03
                }
            }

Example Error Response

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

v1.36.0-20200706 © The Payment Cards Group Limited. All rights reserved.