Yedpay

Description (Show Business Registration)

Show the selected BR. (GET)

End Point

https://api.yedpay.com/v1/brs/{{business_registration_id}}

Variable

Variable
# Name Type Description
1 business_registration_id String Business Registration'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 Show Targeted Business Registration's Information Success or Fail
2 data Array Include Targeted Business Registration's Information (id, name, phone etc..)

Success Response - data

Success Response - data
# Name Type Description
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 type_of_business Integer Type of buisness registered via the BR
6 registered_company_name String Company name displayed on the BR
7 br_number String Business Registration number of the company
8 branch_number String Branch number of the company
9 is_expired Boolean Whether the Business Registration is expired
10 expiry_date String Expiry date of the Business Registration (Format: YYYY-MM-DD)
11 status String Status of the Business Registration (ACTIVE or INACTIVE)
12 updated_at String Datetime business registration last updated (Format: YYYY-MM-DD hh:mm:ss)

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "9302L8KR942ZEPRYJ7",
                    "file_id": "8YN319ZPX90OX2DJ7P",
                    "company_id": "6PEQD4O47W6O5VY8W3",
                    "company_name": "xxxxxxx",
                    "type_of_business": 1,
                    "registered_company_name": "xxxxxxx",
                    "br_number": "94592664",
                    "branch_number": "008",
                    "is_expired": "true",
                    "expiry_date": 2022-11-28,
                    "status": "INACTIVE",
                    "updated_at": 2022-11-28 13:12:53
                }
            }

Example Error Response

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

Type of Business List

Empty string will be returned if type_of_business of the BR is null

Type of Business List
Value Name Desription
1 individual Individual
2 body_corporate Body corporate
3 partnership Partnership
4 uncorporated Unincorporated body of persons

v1.61.4-20221124 © The Payment Cards Group Limited. All rights reserved.