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
3 shared Boolean Share file or not
4 br_number String Business Registration number (for type='br' only, optional)
5 branch_number Numeric String Branch number of the company (for type='br' only, optional, default: 000)
6 expiry_date Date Expiry Date of the BR (for type='br' only, optional), format: YYYY-mm-dd

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 Type of the Image
7 size String Size of the File
8 shared String Whether the File is Shared or Not
9 br_number String Business Registration number (for type='br' only)
10 branch_number Numeric String Branch number of the company
11 expiry_date Date Expiry Date of the BR (for type='br' only)

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "7MoEKveW",
                    "user_id": "Rnp27ow8",
                    "type": "br",
                    "name": "xxx.jpg",
                    "description": "",
                    "mime": "image/jpeg",
                    "size": 7481,
                    "shared": true,
                    "br_number": "12345678",
                    "branch_number": "000",
                    "expiry_date": "2018-12-12",
                }
            }
        

Example Error Response

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

v1.19.0-20190522 © The Payment Cards Group Limited. All rights reserved.