Yedpay API Documentation

Description (Company Contract List)

Company Contract list (GET)

Queries

In order to search you can add in the url the follow parameters.

* limit - control the records show on each page (if not set, default load 40 records)
* page - control load the number of the page

Example:

https://api.yedpay.com/v1/companies/{{company_id}}/contracts?limit=50&page=1

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": "M49E60Z7WERO17G5DN",
                        "company_id": "3GWX1LKV1X9ZER4NYP",
                        "type": "offline_gateway_agreement",
                        "file_id": "PWN67LK1LV6KQX540E",
                        "status": "INACTIVE",
                        "generated_at": "2019-10-23",
                        "client_approved_at": "",
                        "expires_at": "",
                        "created_at": 2026-04-18 18:29:00,
                        "updated_at": 2026-04-18 18:29:00
                    },
                    {
                        "id": "6YEXR4KEEGYK3N8QG5",
                        "company_id": "7V8GMYOWEMJOEJ5NL2",
                        "type": "online_gateway_agreement",
                        "file_id": "6PEQD4O4NQGK5VY8W3",
                        "status": "INACTIVE",
                        "generated_at": "2019-10-23",
                        "client_approved_at": "2019-10-24",
                        "expires_at": "",
                        "created_at": 2026-04-18 18:29:00,
                        "updated_at": 2026-04-18 18:29:00
                    },
                    {
                        "id": "WP5631VZG47ON94JDX",
                        "company_id": "M49E60Z7N6LO17G5DN",
                        "type": "offline_gateway_agreement",
                        "file_id": "80P79LK9884ZVXJ1DQ",
                        "status": "ACTIVE",
                        "generated_at": "2019-10-23",
                        "client_approved_at": "2019-10-24",
                        "expires_at": "2021-10-24",
                        "created_at": 2026-04-18 18:29:00,
                        "updated_at": 2026-04-18 18:29:00
                    }
                ],
                "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