Yedpay

Description (Show User)

Action to show information related with the selected user. (GET)

Can include the follow parameters separated by comma "," adding the parameter "include" in the url to get more information:

  • * stores - provide all stores related with the user.
  • * company - provides the companies related with the user. (SuperOwner: show the first company only)

Example:

https://api.yedpay.com/v1/users/{{user_id}}?include=company,stores

End Point

https://api.yedpay.com/v1/users/{{user_id}}

Variable

# Name Type Description
1 user_id String User's ID

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 User's Information (id, company_id, role 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

            Response for Normal User:
            {
                "success": true,
                "data": {
                    "id": "JwoMPpKy",
                    "company_id": "JwoMPpKy",
                    "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"
                }
            }

            Response for Taxi User:
            {
                "success": true,
                "data": {
                    "id": "JwoMPpKy",
                    "company_id": "JwoMPpKy",
                    "role": "owner",
                    "email": "",
                    "phone": "+852-12345678",
                    "username": "xxxx",
                    "first_name": "xxxx",
                    "last_name": "xxxx",
                    "operation_id": "xxxx",
                    
                    "driving_license": "xxxxxx",
                    "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"
                }
            }
        

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": "No query results",
                "status": 500
            }
        

v1.28.0-20190905 © The Payment Cards Group Limited. All rights reserved.