Description (Update Company)
Update information of the selected company. (PUT)
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 | name | String | Name of the Company |
2 | address | String | Address of the Company |
3 | contact_name | String | Name of the Contact Person (Maximum: 60characters) |
4 | contact_mobile | Numeric String | Mobile of the Contact Person |
5 | business_commencement_date | Date | Business commencement date of the company(Format: YYYY-mm-dd) |
6 | business_description | String | Business description of the company (Maximum: 255 characters) |
7 | website | Url | Business website of the company (Maximum: 100 characters) |
8 | lang | String | Language code for MCC (default: en) Available language code: en,zh |
9 | business_registration | Array | Business Registration information of the company |
Business Registration update request
# | Name | Type | Description |
---|---|---|---|
1 | br_number | Numeric String | Business Registration number of the company (8 digits) |
2 | branch_number | Numeric String | Branch number of the company (3 digits) |
3 | expiry_date | Date | Expiry Date of the BR, format: YYYY-mm-dd |
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Update Selected Company's Information Success or Fail |
2 | data | Array | Include Selected Company's Information (company_id, identifier, address etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | Id of the Company |
2 | identifier | String | Identifier of the Company |
3 | merchant_identifier | String | Merchant Identifier of the Company |
4 | name | String | Name of the Company |
5 | english_name | String | English Name of the Company |
6 | mcc | String | Merchant Category Code of the Company |
7 | mcc_description | String | Merchant Category Code Description of the Company |
8 | merchant_type | String | Type of Merchant (INDIVIDUAL or ENTERPRISE) |
9 | merchant_subtype | String | Subtype of Merchant |
10 | operation_id | String | Subtype of Merchant |
11 | business_type | String | Subtype of Merchant |
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 | Address of the Company |
15 | website | Url | Business website of the Company |
16 | contact_name | String | Name of the Contact Person |
17 | contact_mobile | Numeric String | Mobile of the Contact Person |
18 | business_description | String | Business description of the Company |
19 | status | String | Index of status of the Company |
20 | auto_settlement | Boolean | Status of auto settlement (true/false) |
21 | created_at | String | Date when the company was created "YYYY-mm-dd h:i:s" |
22 | business_registration | Array | Business Registration information of the company |
Business Registration detail response
# | Name | Type | Description |
---|---|---|---|
1 | id | String | ID of the Business Registration (Admin ONLY) |
2 | file_id | String | File Id of the Business Registration (Admin ONLY) |
3 | company_id | String | ID of the Company (Admin ONLY) |
4 | company_name | String | Company Name (Admin ONLY) |
5 | br_number | Numeric 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 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.61.15-20230523 © The Payment Cards Group Limited. All rights reserved.