Description (Upload File to Company Entity)
Action to upload files which relate to company. (POST)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/documents
Variable
# | Name | Type | Description |
---|---|---|---|
1 | company_id | String | Company's ID |
Request Header
# | Key | Value | Description |
---|---|---|---|
1 | Authorization | Bearer {{access_token}} | Login Token |
2 | Content-Type | multipart/form-data | Form-data |
Body
# | Name | Type | Description |
---|---|---|---|
1 | file | File | Select the desired file |
2 | type | String | The type of file (Type "store_br" is for admin ONLY) |
3 | shared | Boolean | Share file or not |
4 | br_number | String | Business Registration number (for type='br' or 'store_br' only, optional) |
5 | branch_number | Numeric String | Branch number of the company (for type='br' or 'store_br' only, optional, default: 000) |
6 | expiry_date | Date | Expiry Date of the BR (for type='br' or 'store_br' only, optional), format: YYYY-mm-dd |
7 | store_id | String | Store ID of the Store BR (for type = 'store_br' only) |
8 | ci_number | String | Number of the CI (for type = "ci" only) |
9 | company_name | String | Company name displayed in the CI (for type = "ci" only) |
10 | date_of_establishment | String | CI's date of establishment (format: YYYY-MM-DD)(for type = "ci" only) |
11 | contract_type | Integer | Type of the contract (Required when type = "yedpay_contract") |
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Upload File Success or Fail |
2 | data | Array | Include File's Information (id, user_id, type, etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | Id of the File |
2 | user_id | String | Id of the User |
3 | type | String | Type of the File |
4 | name | String | Name of the File |
5 | description | String | Description of the File |
6 | mime | String | MIME Type of the File |
7 | size | Integer | Size of the File |
8 | shared | Boolean | Whether the File is Shared or Not (true/false) |
9 | br_number | String | Business Registration number (for type="br" or "store_br" only) |
10 | branch_number | Numeric String | Branch number of the BR (for type="br" or "store_br" only) |
11 | registered_company_name | String | Company name displayed in the BR (for "br" type file only) |
12 | type_of_business | Integer | Type of business registered via the BR (for "br" type file only) |
13 | expiry_date | String | Expiry Date of the BR (format: yyyy-MM-dd) (for type="br" or "store_br" only) |
14 | ci_number | String | Number of the CI (for last "ci" type file only) |
15 | ir_number | String | Number of the IR (for last "ir" type file only) |
16 | company_name | String | Company name displayed in the CI/IR (for last "ci" / "ir" type file only) |
17 | date_of_establishment | String | CI's date of establishment (format: yyyy-MM-dd) (for last "ci" type file only) |
Example Success Response
//normal data { "success": true, "data": { "id": "Q1N07LOJY1VO35P2GD", "user_id": "8YN319ZPM90ZX2DJ7P", "uploader_id": "3GWX1LKVQ86OER4NYP", "fileable_type": "App\Models\Company", "fileable_id": "67VEXG3O82DOY4PD0N", "type": "logo", "name": "xxxxxxxxxxxx", "description": "xxxxxxxxxxxxx", "mime": "xxxxxxx", "size": 781, "shared": false, "updated_at": 2023-09-27 16:16:19 } } //BR data { "success": true, "data": { "id": "3PG7YQKYM0YKDXJRVE", "user_id": "3GWX1LKV546KER4NYP", "uploader_id": "WJ3459ZDW30KY1RP8V", "fileable_type": "App\Models\Company", "fileable_id": "7VEXG3O85W8OY4PD0N", "type": "br", "name": "xxxxxxxxxxxx", "description": "xxxxxxxxxxxxx", "mime": "xxxxxxx", "size": 781, "shared": false, "updated_at": 2023-09-27 16:16:19, "registered_company_name": "xxxxxxxxx", "type_of_business": 2, "br_number": "52117799", "branch_number": "008", "expiry_date": "2023-09-27" } } //CI data { "success": true, "data": { "id": "E03QYVJKQ60KN8LM51", "user_id": "PWN67LK17GJKQX540E", "uploader_id": "7E52LGO2PXWO68YJDQ", "fileable_type": "App\Models\Company", "fileable_id": "3GWX1LKVXRJZER4NYP", "type": "ci", "name": "xxxxxxxxxxxx", "description": "xxxxxxxxxxxxx", "mime": "xxxxxxx", "size": 781, "shared": false, "updated_at": 2023-09-27 16:16:19, "ci_number": "36587554", "company_name": "xxxxxxxxxxxx", "date_of_establishment": "2023-09-27" } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
Available Contract Type
# | Type | Description |
---|---|---|
0 | other_agreement | Other Agreement |
1 | offline_gateway_agreement | Offline Gateway Agreement |
2 | online_gateway_agreement | Online Gateway Agreement |
v1.61.22-20230912 © The Payment Cards Group Limited. All rights reserved.