Yedpay

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 client_approved_at String Date that client approved(signed) the contract (format: YYYY-MM-DD)(for type = "yedpay_contract" only)
12 expires_at String Expiry Date of the Contract (format: YYYY-MM-DD)(for type = "yedpay_contract" only)

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 buisness 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 company_name String Company name displayed in the CI (for last "ci" type file only)
16 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": "8YN319ZP38JKX2DJ7P",
                    "user_id": "3PG7YQKYN4NODXJRVE",
                    "uploader_id": "6PEQD4O488GZ5VY8W3",
                    "fileable_type": "App\Models\Company",
                    "fileable_id": "3590G4Z0D45O76QXV8",
                    "type": "logo",
                    "name": "xxxxxxxxxxxx",
                    "description": "xxxxxxxxxxxxx",
                    "mime": "xxxxxxx",
                    "size": 781,
                    "shared": false,
                    "updated_at": 2020-03-28 22:35:33
                }
            }

            //BR data
            {
                "success": true,
                "data": {
                    "id": "6YEXR4KEEJ4K3N8QG5",
                    "user_id": "3WJ2PMK6PPGZ7Y6DN5",
                    "uploader_id": "7VEXG3O8638ZY4PD0N",
                    "fileable_type": "App\Models\Company",
                    "fileable_id": "WJ3459ZDVW0ZY1RP8V",
                    "type": "br",
                    "name": "xxxxxxxxxxxx",
                    "description": "xxxxxxxxxxxxx",
                    "mime": "xxxxxxx",
                    "size": 781,
                    "shared": false,
                    "updated_at": 2020-03-28 22:35:33​,
                    "registered_company_name": "xxxxxxxxx",
                    "type_of_business": 1,
                    "br_number": "57172911",
                    "branch_number": "010",
                    "expiry_date": "2020-03-28"
                }
            }

            //CI data
            {
                "success": true,
                "data": {
                    "id": "7VEXG3O8GJWOY4PD0N",
                    "user_id": "6YEXR4KEE2YK3N8QG5",
                    "uploader_id": "3GWX1LKV0VXOER4NYP",
                    "fileable_type": "App\Models\Company",
                    "fileable_id": "WJ3459ZDJD0ZY1RP8V",
                    "type": "ci",
                    "name": "xxxxxxxxxxxx",
                    "description": "xxxxxxxxxxxxx",
                    "mime": "xxxxxxx",
                    "size": 781,
                    "shared": false,
                    "updated_at": 2020-03-28 22:35:33,
                    "ci_number": "66577181",
                    "company_name": "xxxxxxxxxxxx",
                    "date_of_establishment": "2020-03-28"
                }
            }


Example Error Response

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

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