Yedpay

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 conntract (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": "P5631VZG6Q7KN94JDX",
                        "company_id": "3PG7YQKY6VYODXJRVE",
                        "type": "offline_gateway_agreement",
                        "file_id": "3PG7YQKY65JODXJRVE",
                        "status": "generated",
                        "generated_at": "2019-10-23",
                        "client_approved_at": "",
                        "expires_at": "",
                        "created_at": 2020-04-01 06:02:13,
                        "updated_at": 2020-04-01 06:02:13
                    },
                    {
                        "id": "WJ3459ZDX49OY1RP8V",
                        "company_id": "6YEXR4KEEMYK3N8QG5",
                        "type": "online_gateway_agreement",
                        "file_id": "9302L8KRG2QOEPRYJ7",
                        "status": "signed",
                        "generated_at": "2019-10-23",
                        "client_approved_at": "2019-10-24",
                        "expires_at": "",
                        "created_at": 2020-04-01 06:02:13,
                        "updated_at": 2020-04-01 06:02:13
                    },
                    {
                        "id": "7E52LGO225LO68YJDQ",
                        "company_id": "R350MQONX59ZEJDYL4",
                        "type": "offline_gateway_agreement",
                        "file_id": "R87P15K5XDDZ4E6LW9",
                        "status": "in_effect",
                        "generated_at": "2019-10-23",
                        "client_approved_at": "2019-10-24",
                        "expires_at": "2021-10-24",
                        "created_at": 2020-04-01 06:02:13,
                        "updated_at": 2020-04-01 06:02:13
                    }
                ],
                "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
1 offline_gateway_agreement Offline Gateway Agreement
2 online_gateway_agreement Online Gateway Agreement

Possible Status

# Type Description
0 generated Contract has been generated
1 signed Contract has been signed/approved by the merchant
2 in_effect Contract is approved by staff and in effect
3 expired Contract is expired

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