Description (Show Company)
Get information related with the Company. (GET)Can include the parameter daily_balance to get the daily balance company.
Example:
https://api.yedpay.com/v1/companies/{{company_id}}?include=daily_balance
End Point
https://api.yedpay.com/v1/companies/{{company_id}}
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 |
---|---|---|---|
1 | lang | String | Language code for MCC (default: en) Available language code: en,zh |
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Show Targeted Company's Information Success or Fail |
2 | data | Array | Include Targeted Company's Information (company_id, identifier, address etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String(64) | Id of the Company |
2 | identifier | String(191) | Identifier of the Company |
3 | merchant_identifier | String(64) | Merchant Identifier of the Company |
4 | name | String(191) | Name of the Company |
5 | english_name | String(255) | English Name of the Company |
6 | mcc | String(4) | Merchant Category Code of the Company |
7 | mcc_description | String(255) | Merchant Category Code Description of the Company |
8 | merchant_type | String | Type of the Merchant (INDIVIDUAL or ENTERPRISE) |
9 | merchant_sub_type | String | (Optional) Subtype of the Merchant (TAXI or HAWKER) |
10 | operation_id | String(20) | (Optional) Operation ID of Taxi |
11 | business_type | String(255) | Business Type |
12 | business_commencement_date | Date | Business commencement date of the company (Format: YYYY-mm-dd) |
13 | has_document | Boolean | Whether the company has any document uploaded |
14 | address | String(65,535) | Address of the Company |
15 | website | Url(100) | Business website of the Company |
16 | contact_name | String(191) | Name of the Contact Person |
17 | contact_mobile | Numeric String(191) | Mobile of the Contact Person |
18 | business_description | String(255) | Business description of the Company |
19 | status | String | Status of the Company |
20 | auto_settlement | Boolean | Status of auto settlement (true/false) |
21 | created_at | Datetime | Date when the company was created "YYYY-mm-dd h:i:s" |
22 | settlement_delay | Boolean | Settlement Delay |
23 | business_registration | Array | Business Registration information of the company |
Business Registration detail response
# | Name | Type | Description |
---|---|---|---|
1 | id | String(64) | ID of the Business Registration (Admin ONLY) |
2 | file_id | String(64) | File Id of the Business Registration (Admin ONLY) |
3 | company_id | String(64) | ID of the Company (Admin ONLY) |
4 | company_name | String(191) | Company Name (Admin ONLY) |
5 | br_number | Numeric String(20) | Business Registration number of the company |
6 | branch_number | Numeric String(3) | Branch number of the company |
7 | expiry_date | Date | Expiry Date of the BR(Format: YYYY-mm-dd) |
8 | updated_at | Date | Last update date of the BR(Format: YYYY-mm-dd) (Admin ONLY) |
Possible company status
# | Status | Description |
---|---|---|
0 | pending_update | Pending update - users are allowed to upload br and contract |
1 | verified | Verified - users are not allowed to upload br and contract |
2 | expiring | Expiring - Indicating BR will expire after 2 months |
3 | expired | Expired - Indicating BR has expired already |
Example Success Response
{ "success": true, "data": { "id": "JwoMPpKy", "identifier": "xxxx", "merchant_identifier": "xxxx", "name": "xxxx", "mcc": "xxxx", "mcc_description": "xxxxxxx", "business_commencement_date": "2018-01-01", "has_document": true, "address": "xxxx", "website": "http://xxxxxxx", "contact_name": "xxxx", "contact_mobile": "xxxxxxxx", "business_description": "xxxxxxxxxx", "status": "verified", "auto_settlement": true, "created_at": "2099-01-02 12:00:00" "business_registration": { "br_number": "xxxxxxxx", "branch_number": "xxx", "expiry_date": "2019-10-11" } } }
Error Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | False |
2 | message | String | Message of the Error |
3 | status | Integer | HTTP Status Code |
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.62.0-20231122 © The Payment Cards Group Limited. All rights reserved.