Yedpay

Description (Show Business Registration)

Show the selected BR. (GET)

End Point

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

Variable

# Name Type Description
1 business_registration_id String Business Registration'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 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

# 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 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": "MJ86QYO3375OEP3RG5",
                    "file_id": "2NMJVPOM5VVO70RL8W",
                    "company_id": "3590G4Z0PX1O76QXV8",
                    "company_name": "xxxxxxx",
                    "type_of_business": 1,
                    "registered_company_name": "xxxxxxx",
                    "br_number": "93788533",
                    "branch_number": "007",
                    "expiry_date": 2020-04-01,
                    "updated_at": 2020-04-01 06:50:22
                }
            }

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

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

v1.34.0-20200317 © The Payment Cards Group Limited. All rights reserved.