Yedpay

Description (Show Company Application)

Show the information of the selected Company Application. (GET)

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

  • * company - provides the company info
  • * store - provides the store info

Example:

https://api.yedpay.com/v1/companies/{{company_id}}/applications?include=company

End Point

https://api.yedpay.com/v1/applications/{{company_application_id}}

Variable

# Name Type Description
1 company_application_id String Company Application'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 Show selected application's Information Success or Fail
2 data Array Include selected application's Information (api_key etc..)

Success Response - data

# Name Type Description
1 id String ID of the application
2 name String Name of Application
3 company_id String ID of Company
4 store_id String ID of Store
5 type Integer Application Type
1: OFFLINE
2: ONLINE
6 last_used String date of the latest application used record(nullable)
7 revoked_at String revoke date of the application (nullable)
8 created_at String create date of the application
9 updated_at String Last update date of the application

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "xxxxxx",
                    "name": "xxxxxx",
                    "company_id": "xxxxxx",
                    "store_id": "xxxxxxx",
                    "type": 2,
                    "last_used": "2019-03-12 16:39:26",
                    "revoked_at": "",
                    "created_at": "2019-03-12 16:39:26"
                    "updated_at": "2019-03-12 16:39:26"
                }
            }
        

Example Error Response

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

v1.30.1-20191128 © The Payment Cards Group Limited. All rights reserved.