Yedpay

Description (Users List)

Show the list of users (operators) related with the companies, only available for Owners of the company. (GET)

Queries

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

  • * username - username of the user
  • * first_name - first_name of the user
  • * last_name - last_name of the user
  • * email - email of the user
  • * activated - whether the user is activated or not (1 or 0)
  • * created_at - date of user created (Y-m-d)

Example:

https://api.yedpay.com/v1/users?username=JhonDoe&first_name=Jhon&last_name=Doe&email=jhon@doe.com&activated=1&created_at>2018-01-01

End Point

https://api.yedpay.com/v1/users

Request Header

# Key Value Description
1 Authorization Bearer {{access_token}} Login Token

Body

# Name Type Description

Response

# Name Type Description
1 success Boolean Request Success or Fail
2 data Array Include all operator's Information (id, company_iD, role etc..)
3 meta Array Include all pagination Information (total, count, per_page etc..)

Success Response - data

# Name Type Description
1 id String Id of the User
2 company_id String Id of the Company
3 role String Role of the User
4 email String Email of the User
5 phone String Country code and Phone number of the User
6 username String Username of the User
7 first_name String First Name of the User
8 last_name String Last Name of the User
9 operation_id String Operation ID of User (For Taxi User ONLY)
10 driving_license String Driving license of User (For Taxi User ONLY)
11 can_refund Boolean Authorization of Refund
12 disabled Boolean Authorization if Disabled
13 last_login_time String Last Login DateTime of user "YYYY-mm-dd h:i:s"
14 created_at String DateTime of user was created "YYYY-mm-dd h:i:s"
15 updated_at String Last modification DateTime of user "YYYY-mm-dd h:i:s"

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "JwoMPpKy",
                        "company_id": "ZOQWDG7K",
                        "role": "owner",
                        "email": "xxx@xxx.com",
                        "phone": "+852-12345678",
                        "username": "xxxx",
                        "first_name": "xxxx",
                        "last_name": "xxxx",
                        "can_refund": true,
                        "disabled": false,
                        "last_login_time": "2018-08-13 13:10:29",
                        "created_at": "2018-03-06 13:38:48",
                        "updated_at": "2018-03-08 14:09:58"
                    },
                    {
                        "id": "VRQO2PLO",
                        "company_id": "ZOQWDG7K",
                        "role": "owner",
                        "email": "",
                        "phone": "+852-12345678",
                        "username": "xxxx",
                        "first_name": "xxxx",
                        "last_name": "xxxx",
                        "operation_id": "xxx",
                        
                        "driving_license": "xxxxxxxxx",
                        "can_refund": true,
                        "disabled": false,
                        "last_login_time": "2018-08-13 13:10:29",
                        "created_at": "2018-03-06 13:38:48",
                        "updated_at": "2018-03-13 12:08:59"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 2,
                        "count": 2,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }
        

Error Response

# Name Type Description
1 success Boolean False
2 message String Message of the Error
3 status Integer HTTP Status Codes

Example Error Response

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

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