Description (Company Contract List)
Company Contract list (GET)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/contracts
Variable
# | Name | Type | Description |
---|---|---|---|
1 | company_id | String | Unique identifier of the company |
Request Header
# | Key | Value | Description |
---|---|---|---|
1 | Authorization | Bearer {{access_token}} | Login Token |
Body
# | Name | Type | Description |
---|
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Show Contract Information Success or Fail |
2 | data | Array | Include Contract Information (id, file_id, type etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | Unique identifier of the contract |
2 | company_id | String | Unique identifier of the company related to the contract |
3 | type | String | Type of the contract |
4 | file_id | String | Unique identifier of the contract file |
5 | status | String | Status of the contract |
6 | generated_at | String | Date of contract being generated (format: YYYY-MM-DD) |
7 | client_approved_at | String | Date of contract being signed/approved by client (format: YYYY-MM-DD) |
8 | expires_at | String | Expiry date of the contract (format: YYYY-MM-DD) |
9 | created_at | String | Datetime of contract model being created (format: YYYY-MM-DD hh:mm:ss) |
10 | updated_at | String | Datetime the contract last updated (format: YYYY-MM-DD hh:mm:ss) |
Example Success Response
{ "success": true, "data": [ { "id": "2M49E60Z7XGZ17G5DN", "company_id": "3WJ2PMK63W9K7Y6DN5", "type": "offline_gateway_agreement", "file_id": "9302L8KR7RRKEPRYJ7", "status": "INACTIVE", "generated_at": "2019-10-23", "client_approved_at": "", "expires_at": "", "created_at": 2023-11-28 20:49:53, "updated_at": 2023-11-28 20:49:53 }, { "id": "VJ9310KLW52Z4LM26Y", "company_id": "MJ86QYO3Y12KEP3RG5", "type": "online_gateway_agreement", "file_id": "3590G4Z02MLO76QXV8", "status": "INACTIVE", "generated_at": "2019-10-23", "client_approved_at": "2019-10-24", "expires_at": "", "created_at": 2023-11-28 20:49:53, "updated_at": 2023-11-28 20:49:53 }, { "id": "VJ9310KL27DO4LM26Y", "company_id": "2NMJVPOMEMMZ70RL8W", "type": "offline_gateway_agreement", "file_id": "3GWX1LKVEG6OER4NYP", "status": "ACTIVE", "generated_at": "2019-10-23", "client_approved_at": "2019-10-24", "expires_at": "2021-10-24", "created_at": 2023-11-28 20:49:53, "updated_at": 2023-11-28 20:49:53 } ], "meta": { "pagination": { "total": 2, "count": 2, "per_page": 40, "current_page": 1, "total_pages": 1, "links": [] } } }
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 |
Possible Status
Type | Description |
---|---|
ACTIVE | Contract is active |
INACTIVE | Contract is inactive |
v1.62.0-20231122 © The Payment Cards Group Limited. All rights reserved.